Annotation of pkgsrc/doc/pkgsrc.html, revision 1.367
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.132 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
1.148 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75 rillig 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.110 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.75 rillig 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.110 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.75 rillig 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.366 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.148 asau 35: <div><div class="abstract">
1.75 rillig 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.210 leot 48: <dl class="toc">
1.75 rillig 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
1.75 rillig 56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
1.267 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.75 rillig 65: <dd><dl>
1.267 rillig 66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 67: <dd><dl>
1.267 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.75 rillig 70: </dl></dd>
1.267 rillig 71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 72: <dd><dl>
1.267 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.75 rillig 75: </dl></dd>
76: </dl></dd>
1.267 rillig 77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75 rillig 78: <dd><dl>
1.267 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.75 rillig 81: </dl></dd>
1.267 rillig 82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75 rillig 83: <dd><dl>
1.267 rillig 84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 85: <dd><dl>
1.267 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.317 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.75 rillig 94: </dl></dd>
1.267 rillig 95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75 rillig 96: <dd><dl>
1.267 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.75 rillig 100: </dl></dd>
101: </dl></dd>
1.267 rillig 102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75 rillig 103: <dd><dl>
1.267 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.355 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.88 wiz 113: </dl></dd>
1.355 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.75 rillig 116: </dl></dd>
1.267 rillig 117: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75 rillig 118: <dd><dl>
1.267 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.106 rillig 121: </dl></dd>
1.267 rillig 122: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 123: builds)</a></span></dt>
1.75 rillig 124: <dd><dl>
1.267 rillig 125: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 126: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 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.293 rillig 129: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
130: <dd><dl>
1.294 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.296 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.293 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.267 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.128 wiz 162: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 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.336 nia 164: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267 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.75 rillig 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.267 rillig 174: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299 rillig 175: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91 rillig 176: <dd><dl>
1.299 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.91 rillig 180: <dd><dl>
1.299 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.91 rillig 186: </dl></dd>
1.299 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.106 rillig 196: </dl></dd>
1.299 rillig 197: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106 rillig 198: <dd><dl>
1.299 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.106 rillig 204: <dd><dl>
1.299 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.106 rillig 207: </dl></dd>
1.299 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.106 rillig 224: <dd><dl>
1.334 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.106 rillig 228: </dl></dd>
1.299 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.106 rillig 231: </dl></dd>
1.299 rillig 232: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 233: <dd><dl>
1.299 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.106 rillig 238: <dd><dl>
1.299 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.344 gutterid 243: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.106 rillig 244: </dl></dd>
245: </dl></dd>
1.299 rillig 246: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106 rillig 247: <dd><dl>
1.299 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.106 rillig 252: </dl></dd>
1.299 rillig 253: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106 rillig 254: <dd><dl>
1.299 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.106 rillig 263: <dd><dl>
1.299 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.133 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.106 rillig 270: </dl></dd>
1.299 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.355 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.299 rillig 273: </dl></dd>
274: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106 rillig 275: <dd><dl>
1.299 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.106 rillig 285: </dl></dd>
1.299 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.106 rillig 292: </dl></dd>
1.299 rillig 293: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106 rillig 294: <dd><dl>
1.299 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.353 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.299 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.267 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.338 nia 336: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.267 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.320 wiz 342: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338 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.267 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.287 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.267 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.318 nia 363: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 364: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
365: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 366: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
367: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
368: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
369: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
370: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
371: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
372: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 373: emulation</a></span></dt>
1.318 nia 374: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
375: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.77 rillig 376: </dl></dd>
1.267 rillig 377: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 378: </dl></dd>
1.299 rillig 379: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
380: <dd><dl>
381: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
382: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
383: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
384: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
385: </dl></dd>
1.267 rillig 386: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 387: <dd><dl>
1.267 rillig 388: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
389: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
390: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
391: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
392: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
393: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
394: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
395: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
396: </dl></dd>
397: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75 rillig 398: </dl></dd>
399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
400: <dd><dl>
1.299 rillig 401: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 402: <dd><dl>
1.299 rillig 403: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
404: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
405: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81 rillig 406: <dd><dl>
1.299 rillig 407: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
408: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81 rillig 409: </dl></dd>
1.299 rillig 410: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
411: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 412: <dd><dl>
1.299 rillig 413: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
414: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 415: </dl></dd>
1.299 rillig 416: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 417: <dd><dl>
1.299 rillig 418: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
419: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 420: </dl></dd>
421: </dl></dd>
1.299 rillig 422: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 423: <dd><dl>
1.299 rillig 424: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
425: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 426: <dd><dl>
1.299 rillig 427: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
428: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 429: </dl></dd>
430: </dl></dd>
1.299 rillig 431: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
432: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75 rillig 433: </dl></dd>
434: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
435: <dd><dl>
436: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
437: <dd><dl>
438: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
439: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
440: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287 rillig 441: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 442: </dl></dd>
443: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
444: </dl></dd>
1.322 leot 445: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.75 rillig 446: <dd><dl>
1.322 leot 447: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
448: <dd><dl>
449: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
450: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
451: </dl></dd>
452: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
453: <dd><dl>
454: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
455: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
456: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
457: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
458: </dl></dd>
459: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
460: <dd><dl>
461: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
462: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
463: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
464: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
465: </dl></dd>
466: </dl></dd>
467: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
468: <dd><dl>
469: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
470: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.75 rillig 471: </dl></dd>
1.322 leot 472: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.76 rillig 473: <dd><dl>
1.322 leot 474: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
475: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
476: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
477: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
478: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.261 leot 479: <code class="filename">stable</code>,
1.128 wiz 480: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 481: source packages</a></span></dt>
482: </dl></dd>
1.322 leot 483: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
484: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75 rillig 485: <dd><dl>
1.322 leot 486: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
487: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75 rillig 488: </dl></dd>
489: </dl>
490: </div>
1.82 rillig 491: <div class="list-of-tables">
492: <p><b>List of Tables</b></p>
493: <dl>
494: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
495: </dt>
1.299 rillig 496: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 497: </dt>
1.299 rillig 498: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 499: </dt>
1.82 rillig 500: </dl>
501: </div>
1.148 asau 502: <div class="chapter">
503: <div class="titlepage"><div><div><h1 class="title">
504: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 505: <div class="toc">
506: <p><b>Table of Contents</b></p>
1.210 leot 507: <dl class="toc">
1.75 rillig 508: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 509: <dd><dl>
510: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
511: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
512: </dl></dd>
1.75 rillig 513: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
514: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 515: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 516: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
517: </dl>
518: </div>
1.148 asau 519: <div class="sect1">
1.75 rillig 520: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
521: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 522: <p>There is a lot of software freely available for Unix-based
523: systems, which is usually available in form of the source code. Before
524: such software can be used, it needs to be configured to the local
525: system, compiled and installed, and this is exactly what The NetBSD
526: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
527: to handle binary packages, so that not every user has to build the
528: packages for himself, which is a time-costly task.</p>
1.75 rillig 529: <p>pkgsrc currently contains several thousand packages,
530: including:</p>
1.148 asau 531: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 532: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.75 rillig 533: web server</p></li>
1.322 leot 534: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75 rillig 535: web browser</p></li>
1.322 leot 536: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75 rillig 537: Desktop Environment</p></li>
1.322 leot 538: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.75 rillig 539: Desktop Environment</p></li>
540: </ul></div>
1.219 rillig 541: <p>… just to name a few.</p>
1.75 rillig 542: <p>pkgsrc has built-in support for handling varying dependencies,
543: such as pthreads and X11, and extended features such as IPv6 support on
544: a range of platforms.</p>
1.148 asau 545: <div class="sect2">
1.82 rillig 546: <div class="titlepage"><div><div><h3 class="title">
547: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
548: <p>
549: pkgsrc provides the following key features:
550: </p>
1.148 asau 551: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 552: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 553: and installation of binary packages. The source and latest
554: patches are retrieved from a master or mirror download site, checksum
555: verified, then built on your system. Support for binary-only
556: distributions is available for both native platforms and NetBSD
557: emulated platforms.</p></li>
1.128 wiz 558: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 559: including binaries, libraries, man pages and other
560: documentation.</p></li>
1.214 sevan 561: <li class="listitem"><p>Tracking of package dependencies automatically, including when
562: performing updates, to ensure required packages are installed. The
563: configuration files of various packages are handled automatically during
564: updates, so local changes are preserved.</p></li>
1.128 wiz 565: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 566: consists of highly portable code. This allows the greatest speed of
1.132 spz 567: development when porting to a new platform. This portability also
1.82 rillig 568: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
569: platforms</em></span>.</p></li>
1.128 wiz 570: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 571: international encryption requirements and build-time options for a
572: large number of packages are all set in a simple, central
573: configuration file.</p></li>
1.128 wiz 574: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 575: freely available under a BSD license, so you may extend and adapt
576: pkgsrc to your needs. Support for local packages and patches is
577: available right out of the box, so you can configure it specifically
578: for your environment.</p></li>
579: </ul></div>
1.91 rillig 580: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 581: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 582: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 583: — That means, if a package contains bugs, it's better to find
1.91 rillig 584: them and to complain about them rather than to just install the package
585: and hope that it works. There are numerous checks in pkgsrc that try to
1.322 leot 586: find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91 rillig 587: of shell scripts), and post-installation checks (installed files,
588: references to shared libraries, script interpreters).</p></li>
1.128 wiz 589: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 590: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 591: pkgsrc has been ported to many operating systems. Care is taken that
592: packages behave the same on all platforms.</p></li>
593: </ul></div>
1.82 rillig 594: </div>
1.148 asau 595: <div class="sect2">
1.82 rillig 596: <div class="titlepage"><div><div><h3 class="title">
597: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
598: <p>pkgsrc consists of both a source distribution and a binary
599: distribution for these operating systems. After retrieving the required
600: source or binaries, you can be up and running with pkgsrc in just
601: minutes!</p>
1.75 rillig 602: <p>pkgsrc was derived from FreeBSD's ports system, and
603: initially developed for NetBSD only. Since then, pkgsrc has
604: grown a lot, and now supports the following platforms:</p>
1.82 rillig 605: <div class="table">
606: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216 tnn 607: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 608: <colgroup>
609: <col>
610: <col>
1.202 sevan 611: <col>
1.82 rillig 612: </colgroup>
613: <thead><tr>
614: <th>Platform</th>
615: <th>Date Support Added</th>
1.202 sevan 616: <th>Notes</th>
1.82 rillig 617: </tr></thead>
618: <tbody>
619: <tr>
1.289 leot 620: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 621: <td align="center">Aug 1997</td>
1.202 sevan 622: <td class="auto-generated"> </td>
1.82 rillig 623: </tr>
624: <tr>
1.110 hubertf 625: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 626: <td align="center">Mar 1999</td>
1.264 sevan 627: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.82 rillig 628: </tr>
629: <tr>
1.289 leot 630: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 631: <td align="center">Jun 1999</td>
1.264 sevan 632: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.82 rillig 633: </tr>
634: <tr>
635: <td>
1.230 sevan 636: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82 rillig 637: </td>
638: <td align="center">Oct 2001</td>
1.305 bacon 639: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.82 rillig 640: </tr>
641: <tr>
1.289 leot 642: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 643: <td align="center">Nov 2002</td>
1.264 sevan 644: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.82 rillig 645: </tr>
646: <tr>
1.289 leot 647: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 648: <td align="center">Nov 2002</td>
1.264 sevan 649: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.82 rillig 650: </tr>
651: <tr>
1.289 leot 652: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 653: <td align="center">Dec 2002</td>
1.202 sevan 654: <td>
1.264 sevan 655: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.202 sevan 656: </td>
1.82 rillig 657: </tr>
658: <tr>
659: <td>BSD/OS</td>
660: <td align="center">Dec 2003</td>
1.202 sevan 661: <td class="auto-generated"> </td>
1.82 rillig 662: </tr>
663: <tr>
1.289 leot 664: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 665: <td align="center">Dec 2003</td>
1.264 sevan 666: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.82 rillig 667: </tr>
668: <tr>
669: <td>
1.289 leot 670: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 671: (Microsoft Windows Services for Unix)
672: </td>
673: <td align="center">Mar 2004</td>
1.264 sevan 674: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.82 rillig 675: </tr>
676: <tr>
1.289 leot 677: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 678: <td align="center">Oct 2004</td>
1.202 sevan 679: <td class="auto-generated"> </td>
1.82 rillig 680: </tr>
681: <tr>
1.110 hubertf 682: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 683: <td align="center">Nov 2004</td>
1.264 sevan 684: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.82 rillig 685: </tr>
1.98 wiz 686: <tr>
1.289 leot 687: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 688: <td align="center">Apr 2007</td>
1.264 sevan 689: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.98 wiz 690: </tr>
1.128 wiz 691: <tr>
1.289 leot 692: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128 wiz 693: <td align="center">Sep 2010</td>
1.264 sevan 694: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.128 wiz 695: </tr>
1.151 obache 696: <tr>
1.289 leot 697: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 698: <td align="center">Jan 2011</td>
1.202 sevan 699: <td class="auto-generated"> </td>
1.151 obache 700: </tr>
701: <tr>
1.289 leot 702: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151 obache 703: <td align="center">Nov 2011</td>
1.264 sevan 704: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.151 obache 705: </tr>
706: <tr>
1.289 leot 707: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151 obache 708: <td align="center">Mar 2013</td>
1.264 sevan 709: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.151 obache 710: </tr>
1.166 jnemeth 711: <tr>
1.289 leot 712: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166 jnemeth 713: <td align="center">Jul 2013</td>
1.264 sevan 714: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.166 jnemeth 715: </tr>
1.214 sevan 716: <tr>
1.289 leot 717: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214 sevan 718: <td align="center">Jun 2014</td>
1.344 gutterid 719: <td>Removed from pkgsrc Sep 2022</td>
1.214 sevan 720: </tr>
1.82 rillig 721: </tbody>
1.91 rillig 722: </table></div>
1.82 rillig 723: </div>
1.91 rillig 724: <br class="table-break">
1.82 rillig 725: </div>
1.75 rillig 726: </div>
1.148 asau 727: <div class="sect1">
1.75 rillig 728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
729: <a name="overview"></a>1.2. Overview</h2></div></div></div>
730: <p>This document is divided into three parts. The first,
1.110 hubertf 731: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 732: describes how one can use one of the packages in the Package
733: Collection, either by installing a precompiled binary package,
1.93 rillig 734: or by building one's own copy using the NetBSD package system.
1.110 hubertf 735: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75 rillig 736: package so it can be easily built by other NetBSD users without
737: knowing about the package's building details. The third part,
1.110 hubertf 738: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 739: is intended for those who want to understand how pkgsrc is
740: implemented.</p>
741: <p>This document is available in various formats:
1.110 hubertf 742: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75 rillig 743: </div>
1.148 asau 744: <div class="sect1">
1.75 rillig 745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
746: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 747: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
748: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 749: terminology used within this document.</p>
1.148 asau 750: <div class="variablelist"><dl class="variablelist">
1.75 rillig 751: <dt><span class="term">Package</span></dt>
752: <dd><p>A set of files and building instructions
753: that describe what's necessary
754: to build a certain piece of software using
755: pkgsrc. Packages are traditionally stored under
1.236 wiz 756: <code class="filename">/usr/pkgsrc</code>,
757: but may be stored in any location,
758: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75 rillig 759: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 760: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 761: is part of the NetBSD operating system and can be bootstrapped
762: to run on non-NetBSD operating systems as well. It handles
763: building (compiling), installing, and removing of
764: packages.</p></dd>
1.75 rillig 765: <dt><span class="term">Distfile</span></dt>
766: <dd><p>This term describes the file or files that are
767: provided by the author of the piece of software to
768: distribute his work. All the changes necessary to build on
769: NetBSD are reflected in the corresponding package. Usually
770: the distfile is in the form of a compressed tar-archive,
771: but other types are possible, too. Distfiles are usually
772: stored below
1.76 rillig 773: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 774: <dt><span class="term">Port</span></dt>
775: <dd><p>This is the term used by FreeBSD and OpenBSD people
776: for what we call a package.
1.128 wiz 777: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 778: architecture.</p></dd>
779: <dt><span class="term">Precompiled/binary package</span></dt>
780: <dd>
781: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 782: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 783: file so it can be installed on machines of the same
784: machine architecture without the need to
785: recompile. Packages are usually generated in
1.76 rillig 786: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 787: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 788: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 789: especially in the context of precompiled packages.</p>
790: </dd>
791: <dt><span class="term">Program</span></dt>
1.88 wiz 792: <dd><p>The piece of software to be installed which will be
793: constructed from all the files in the distfile by the
794: actions defined in the corresponding package.</p></dd>
1.75 rillig 795: </dl></div>
1.148 asau 796: <div class="sect2">
1.75 rillig 797: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 798: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 799: <div class="variablelist"><dl class="variablelist">
1.75 rillig 800: <dt><span class="term">pkgsrc users</span></dt>
801: <dd>
802: <p>The
803: pkgsrc users are people who use the packages provided by pkgsrc.
804: Typically they are system administrators. The people using the
1.128 wiz 805: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
806: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 807: <p>There are two kinds of pkgsrc users: Some only want to
808: install pre-built binary packages. Others build the pkgsrc
809: packages from source, either for installing them directly or for
1.110 hubertf 810: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.75 rillig 811: documentation.</p>
812: </dd>
813: <dt><span class="term">package maintainers</span></dt>
814: <dd><p>A
1.110 hubertf 815: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.75 rillig 816: <dt><span class="term">infrastructure developers</span></dt>
817: <dd><p>These people are involved in all those files
1.76 rillig 818: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 819: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.75 rillig 820: too.</p></dd>
821: </dl></div>
822: </div>
823: </div>
1.148 asau 824: <div class="sect1">
1.75 rillig 825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
826: <a name="typography"></a>1.4. Typography</h2></div></div></div>
827: <p>When giving examples for commands, shell prompts are used to
828: show if the command should/can be issued as root, or if
1.128 wiz 829: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.226 sevan 830: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
831: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.344 gutterid 832: Bourne shell and derivatives.</p>
1.75 rillig 833: </div>
834: </div>
1.148 asau 835: <div class="part">
1.75 rillig 836: <div class="titlepage"><div><div><h1 class="title">
837: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
838: <div class="toc">
839: <p><b>Table of Contents</b></p>
1.210 leot 840: <dl class="toc">
1.267 rillig 841: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
842: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75 rillig 843: <dd><dl>
1.267 rillig 844: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 845: <dd><dl>
1.267 rillig 846: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
847: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 848: </dl></dd>
1.267 rillig 849: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 850: <dd><dl>
1.267 rillig 851: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
852: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 853: </dl></dd>
854: </dl></dd>
1.267 rillig 855: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75 rillig 856: <dd><dl>
1.267 rillig 857: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
858: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 859: </dl></dd>
1.267 rillig 860: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75 rillig 861: <dd><dl>
1.267 rillig 862: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 863: <dd><dl>
1.267 rillig 864: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
865: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317 nia 866: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
867: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
868: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
869: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
870: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
871: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75 rillig 872: </dl></dd>
1.267 rillig 873: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75 rillig 874: <dd><dl>
1.267 rillig 875: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
876: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
877: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75 rillig 878: </dl></dd>
879: </dl></dd>
1.267 rillig 880: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75 rillig 881: <dd><dl>
1.267 rillig 882: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
883: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.355 rillig 884: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
885: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
886: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
887: <dd><dl>
888: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
889: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
890: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 891: </dl></dd>
1.355 rillig 892: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
893: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.75 rillig 894: </dl></dd>
1.267 rillig 895: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75 rillig 896: <dd><dl>
1.267 rillig 897: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
898: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 899: </dl></dd>
1.267 rillig 900: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 901: builds)</a></span></dt>
1.75 rillig 902: <dd><dl>
1.267 rillig 903: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 904: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 905: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
906: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 907: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
908: <dd><dl>
1.294 rillig 909: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
910: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296 rillig 911: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
912: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
913: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
914: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
915: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
916: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
917: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
918: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 919: </dl></dd>
920: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
921: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267 rillig 922: </dl></dd>
923: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
924: <dd><dl>
925: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
926: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
927: </dl></dd>
928: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
929: <dd><dl>
930: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
931: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
932: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
933: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
934: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
935: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
936: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
937: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
938: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
939: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 940: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 941: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.336 nia 942: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267 rillig 943: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
944: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
945: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
946: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
947: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 948: </dl></dd>
949: </dl>
950: </div>
1.148 asau 951: <div class="chapter">
1.75 rillig 952: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 953: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
954: <p>
955: To get help when using pkgsrc, the definitive source is this
956: document, the pkgsrc guide. If you don't find anything here,
957: there are alternatives:
958: </p>
959: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
960: <li class="listitem">
961: <p>
962: The built-in pkgsrc help, which is available after bootstrapping
963: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
964: help for any topic, such as a variable name like
965: <code class="varname">BUILD_DEFS</code>, a make target like
966: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
967: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322 leot 968: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.267 rillig 969: </li>
970: <li class="listitem"><p>
1.278 rillig 971: To see the value of a single variable, run <span class="command"><strong>bmake
972: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
973: </p></li>
974: <li class="listitem"><p>
975: To see the values of the most common variables, run
976: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
977: topic. To see the variables for a single topic, run
978: <span class="command"><strong>bmake
979: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
980: <span class="command"><strong>bmake show-all-fetch</strong></span>.
981: </p></li>
982: <li class="listitem"><p>
1.267 rillig 983: The pkgsrc-users mailing list, to which
984: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
985: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
986: questions</a>.</p></li>
987: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
988: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
989: or by using a specialized chat program such as
990: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
991: Pick any user name and join the channel #pkgsrc.</p></li>
992: </ul></div>
993: </div>
994: <div class="chapter">
995: <div class="titlepage"><div><div><h2 class="title">
996: <a name="getting"></a>Chapter 3. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
1.75 rillig 997: <div class="toc">
998: <p><b>Table of Contents</b></p>
1.210 leot 999: <dl class="toc">
1.267 rillig 1000: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 1001: <dd><dl>
1.267 rillig 1002: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
1003: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 1004: </dl></dd>
1.267 rillig 1005: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 1006: <dd><dl>
1.267 rillig 1007: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
1008: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 1009: </dl></dd>
1010: </dl>
1011: </div>
1.91 rillig 1012: <p>Before you download and extract the files, you need to decide
1013: where you want to extract them. When using pkgsrc as root user, pkgsrc
1014: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
1015: free to install the sources and binary packages wherever you want in
1016: your filesystem, provided that the pathname does not contain white-space
1017: or other characters that are interpreted specially by the shell and some
1018: other programs. A safe bet is to use only letters, digits, underscores
1019: and dashes.</p>
1.148 asau 1020: <div class="sect1">
1.75 rillig 1021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1022: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75 rillig 1023: <p>Before you download any pkgsrc files, you should decide
1024: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1025: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1026: quarterly basis from the current branch and only gets modified
1027: for security updates. The names of the stable branches are built
1028: from the year and the quarter, for example
1.360 leot 1029: <code class="literal">2023Q3</code>.</p>
1.75 rillig 1030: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 1031: want to download pkgsrc. You can get it as a tar file or via CVS.
1032: Both ways are described here.</p>
1.157 asau 1033: <p>Note that tar archive contains CVS working copy.
1034: Thus you can switch to using CVS at any later time.</p>
1.148 asau 1035: <div class="sect2">
1.75 rillig 1036: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1037: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75 rillig 1038: <p>The primary download location for all pkgsrc files is
1.264 sevan 1039: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157 asau 1040: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1041: (it points to the same location).
1042: There are a number of subdirectories for different purposes,
1.322 leot 1043: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix D. Directory layout of the pkgsrc FTP server">Appendix D, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.157 asau 1044: <p>The tar archive for the current branch is in the directory
1.264 sevan 1045: <code class="filename">current</code> and is called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.230 sevan 1046: It is autogenerated weekly.</p>
1.157 asau 1047: <p>To save download time we provide bzip2- and
1048: xz-compressed archives which are published at
1.264 sevan 1049: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
1.157 asau 1050: and
1.264 sevan 1051: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
1.157 asau 1052: respectively.
1053: </p>
1054: <p>You can fetch the same files using FTP.</p>
1.360 leot 1055: <p>The tar file for the stable branch 2023Q3 is in the
1056: 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.249 leot 1057: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112 weinem 1058: <pre class="screen">
1.360 leot 1059: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2023Q3/pkgsrc.tar.gz</code></strong></pre>
1.188 snj 1060: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 1061: or your web browser.</p>
1.112 weinem 1062: <p>Then, extract it with:</p>
1.188 snj 1063: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 weinem 1064: <p>This will create the directory <code class="filename">pkgsrc/</code>
1065: in <code class="filename">/usr/</code> and all the package source will be
1066: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1067: <p>To download pkgsrc-current, run:</p>
1068: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75 rillig 1069: </div>
1.148 asau 1070: <div class="sect2">
1.75 rillig 1071: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1072: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128 wiz 1073: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.360 leot 1074: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2023Q3 -P pkgsrc</code></strong>
1.128 wiz 1075: </pre>
1076: <p>This will create the directory <code class="filename">pkgsrc/</code>
1077: in your <code class="filename">/usr/</code> directory and all the package source
1078: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1079: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 1080: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 grant 1081: </pre>
1.289 leot 1082: <p>Refer to the <a class="ulink" href="https://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128 wiz 1083: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.146 wiz 1084: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.128 wiz 1085: </pre>
1086: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1087: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1088: or better globally in <code class="filename">/etc/profile</code>:</p>
1089: <pre class="programlisting">
1090: # set CVS remote shell command
1091: CVS_RSH=ssh
1092: export CVS_RSH
1093: </pre>
1094: <p>By default, CVS doesn't do things like most people would expect it to do.
1095: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1096: in your home directory and saving the following lines to it.
1097: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1098: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1099: <pre class="programlisting">
1100: # recommended CVS configuration file from the pkgsrc guide
1.268 sevan 1101: cvs -q
1.101 rillig 1102: checkout -P
1.103 wiz 1103: update -dP
1104: diff -upN
1.101 rillig 1105: rdiff -u
1.128 wiz 1106: release -d
1.101 rillig 1107: </pre>
1.75 rillig 1108: </div>
1109: </div>
1.148 asau 1110: <div class="sect1">
1.75 rillig 1111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1112: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75 rillig 1113: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1114: (which also works if you have first installed it via a tar
1115: file). It saves bandwidth and hard disk activity, compared to
1116: downloading the tar file again.</p>
1.148 asau 1117: <div class="sect2">
1.75 rillig 1118: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1119: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148 asau 1120: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1121: <h3 class="title">Warning</h3>
1.77 rillig 1122: <p>When updating from a tar file, you first need to
1123: completely remove the old pkgsrc directory. Otherwise those
1124: files that have been removed from pkgsrc in the mean time will
1125: not be removed on your local disk, resulting in inconsistencies.
1126: When removing the old files, any changes that you have done to
1127: the pkgsrc files will be lost after updating. Therefore updating
1128: via CVS is strongly recommended.</p>
1.75 rillig 1129: </div>
1.82 rillig 1130: <p>Note that by default the distfiles and the binary packages
1131: are saved in the pkgsrc tree, so don't forget to rescue them
1.188 snj 1132: before updating. You can also configure pkgsrc to store distfiles
1133: and packages in directories outside the pkgsrc tree by setting the
1.82 rillig 1134: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267 rillig 1135: variables. See <a class="xref" href="#configuring" title="Chapter 6. Configuring pkgsrc">Chapter 6, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 1136: <p>To update pkgsrc from a tar file, download the tar file as
1137: explained above. Then, make sure that you have not made any
1138: changes to the files in the pkgsrc directory. Remove the pkgsrc
1139: directory and extract the new tar file. Done.</p>
1140: </div>
1.148 asau 1141: <div class="sect2">
1.75 rillig 1142: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1143: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132 spz 1144: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1145: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1146: </pre>
1147: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
1148: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1149: </pre>
1.148 asau 1150: <div class="sect3">
1.75 rillig 1151: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1152: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75 rillig 1153: <p>When updating pkgsrc, the CVS program keeps track of the
1154: branch you selected. But if you, for whatever reason, want to
1155: switch from the stable branch to the current one, you can do it
1.128 wiz 1156: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1157: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1158: back to the stable branch, add the
1.360 leot 1159: <span class="quote">“<span class="quote">-rpkgsrc-2023Q3</span>”</span> option.</p>
1.75 rillig 1160: </div>
1.148 asau 1161: <div class="sect3">
1.75 rillig 1162: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1163: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75 rillig 1164: <p>When you update pkgsrc, the CVS program will only touch
1165: those files that are registered in the CVS repository. That
1166: means that any packages that you created on your own will stay
1167: unmodified. If you change files that are managed by CVS, later
1168: updates will try to merge your changes with those that have been
1169: done by others. See the CVS manual, chapter
1.128 wiz 1170: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1171: </div>
1172: </div>
1173: </div>
1174: </div>
1.148 asau 1175: <div class="chapter">
1.75 rillig 1176: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1177: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75 rillig 1178: <div class="toc">
1179: <p><b>Table of Contents</b></p>
1.210 leot 1180: <dl class="toc">
1.267 rillig 1181: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1182: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 1183: </dl>
1184: </div>
1.148 asau 1185: <div class="sect1">
1.75 rillig 1186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1187: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1188: <p>See <a class="xref" href="#using-pkg" title="5.1. Using binary packages">Section 5.1, “Using binary packages”</a>.</p>
1.82 rillig 1189: </div>
1.148 asau 1190: <div class="sect1">
1.82 rillig 1191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1192: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1193: <p>pkgsrc can be bootstrapped for use in two different modes:
1194: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1195: to privileged one all programs are installed under one particular user
1.149 asau 1196: and cannot utilise privileged operations (packages don't create
1197: special users and all special file permissions like setuid are ignored).
1198: </p>
1.82 rillig 1199: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1200: <pre class="screen">
1.167 asau 1201: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.75 rillig 1202: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1203: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1204: </pre>
1.149 asau 1205: <p>To bootstrap in unprivileged mode pass <span class="quote">“<span class="quote">--unprivileged</span>”</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
1206: <p>By default, in privileged mode pkgsrc uses
1207: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1208: where programs will be installed in,
1.230 sevan 1209: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149 asau 1210: directory where pkgsrc will do its internal bookkeeping,
1211: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1212: where packages install their persistent data.
1213: In unprivileged mode pkgsrc uses
1214: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230 sevan 1215: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149 asau 1216: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1217: </p>
1218: <p>You can change default layout using command-line arguments.
1219: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1220: </p>
1.148 asau 1221: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1222: <h3 class="title">Note</h3>
1.110 hubertf 1223: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1224: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1225: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1226: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1227: </div>
1.149 asau 1228: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1229: <h3 class="title">Note</h3>
1230: <p>It is possible to bootstrap multiple instances of pkgsrc
1231: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1232: corresponding to the installation you're working with to build
1233: and install packages.
1234: </p>
1235: </div>
1.75 rillig 1236: </div>
1237: </div>
1.148 asau 1238: <div class="chapter">
1.75 rillig 1239: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1240: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75 rillig 1241: <div class="toc">
1242: <p><b>Table of Contents</b></p>
1.210 leot 1243: <dl class="toc">
1.267 rillig 1244: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 1245: <dd><dl>
1.267 rillig 1246: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1247: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317 nia 1248: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1249: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1250: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1251: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1252: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
1253: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.267 rillig 1254: </dl></dd>
1255: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1256: <dd><dl>
1257: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1258: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1259: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75 rillig 1260: </dl></dd>
1261: </dl>
1262: </div>
1263: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1264: is to only install the package tools and to use binary packages
1.128 wiz 1265: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1266: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1267: of pkgsrc, too. Then you are able to build your own packages,
1268: and you can still use binary packages from someone else.</p>
1.148 asau 1269: <div class="sect1">
1.75 rillig 1270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1271: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.317 nia 1272: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264 sevan 1273: site and mirrors, there are collections of binary packages,
1.109 rillig 1274: ready to be installed. These binary packages have been built using the
1275: default settings for the directories, that is:</p>
1.148 asau 1276: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1277: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1278: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1279: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.109 rillig 1280: </ul></div>
1281: <p>If you cannot use these directories for whatever reasons (maybe
1282: because you're not root), you cannot use these binary packages, but
1.267 rillig 1283: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="4.2. Bootstrapping pkgsrc">Section 4.2, “Bootstrapping pkgsrc”</a>.</p>
1.148 asau 1284: <div class="sect2">
1.75 rillig 1285: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1286: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1287: <p>To install binary packages, you first need to know from where
1288: to get them. The first place where you should look is on the main
1.317 nia 1289: pkgsrc CDN in the directory <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105 weinem 1290: <p>This directory contains binary packages for multiple
1.341 gutterid 1291: platforms. First, select your operating system. Then, select your
1292: hardware architecture, and in the third step, the OS version and
1293: the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1294: <p>In this directory, you may find a file called
1.109 rillig 1295: <code class="filename">bootstrap.tar.gz</code> which contains the package
1296: management tools. If the file is missing, it is likely that your
1297: operating system already provides those tools. Download the file and
1298: extract it in the <code class="filename">/</code> directory. It will create
1299: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230 sevan 1300: for managing binary packages and the database of installed packages).</p>
1.75 rillig 1301: </div>
1.148 asau 1302: <div class="sect2">
1.75 rillig 1303: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1304: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1305: <p>In the directory from the last section, there is a
1.196 wiz 1306: subdirectory called <code class="filename">All/</code>, which contains all the
1.109 rillig 1307: binary packages that are available for the platform, excluding those
1.317 nia 1308: that may not be distributed via HTTP or FTP.</p>
1.109 rillig 1309: <p>To install packages directly from an FTP or HTTP server, run
1310: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1311: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1312: <pre class="screen">
1.317 nia 1313: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1314: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284 rillig 1315: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="$PKG_PATH/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.109 rillig 1316: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.317 nia 1317: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.109 rillig 1318: </pre>
1319: <p>Instead of URLs, you can also use local paths, for example if
1320: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1321: repository. If you want to install packages from multiple sources,
1322: you can separate them by a semicolon in
1323: <code class="varname">PKG_PATH</code>.</p>
1324: <p>After these preparations, installing a package is very
1325: easy:</p>
1326: <pre class="screen">
1.317 nia 1327: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1328: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1329: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1330: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1331: </pre>
1332: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1333: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1334: <p>Any prerequisite packages needed to run the
1.88 wiz 1335: package in question will be installed, too, assuming they are
1.317 nia 1336: present in the repository.</p>
1.75 rillig 1337: <p>After you've installed packages, be sure to have
1.88 wiz 1338: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1339: <code class="varname">PATH</code> so you can actually start the just
1340: installed program.</p>
1.75 rillig 1341: </div>
1.148 asau 1342: <div class="sect2">
1.75 rillig 1343: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1344: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1345: <p>To update binary packages, it is recommended that you use
1346: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1347: package repository to your locally installed packages and safely
1348: replace any older packages.</p>
1349: <p>Note that pkgsrc is released as quarterly branches.
1350: If you are updating to a newer quarterly branch of pkgsrc, you may
1351: need to adjust the repository in
1352: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1353: </div>
1354: <div class="sect2">
1355: <div class="titlepage"><div><div><h3 class="title">
1356: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.82 rillig 1357: <p>To deinstall a package, it does not matter whether it was
1.317 nia 1358: installed from source code or from a binary package. Neither the
1359: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1360: command need to know.</p>
1361: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.88 wiz 1362: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.317 nia 1363: name can be given with or without version number.</p>
1.82 rillig 1364: </div>
1.148 asau 1365: <div class="sect2">
1.82 rillig 1366: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1367: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1368: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.317 nia 1369: installed packages or binary package files.
1370: As with other management tools, it works with packages installed
1371: from source or binaries.</p>
1.82 rillig 1372: </div>
1.148 asau 1373: <div class="sect2">
1.82 rillig 1374: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1375: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82 rillig 1376: <p>
1.279 leot 1377: The pkgsrc Security Team and Packages Groups maintain a list of
1.317 nia 1378: known vulnerabilities to packages which are (or have been)
1.88 wiz 1379: included in pkgsrc. The list is available from the NetBSD
1.317 nia 1380: CDN at <a class="ulink" href="https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
1381: </p>
1382: <p>
1383: Please note that not every "vulnerability" with a CVE assignment is
1384: exploitable in every configuration.
1385: Some bugs are marked as active simply because an fix was not
1386: marked as such.
1387: Operating system specific hardening and mitigation features may also
1388: reduce the impact of bugs.
1.88 wiz 1389: </p>
1.82 rillig 1390: <p>
1.125 wiz 1391: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1392: this list can be downloaded
1393: automatically, and a security audit of all packages installed on a system
1394: can take place.
1395: </p>
1.82 rillig 1396: <p>
1.125 wiz 1397: There are two components to auditing. The first
1398: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1399: is for downloading
1.88 wiz 1400: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1401: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1402: installed packages are vulnerable. If a package is vulnerable, you
1403: will see output similar to the following:
1404: </p>
1.82 rillig 1405: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289 leot 1406: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1407: <p>
1.125 wiz 1408: You may wish to have the
1.317 nia 1409: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1410: file downloaded daily so that
1411: it remains current. This may be done by adding an appropriate entry
1.360 leot 1412: 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.125 wiz 1413: </p>
1414: <pre class="screen">
1.233 sevan 1415: # Download vulnerabilities file
1.230 sevan 1416: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.233 sevan 1417: # Audit the installed packages and email results to root
1418: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1419: root >/dev/null 2>&1
1.125 wiz 1420: </pre>
1421: <p>
1.230 sevan 1422: will update the vulnerability list every day at 3AM, followed by an audit
1423: at 3:09AM. The result of the audit are then emailed to root.
1.125 wiz 1424:
1.230 sevan 1425: On NetBSD this may be accomplished instead by adding the following
1426: line to <code class="filename">/etc/daily.conf</code>:
1427: </p>
1428: <pre class="screen">
1429: fetch_pkg_vulnerabilities=YES
1430: </pre>
1431: <p>
1432: to fetch the vulnerability list from the daily security script. The system
1433: is set to audit the packages by default but can be set explicitly, if
1.235 yyamano 1434: desired (not required), by adding the following line to
1.230 sevan 1435: <code class="filename">/etc/security.conf</code>:
1.125 wiz 1436: </p>
1437: <pre class="screen">
1.230 sevan 1438: check_pkg_vulnerabilities=YES
1.125 wiz 1439: </pre>
1440: <p>
1.360 leot 1441: 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.88 wiz 1442: </p>
1.82 rillig 1443: </div>
1.148 asau 1444: <div class="sect2">
1.82 rillig 1445: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1446: <a name="pkg_versions"></a>5.1.7. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.82 rillig 1447: <p>
1.322 leot 1448: Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128 wiz 1449: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.317 nia 1450: argument to check if any packages are stale, e.g.
1.88 wiz 1451: </p>
1452: <pre class="screen">
1453: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1454: ...
1.88 wiz 1455: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1456: </pre>
1.82 rillig 1457: </div>
1.148 asau 1458: <div class="sect2">
1.82 rillig 1459: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1460: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.110 hubertf 1461: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1462: administrative functions on the package system.</p>
1.82 rillig 1463: </div>
1.75 rillig 1464: </div>
1.148 asau 1465: <div class="sect1">
1.75 rillig 1466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1467: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88 wiz 1468: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1469: directory now contains a set of packages, organized into
1470: categories. You can browse the online index of packages, or run
1.110 hubertf 1471: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1472: directory to build local <code class="filename">README.html</code> files for
1.322 leot 1473: all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/index.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88 wiz 1474: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1475: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1476: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1477: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1478: different <code class="varname">LOCALBASE</code> definitions on the same
1479: system (inside a chroot is an exception). </p>
1480: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1481: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.88 wiz 1482: instructions how to create your own packages.</p>
1.148 asau 1483: <div class="sect2">
1.75 rillig 1484: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1485: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82 rillig 1486: <p>To build packages from source, you need a working C
1.88 wiz 1487: compiler. On NetBSD, you need to install the
1.128 wiz 1488: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1489: sets. If you want to build X11-related packages, the
1.128 wiz 1490: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1491: sets are required, too.</p>
1.75 rillig 1492: </div>
1.148 asau 1493: <div class="sect2">
1.75 rillig 1494: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1495: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75 rillig 1496: <p>The first step for building a package is downloading the
1.88 wiz 1497: distfiles (i.e. the unmodified source). If they have not yet been
1498: downloaded, pkgsrc will fetch them automatically.</p>
1499: <p>If you have all files that you need in the
1500: <code class="filename">distfiles</code> directory,
1501: you don't need to connect. If the distfiles are on CD-ROM, you can
1502: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1503: </p>
1.82 rillig 1504: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1505: <p>
1.110 hubertf 1506: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1507: <p>By default a list of distribution sites will be randomly
1508: intermixed to prevent huge load on servers which holding popular
1509: packages (for example, SourceForge.net mirrors). Thus, every
1510: time when you need to fetch yet another distfile all the mirrors
1511: will be tried in new (random) order. You can turn this feature
1512: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1513: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1514: <p>You can overwrite some of the major distribution sites to
1515: fit to sites that are close to your own. By setting one or two
1516: variables you can modify the order in which the master sites are
1517: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1518: delimited list of domain suffixes.
1519: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1520: contains a whitespace delimited list of regular expressions. It
1521: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1522: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1523: some examples. This may save some of your bandwidth and
1524: time.</p>
1.75 rillig 1525: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1526: if you want to keep the settings, by editing the
1.110 hubertf 1527: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1528: and adding the definitions there.</p>
1.82 rillig 1529: <p>
1.88 wiz 1530: If a package depends on many other packages (such as
1.322 leot 1531: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.88 wiz 1532: alternate between periods of
1533: downloading source, and compiling. To ensure you have all the source
1534: downloaded initially you can run the command:
1535: </p>
1.82 rillig 1536: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1537: <p>
1.88 wiz 1538: which will output and run a set of shell commands to fetch the
1539: necessary files into the <code class="filename">distfiles</code> directory. You can
1540: also choose to download the files manually.
1541: </p>
1.75 rillig 1542: </div>
1.148 asau 1543: <div class="sect2">
1.75 rillig 1544: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1545: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1546: <p>
1.88 wiz 1547: Once the software has downloaded, any patches will be applied, then it
1548: will be compiled for you. This may take some time depending on your
1549: computer, and how many other packages the software depends on and their
1550: compile time.
1551: </p>
1.148 asau 1552: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1553: <h3 class="title">Note</h3>
1554: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1555: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1556: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1557: </div>
1.87 wiz 1558: <p>For example, type</p>
1.88 wiz 1559: <pre class="screen">
1560: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1561: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1562: </pre>
1.75 rillig 1563: <p>at the shell prompt to build the various components of the
1.88 wiz 1564: package.</p>
1.82 rillig 1565: <p>The next stage is to actually install the newly compiled
1.88 wiz 1566: program onto your system. Do this by entering:
1.82 rillig 1567:
1.88 wiz 1568: </p>
1.82 rillig 1569: <pre class="screen">
1.88 wiz 1570: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1571: </pre>
1.82 rillig 1572: <p>
1573:
1.88 wiz 1574: while you are still in the directory for whatever package you
1575: are installing.</p>
1.82 rillig 1576: <p>Installing the package on your system may require you to
1.88 wiz 1577: be root. However, pkgsrc has a
1578: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1579: to only become root for the actual installation step.</p>
1.82 rillig 1580: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1581: You can now enter:
1.82 rillig 1582:
1.88 wiz 1583: </p>
1.82 rillig 1584: <pre class="screen">
1.88 wiz 1585: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1586: </pre>
1.82 rillig 1587: <p>
1588:
1.88 wiz 1589: to remove the compiled files in the work directory, as you shouldn't need
1590: them any more. If other packages were also added to your system
1591: (dependencies) to allow your program to compile, you can tidy these up
1592: also with the command:</p>
1.82 rillig 1593: <pre class="screen">
1.88 wiz 1594: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1595: </pre>
1.75 rillig 1596: <p>Taking the figlet utility as an example, we can install it on our
1.322 leot 1597: system by building as shown in <a class="xref" href="#logs" title="Appendix C. Build logs">Appendix C, <i>Build logs</i></a>.</p>
1.88 wiz 1598: <p>The program is installed under the default root of the
1599: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1600: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1601: variable in your environment, and it will use that value as the
1602: root of your packages tree. So, to use
1603: <code class="filename">/usr/local</code>, set
1604: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1605: Please note that you should use a directory which is dedicated to
1606: packages and not shared with other programs (i.e., do not try and
1607: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1608: to add any of your own files or directories (such as
1609: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1610: <code class="filename">pkgsrc/</code>) below the
1611: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1612: conflicts between programs and other files installed by the
1613: package system and whatever else may have been installed
1614: there.</p>
1.110 hubertf 1615: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1616: alter some configuration options at build time. Have a look at
1617: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1618: of what will be set there by default. Environment variables such
1619: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1620: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1621: set them each time you want to use pkgsrc.</p>
1.128 wiz 1622: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1623: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 1624: or being installed. This may be for debugging purposes, or out of
1625: simple curiosity. A number of utility values have been added to
1626: help with this.</p>
1.128 wiz 1627: <div class="orderedlist"><ol class="orderedlist" type="1">
1628: <li class="listitem">
1.360 leot 1629: <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.88 wiz 1630: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1631: information will be displayed. For example,</p>
1.75 rillig 1632: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1633: <p>will show all the commands that are invoked, up to and
1.128 wiz 1634: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1635: </li>
1.128 wiz 1636: <li class="listitem">
1.360 leot 1637: <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.88 wiz 1638: definition, then the <code class="varname">VARNAME</code> definition
1639: should be used, in conjunction with the show-var
1.360 leot 1640: 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.88 wiz 1641: variable <code class="varname">LOCALBASE</code>:</p>
1642: <pre class="screen">
1643: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 1644: /usr/pkg
1645: <code class="prompt">%</code>
1.88 wiz 1646: </pre>
1.75 rillig 1647: </li>
1648: </ol></div>
1649: <p>If you want to install a binary package that you've either
1.88 wiz 1650: created yourself (see next section), that you put into
1651: pkgsrc/packages manually or that is located on a remote FTP
1652: server, you can use the "bin-install" target. This target will
1.360 leot 1653: 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.110 hubertf 1654: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1655: sites searched is kept in the variable
1656: <code class="varname">BINPKG_SITES</code>, which defaults to
1.360 leot 1657: 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.88 wiz 1658: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1659: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1660: details.</p>
1661: <p>A final word of warning: If you set up a system that has a
1662: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1663: set that before any packages are installed, as you cannot use
1664: several directories for the same purpose. Doing so will result in
1665: pkgsrc not being able to properly detect your installed packages,
1666: and fail miserably. Note also that precompiled binary packages are
1667: usually built with the default <code class="varname">LOCALBASE</code> of
1668: <code class="filename">/usr/pkg</code>, and that you should
1669: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1670: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 1671: </div>
1672: </div>
1673: </div>
1.148 asau 1674: <div class="chapter">
1.75 rillig 1675: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1676: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75 rillig 1677: <div class="toc">
1678: <p><b>Table of Contents</b></p>
1.210 leot 1679: <dl class="toc">
1.267 rillig 1680: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1681: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.355 rillig 1682: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
1683: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
1684: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
1685: <dd><dl>
1686: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
1687: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1688: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 1689: </dl></dd>
1.355 rillig 1690: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
1691: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.75 rillig 1692: </dl>
1693: </div>
1.104 rillig 1694: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 1695: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1696: that file depends on the installation. On NetBSD, when you use
1.360 leot 1697: <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.89 rillig 1698: <code class="filename">/etc/</code>. In all other cases the default location is
1699: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1700: bootstrap program to install the binary packages.</p>
1701: <p>The format of the configuration file is that of the usual
1702: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1703: is done by setting variables in this file. Note that you can define all
1704: kinds of variables, and no special error checking (for example for
1.223 rillig 1705: spelling mistakes) takes place.</p>
1.148 asau 1706: <div class="sect1">
1.75 rillig 1707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1708: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223 rillig 1709: <p>The following variables apply to all
1.89 rillig 1710: pkgsrc packages. A complete list of the variables that can be
1711: configured by the user is available in
1712: <code class="filename">mk/defaults/mk.conf</code>, together with some
1713: comments that describe each variable's intent.</p>
1.148 asau 1714: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1715: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 1716: packages will be installed. The default is
1.76 rillig 1717: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 1718: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 1719: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1720: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 1721: installed. The default is
1.76 rillig 1722: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 1723: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 1724: X11 is installed on the system. The default is
1.194 bsiegert 1725: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 1726: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 1727: downloaded copies of the original source distributions used
1728: for building pkgsrc packages. The default is
1.76 rillig 1729: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 1730: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 1731: database about installed packages is stored. The default is
1.230 sevan 1732: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128 wiz 1733: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 1734: If set, override the packages'
1735: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 1736: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 1737: Backup location(s) for distribution files and patch files
1738: if not found locally or in
1.76 rillig 1739: <code class="filename">${MASTER_SITES}</code> or
1740: <code class="filename">${PATCH_SITES}</code> respectively.
1.230 sevan 1741: The defaults is
1742: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 1743: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 1744: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1745: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 1746: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1747: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1748: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 1749: List of acceptable licenses. License names are case-sensitive.
1750: Whenever you try to build a package whose license is not in this
1751: list, you will get an error message. If the license condition is
1752: simple enough, the error message will include specific
1753: instructions on how to change this variable.</p></li>
1.75 rillig 1754: </ul></div>
1755: </div>
1.148 asau 1756: <div class="sect1">
1.75 rillig 1757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1758: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219 rillig 1759: <p>
1.75 rillig 1760: </p>
1.148 asau 1761: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1762: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 1763: directory for the binary packages. The default is
1.76 rillig 1764: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 1765: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 1766: The top level directory where, if defined, the separate
1767: working directories will get created, and symbolically
1.76 rillig 1768: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 1769: This is useful for building packages on several
1.76 rillig 1770: architectures, then <code class="filename">${PKGSRCDIR}</code>
1771: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 1772: is local to every architecture. (It should be noted that
1773: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 1774: — it is an internal definition which refers to the
1.75 rillig 1775: root of the pkgsrc tree. It is possible to have many
1776: pkgsrc tree instances.)</p></li>
1.128 wiz 1777: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 1778: Directory for local patches that aren't part of pkgsrc.
1.299 rillig 1779: See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> for more
1.93 rillig 1780: information.</p></li>
1.128 wiz 1781: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 1782: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 1783: BSD-style Makefile. If this is not set,
1784: <code class="varname">MAKECONF</code> is set to
1.76 rillig 1785: <code class="filename">/dev/null</code> to avoid picking up
1786: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75 rillig 1787: </ul></div>
1788: </div>
1.148 asau 1789: <div class="sect1">
1.75 rillig 1790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.355 rillig 1791: <a name="native-or-pkgsrc-preference"></a>6.3. Preferences for native or pkgsrc software</h2></div></div></div>
1792: <p>Whenever a package depends on a package that has a
1793: <code class="filename">builtin.mk</code> file, the dependent package can
1794: either use the built-in (native) version from the base system or the
1795: pkgsrc-provided version. This only affects dependencies, so it is
1796: still possible to build the pkgsrc package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pcre++/index.html" target="_top"><code class="filename">devel/pcre++</code></a> even when other packages depend
1797: on the native pcre++ version instead.</p>
1798: <p>To force using the pkgsrc-provided version for a particular
1799: package, define <span class="quote">“<span class="quote"><code class="varname">PREFER_PKGSRC</code> =
1800: <em class="replaceable"><code>package-ID</code></em></span>”</span> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. To force
1801: using the native package, define
1802: <span class="quote">“<span class="quote"><code class="varname">PREFER_NATIVE</code> =
1803: <em class="replaceable"><code>package-ID</code></em></span>”</span>. In both cases, the
1804: <em class="replaceable"><code>package-ID</code></em> is the one from the
1805: <code class="filename">buildlink3.mk</code> of the package. In most cases,
1806: this ID is the same as the directory name of the package, but for
1807: example, <code class="filename">devel/pcre++</code> has the
1808: package ID <span class="quote">“<span class="quote">pcrexx</span>”</span>.</p>
1809: <p>For the packages that are not listed by their package ID,
1810: pkgsrc uses the pkgsrc-provided version if
1811: <code class="varname">PREFER_PKGSRC</code> contains the word
1812: <span class="quote">“<span class="quote">yes</span>”</span>. Otherwise, if <code class="varname">PREFER_NATIVE</code>
1813: contains the word <span class="quote">“<span class="quote">yes</span>”</span>, pkgsrc uses the native
1814: version. For example, to require using the pkgsrc-provided versions
1815: for all but the most basic bits on a NetBSD system, you can
1816: set:</p>
1817: <pre class="programlisting">
1818: PREFER_PKGSRC= yes
1819: PREFER_NATIVE= getopt skey tcp_wrappers
1820: </pre>
1821: <p>A package <span class="emphasis"><em>must</em></span> have a
1822: <code class="filename">builtin.mk</code> file to be listed in
1823: <code class="varname">PREFER_NATIVE</code>, otherwise it is simply ignored in
1824: that list.</p>
1825: <p><code class="varname">PREFER_PKGSRC</code> and
1826: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap to
1827: ensure that the bootstrap process does not use inapropriate native
1828: tools as dependencies for core packages.</p>
1829: <pre class="screen">
1830: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
1831: </pre>
1832: <p>Switching between settings globally at a later date can
1833: introduce complications with dependency resolution. This is caused
1834: by packages built with the opposite preference being installed
1835: alongside each other. Hence, when changing any of these variables
1836: after bootstrap, you need to rebuild all packages depending on those
1837: whose preference has been changed. This is not trivial and should
1838: be avoided.</p>
1839: <p>When using pkgsrc on Linux systems, there is high risk of
1840: <span class="quote">“<span class="quote">leakage</span>”</span>, where programs installed by pkgsrc may
1841: inadvertently use a command or library not installed by pkgsrc, e.g.
1842: those installed by yum or apt. Such foreign dependencies may be
1843: installed, removed, or upgraded to a version incompatible with the
1844: pkgsrc package at any time, causing pkgsrc packages to subsequently
1845: malfunction. Pkgsrc cannot prevent this, as it has no control over
1846: other package managers. Another potential problem is that under
1847: Redhat Enterprise and related Linux systems, yum packages are only
1848: patched and never upgraded, so eventually they may become too
1849: outdated for use by pkgsrc. Even intentionally using foreign
1850: dependencies, not considered leakage, can lead to these problems, so
1851: it is generally discouraged. In order to minimize such problems,
1852: PREFER_PKGSRC defaults to <span class="quote">“<span class="quote">yes</span>”</span> on Linux systems. This ensures that
1853: pkgsrc is aware of any changes to dependency packages and can
1854: rebuild or upgrade the entire dependency tree as needed. This
1855: default can be overridden by setting --prefer-pkgsrc to a
1856: list of packages and --prefer-native to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1857: </div>
1858: <div class="sect1">
1859: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1860: <a name="variables-affecting-installation"></a>6.4. Variables affecting the installation process</h2></div></div></div>
1.312 gdt 1861: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
1.256 maya 1862: By default, binary packages of built packages are
1.263 leot 1863: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256 maya 1864: this variable to "no" prevents this.</p></li></ul></div>
1.217 jnemeth 1865: <p>Packages have to support installation into a
1.103 wiz 1866: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1867: to be built, before the actual filesystem is touched. DESTDIR
1868: support exists in two variations:</p>
1.148 asau 1869: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1870: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 1871: installation and packaging is still run as root.</p></li>
1872: <li class="listitem"><p>Full DESTDIR support can run the complete
1873: build, installation and packaging as normal user. Root
1874: privileges are only needed to add packages.</p></li>
1875: </ul></div>
1.103 wiz 1876: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1877: clean</code></strong> needs to be run as root.</p>
1.118 imil 1878: <p>Considering the <code class="filename">foo/bar</code> package,
1879: DESTDIR full support can be tested using the following commands
1880:
1881: </p>
1882: <pre class="programlisting">
1883: <code class="prompt">$</code> id
1884: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1885: <code class="prompt">$</code> mkdir $HOME/packages
1886: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1887: </pre>
1888: <p>
1889:
1890: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1891: should be needed
1892:
1893: </p>
1894: <pre class="programlisting">
1.174 asau 1895: <code class="prompt">$</code> make stage-install
1.118 imil 1896: </pre>
1897: <p>
1898:
1899: Create a package without root privileges
1900:
1901: </p>
1902: <pre class="programlisting">
1.174 asau 1903: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 1904: </pre>
1905: <p>
1906:
1907: For the following command, you must be able to gain root
1.360 leot 1908: 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.118 imil 1909:
1910: </p>
1911: <pre class="programlisting">
1.174 asau 1912: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 1913: </pre>
1914: <p>
1915:
1916: Then, as a simple user
1917:
1918: </p>
1919: <pre class="programlisting">
1920: <code class="prompt">$</code> make clean
1921: </pre>
1922: <p>
1923:
1924: </p>
1.103 wiz 1925: </div>
1.148 asau 1926: <div class="sect1">
1.103 wiz 1927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.355 rillig 1928: <a name="conf.compiler"></a>6.5. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 1929: <div class="sect2">
1.78 rillig 1930: <div class="titlepage"><div><div><h3 class="title">
1.355 rillig 1931: <a name="selecting-the-compiler"></a>6.5.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 1932: <p>By default, pkgsrc will use GCC to build packages. This may be
1933: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 1934: <div class="variablelist"><dl class="variablelist">
1.89 rillig 1935: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1936: <dd>
1937: <p>This is a list of values specifying the chain of
1938: compilers to invoke when building packages. Valid values
1939: are:</p>
1.148 asau 1940: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 1941: <li class="listitem"><p><code class="varname">ccc</code>:
1942: Compaq C Compilers (Tru64)</p></li>
1943: <li class="listitem"><p><code class="varname">ccache</code>:
1944: compiler cache (chainable)</p></li>
1945: <li class="listitem"><p><code class="varname">clang</code>:
1946: Clang C and Objective-C compiler</p></li>
1.128 wiz 1947: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 1948: distributed C/C++ (chainable)</p></li>
1.174 asau 1949: <li class="listitem"><p><code class="varname">f2c</code>:
1950: Fortran 77 to C compiler (chainable)</p></li>
1951: <li class="listitem"><p><code class="varname">icc</code>:
1952: Intel C++ Compiler (Linux)</p></li>
1953: <li class="listitem"><p><code class="varname">ido</code>:
1954: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 1955: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 1956: GNU C/C++ Compiler</p></li>
1.174 asau 1957: <li class="listitem"><p><code class="varname">hp</code>:
1958: HP-UX C/aC++ compilers</p></li>
1.128 wiz 1959: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 1960: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 1961: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 1962: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 1963: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 1964: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 1965: <li class="listitem"><p><code class="varname">xlc</code>:
1.230 sevan 1966: IBM's XL C/C++ compiler suite</p></li>
1.89 rillig 1967: </ul></div>
1968: <p>The default is
1.128 wiz 1969: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 1970: <code class="varname">ccache</code> and/or
1971: <code class="varname">distcc</code> with an appropriate
1972: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 1973: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 1974: variable should always be terminated with a value for
1975: a real compiler. Note that only one real compiler
1.128 wiz 1976: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 1977: is not allowed).</p>
1.89 rillig 1978: </dd>
1979: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1980: <dd><p>This specifies the minimum version of GCC to use
1981: when building packages. If the system GCC doesn't
1982: satisfy this requirement, then pkgsrc will build and
1983: install one of the GCC packages to use instead.</p></dd>
1.266 leot 1984: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225 maya 1985: <dd><p>Specifies which version of python to use when several
1986: options are available.</p></dd>
1987: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291 gutterid 1988: <dd><p>Specifies the Fortran compiler to use.
1989: The default is <code class="varname">gfortran</code>.</p></dd>
1.225 maya 1990: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1991: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1992: <code class="varname">gfortran</code> is used, this option specifies which
1993: version to use.</p></dd>
1.89 rillig 1994: </dl></div>
1995: </div>
1.148 asau 1996: <div class="sect2">
1.89 rillig 1997: <div class="titlepage"><div><div><h3 class="title">
1.355 rillig 1998: <a name="conf.cflags"></a>6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78 rillig 1999: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2000: please make sure to use the <code class="literal">+=</code> operator
2001: instead of the <code class="literal">=</code> operator:</p>
2002: <pre class="programlisting">
1.100 rillig 2003: CFLAGS+= -your -flags
1.78 rillig 2004: </pre>
2005: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 2006: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 2007: need to add their own flags. You may want to take a look
1.322 leot 2008: at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128 wiz 2009: package if you're interested in optimization specifically
2010: for the current CPU. </p>
1.78 rillig 2011: </div>
1.148 asau 2012: <div class="sect2">
1.88 wiz 2013: <div class="titlepage"><div><div><h3 class="title">
1.355 rillig 2014: <a name="conf.ldflags"></a>6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88 wiz 2015: <p>If you want to pass flags to the linker, both in the configure
2016: step and the build step, you can do this in two ways. Either set
2017: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2018: between the two is that <code class="varname">LIBS</code> will be appended to
2019: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2020: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2021: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2022: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2023: <code class="varname">CFLAGS</code>, if you do not wish to override these
2024: settings, use the <code class="literal">+=</code> operator:</p>
2025: <pre class="programlisting">
1.100 rillig 2026: LDFLAGS+= -your -linkerflags
1.88 wiz 2027: </pre>
2028: </div>
1.78 rillig 2029: </div>
1.148 asau 2030: <div class="sect1">
1.78 rillig 2031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.355 rillig 2032: <a name="developer-advanced-settings"></a>6.6. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 2033: <p>
1.75 rillig 2034: </p>
1.148 asau 2035: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2036: <li class="listitem">
1.75 rillig 2037: <p><code class="varname">PKG_DEVELOPER</code>:
1.347 gutterid 2038: Run some sanity checks that package developers want:
2039: </p>
1.148 asau 2040: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2041: <li class="listitem"><p>make sure patches apply with zero
1.347 gutterid 2042: fuzz</p></li>
1.128 wiz 2043: <li class="listitem"><p>run check-shlibs to see that all
1.347 gutterid 2044: binaries will find their shared libs.</p></li>
1.75 rillig 2045: </ul></div>
2046: </li>
1.347 gutterid 2047: <li class="listitem"><p><code class="varname">CHECK_FILES_STRICT</code>:
2048: Also check <code class="varname">VARBASE</code> and <code class="varname">PKG_SYSCONFDIR
2049: </code> values in PLIST entries.
2050: </p></li>
1.128 wiz 2051: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.347 gutterid 2052: of debugging output which is displayed whilst making and
2053: installing the package. The default value for this is 0,
2054: which will not display the commands as they are executed
2055: (normal, default, quiet operation); the value 1 will display
2056: all shell commands before their invocation, and the value 2
2057: will display both the shell commands before their invocation,
2058: as well as their actual execution progress with <span class="command"><strong>set
2059: -x</strong></span>.</p></li>
1.75 rillig 2060: </ul></div>
2061: <p>
2062: </p>
2063: </div>
1.148 asau 2064: <div class="sect1">
1.75 rillig 2065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.355 rillig 2066: <a name="selecting-build-options"></a>6.7. Selecting Build Options</h2></div></div></div>
1.88 wiz 2067: <p>Some packages have build time options, usually to select
2068: between different dependencies, enable optional support for big
2069: dependencies or enable experimental features.</p>
1.75 rillig 2070: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2071: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2072: show-options</strong></span>, for example:</p>
1.75 rillig 2073: <pre class="programlisting">
2074: The following options are supported by this package:
2075: ssl Enable SSL support.
2076: Exactly one of the following gecko options is required:
2077: firefox Use firefox as gecko rendering engine.
2078: mozilla Use mozilla as gecko rendering engine.
2079: At most one of the following database options may be selected:
2080: mysql Enable support for MySQL database.
2081: pgsql Enable support for PostgreSQL database.
1.1 grant 2082:
1.75 rillig 2083: These options are enabled by default: firefox
2084: These options are currently enabled: mozilla ssl
1.1 grant 2085: </pre>
1.75 rillig 2086: <p>The following variables can be defined in
1.110 hubertf 2087: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2088: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2089: which can be used to select or disable options for all packages
2090: that support them, and
2091: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2092: which can be used to select or disable options specifically for
2093: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2094: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2095: are disabled. A few examples:</p>
1.75 rillig 2096: <pre class="screen">
1.110 hubertf 2097: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75 rillig 2098: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2099: PKG_OPTIONS.kdebase= debug -sasl
2100: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2101: <p>It is important to note that options that were specifically
1.120 snj 2102: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2103: you do not wish to include the option. If you are unsure you can view
2104: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2105: <p>The following settings are consulted in the order given, and
2106: the last setting that selects or disables an option is
2107: used:</p>
1.128 wiz 2108: <div class="orderedlist"><ol class="orderedlist" type="1">
2109: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2110: maintainer</p></li>
1.128 wiz 2111: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2112: variables (see below)</p></li>
1.128 wiz 2113: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2114: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2115: </ol></div>
2116: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2117: selected is used, all others are automatically disabled. If an
2118: option of the group is explicitly disabled, the previously
2119: selected option, if any, is used. It is an error if no option
2120: from a required group of options is selected, and building the
2121: package will fail.</p>
2122: <p>Before the options framework was introduced, build options
2123: were selected by setting a variable (often named
2124: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2125: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2126: transition to the options framework for the user, these legacy
2127: variables are converted to the appropriate options setting
2128: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2129: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2130: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2131: directly. Support for the legacy variables will be removed
2132: eventually.</p>
1.75 rillig 2133: </div>
2134: </div>
1.148 asau 2135: <div class="chapter">
1.75 rillig 2136: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2137: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75 rillig 2138: <div class="toc">
2139: <p><b>Table of Contents</b></p>
1.210 leot 2140: <dl class="toc">
1.267 rillig 2141: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2142: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.75 rillig 2143: </dl>
2144: </div>
1.148 asau 2145: <div class="sect1">
1.75 rillig 2146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2147: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2148: <p>Once you have built and installed a package, you can create
2149: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.360 leot 2150: 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.87 wiz 2151: the same package on a group of hosts and wasting CPU time. It also
2152: provides a simple means for others to install your package, should
2153: you distribute it.</p>
2154: <p>To create a binary package, change into the appropriate
1.110 hubertf 2155: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2156: package</strong></span>:</p>
2157: <pre class="screen">
1.223 rillig 2158: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2159: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2160: </pre>
1.356 gutterid 2161: <p>This will build your package (if not already done) and package
2162: it into a binary package. You can then use the
2163: <span class="command"><strong>pkg_*</strong></span> tools to manipulate it. Binary packages are
2164: created in <code class="varname">PACKAGES</code>, which defaults to
2165: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a compressed
2166: tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a continuation of
2167: the above <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/index.html" target="_top"><code class="filename">misc/figlet</code></a>
2168: example.</p>
1.267 rillig 2169: <p>See <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a> for information on how to submit
1.87 wiz 2170: such a binary package.</p>
1.75 rillig 2171: </div>
1.148 asau 2172: <div class="sect1">
1.75 rillig 2173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2174: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.299 rillig 2175: <p>See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a>.</p>
1.106 rillig 2176: </div>
2177: </div>
1.148 asau 2178: <div class="chapter">
1.106 rillig 2179: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2180: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 2181: builds)</h2></div></div></div>
2182: <div class="toc">
2183: <p><b>Table of Contents</b></p>
1.210 leot 2184: <dl class="toc">
1.267 rillig 2185: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 2186: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 2187: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2188: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 2189: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2190: <dd><dl>
1.294 rillig 2191: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2192: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296 rillig 2193: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
2194: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
2195: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
2196: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
2197: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
2198: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
2199: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
2200: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 2201: </dl></dd>
2202: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2203: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2204: </dl>
2205: </div>
1.290 gutterid 2206: <p>For a number of reasons, you may want to build binary packages
2207: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180 wiz 2208: For instance, when you have multiple machines that should run the same software,
2209: it is wasted time if they all build their packages themselves from source.
2210: Or you may want to build a list of packages you want and check them before
1.290 gutterid 2211: deploying onto production systems.
1.180 wiz 2212: There is a way of getting a set of binary packages:
1.290 gutterid 2213: the bulk build system, or pbulk ("p" stands for "parallel").
1.223 rillig 2214: This chapter describes how to set it up.</p>
1.148 asau 2215: <div class="sect1">
1.106 rillig 2216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2217: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180 wiz 2218: <p>First of all, you have to decide whether you build all packages
2219: or a limited set of them. Full bulk builds usually consume a lot more resources,
2220: both space and time, than builds for some practical sets of packages.
1.290 gutterid 2221: A number of particularly heavy packages exist that are not actually
2222: interesting to a wide audience. (The approximate resource consumption for a
2223: full bulk build is given in section <a class="xref" href="#bulk.req" title="8.3. Requirements of a full bulk build">Section 8.3, “Requirements of a full bulk build”</a>.)
2224: For limited bulk builds you need to make a list of packages you want to build.
1.223 rillig 2225: Note that all their dependencies will be built, so you don't need to track them manually.
1.180 wiz 2226: </p>
2227: <p>During bulk builds various packages are installed and deinstalled
2228: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2229: so make sure that you don't need any package during the builds.
1.223 rillig 2230: Essentially, you should provide a fresh system, either a chroot environment
1.180 wiz 2231: or something even more restrictive, depending on what the operating system provides,
2232: or dedicate the whole physical machine.
2233: As a useful side effect this makes sure that bulk builds cannot
2234: break anything in your system. There have been numerous cases where
1.106 rillig 2235: certain packages tried to install files outside the
2236: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2237: <code class="filename">/etc</code>.
2238: </p>
1.106 rillig 2239: </div>
1.148 asau 2240: <div class="sect1">
1.106 rillig 2241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.295 rillig 2242: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
2243: <p>Running a bulk build works roughly as follows:</p>
1.148 asau 2244: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2245: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2246: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2247: </ul></div>
1.148 asau 2248: <div class="sect2">
1.116 rillig 2249: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 2250: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223 rillig 2251: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178 asau 2252: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2253: Configure network access to fetch distribution files.
1.223 rillig 2254: Create a user with name "pbulk".</p>
1.178 asau 2255: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2256: <pre class="screen">
1.264 sevan 2257: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && ftp -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
2258: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
1.181 wiz 2259: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.178 asau 2260: </pre>
2261: <p>Or any other way that fits (e.g., curl, wget).</p>
2262: <p>Deploy and configure pbulk tools, e.g.:</p>
2263: <pre class="screen">
1.230 sevan 2264: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.178 asau 2265: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment</code></strong>
2266: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2267: </pre>
2268: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2269: <h3 class="title">Note</h3>
2270: <p><code class="filename">mk.conf.frag</code> is a fragment of
2271: <code class="filename">mk.conf</code> that contains settings you want to
2272: apply to packages you build. For instance,</p>
2273: <pre class="programlisting">
1.223 rillig 2274: PKG_DEVELOPER= yes # perform more checks
2275: X11_TYPE= modular # use pkgsrc X11
2276: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2277: # when building all packages)
1.178 asau 2278: </pre>
2279: </div>
2280: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223 rillig 2281: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178 asau 2282: <pre class="programlisting">
2283: www/firefox
2284: mail/thunderbird
2285: misc/libreoffice4
2286: </pre>
1.179 asau 2287: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2288: and make final amendments, if wanted.</p>
1.178 asau 2289: <p>Start it:</p>
2290: <pre class="screen">
2291: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2292: </pre>
2293: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2294: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2295: </p>
2296: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2297: <h3 class="title">Note</h3>
2298: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2299: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2300: The script is kept small enough for better understanding.</p>
2301: </div>
2302: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2303: <h3 class="title">Note</h3>
2304: <p>The <code class="filename">pbulk.sh</code> script supports running
1.320 wiz 2305: unprivileged bulk build and helps configuring distributed bulk builds.
2306: Distributed bulk builds support either building in worker chroots
2307: (each node is a path to a different chroot)
2308: that replicate the target system, including the pbulk prefix,
2309: or remote machines (each node is
2310: an IP address that must be accessible over SSH without a password).</p>
1.178 asau 2311: </div>
1.106 rillig 2312: </div>
2313: </div>
1.148 asau 2314: <div class="sect1">
1.106 rillig 2315: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2316: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180 wiz 2317: <p>A complete bulk build requires lots of disk space. Some of the
2318: disk space can be read-only, some other must be writable. Some can be on
2319: remote filesystems (such as NFS) and some should be local. Some can be
2320: temporary filesystems, others must survive a sudden reboot.</p>
2321: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.320 wiz 2322: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2323: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.180 wiz 2324: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2325: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2326: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2327: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2328: </ul></div>
2329: </div>
2330: <div class="sect1">
2331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.293 rillig 2332: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2333: <p>To ensure that pkgsrc packages work in different configurations, it
2334: makes sense to run non-default bulk builds from time to time. This
2335: section lists some ideas for bulk builds that intentionally let packages
2336: fail if they don't follow the pkgsrc style.</p>
2337: <div class="sect2">
2338: <div class="titlepage"><div><div><h3 class="title">
1.294 rillig 2339: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.293 rillig 2340: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2341: <pre class="programlisting">
2342: GNU_CONFIGURE_STRICT= yes
2343: </pre>
2344: <p>When a package fails this additional check, the most common cause
2345: is that the configure option was valid for an older version of the
2346: package but does not apply anymore. In that case, just remove it.</p>
2347: </div>
2348: <div class="sect2">
2349: <div class="titlepage"><div><div><h3 class="title">
1.294 rillig 2350: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293 rillig 2351: <p>The job of a compiler is not restricted to producing executable
1.294 rillig 2352: code, most compilers also detect typical programming mistakes. The pkgsrc
2353: compiler wrappers make it easy to force compiler options when the package
2354: is built. This can be used to find typical bugs across all packages that
2355: are in pkgsrc. By reporting these bugs upstream, the packages will be
2356: more reliable with the next updates.</p>
2357: <p>Add some of the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.293 rillig 2358: <pre class="programlisting">
2359: CFLAGS+= -Werror=char-subscripts
1.294 rillig 2360: CFLAGS+= -Werror=implicit-function-declaration
1.293 rillig 2361: </pre>
1.294 rillig 2362: <p>When a package fails to build using these stricter compiler
2363: options, document the circumstances in which the compiler produced the
2364: error message. This includes:</p>
1.293 rillig 2365: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2366: <li class="listitem"><p>The platform
2367: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2368: <li class="listitem"><p>The source file</p></li>
2369: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2370: part of the diagnostic.</p></li>
1.294 rillig 2371: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293 rillig 2372: </ul></div>
2373: <p>If a package produces these error messages, but the package is
1.294 rillig 2374: fine, record this in your local <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, like this, to skip this check
2375: in the next builds:</p>
1.293 rillig 2376: <pre class="programlisting">
1.294 rillig 2377: .if ${PKGPATH} == category/package
1.293 rillig 2378: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2379: # error message
2380: # code
1.294 rillig 2381: # Reason why the code does not need to be fixed.
1.293 rillig 2382: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.294 rillig 2383: .endif
1.293 rillig 2384: </pre>
2385: <p>If the error messages from the compiler are valid and the code
1.294 rillig 2386: needs to be fixed, prepare a local patch (see
2387: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2388: authors of the package, providing them with the information you collected
2389: above.</p>
2390: <p>Patches that are not essential for the package to work should only
2391: be reported upstream but not committed to pkgsrc, to make future updates
2392: easier.</p>
1.293 rillig 2393: </div>
2394: <div class="sect2">
2395: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2396: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
2397: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2398: these apply to all phases of the package build process. Especially in the
2399: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2400: decisions. The GNU configure scripts feed many small test programs to the
2401: C compiler to see whether certain headers are available, functions are
2402: defined in a library and programs can be run. In many cases these
2403: programs would not survive a strict compiler run with <code class="literal">-Wall
2404: -Wextra -Werror</code>.</p>
2405: <p>The pkgsrc infrastructure is flexible enough to support compiler
2406: options being added between the <code class="literal">configure</code> and
2407: <code class="literal">build</code> phases. It's a little more complicated than the
2408: other examples in this section but still easy enough.</p>
2409: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2410: desired compiler options. The compiler wrapper's original task is to hide
2411: unwanted directories of include files and to normalize compiler options.
2412: It does this by wrapping the compiler command and rewriting the command
2413: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2414: package directory and examine the
2415: <code class="filename">work/.cwrappers/config</code> directory. It contains
2416: individual configurations for the C compiler and the related tools. The
2417: plan is to find a hook between the configure and build phases, and to
2418: modify these configuration files at that point.</p>
2419: <p>To find this hook, have a look at
2420: <code class="filename">mk/build/build.mk</code>, which contains among others the
2421: <code class="literal">pre-build-checks-hook</code>. The word
2422: <code class="literal">checks</code> doesn't quite fit, but the
2423: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2424: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2425: <pre class="programlisting">
2426: # Just a few example options.
2427: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2428:
2429: .if ${BUILD_ONLY_CFLAGS:U:M*}
2430: pre-build-checks-hook: add-build-only-cflags
2431:
2432: add-build-only-cflags: .PHONY
2433: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2434: ${TEST} ! -f ${.TARGET} || exit 0; \
2435: for flag in ${BUILD_ONLY_CFLAGS}; do \
2436: ${ECHO} "append=$$flag" >> cc; \
2437: done; \
2438: > ${.TARGET}
2439: .endif
2440: </pre>
2441: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2442: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2443: not with spaces.)</p>
2444: <p>The condition in the <code class="literal">.if</code> statement contains the
2445: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2446: should be undefined, possibly because it is only defined for a subset of
2447: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2448: at least one compiler option, to prevent a syntax error in the shell
2449: parser.</p>
2450: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2451: that the additional compiler options are only appended once, even if
2452: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2453: creates a marker file.</p>
2454: <p>To verify that this setup works, run <span class="command"><strong>bmake
2455: configure</strong></span> in a package directory. Up to now, everything works
2456: as usual. Examine the directory
2457: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2458: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2459: the file <code class="filename">cc</code>. Examine the tail of the
2460: <code class="filename">work/.work.log</code> file to see that the normal compiler
2461: options are used.</p>
2462: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2463: options to the file <code class="filename">cc</code> and will create the marker
2464: file in the same directory. After that, the build starts as usual, but
2465: with the added compiler options. Examine the tail of the file
2466: <code class="filename">work/.work.log</code> to see that the lines starting with
2467: <code class="literal">[*]</code> don't contain the compiler options, but the
2468: corresponding lines starting with <code class="literal"><.></code> do end
2469: with these options.</p>
2470: <p>Building packages using this setup variant and fixing the resulting
2471: bugs is the same as in <a class="xref" href="#bulk.var.comperr" title="8.4.2. Detect classes of bugs by forcing compiler warnings">Section 8.4.2, “Detect classes of bugs by forcing compiler warnings”</a>.</p>
2472: </div>
2473: <div class="sect2">
2474: <div class="titlepage"><div><div><h3 class="title">
2475: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.293 rillig 2476: <p>Some directories like <code class="varname">PREFIX</code>,
2477: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2478: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2479: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2480: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2481: <pre class="programlisting">
2482: PREFIX= /a-random-uuid
2483: PKG_SYSCONFDIR= /a-random-uuid
2484: VARBASE= /a-random-uuid
2485: PKGMANDIR= a-random-uuid
2486: PKG_INFODIR= a-random-uuid
2487: </pre>
2488: </div>
2489: <div class="sect2">
2490: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2491: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.293 rillig 2492: <p>When building a package, warnings are typically ignored since they
2493: just flow by and do not cause the build to fail immediately. To find
2494: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2495: <pre class="programlisting">
2496: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2497: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2498: </pre>
2499: <p>(There are many more classes of warnings in pkgsrc, and most of
2500: them can be redefined with a simple definition like above.</p>
1.294 rillig 2501: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293 rillig 2502: the package Makefile, research whether the package actually needs Perl.
2503: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2504: Makefile, and if it doesn't, add
2505: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2506: </div>
2507: <div class="sect2">
2508: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2509: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293 rillig 2510: <p>Using pkglint as part of the regular build process is mostly a
2511: waste of time. If you want to fix some of the warnings, just run pkglint
2512: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2513: 10), which is much faster than a complete bulk build.</p>
2514: </div>
2515: <div class="sect2">
2516: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2517: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293 rillig 2518: <p>To ensure that the binary packages don't contain references to the
2519: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2520: that variable includes the item <code class="literal">extra</code>, it is
2521: possible to define additional patterns that must not appear in any
2522: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2523: <pre class="programlisting">
2524: CHECK_WRKREF= extra
2525: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2526: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2527: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2528: </pre>
2529: <p>The above patterns will probably generate many false positives,
2530: therefore the results need to be taken with a grain of salt.</p>
2531: </div>
2532: <div class="sect2">
2533: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2534: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.293 rillig 2535: <p>To run the test suites that come with each package, add this line
2536: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2537: <pre class="programlisting">
2538: PKGSRC_RUN_TEST= yes
2539: </pre>
2540: <p>Be prepared that even the most basic packages fail this test. When
2541: doing a bulk build with this, it will often abort in the early phase
2542: where the packages are scanned for their dependencies since there are
2543: cyclic dependencies. There is still a lot to do in this area.</p>
2544: </div>
2545: <div class="sect2">
2546: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2547: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293 rillig 2548: <p>To catch typos in the shell snippets from the Makefile fragments,
2549: add the <code class="literal">-u</code> flag to most of the commands by adding this
2550: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2551: <pre class="programlisting">
2552: RUN= @set -eu;
2553: </pre>
1.296 rillig 2554: <p>After that, ensure that none of the bulk build log files (even
2555: those for successfully built packages) contains the string
2556: <code class="literal">parameter not set</code> or whatever error message the
2557: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293 rillig 2558: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2559: definition.</p>
2560: </div>
2561: <div class="sect2">
2562: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2563: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.293 rillig 2564: <p>The build logs of a package are often quite long. This allows error
2565: messages or other interesting details to hide between the noise. To make
2566: the actual error message stand out more, add these lines to
2567: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2568: <pre class="programlisting">
2569: GNU_CONFIGURE_QUIET= yes
2570: MAKE_FLAGS+= -s
2571: </pre>
2572: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2573: Make. On exotic platforms with their own make, it may be a little
2574: different.</p>
2575: </div>
2576: </div>
2577: <div class="sect1">
2578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2579: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2580: <p>After your pkgsrc bulk-build has completed, you may wish to
2581: create a CD-ROM set of the resulting binary packages to assist
2582: in installing packages on other machines. The
1.322 leot 2583: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/index.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87 wiz 2584: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2585: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2586: way that keeps all the dependencies for a given package on the same
2587: CD as that package.</p>
1.148 asau 2588: <div class="sect2">
1.75 rillig 2589: <div class="titlepage"><div><div><h3 class="title">
1.293 rillig 2590: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2591: <p>Complete documentation for cdpack is found in the cdpack(1)
2592: man page. The following short example assumes that the binary
2593: packages are left in
2594: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2595: sufficient disk space exists in <code class="filename">/u2</code> to
2596: hold the ISO 9660 images.</p>
2597: <pre class="screen">
2598: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2599: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2600: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2601: </pre>
2602: <p>If you wish to include a common set of files
2603: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2604: etc.) on each CD in the collection, then you need to create a
1.290 gutterid 2605: directory which contains these files, e.g.:</p>
1.87 wiz 2606: <pre class="screen">
2607: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2608: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2609: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2610: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2611: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2612: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2613: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2614: </pre>
1.75 rillig 2615: <p>Now create the images:</p>
2616: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76 rillig 2617: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2618: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2619: in their root directories.</p>
1.75 rillig 2620: </div>
2621: </div>
2622: </div>
1.148 asau 2623: <div class="chapter">
1.75 rillig 2624: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2625: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2626: <div class="toc">
2627: <p><b>Table of Contents</b></p>
1.210 leot 2628: <dl class="toc">
1.267 rillig 2629: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2630: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90 rillig 2631: </dl>
2632: </div>
2633: <p>The files that are installed by pkgsrc are organized in a way that
2634: is similar to what you find in the <code class="filename">/usr</code> directory
2635: of the base system. But some details are different. This is because
2636: pkgsrc initially came from FreeBSD and had adopted its file system
2637: hierarchy. Later it was largely influenced by NetBSD. But no matter
2638: which operating system you are using pkgsrc with, you can expect the
2639: same layout for pkgsrc.</p>
1.91 rillig 2640: <p>There are mainly four root directories for pkgsrc, which are all
2641: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2642: When pkgsrc has been installed as root, the default locations
2643: are:</p>
2644: <pre class="programlisting">
1.100 rillig 2645: LOCALBASE= /usr/pkg
2646: PKG_SYSCONFBASE= /usr/pkg/etc
2647: VARBASE= /var
1.231 sevan 2648: PKG_DBDIR= /usr/pkg/pkgdb
1.91 rillig 2649: </pre>
2650: <p>In unprivileged mode (when pkgsrc has been installed as any other
2651: user), the default locations are:</p>
2652: <pre class="programlisting">
1.100 rillig 2653: LOCALBASE= ${HOME}/pkg
2654: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2655: VARBASE= ${HOME}/pkg/var
1.231 sevan 2656: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.91 rillig 2657: </pre>
2658: <p>What these four directories are for, and what they look like is
2659: explained below.</p>
1.148 asau 2660: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2661: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2662: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2663: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2664: the well-known subdirectories like <code class="filename">bin</code>,
2665: <code class="filename">include</code>, <code class="filename">lib</code>,
2666: <code class="filename">share</code> and
2667: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2668: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2669: <code class="filename">/var</code> in the base system. Some programs (especially
2670: games, network daemons) need write access to it during normal
2671: operation.</p></li>
1.128 wiz 2672: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2673: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2674: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90 rillig 2675: itself.</p></li>
2676: </ul></div>
1.148 asau 2677: <div class="sect1">
1.90 rillig 2678: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2679: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2680: </h2></div></div></div>
1.90 rillig 2681: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2682: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2683: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2684: <dt><span class="term"><code class="filename">bin</code></span></dt>
2685: <dd><p>Contains executable programs that are intended to be
2686: directly used by the end user.</p></dd>
2687: <dt><span class="term"><code class="filename">emul</code></span></dt>
2688: <dd><p>Contains files for the emulation layers of various other
2689: operating systems, especially for
2690: NetBSD.</p></dd>
2691: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2692: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2693: <dd><p>Contains
2694: the configuration files.</p></dd>
2695: <dt><span class="term"><code class="filename">include</code></span></dt>
2696: <dd><p>Contains headers for the C and C++ programming
2697: languages.</p></dd>
2698: <dt><span class="term"><code class="filename">info</code></span></dt>
2699: <dd><p>Contains GNU info files of various
2700: packages.</p></dd>
2701: <dt><span class="term"><code class="filename">lib</code></span></dt>
2702: <dd><p>Contains shared and static
2703: libraries.</p></dd>
2704: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2705: <dd><p>Contains data files that don't change after
2706: installation. Other data files belong into
2707: <code class="filename">${VARBASE}</code>.</p></dd>
2708: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2709: <dd><p>Contains programs that are not intended to be used by
2710: end users, such as helper programs or network
2711: daemons.</p></dd>
2712: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2713: <dd><p>Contains programs that are intended to be executed as
2714: CGI scripts by a web server.</p></dd>
2715: <dt><span class="term"><code class="filename">man</code> (the usual value of
2716: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2717: <dd><p>Contains brief
2718: documentation in form of manual pages.</p></dd>
2719: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2720: <dd><p>Contains programs that are intended to be used only by
2721: the super-user.</p></dd>
2722: <dt><span class="term"><code class="filename">share</code></span></dt>
2723: <dd><p>Contains platform-independent data files that don't
2724: change after installation.</p></dd>
2725: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2726: <dd><p>Contains documentation files provided by the
2727: packages.</p></dd>
2728: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2729: <dd><p>Contains example files provided by the packages. Among
2730: others, the original configuration files are saved here and copied to
2731: <code class="filename">${PKG_SYSCONFDIR}</code> during
2732: installation.</p></dd>
2733: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2734: <dd><p>Contains the original files for rc.d
2735: scripts.</p></dd>
2736: <dt><span class="term"><code class="filename">var</code> (the usual location of
2737: <code class="filename">${VARBASE}</code>)</span></dt>
2738: <dd><p>Contains files
2739: that may be modified after
2740: installation.</p></dd>
2741: </dl></div>
2742: </div>
1.148 asau 2743: <div class="sect1">
1.90 rillig 2744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2745: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2746: </h2></div></div></div>
1.148 asau 2747: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2748: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2749: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2750: <dd><p>Contains
2751: information about the currently installed
2752: packages.</p></dd>
2753: <dt><span class="term"><code class="filename">games</code></span></dt>
2754: <dd><p>Contains highscore
2755: files.</p></dd>
2756: <dt><span class="term"><code class="filename">log</code></span></dt>
2757: <dd><p>Contains log files.</p></dd>
2758: <dt><span class="term"><code class="filename">run</code></span></dt>
2759: <dd><p>Contains informational files about daemons that are
2760: currently running.</p></dd>
2761: </dl></div>
2762: </div>
2763: </div>
1.148 asau 2764: <div class="chapter">
1.90 rillig 2765: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2766: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2767: <div class="toc">
2768: <p><b>Table of Contents</b></p>
1.210 leot 2769: <dl class="toc">
1.267 rillig 2770: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2771: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2772: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2773: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2774: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
2775: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2776: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2777: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
2778: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2779: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 2780: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 2781: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.336 nia 2782: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267 rillig 2783: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2784: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2785: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2786: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2787: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 2788: </dl>
2789: </div>
2790: <p>This section contains hints, tips & tricks on special things in
2791: pkgsrc that we didn't find a better place for in the previous chapters, and
2792: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2793: <div class="sect1">
1.75 rillig 2794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2795: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2796: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2797: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2798: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 2799: This is a general purpose list for most issues regarding
2800: pkgsrc, regardless of platform, e.g. soliciting user help
2801: for pkgsrc configuration, unexpected build failures, using
2802: particular packages, upgrading pkgsrc installations,
2803: questions regarding the pkgsrc release branches, etc. General announcements or
2804: proposals for changes that impact the pkgsrc user community,
2805: e.g. major infrastructure changes, new features, package
2806: removals, etc., may also be posted.</p></li>
1.289 leot 2807: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 2808: A list where the results of pkgsrc bulk builds are sent and
2809: discussed.</p></li>
1.289 leot 2810: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 2811: This list is for those who are interested in getting a
2812: commit message for every change committed to pkgsrc. It is
2813: also available in digest form, meaning one daily message
2814: containing all commit messages for changes to the package
2815: source tree in that 24 hour period.</p></li>
2816: </ul></div>
2817: <p>To subscribe, do:</p>
2818: <pre class="programlisting">
1.100 rillig 2819: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2820: </pre>
2821: <p>Archives for all these mailing lists are available from
1.289 leot 2822: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2823: </div>
1.148 asau 2824: <div class="sect1">
1.75 rillig 2825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2826: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2827: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2828: a number of useful utilities for both users and developers of pkgsrc. This
1.233 sevan 2829: section attempts only to make the reader aware of some of the utilities and when
1.75 rillig 2830: they might be useful, and not to duplicate the documentation that comes
2831: with each package.</p>
2832: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.322 leot 2833: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/index.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75 rillig 2834: Symlinks for use by buildlink.</p></li></ul></div>
2835: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2836: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2837: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/index.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233 sevan 2838: Calculates various kinds of checksums (including SHA3).</p></li>
1.322 leot 2839: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/index.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75 rillig 2840: Compatibility library for pkgsrc tools.</p></li>
1.322 leot 2841: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/index.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87 wiz 2842: non-BSD systems due to lack of native mtree.</p></li>
1.322 leot 2843: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75 rillig 2844: Up-to-date replacement for
1.76 rillig 2845: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2846: systems where pkg_install is not present.</p></li>
2847: </ul></div>
2848: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2849: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2850: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75 rillig 2851: Create a binary package from an
1.110 hubertf 2852: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2853: save the old package.</p></li>
1.322 leot 2854: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/index.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75 rillig 2855: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2856: from multiple locations. It currently supports the following
2857: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.322 leot 2858: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117 jnemeth 2859: the best compiler flags to optimise code for your current
1.128 wiz 2860: CPU and compiler. </p></li>
1.75 rillig 2861: </ul></div>
2862: <p>Utilities for keeping track of installed packages, being up to date,
2863: etc:</p>
1.148 asau 2864: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2865: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/index.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173 wiz 2866: update tool similar to apt(1). Download, install, and upgrade
2867: binary packages easily.</p></li>
1.322 leot 2868: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75 rillig 2869: packages whose installed versions do not match the latest pkgsrc
2870: entries.</p></li>
1.322 leot 2871: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75 rillig 2872: dependency graphs of packages, to aid in choosing a strategy for
2873: updating.</p></li>
1.322 leot 2874: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/index.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
2875: graphs from the output of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
2876: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112 weinem 2877: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.322 leot 2878: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75 rillig 2879: does various checks on the complete pkgsrc system.</p></li>
1.322 leot 2880: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/index.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75 rillig 2881: packages you have installed.</p></li>
2882: </ul></div>
2883: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2884: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2885: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75 rillig 2886: making and maintaining patches for a package (includes pkgdiff,
2887: pkgvi, mkpatches, etc.).</p></li>
1.322 leot 2888: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/index.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75 rillig 2889: converting to pkgsrc.</p></li>
2890: </ul></div>
2891: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2892: utilities)</p>
1.148 asau 2893: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2894: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/index.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75 rillig 2895: packages in a chrooted area.</p></li>
1.322 leot 2896: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/index.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75 rillig 2897: kernel version for chrooted cross builds.</p></li>
2898: </ul></div>
2899: </div>
1.148 asau 2900: <div class="sect1">
1.75 rillig 2901: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2902: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219 rillig 2903: <p>To install packages from source as a non-root user, download
1.267 rillig 2904: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 3. Where to get pkgsrc and how to keep it up-to-date">Chapter 3, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
1.219 rillig 2905: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2906: --unprivileged</strong></span>.</p>
2907: <p>This will install the binary part of pkgsrc to
2908: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2909: into <code class="filename">~/pkg/etc</code>.</p>
2910: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75 rillig 2911: </div>
1.148 asau 2912: <div class="sect1">
1.75 rillig 2913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2914: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 2915: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2916: enable this feature by adding the option
2917: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 2918: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 2919: distfile is found, pkgsrc will try to resume it.</p>
2920: <p>You can also
1.168 wiz 2921: use a different program than the platform default program by changing the
1.117 jnemeth 2922: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2923: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2924: by using the value manual. A value of custom disables the system defaults
2925: and dependency tracking for the fetch program. In that case you have to
2926: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2927: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2928: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 2929: <p>For example, if you want to use
1.117 jnemeth 2930: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 2931: like:</p>
2932: <pre class="programlisting">
1.223 rillig 2933: FETCH_USING= wget
1.1 grant 2934: </pre>
1.75 rillig 2935: </div>
1.148 asau 2936: <div class="sect1">
1.75 rillig 2937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2938: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103 wiz 2939: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 2940: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 2941: you will have to add the following line into
1.110 hubertf 2942: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 2943: <pre class="programlisting">
1.103 wiz 2944: X11_TYPE=modular
1.1 grant 2945: </pre>
1.75 rillig 2946: </div>
1.148 asau 2947: <div class="sect1">
1.75 rillig 2948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2949: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 2950: <p>If you are sitting behind a firewall which does not allow direct
2951: connections to Internet hosts (i.e. non-NAT), you may specify the
2952: relevant proxy hosts. This is done using an environment variable in the
2953: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 2954: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 2955: port 80 as the proxy port number. So the proxy environment variables
2956: are:</p>
2957: <pre class="programlisting">
1.100 rillig 2958: ftp_proxy=ftp://orpheus.amdahl.com:80/
2959: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 2960: </pre>
1.75 rillig 2961: </div>
1.148 asau 2962: <div class="sect1">
1.75 rillig 2963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2964: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 wiz 2965: <p>Some fetch tools are not prepared to support HTTPS by default
2966: (for example, the one in NetBSD 6.0), or the one installed by the
2967: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2968: dependency graph).</p>
2969: <p>Usually you won't notice, because distribution files are
2970: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2971: be often enough if you are following pkgsrc-current. In that case, set
2972: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2973: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2974: with HTTPS support by default. Of course, these tools need to be
2975: installed before you can use them this way.</p>
2976: </div>
2977: <div class="sect1">
2978: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2979: <a name="passive-ftp"></a>10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75 rillig 2980: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 2981: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 2982: the first available command from the following list:</p>
1.148 asau 2983: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2984: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2985: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 2986: </ul></div>
2987: <p>On a default NetBSD installation, this will be
1.76 rillig 2988: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 2989: connections first, and falls back to active connections if the server
2990: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 2991: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 2992: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2993: <p>Having that option present will prevent
1.76 rillig 2994: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 2995: transfers.</p>
2996: </div>
1.148 asau 2997: <div class="sect1">
1.75 rillig 2998: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2999: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3000: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3001: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 3002: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75 rillig 3003: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3004: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3005: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3006: resulting list to your machine at work/school and use it there. If you
1.360 leot 3007: 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.75 rillig 3008: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3009: URL:</p>
3010: <p>At home:</p>
3011: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3012: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3013: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3014: <p>At work:</p>
3015: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3016: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3017: home.</p>
3018: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3019: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3020: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3021: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3022: directly by running:</p>
1.75 rillig 3023: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3024: <p>If you even decide to ignore
3025: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3026: by running:</p>
3027: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3028: </div>
1.148 asau 3029: <div class="sect1">
1.75 rillig 3030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3031: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 3032: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.322 leot 3033: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75 rillig 3034: package, you get the error from make that it doesn't know how to make
1.76 rillig 3035: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 3036: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 3037: the NetBSD base distribution on your machine. It is recommended to do
3038: that to format man pages.</p>
1.322 leot 3039: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75 rillig 3040: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3041: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3042: </div>
1.148 asau 3043: <div class="sect1">
1.75 rillig 3044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3045: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.87 wiz 3046: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3047: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3048: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3049: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3050: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3051: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3052: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3053: -r</strong></span>).</p>
3054: </div>
1.148 asau 3055: <div class="sect1">
1.75 rillig 3056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.336 nia 3057: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.75 rillig 3058: <p>When installing packages as non-root user and using the just-in-time
1.360 leot 3059: <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.75 rillig 3060: password for each required package installed. To avoid this, the sudo
3061: package can be used, which does password caching over a limited time. To
1.336 nia 3062: use it, install <span class="command"><strong>sudo</strong></span> or
3063: <span class="command"><strong>priv</strong></span> (either as binary package, from
3064: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/priv/index.html" target="_top"><code class="filename">security/priv</code></a>, or
1.322 leot 3065: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/index.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110 hubertf 3066: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3067: <span class="emphasis"><em>after</em></span> the definition of the
3068: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3069: <pre class="programlisting">
1.100 rillig 3070: .if exists(${LOCALBASE}/bin/sudo)
3071: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3072: .endif
1.1 grant 3073: </pre>
1.75 rillig 3074: </div>
1.148 asau 3075: <div class="sect1">
1.75 rillig 3076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3077: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3078: <p>As the system administrator, you can choose where configuration files
3079: are installed. The default settings make all these files go into
1.76 rillig 3080: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3081: be suboptimal depending on your expectations (e.g., a read-only,
3082: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3083: configuration of the provided packages).</p>
3084: <p>In order to change the defaults, you can modify the
3085: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3086: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3087: directory; some common examples include <code class="filename">/etc</code> or
3088: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3089: <p>Furthermore, you can change this value on a per-package basis by
3090: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3091: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3092: package you would like to modify, that is, the contents of
3093: <code class="varname">PKGBASE</code>.</p>
3094: <p>Note that after changing these settings, you must rebuild and
3095: reinstall any affected packages.</p>
3096: </div>
1.148 asau 3097: <div class="sect1">
1.75 rillig 3098: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3099: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75 rillig 3100: <p>Please be aware that there can often be bugs in third-party software,
3101: and some of these bugs can leave a machine vulnerable to exploitation by
3102: attackers. In an effort to lessen the exposure, the NetBSD packages team
3103: maintains a database of known-exploits to packages which have at one time
3104: been included in pkgsrc. The database can be downloaded automatically, and
3105: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3106: do this, refer to the following two tools (installed as part of the
1.322 leot 3107: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128 wiz 3108: <div class="orderedlist"><ol class="orderedlist" type="1">
3109: <li class="listitem">
1.122 reed 3110: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3111: download a list of the security vulnerabilities information. This list
1.132 spz 3112: is kept up to date by the pkgsrc security team, and is distributed
3113: from the NetBSD ftp server:</p>
1.292 leot 3114: <p><a class="ulink" href="https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a></p>
1.75 rillig 3115: </li>
1.128 wiz 3116: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3117: current machine, checking each known vulnerability. If a
1.75 rillig 3118: vulnerable package is installed, it will be shown by output to stdout,
3119: including a description of the type of vulnerability, and a URL
3120: containing more information.</p></li>
3121: </ol></div>
1.233 sevan 3122: <p>Use of these tools is strongly recommended!
1.317 nia 3123: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, “Checking for security vulnerabilities in installed packages”</a> for instructions on how to automate checking and
1.233 sevan 3124: reporting.</p>
3125: <p>If this database is installed, pkgsrc builds will use it to
3126: perform a security check before building any package.</p>
1.75 rillig 3127: </div>
1.148 asau 3128: <div class="sect1">
1.75 rillig 3129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3130: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 3131: <p>When you add your own preferences to the
3132: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3133: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3134: environment variables to the <code class="filename">./configure</code>
1.360 leot 3135: 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.75 rillig 3136: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3137: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3138: package.</p>
3139: <p>Currently there is no solution to this problem. If you
3140: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3141: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3142: directory and then inspect any <code class="filename">Makefile</code> and
3143: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3144: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3145: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3146: programmers write so bad code that it only works for the
3147: specific combination of <code class="varname">CFLAGS</code> they have
3148: chosen.</p>
1.287 rillig 3149: <p>To find out where the CFLAGS are ignored, add the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
3150: <pre class="programlisting">
3151: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3152: CFLAGS+= -Dpkgsrc___CFLAGS
3153: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3154: </pre>
3155: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3156: to see whether the above flags are passed to the actual build
3157: commands in general.</p>
3158: <p>To find out whether the flags are passed to individual compiler
3159: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3160: most cases, the flags from the original command lines (the lines starting
3161: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3162: (the lines starting with <code class="literal"><.></code>). If the flag is
3163: missing from the actual compiler command, it must have been removed by
1.299 rillig 3164: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75 rillig 3165: </div>
1.148 asau 3166: <div class="sect1">
1.80 rillig 3167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3168: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3169: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3170: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3171: case that occurs often is that people only update pkgsrc in
3172: parts, because of performance reasons. Since pkgsrc is one large
3173: system, not a collection of many small systems, there are
3174: sometimes changes that only work when the whole pkgsrc tree is
3175: updated.</p></li>
1.148 asau 3176: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3177: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3178: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3179: files.</p></li>
1.148 asau 3180: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3181: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3182: verify this.</p></li>
1.218 rillig 3183: <li class="step"><p>If you are a package developer who wants to invest
1.267 rillig 3184: some work, have a look at <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.148 asau 3185: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3186: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3187: </ol></div>
3188: </div>
1.148 asau 3189: <div class="sect1">
1.88 wiz 3190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3191: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.89 rillig 3192: <p>You have modified a file from pkgsrc, and someone else has
3193: modified that same file afterwards in the CVS repository. Both changes
3194: are in the same region of the file, so when you updated pkgsrc, the
3195: <code class="literal">cvs</code> command marked the conflicting changes in the
3196: file. Because of these markers, the file is no longer a valid
3197: <code class="filename">Makefile</code>.</p>
3198: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3199: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3200: -dP</strong></span> in that directory to download the current version.</p>
3201: </div>
1.75 rillig 3202: </div>
3203: </div>
1.148 asau 3204: <div class="part">
1.75 rillig 3205: <div class="titlepage"><div><div><h1 class="title">
3206: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3207: <div class="partintro">
1.77 rillig 3208: <div></div>
3209: <p>This part of the book deals with creating and
1.128 wiz 3210: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3211: guide on creating a new package. The remaining chapters are more
3212: like a reference manual for pkgsrc.</p>
1.75 rillig 3213: <div class="toc">
3214: <p><b>Table of Contents</b></p>
1.210 leot 3215: <dl class="toc">
1.267 rillig 3216: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299 rillig 3217: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91 rillig 3218: <dd><dl>
1.299 rillig 3219: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3220: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3221: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91 rillig 3222: <dd><dl>
1.299 rillig 3223: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3224: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3225: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3226: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3227: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91 rillig 3228: </dl></dd>
1.299 rillig 3229: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3230: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3231: <dd><dl>
3232: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3233: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3234: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3235: </dl></dd>
3236: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3237: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3238: </dl></dd>
1.299 rillig 3239: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106 rillig 3240: <dd><dl>
1.299 rillig 3241: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3242: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3243: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3244: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3245: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 3246: <dd><dl>
1.299 rillig 3247: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3248: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106 rillig 3249: </dl></dd>
1.299 rillig 3250: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3251: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3252: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3253: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3254: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3255: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3256: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3257: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3258: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3259: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3260: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3261: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3262: </dl></dd>
3263: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3264: <dd><dl>
3265: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106 rillig 3266: <dd><dl>
1.334 nia 3267: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
3268: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
3269: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106 rillig 3270: </dl></dd>
1.299 rillig 3271: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3272: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106 rillig 3273: </dl></dd>
1.299 rillig 3274: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3275: <dd><dl>
1.299 rillig 3276: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3277: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3278: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3279: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106 rillig 3280: <dd><dl>
1.299 rillig 3281: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3282: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3283: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
3284: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344 gutterid 3285: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.106 rillig 3286: </dl></dd>
3287: </dl></dd>
1.299 rillig 3288: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106 rillig 3289: <dd><dl>
1.299 rillig 3290: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3291: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
3292: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3293: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3294: </dl></dd>
1.299 rillig 3295: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106 rillig 3296: <dd><dl>
1.299 rillig 3297: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3298: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3299: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3300: </dl></dd>
3301: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3302: <dd><dl>
3303: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3304: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3305: <dd><dl>
1.299 rillig 3306: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3307: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133 wiz 3308: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3309: and
3310: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3311: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3312: </dl></dd>
1.299 rillig 3313: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.355 rillig 3314: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.299 rillig 3315: </dl></dd>
3316: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106 rillig 3317: <dd><dl>
1.299 rillig 3318: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3319: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3320: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
3321: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3322: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3323: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3324: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3325: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3326: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106 rillig 3327: </dl></dd>
1.299 rillig 3328: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3329: <dd><dl>
3330: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3331: <dd><dl>
3332: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3333: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106 rillig 3334: </dl></dd>
1.299 rillig 3335: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106 rillig 3336: <dd><dl>
1.299 rillig 3337: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3338: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.353 dholland 3339: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
3340: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
3341: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299 rillig 3342: </dl></dd>
3343: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3344: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
3345: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3346: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3347: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3348: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3349: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.267 rillig 3350: </dl></dd>
3351: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3352: <dd><dl>
3353: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3354: <dd><dl>
3355: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
3356: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3357: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3358: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3359: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3360: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3361: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3362: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3363: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3364: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3365: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3366: </dl></dd>
3367: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3368: <dd><dl>
3369: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3370: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
3371: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3372: </dl></dd>
3373: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3374: <dd><dl>
3375: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3376: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3377: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338 nia 3378: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.267 rillig 3379: </dl></dd>
3380: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3381: <dd><dl>
3382: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3383: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 3384: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338 nia 3385: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
3386: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
3387: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
3388: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267 rillig 3389: </dl></dd>
3390: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3391: <dd><dl>
3392: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3393: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 3394: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3395: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
3396: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 3397: </dl></dd>
3398: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3399: <dd><dl>
3400: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3401: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3402: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3403: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3404: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 3405: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 3406: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
3407: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 3408: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
3409: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
3410: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
3411: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
3412: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
3413: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
3414: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 3415: emulation</a></span></dt>
1.318 nia 3416: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
3417: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.77 rillig 3418: </dl></dd>
1.267 rillig 3419: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3420: </dl></dd>
1.299 rillig 3421: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3422: <dd><dl>
3423: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3424: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3425: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3426: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3427: </dl></dd>
1.267 rillig 3428: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 3429: <dd><dl>
1.267 rillig 3430: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3431: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3432: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3433: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3434: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3435: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3436: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3437: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3438: </dl></dd>
3439: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75 rillig 3440: </dl>
3441: </div>
1.77 rillig 3442: </div>
1.148 asau 3443: <div class="chapter">
1.77 rillig 3444: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 3445: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3446: <p>
3447: To get help when developing pkgsrc, the definitive source is this
3448: document, the pkgsrc guide. If you don't find anything here,
3449: there are alternatives:
3450: </p>
3451: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3452: <li class="listitem">
3453: <p>
3454: The built-in pkgsrc help, which is available after bootstrapping
3455: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3456: help for any topic, such as a variable name like
3457: <code class="varname">BUILD_DEFS</code>, a make target like
3458: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3459: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322 leot 3460: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.267 rillig 3461: </li>
3462: <li class="listitem"><p>
1.278 rillig 3463: To see the value of a single variable, run <span class="command"><strong>bmake
3464: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3465: </p></li>
3466: <li class="listitem"><p>
3467: To see the values of the most common variables, run
3468: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3469: topic. To see the variables for a single topic, run
3470: <span class="command"><strong>bmake
3471: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3472: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3473: </p></li>
3474: <li class="listitem"><p>
1.267 rillig 3475: The tech-pkg mailing list, to which
3476: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3477: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3478: questions</a>.</p></li>
3479: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3480: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3481: or by using a specialized chat program such as
3482: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3483: Pick any user name and join the channel #pkgsrc.</p></li>
3484: </ul></div>
3485: </div>
3486: <div class="chapter">
3487: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 3488: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91 rillig 3489: <div class="toc">
3490: <p><b>Table of Contents</b></p>
1.210 leot 3491: <dl class="toc">
1.299 rillig 3492: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3493: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3494: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3495: <dd><dl>
3496: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3497: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3498: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3499: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3500: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3501: </dl></dd>
3502: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3503: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3504: <dd><dl>
3505: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3506: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3507: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91 rillig 3508: </dl></dd>
1.299 rillig 3509: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3510: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91 rillig 3511: </dl>
3512: </div>
1.299 rillig 3513: <p>Whenever you're preparing a package, there are a number of
3514: files involved which are described in the following
3515: sections.</p>
3516: <div class="sect1">
3517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3518: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3519: </h2></div></div></div>
3520: <p>Building, installation and creation of a binary package are all
3521: controlled by the package's <code class="filename">Makefile</code>.
3522: The <code class="filename">Makefile</code> describes various things about
3523: a package, for example from where to get it, how to configure,
3524: build, and install it.</p>
3525: <p>A package <code class="filename">Makefile</code> contains several
3526: sections that describe the package.</p>
3527: <p>In the first section there are the following variables, which
3528: should appear exactly in the order given here. The order and
3529: grouping of the variables is mostly historical and has no further
3530: meaning.</p>
3531: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3532: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3533: distribution file to be downloaded from the package's
3534: website.</p></li>
3535: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3536: package, as used by pkgsrc. You need to provide it if
3537: <code class="varname">DISTNAME</code> (which is the default) is not a good
3538: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3539: provided (no distribution file is required). Usually it is the pkgsrc
3540: directory name together with the version number. It must match the
3541: regular expression
3542: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3543: starts with a letter or digit, and contains only letters, digits,
1.319 nia 3544: dashes, underscores, dots and plus signs.
3545: New packages should have entirely lower-case names, with the exception
3546: of some that must follow pre-existing conventions
3547: (e.g. R packages begin with <code class="varname">R-</code>).
3548: You can use the <code class="code">:tl</code> variable modifier to lower-case
3549: the package name.</p></li>
1.299 rillig 3550: <li class="listitem">
3551: <p><code class="varname">CATEGORIES</code> is a list of categories
3552: which the package fits in. You can choose any of the top-level
3553: directories of pkgsrc for it.</p>
3554: <p>Currently the following values are available for
3555: <code class="varname">CATEGORIES</code>. If more than
3556: one is used, they need to be separated by spaces:</p>
1.77 rillig 3557: <pre class="programlisting">
1.299 rillig 3558: archivers cross geography meta-pkgs security
3559: audio databases graphics misc shells
3560: benchmarks devel ham multimedia sysutils
3561: biology editors inputmethod net textproc
3562: cad emulators lang news time
3563: chat finance mail parallel wm
3564: comms fonts math pkgtools www
3565: converters games mbone print x11
1.77 rillig 3566: </pre>
3567: </li>
1.299 rillig 3568: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3569: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3570: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3571: and <code class="varname">DISTFILES</code> are discussed in detail in
3572: <a class="xref" href="#build.fetch" title="13.5. The fetch phase">Section 13.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
3573: </ul></div>
3574: <p>The second section contains information about separately
3575: downloaded patches, if any.
3576: </p>
3577: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3578: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3579: Name(s) of additional files that contain distribution patches.
3580: There is no default. pkgsrc will look for them at
3581: <code class="varname">PATCH_SITES</code>.
3582: They will automatically be uncompressed before patching if
3583: the names end with <code class="filename">.gz</code> or
3584: <code class="filename">.Z</code>.</p></li>
3585: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3586: Primary location(s) for distribution patch files (see
3587: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3588: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.360 leot 3589: 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.299 rillig 3590: help find the correct files to patch. It defaults to
3591: <span class="command"><strong>-p0</strong></span>.</p></li>
3592: </ul></div>
3593: <p>The third section contains the following variables.
3594: </p>
3595: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.367 ! gdt 3596: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email address
! 3597: of the person who is currently responsible for this package. In
! 3598: theory, the maintainer will be aware of upstream release, keep it
! 3599: updated, and generally resolve problems. Others contemplating
! 3600: significant changes should ask the maintainer for advice or review
! 3601: of a proposed change. This is not necessary for micro updates,
! 3602: bug fixes, pkgsrc-wide changes affecting many packages, and other
! 3603: things expected to be uncontroversial. It goes with this "should
! 3604: ask" that the maintainer should respond to inquiries reasonably
! 3605: promptly (most of the time), and either approve changes or provide
! 3606: reasons why not. Typically, when packaging a new program, set
! 3607: <code class="varname">MAINTAINER</code> to yourself. If you don't intend to
! 3608: maintain the package (especially if you feel you have no special
! 3609: insight), set it to <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>. This
! 3610: special value is a code point indicating that there is no
! 3611: maintainer, but the variable is mandatory, absent
! 3612: <code class="varname">OWNER</code>.</p></li>
! 3613: <li class="listitem">
! 3614: <p><code class="varname">OWNER</code> can be used instead of
! 3615: <code class="varname">MAINTAINER</code> in relatively rare circumstances
! 3616: when the package is such that modifying it is riskier than normal.
! 3617: This is a stronger form of being the maintainer, with an
! 3618: expectation that others will ask for almost all changes, except
! 3619: revbumps and accommodating structural changes. Someone who becomes
! 3620: <code class="varname">OWNER</code> has a strong obligation to keep the
! 3621: package very well maintained, to answer queries promptly and to be
! 3622: a steward of the package on behalf of users. In this case,
! 3623: <code class="varname">MAINTAINER</code> should be omitted.</p>
! 3624: <p>Because of the friction that <code class="varname">OWNER</code> adds,
! 3625: PMC may downgrade it to <code class="varname">MAINTAINER</code> at any
! 3626: time.</p>
! 3627: </li>
1.299 rillig 3628: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3629: find more information about the package.</p></li>
3630: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3631: description of the package (should not include the package
3632: name).</p></li>
3633: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3634: 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>
3635: </ul></div>
3636: <p>Other variables that affect the build:
3637: </p>
3638: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3639: <p><code class="varname">WRKSRC</code>: The directory where the
3640: interesting distribution files of the package are found. The
3641: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3642: works for most packages.</p>
3643: <p>If a package doesn't create a subdirectory for itself
3644: (most GNU software does, for instance), but extracts itself in
3645: the current directory, you should set
3646: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3647: <p>If a package doesn't create a subdirectory with the
3648: name of <code class="varname">DISTNAME</code> but some different name,
3649: set <code class="varname">WRKSRC</code> to point to the proper name in
3650: <code class="filename">${WRKDIR}</code>, for example
3651: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.322 leot 3652: <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.299 rillig 3653: <p>The name of the working directory created by pkgsrc is
3654: taken from the <code class="varname">WRKDIR_BASENAME</code>
3655: variable. By default, its value is
3656: <code class="filename">work</code>. If you want to use the same
3657: pkgsrc tree for building different kinds of binary packages,
3658: you can change the variable according to your needs. Two
3659: other variables handle common cases of setting
3660: <code class="varname">WRKDIR_BASENAME</code> individually. If
3661: <code class="varname">OBJHOSTNAME</code> is defined in
3662: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3663: the host's name is attached to the directory name. If
3664: <code class="varname">OBJMACHINE</code> is defined, the platform name
3665: is attached, which might look like
3666: <code class="filename">work.i386</code> or
3667: <code class="filename">work.sparc</code>.</p>
3668: </li></ul></div>
3669: <p>Please pay attention to the following gotchas:</p>
3670: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3671: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3672: installed in compressed form by the package. For packages using
3673: BSD-style makefiles which honor MANZ, there is
3674: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3675: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3676: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3677: below).</p></li>
3678: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.7. Packages installing info files">Section 21.6.7, “Packages installing info files”</a>.</p></li>
3679: </ul></div>
3680: </div>
1.148 asau 3681: <div class="sect1">
1.91 rillig 3682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 3683: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3684: </h2></div></div></div>
3685: <p>The <code class="filename">distinfo</code> file contains the message
3686: digest, or checksum, of each distfile needed for the package. This
3687: ensures that the distfiles retrieved from the Internet have not been
3688: corrupted during transfer or altered by a malign force to introduce
3689: a security hole. To provide maximum security, all distfiles are
1.357 gutterid 3690: protected using two different message digest algorithms (BLAKE2s
3691: and SHA512), as well as the file size.</p>
1.299 rillig 3692: <p>The <code class="filename">distinfo</code> file also contains the
3693: checksums for all the patches found in the
3694: <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
3695: are only applied intentionally and that they don't accidentally change,
3696: e.g. when merging different changes together. They also make sure that
3697: new patches are actually added to CVS and old ones are removed.
3698: Too see whether the patches and the <code class="filename">distinfo</code> file
3699: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3700: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3701: <span class="command"><strong>make distinfo</strong></span> command.</p>
3702: <p>Some packages have different sets of distfiles depending on
1.322 leot 3703: 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.299 rillig 3704: <code class="filename">distinfo</code> file and care should be taken when
3705: upgrading such a package to ensure distfile information is not
3706: lost.</p>
3707: </div>
3708: <div class="sect1">
3709: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3710: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3711: </h2></div></div></div>
3712: <p>Some packages don't work out-of-the box on the various
3713: platforms that are supported by pkgsrc. These packages need
3714: to be patched to make them work. The patch files can be
3715: found in the <code class="filename">patches/</code> directory.</p>
3716: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3717: applied to the files in <code class="varname">WRKSRC</code> directory after
3718: extracting them, in alphabetic order.</p>
1.148 asau 3719: <div class="sect2">
1.91 rillig 3720: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3721: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3722: <p>The <code class="filename">patch-*</code> files should be in
3723: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3724: problems. (To force patches to apply with fuzz you can set
3725: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3726: should contain only changes for a single file, and no file should be
3727: patched by more than one patch file. This helps to keep future
3728: modifications simple.</p>
3729: <p>Each patch file is structured as follows: In the first line,
3730: there is the RCS Id of the patch itself. The second line should be
3731: empty for aesthetic reasons. After that, there should be a comment for
3732: each change that the patch does. There are a number of standard
3733: cases:</p>
3734: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3735: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3736: mention the vulnerability ID (CAN, CVE).</p></li>
3737: <li class="listitem"><p>Patches that change source code should mention the
3738: platform and other environment (for example, the compiler) that the
3739: patch is needed for.</p></li>
3740: </ul></div>
3741: <p>The patch should be commented so that any
3742: developer who knows the code of the application can make some use of
3743: the patch. Special care should be taken for the upstream developers,
3744: since we generally want that they accept our patches, so we have less
3745: work in the future.</p>
1.91 rillig 3746: </div>
1.148 asau 3747: <div class="sect2">
1.91 rillig 3748: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3749: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3750: <p>One important thing to mention is to pay attention that no RCS
3751: IDs get stored in the patch files, as these will cause problems when
3752: later checked into the NetBSD CVS tree. Use the
1.322 leot 3753: <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.299 rillig 3754: problems.</p>
3755: <p>For even more automation, we recommend using
3756: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.337 gutterid 3757: whole set of patches. You just have to back up files before you
3758: edit them to <code class="filename">filename.orig</code>, e.g., with
1.299 rillig 3759: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3760: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3761: you upgrade a package this way, you can easily compare the new
3762: set of patches with the previously existing one with
3763: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3764: are replaced by new files, so carefully check if you want to take all
3765: the changes.</p>
3766: <p>When you have finished a package, remember to generate
3767: the checksums for the patch files by using the <span class="command"><strong>make
3768: 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>
3769: <p>When adding a patch that corrects a problem in the
3770: distfile (rather than e.g. enforcing pkgsrc's view of where
3771: man pages should go), send the patch as a bug report to the
3772: maintainer. This benefits non-pkgsrc users of the package,
3773: and usually makes it possible to remove the patch in future
3774: version.</p>
3775: <p>The file names of the patch files are usually of the form
3776: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3777: Many packages still use the previous convention
3778: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3779: but new patches should be of the form containing the filename.
1.322 leot 3780: <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.299 rillig 3781: automatically.</p>
1.337 gutterid 3782: <p>When updating pre-existing patch files, if a file uses the old
3783: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
3784: convention, it's best not to change it to the new form, as that will
3785: just cause churn that makes it harder to track changes to patching
3786: over time. Similarly, if a patch now applies at different line offsets,
3787: but still applies cleanly as-is, there's no need to update it, as that
3788: also unnecessarily complicates the patch history.</p>
1.118 imil 3789: </div>
1.275 brook 3790: <div class="sect2">
3791: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3792: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3793: <p>If you want to share patches between multiple packages
3794: in pkgsrc, e.g. because they use the same distfiles, set
3795: <code class="varname">PATCHDIR</code> to the path where the patch files
3796: can be found, e.g.:</p>
3797: <pre class="programlisting">
3798: PATCHDIR= ../../editors/xemacs/patches
3799: </pre>
3800: <p>Patch files that are distributed by the author or other
3801: maintainers can be listed in
3802: <code class="varname">PATCHFILES</code>.</p>
3803: <p>If it is desired to store any patches that should not be
3804: committed into pkgsrc, they can be kept outside the pkgsrc
3805: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3806: directory tree there is expected to have the same
3807: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3808: patches are expected to be stored inside these dirs (also
3809: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3810: example, if you want to keep a private patch for
3811: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3812: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3813: files in the named directory are expected to be patch files,
3814: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3815: applied</em></span>.</p>
1.275 brook 3816: </div>
3817: <div class="sect2">
3818: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3819: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3820: <p>When fixing a portability issue in the code do not use
3821: preprocessor magic to check for the current operating system nor
3822: platform. Doing so hurts portability to other platforms because
3823: the OS-specific details are not abstracted appropriately.</p>
3824: <p>The general rule to follow is: instead of checking for the
3825: operating system the application is being built on, check for the
3826: specific <span class="emphasis"><em>features</em></span> you need. For example,
3827: instead of assuming that kqueue is available under NetBSD and
3828: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3829: kqueue support, add a check that detects kqueue itself —
3830: yes, this generally involves patching the
3831: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3832: that prevents some OSes from adopting interfaces from other OSes
3833: (e.g. Linux implementing kqueue), something that the above checks
3834: cannot take into account.</p>
3835: <p>Of course, checking for features generally involves more
3836: work on the developer's side, but the resulting changes are
3837: cleaner and there are chances they will work on many other
3838: platforms. Not to mention that there are higher chances of being
3839: later integrated into the mainstream sources. Remember:
3840: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3841: <p>Some typical examples:</p>
3842: <div class="table">
3843: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3844: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3845: <colgroup>
3846: <col>
3847: <col>
3848: <col>
3849: </colgroup>
3850: <thead><tr>
3851: <th>Where</th>
3852: <th>Incorrect</th>
3853: <th>Correct</th>
3854: </tr></thead>
3855: <tbody>
3856: <tr>
3857: <td>configure script</td>
3858: <td>
1.275 brook 3859: <pre class="programlisting">
1.299 rillig 3860: case ${target_os} in
3861: netbsd*) have_kvm=yes ;;
3862: *) have_kvm=no ;;
3863: esac
1.275 brook 3864: </pre>
1.299 rillig 3865: </td>
3866: <td>
1.275 brook 3867: <pre class="programlisting">
1.299 rillig 3868: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275 brook 3869: </pre>
1.299 rillig 3870: </td>
3871: </tr>
3872: <tr>
3873: <td>C source file</td>
3874: <td>
1.91 rillig 3875: <pre class="programlisting">
1.299 rillig 3876: #if defined(__NetBSD__)
3877: # include <sys/event.h>
3878: #endif
1.91 rillig 3879: </pre>
1.299 rillig 3880: </td>
3881: <td>
1.91 rillig 3882: <pre class="programlisting">
1.299 rillig 3883: #if defined(HAVE_SYS_EVENT_H)
3884: # include <sys/event.h>
3885: #endif
1.91 rillig 3886: </pre>
1.299 rillig 3887: </td>
3888: </tr>
3889: <tr>
3890: <td>C source file</td>
3891: <td>
1.91 rillig 3892: <pre class="programlisting">
1.299 rillig 3893: int
3894: monitor_file(...)
3895: {
3896: #if defined(__NetBSD__)
3897: int fd = kqueue();
3898: ...
3899: #else
3900: ...
3901: #endif
3902: }
1.91 rillig 3903: </pre>
1.299 rillig 3904: </td>
3905: <td>
1.91 rillig 3906: <pre class="programlisting">
1.299 rillig 3907: int
3908: monitor_file(...)
3909: {
3910: #if defined(HAVE_KQUEUE)
3911: int fd = kqueue();
3912: ...
3913: #else
3914: ...
3915: #endif
3916: }
1.91 rillig 3917: </pre>
1.299 rillig 3918: </td>
3919: </tr>
3920: </tbody>
3921: </table></div>
3922: </div>
3923: <br class="table-break">
3924: </div>
3925: <div class="sect2">
3926: <div class="titlepage"><div><div><h3 class="title">
3927: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3928: <p>Always, always, <span class="strong"><strong>always</strong></span>
3929: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3930: improvements you do to a package to the mainstream developers.
3931: This is the only way to get their attention on portability issues
3932: and to ensure that future versions can be built out-of-the box on
3933: NetBSD. Furthermore, any user that gets newer distfiles will get
3934: the fixes straight from the packaged code.</p>
3935: <p>This generally involves cleaning up the patches
3936: (because sometimes the patches that are
3937: added to pkgsrc are quick hacks), filing bug reports in the
3938: appropriate trackers for the projects and working with the
3939: mainstream authors to accept your changes. It is
3940: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3941: the packages in pkgsrc are kept simple and thus further changes
3942: can be done without much hassle.</p>
3943: <p>When you have done this, please add a URL to the upstream
3944: bug report to the patch comment.</p>
3945: <p>Support the idea of free software!</p>
3946: </div>
1.91 rillig 3947: </div>
1.299 rillig 3948: <div class="sect1">
3949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3950: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3951: <div class="variablelist"><dl class="variablelist">
3952: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3953: <dd><p>A multi-line description of the piece of software. This should include
3954: any credits where they are due. Please bear in mind that others do not
3955: share your sense of humour (or spelling idiosyncrasies), and that others
3956: will read everything that you write here.</p></dd>
3957: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3958: <dd><p>This file governs the files that are installed on your
3959: system: all the binaries, manual pages, etc. There are other
3960: directives which may be entered in this file, to control the
3961: creation and deletion of directories, and the location of
3962: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3963: information.</p></dd>
3964: </dl></div>
3965: </div>
3966: <div class="sect1">
3967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3968: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3969: <div class="sect2">
3970: <div class="titlepage"><div><div><h3 class="title">
3971: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3972: <div class="variablelist"><dl class="variablelist">
3973: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3974: <dd>
1.360 leot 3975: <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.299 rillig 3976: First time after package extraction and before files are
3977: moved in place, the second time after the files to install
3978: are moved in place. This can be used to do any custom
3979: procedures not possible with @exec commands in
1.360 leot 3980: <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
3981: <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.299 rillig 3982: Please note that you can modify variables in it easily by using
3983: <code class="varname">FILES_SUBST</code> in the package's
3984: <code class="filename">Makefile</code>:</p>
1.91 rillig 3985: <pre class="programlisting">
1.299 rillig 3986: FILES_SUBST+= SOMEVAR="somevalue"
1.91 rillig 3987: </pre>
1.299 rillig 3988: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3989: <code class="filename">INSTALL</code>. By default, substitution is
3990: performed for <code class="varname">PREFIX</code>,
3991: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3992: <code class="varname">VARBASE</code>, and a few others, type
3993: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3994: complete list.</p>
3995: </dd>
3996: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3997: <dd><p>This script is executed before and after any files are removed. It is
3998: this script's responsibility to clean up any additional messy details
3999: around the package's installation, since all pkg_delete knows is how to
4000: delete the files created in the original distribution.
1.360 leot 4001: 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>
4002: 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.299 rillig 4003: The same methods to replace variables can be used as for
4004: the <code class="filename">INSTALL</code> file.</p></dd>
4005: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4006: <dd>
4007: <p>This file is displayed after installation of the package.
1.312 gdt 4008: While this was used often in the past, it has two
4009: problems: the display will be missed if many packages are
4010: intalled at once, and the person installing the package
4011: and the one using or configuring it may be different. It
4012: should therefore be used only in exceptional circumstances
4013: where lasting negative consequences would result from
4014: someone not reading it.</p>
4015: <p>MESSAGE should not be used for:</p>
4016: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4017: <li class="listitem"><p>exhortations to read the documentation</p></li>
4018: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
4019: <li class="listitem"><p>anything that should be explained in the
4020: installation/configuration documentation that should
4021: come with the package</p></li>
4022: </ul></div>
4023: <p>If the documentation provided by upstream needs
1.313 leot 4024: enhancing, create e.g. files/README.pkgsrc and install it
4025: in the package's documentation directory.
1.312 gdt 4026: </p>
4027: <p>Note that MESSAGE is shown for all operating
4028: systems and all init systems. If a MESSAGE is necessary,
1.313 leot 4029: it should be narrowed to only those operating systems and
1.312 gdt 4030: init systems to which it applies.</p>
4031: <p>Note that you can modify variables in it easily by using
1.299 rillig 4032: <code class="varname">MESSAGE_SUBST</code> in the package's
4033: <code class="filename">Makefile</code>:</p>
1.91 rillig 4034: <pre class="programlisting">
1.299 rillig 4035: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.91 rillig 4036: </pre>
1.299 rillig 4037: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
4038: <code class="filename">MESSAGE</code>. By default, substitution is
4039: performed for <code class="varname">PKGNAME</code>,
4040: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4041: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4042: <code class="varname">PKG_SYSCONFDIR</code>,
4043: <code class="varname">ROOT_GROUP</code>, and
4044: <code class="varname">ROOT_USER</code>.</p>
4045: <p>You can display a different or additional files by
4046: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4047: default is <code class="filename">MESSAGE</code>, if the file
4048: exists.</p>
4049: </dd>
4050: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4051: <dd>
4052: <p>This file is used by the alternatives framework.
4053: It creates, configures, and destroys generic wrappers used to
4054: run programs with similar interfaces.
4055: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4056: for more information.</p>
4057: <p>Each line of the file contains two filenames, first
4058: the wrapper and then the alternative provided by the package.
4059: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4060: </dd>
4061: </dl></div>
4062: </div>
4063: <div class="sect2">
4064: <div class="titlepage"><div><div><h3 class="title">
4065: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
4066: <div class="variablelist"><dl class="variablelist">
4067: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4068: <dd><p>This file contains arbitrary things that could
4069: also go into a <code class="filename">Makefile</code>, but its purpose is
4070: to be used by more than one package. This file should only be
4071: used when the packages that will use the file are known in
4072: advance. For other purposes it is often better to write a
4073: <code class="filename">*.mk</code> file and give it a good name that
4074: describes what it does.</p></dd>
4075: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4076: <dd><p>This file contains the dependency information
4077: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
4078: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4079: <dd><p>This file contains workarounds for compiler bugs
4080: and similar things. It is included automatically by the pkgsrc
4081: infrastructure, so you don't need an extra
4082: <code class="literal">.include</code> line for
4083: it.</p></dd>
4084: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4085: <dd><p>This file contains the code for the
4086: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
4087: selected by the user. If a package has only one or two options,
4088: it is equally acceptable to put the code directly into the
4089: <code class="filename">Makefile</code>.</p></dd>
4090: </dl></div>
4091: </div>
4092: <div class="sect2">
4093: <div class="titlepage"><div><div><h3 class="title">
4094: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
4095: <div class="variablelist"><dl class="variablelist">
4096: <dt><span class="term"><code class="filename">README*</code></span></dt>
4097: <dd><p>These files do not take place in the creation of
4098: a package and thus are purely informative to the package
4099: developer.</p></dd>
4100: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4101: <dd><p>This file contains things that need to be done
4102: to make the package even
4103: better.</p></dd>
4104: </dl></div>
4105: </div>
4106: </div>
4107: <div class="sect1">
4108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4109: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
4110: </h2></div></div></div>
4111: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4112: unpacked into the directory denoted by
4113: <code class="varname">WRKDIR</code>. It can be removed by running
4114: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4115: directory is also used to keep various timestamp files.
4116: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4117: The default is <code class="filename">${.CURDIR}/work</code>
4118: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4119: if <code class="varname">OBJMACHINE</code> is set.</p>
1.91 rillig 4120: </div>
1.299 rillig 4121: <div class="sect1">
4122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4123: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
4124: </h2></div></div></div>
4125: <p>If you have any files that you wish to be placed in the package
4126: prior to configuration or building, you can place these files here
4127: and use a <span class="command"><strong>${CP}</strong></span> command in the
4128: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4129: <p>If you want to share files in this way with other
4130: packages, set the <code class="varname">FILESDIR</code> variable to point
4131: to the other package's <code class="filename">files</code> directory,
4132: e.g.:</p>
1.91 rillig 4133: <pre class="programlisting">
1.299 rillig 4134: FILESDIR= ../../editors/xemacs/files
1.91 rillig 4135: </pre>
4136: </div>
4137: </div>
1.148 asau 4138: <div class="chapter">
1.75 rillig 4139: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 4140: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75 rillig 4141: <div class="toc">
4142: <p><b>Table of Contents</b></p>
1.210 leot 4143: <dl class="toc">
1.299 rillig 4144: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4145: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4146: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4147: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4148: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4149: <dd><dl>
4150: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4151: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4152: </dl></dd>
4153: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4154: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4155: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4156: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4157: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4158: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4159: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4160: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4161: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4162: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4163: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4164: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75 rillig 4165: </dl>
4166: </div>
1.148 asau 4167: <div class="sect1">
1.75 rillig 4168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4169: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4170: <p>This chapter gives a detailed description on how a package is
4171: built. Building a package is separated into different
4172: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4173: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4174: described in the following sections. Each phase is split into
4175: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4176: containing phase, prefixed by one of <code class="varname">pre-</code>,
4177: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4178: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4179: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4180: <p>Never override the regular targets (like
4181: <code class="varname">fetch</code>), if you have to, override the
4182: <code class="varname">do-*</code> ones instead.</p>
4183: <p>The basic steps for building a program are always the same. First
4184: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4185: the local system and then extracted. After any pkgsrc-specific patches
4186: to compile properly are applied, the software can be configured, then
4187: built (usually by compiling), and finally the generated binaries, etc.
4188: can be put into place on the system.</p>
4189: <p>To get more details about what is happening at each step,
4190: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4191: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4192: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4193: </div>
4194: <div class="sect1">
4195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4196: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4197: <p>Before outlining the process performed by the NetBSD package system in
4198: the next section, here's a brief discussion on where programs are
4199: installed, and which variables influence this.</p>
4200: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4201: where all files of the final program shall be installed. It is
4202: usually set to <code class="varname">LOCALBASE</code>
4203: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4204: for pkgs in the <code class="filename">cross</code> category. The value of
4205: <code class="varname">PREFIX</code> needs to be put
4206: into the various places in the program's source where paths to
4207: 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>
4208: <p>When choosing which of these variables to use,
4209: follow the following rules:</p>
1.148 asau 4210: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 4211: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4212: where the current pkg will be installed. When referring to a
4213: pkg's own installation path, use
4214: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
1.338 nia 4215: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.299 rillig 4216: are installed. If you need to construct a -I or -L argument
4217: to the compiler to find includes and libraries installed by
1.338 nia 4218: another pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.299 rillig 4219: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4220: installed all packages in <code class="filename">/usr/local</code>. As
4221: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4222: administrator, this variable is a misnomer.</p></li>
4223: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4224: distribution (from xsrc, etc.) is installed. When looking for
4225: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4226: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4227: <li class="listitem"><p>X11-based packages using imake must set
4228: <code class="varname">USE_IMAKE</code> to be installed correctly under
4229: <code class="varname">LOCALBASE</code>.</p></li>
4230: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.360 leot 4231: 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.299 rillig 4232: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4233: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4234: </ul></div>
4235: </div>
4236: <div class="sect1">
4237: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4238: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4239: <p>When building a package, various directories are used to store
4240: source files, temporary files, pkgsrc-internal files, and so on. These
4241: directories are explained here.</p>
4242: <p>Some of the directory variables contain relative pathnames. There
4243: are two common base directories for these relative directories:
4244: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4245: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4246: inside the package itself.</p>
4247: <div class="variablelist"><dl class="variablelist">
4248: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4249: <dd><p>This is an absolute pathname that points to the pkgsrc
4250: root directory. Generally, you don't need
4251: it.</p></dd>
4252: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4253: <dd><p>This is an absolute pathname that points to the
4254: current package.</p></dd>
4255: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.343 gutterid 4256: <dd>
4257: <p>This is a pathname relative to
4258: <code class="varname">PKGSRCDIR</code> that points to the current package.
4259: It is defined after including <code class="filename">bsd.prefs.mk</code>
4260: and can be used in makefile fragments that are used by several
4261: packages to distinguish between these packages. Other variables
4262: that would serve the same purpose are <code class="varname">PKGBASE</code>
4263: and <code class="varname">PKGNAME</code>, but these are only defined after
4264: including <code class="filename">bsd.pkg.mk</code>, which is too
4265: late.</p>
4266: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
4267: <code class="varname">PKGPATH</code> to tweak variables like
4268: <code class="varname">MAKE_JOBS</code> and
4269: <code class="varname">CFLAGS</code>.</p>
4270: </dd>
1.299 rillig 4271: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4272: <dd><p>This is an absolute pathname pointing to the directory
4273: where all work takes place. The distfiles are extracted to this
4274: directory. It also contains temporary directories and log files used by
4275: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4276: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4277: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4278: <dd><p>This is an absolute pathname pointing to the directory
4279: where the distfiles are extracted. It is usually a direct subdirectory
4280: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4281: that isn't hidden. This variable may be changed by a package
4282: <code class="filename">Makefile</code>.</p></dd>
4283: </dl></div>
4284: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4285: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4286: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4287: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4288: If users would like to have their pkgsrc trees behave in a
4289: read-only manner, then the value of
4290: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4291: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 4292: </div>
1.148 asau 4293: <div class="sect1">
1.75 rillig 4294: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4295: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4296: <p>You can run a particular phase by typing <span class="command"><strong>make
1.343 gutterid 4297: <em class="replaceable"><code>phase</code></em></strong></span>, where
4298: <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
4299: automatically run all phases that are required for this phase. The
4300: default phase is <code class="varname">build</code>, that is, when you run
4301: <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.299 rillig 4302: the package will be built, but not installed.</p>
1.75 rillig 4303: </div>
1.148 asau 4304: <div class="sect1">
1.75 rillig 4305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4306: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4307: <p>The first step in building a package is to fetch the
4308: distribution files (distfiles) from the sites that are providing
4309: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4310: phase.</p>
1.148 asau 4311: <div class="sect2">
1.93 rillig 4312: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 4313: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4314: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4315: defines all URLs from where the distfile, whose name is
4316: derived from the <code class="varname">DISTNAME</code> variable, is
4317: fetched. The more complicated cases are described
4318: below.</p>
4319: <p>The variable <code class="varname">DISTFILES</code> specifies
4320: the list of distfiles that have to be fetched. Its value
4321: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4322: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4323: so that most packages don't need to define it at all.
4324: <code class="varname">EXTRACT_SUFX</code> is
4325: <code class="literal">.tar.gz</code> by default, but can be changed
4326: freely. Note that if your package requires additional
4327: distfiles to the default one, you cannot just append the
4328: additional filenames using the <code class="literal">+=</code>
4329: operator, but you have write for example:</p>
4330: <pre class="programlisting">
4331: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4332: </pre>
4333: <p>Each distfile is fetched from a list of sites, usually
4334: <code class="varname">MASTER_SITES</code>. If the package has multiple
4335: <code class="varname">DISTFILES</code> or multiple
4336: <code class="varname">PATCHFILES</code> from different sites, you can
4337: set
4338: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4339: to the list of URLs where the file
4340: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4341: (including the suffix) can be found.</p>
4342: <pre class="programlisting">
4343: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4344: DISTFILES+= foo-file.tar.gz
4345: SITES.foo-file.tar.gz= \
4346: https://www.somewhere.com/somehow/ \
4347: https://www.somewhereelse.com/mirror/somehow/
4348: </pre>
4349: <p>When actually fetching the distfiles, each item from
4350: <code class="varname">MASTER_SITES</code> or
4351: <code class="varname">SITES.*</code> gets the name of each distfile
4352: appended to it, without an intermediate slash. Therefore,
4353: all site values have to end with a slash or other separator
4354: character. This allows for example to set
4355: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4356: that gets the name of the distfile as a parameter. In this
4357: case, the definition would look like:</p>
4358: <pre class="programlisting">
4359: MASTER_SITES= https://www.example.com/download.cgi?file=
4360: </pre>
4361: <p> The exception to this rule are URLs starting with a dash.
4362: In that case the URL is taken as is, fetched and the result
4363: stored under the name of the distfile. You can use this style
4364: for the case when the download URL style does not match the
4365: above common case. For example, if permanent download URL is a
4366: redirector to the real download URL, or the download file name
4367: is offered by an HTTP Content-Disposition header. In the
4368: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4369: created instead of the default
4370: <code class="filename">v1.0.0.tar.gz</code>.</p>
4371: <pre class="programlisting">
4372: DISTNAME= foo-1.0.0
4373: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4374: </pre>
4375: <p>There are some predefined values for
4376: <code class="varname">MASTER_SITES</code>, which can be used in
4377: packages. The names of the variables should speak for
4378: themselves.</p>
4379: <table border="0" summary="Simple list" class="simplelist">
4380: <tr>
4381: <td>MASTER_SITE_APACHE</td>
4382: <td>MASTER_SITE_BACKUP</td>
4383: </tr>
4384: <tr>
4385: <td>MASTER_SITE_CRATESIO</td>
4386: <td>MASTER_SITE_CYGWIN</td>
4387: </tr>
4388: <tr>
4389: <td>MASTER_SITE_DEBIAN</td>
4390: <td>MASTER_SITE_FREEBSD</td>
4391: </tr>
4392: <tr>
4393: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4394: <td>MASTER_SITE_GENTOO</td>
4395: </tr>
4396: <tr>
4397: <td>MASTER_SITE_GITHUB</td>
1.340 gutterid 4398: <td>MASTER_SITE_GITLAB</td>
4399: </tr>
4400: <tr>
1.299 rillig 4401: <td>MASTER_SITE_GNOME</td>
1.340 gutterid 4402: <td>MASTER_SITE_GNU</td>
1.299 rillig 4403: </tr>
4404: <tr>
4405: <td>MASTER_SITE_GNUSTEP</td>
1.340 gutterid 4406: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.299 rillig 4407: </tr>
4408: <tr>
4409: <td>MASTER_SITE_IFARCHIVE</td>
1.340 gutterid 4410: <td>MASTER_SITE_KDE</td>
1.299 rillig 4411: </tr>
4412: <tr>
4413: <td>MASTER_SITE_MOZILLA</td>
1.340 gutterid 4414: <td>MASTER_SITE_MOZILLA_ALL</td>
1.299 rillig 4415: </tr>
4416: <tr>
4417: <td>MASTER_SITE_MYSQL</td>
1.340 gutterid 4418: <td>MASTER_SITE_NETLIB</td>
1.299 rillig 4419: </tr>
4420: <tr>
4421: <td>MASTER_SITE_OPENBSD</td>
1.340 gutterid 4422: <td>MASTER_SITE_OPENOFFICE</td>
1.299 rillig 4423: </tr>
4424: <tr>
4425: <td>MASTER_SITE_OSDN</td>
1.340 gutterid 4426: <td>MASTER_SITE_PERL_CPAN</td>
1.299 rillig 4427: </tr>
4428: <tr>
4429: <td>MASTER_SITE_PGSQL</td>
1.340 gutterid 4430: <td>MASTER_SITE_PYPI</td>
1.299 rillig 4431: </tr>
4432: <tr>
4433: <td>MASTER_SITE_RUBYGEMS</td>
1.340 gutterid 4434: <td>MASTER_SITE_R_CRAN</td>
1.299 rillig 4435: </tr>
4436: <tr>
4437: <td>MASTER_SITE_SOURCEFORGE</td>
1.340 gutterid 4438: <td>MASTER_SITE_SUNSITE</td>
1.299 rillig 4439: </tr>
1.85 jmmv 4440: <tr>
1.299 rillig 4441: <td>MASTER_SITE_SUSE</td>
1.340 gutterid 4442: <td>MASTER_SITE_TEX_CTAN</td>
1.85 jmmv 4443: </tr>
4444: <tr>
1.299 rillig 4445: <td>MASTER_SITE_XCONTRIB</td>
1.340 gutterid 4446: <td>MASTER_SITE_XEMACS</td>
1.85 jmmv 4447: </tr>
4448: <tr>
1.299 rillig 4449: <td>MASTER_SITE_XORG</td>
1.340 gutterid 4450: <td> </td>
1.299 rillig 4451: </tr>
4452: </table>
4453: <p>Some explanations for the less self-explaining ones:
4454: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
4455: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
4456: 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>
4457: <p>If you choose one of these predefined sites, you may
4458: want to specify a subdirectory of that site. Since these
4459: macros may expand to more than one actual site, you
4460: <span class="emphasis"><em>must</em></span> use the following construct to
4461: specify a subdirectory:</p>
1.100 rillig 4462: <pre class="programlisting">
1.299 rillig 4463: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4464: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100 rillig 4465: </pre>
1.299 rillig 4466: <p>Note the trailing slash after the subdirectory
4467: name.</p>
4468: </div>
4469: <div class="sect2">
4470: <div class="titlepage"><div><div><h3 class="title">
4471: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4472: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4473: all the distfiles exist in a local directory
4474: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4475: user). If the files do not exist, they are fetched using
4476: commands of the form</p>
1.100 rillig 4477: <pre class="programlisting">
1.299 rillig 4478: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4479: </pre>
4480: <p>where <code class="literal">${site}</code> varies through
4481: several possibilities in turn: first,
4482: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4483: sites specified in either <code class="varname">SITES.file</code> if
4484: defined, else <code class="varname">MASTER_SITES</code> or
4485: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4486: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4487: all except the first and the last can be optionally sorted
4488: by the user, via setting either
4489: <code class="varname">MASTER_SORT_RANDOM</code>, and
4490: <code class="varname">MASTER_SORT_AWK</code> or
4491: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4492: <p> The specific command and arguments used depend on the
4493: <code class="varname">FETCH_USING</code> parameter. The example above is
4494: for <code class="literal">FETCH_USING=custom</code>.</p>
4495: <p>The distfiles mirror run by the NetBSD Foundation uses the
4496: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4497: distfiles, if they are freely distributable. Packages setting
4498: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4499: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4500: mirrored.</p>
1.85 jmmv 4501: </div>
4502: </div>
1.299 rillig 4503: <div class="sect1">
4504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4505: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4506: <p>After the distfile(s) are fetched, their checksum is
4507: generated and compared with the checksums stored in the
4508: distinfo file. If the checksums don't match, the build is
4509: aborted. This is to ensure the same distfile is used for
4510: building, and that the distfile wasn't changed, e.g. by some
4511: malign force, deliberately changed distfiles on the master
4512: distribution site or network lossage.</p>
1.75 rillig 4513: </div>
1.148 asau 4514: <div class="sect1">
1.75 rillig 4515: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4516: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4517: <p>When the distfiles are present on the local system, they
4518: need to be extracted, as they usually come in the form of some
4519: compressed archive format.</p>
4520: <p>By default, all <code class="varname">DISTFILES</code> are
4521: extracted. If you only need some of them, you can set the
4522: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4523: files.</p>
4524: <p>Extracting the files is usually done by a little
4525: program, <code class="filename">mk/extract/extract</code>, which
4526: already knows how to extract various archive formats, so most
4527: likely you will not need to change anything here. But if you
4528: need, the following variables may help you:</p>
1.148 asau 4529: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4530: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4531: <dd><p>Use these variables to override the default
4532: options for an extract command, which are defined in
4533: <code class="filename">mk/extract/extract</code>.</p></dd>
4534: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4535: <dd><p>This variable can be set to
4536: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4537: (which is the default value), <code class="literal">pax</code>, or an
4538: absolute pathname pointing to the command with which tar
4539: archives should be extracted. It is preferred to choose bsdtar over gtar
4540: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 4541: </dl></div>
1.299 rillig 4542: <p>If the <code class="filename">extract</code> program doesn't
4543: serve your needs, you can also override the
4544: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4545: command used for extracting the files. This command is
4546: executed in the <code class="filename">${WRKSRC}</code>
4547: directory. During execution of this command, the shell
4548: variable <code class="varname">extract_file</code> holds the absolute
4549: pathname of the file that is going to be extracted.</p>
4550: <p>And if that still does not suffice, you can override the
4551: <code class="varname">do-extract</code> target in the package
4552: Makefile.</p>
1.75 rillig 4553: </div>
1.148 asau 4554: <div class="sect1">
1.75 rillig 4555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4556: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4557: <p>After extraction, all the patches named by the
4558: <code class="varname">PATCHFILES</code>, those present in the patches
4559: subdirectory of the package as well as in
4560: $LOCALPATCHES/$PKGPATH (e.g.
4561: <code class="filename">/usr/local/patches/graphics/png</code>) are
4562: applied. Patchfiles ending in <code class="filename">.Z</code> or
4563: <code class="filename">.gz</code> are uncompressed before they are
4564: applied, files ending in <code class="filename">.orig</code> or
4565: <code class="filename">.rej</code> are ignored. Any special options to
1.360 leot 4566: <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.299 rillig 4567: <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.360 leot 4568: <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.299 rillig 4569: fail if the expected text from the patch context is not found in the
4570: patched file. If that happens, fix the patch file by comparing it
4571: with the actual text in the file to be patched.</p>
1.78 rillig 4572: </div>
1.148 asau 4573: <div class="sect1">
1.75 rillig 4574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4575: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4576: <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>.
4577: </p>
1.75 rillig 4578: </div>
1.148 asau 4579: <div class="sect1">
1.75 rillig 4580: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4581: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4582: <p>This phase creates wrapper programs for the compilers and
4583: linkers. The following variables can be used to tweak the
4584: wrappers.</p>
4585: <div class="variablelist"><dl class="variablelist">
4586: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4587: <dd><p>The command used to print progress
4588: messages. Does nothing by default. Set to
4589: <code class="literal">${ECHO}</code> to see the progress
4590: messages.</p></dd>
4591: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4592: <dd><p>This variable can be set to
4593: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4594: depending on whether you want additional information in the
4595: wrapper log file.</p></dd>
4596: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4597: <dd><p>This variable can be set to
4598: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4599: on whether the wrapper should use its cache, which will
4600: improve the speed. The default value is
4601: <code class="literal">yes</code>, but is forced to
4602: <code class="literal">no</code> if the platform does not support
4603: it.</p></dd>
4604: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4605: <dd><p>A list of reordering commands. A reordering
4606: command has the form
4607: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4608: It ensures that that
4609: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4610: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4611: </p></dd>
4612: </dl></div>
4613: </div>
4614: <div class="sect1">
4615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4616: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4617: <p>Most pieces of software need information on the header
4618: files, system calls, and library routines which are available
4619: on the platform they run on. The process of determining this
4620: information is known as configuration, and is usually
4621: automated. In most cases, a script is supplied with the
4622: distfiles, and its invocation results in generation of header
4623: files, Makefiles, etc.</p>
4624: <p>If the package contains a configure script, this can be
4625: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4626: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4627: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.301 rillig 4628: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4629: <p>In the <code class="literal">do-configure</code> stage, a rough
4630: equivalent of the following command is run. See
4631: <code class="filename">mk/configure/configure.mk</code>, target
4632: <code class="literal">do-configure-script</code> for the exact
4633: definition.</p>
4634: <pre class="programlisting">
4635: .for dir in ${CONFIGURE_DIRS}
4636: cd ${WRKSRC} && cd ${dir} \
4637: && env ${CONFIGURE_ENV} \
4638: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299 rillig 4639: .endfor
1.100 rillig 4640: </pre>
1.299 rillig 4641: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4642: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4643: <code class="varname">WRKSRC</code>. In each of these directories, the
4644: configure script is run with the environment
4645: <code class="varname">CONFIGURE_ENV</code> and arguments
4646: <code class="varname">CONFIGURE_ARGS</code>. The variables
4647: <code class="varname">CONFIGURE_ENV</code>,
4648: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4649: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4650: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4651: package.</p>
4652: <p>If the program uses the Perl way of configuration (mainly Perl
4653: modules, but not only), i.e. a file called
4654: <code class="filename">Makefile.PL</code>, it should include
4655: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4656: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4657: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4658: <p>If the program uses an <code class="filename">Imakefile</code>
4659: for configuration, the appropriate steps can be invoked by
4660: setting <code class="varname">USE_IMAKE</code> to
4661: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4662: You can add variables to xmkmf's environment by adding them to the
4663: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4664: <p>If the program uses <code class="filename">cmake</code>
4665: for configuration, the appropriate steps can be invoked by
1.348 wiz 4666: including <code class="filename">../../devel/cmake/build.mk</code>.
1.299 rillig 4667: You can add variables to cmake's environment by adding them to the
4668: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
4669: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
1.348 wiz 4670: If you want to add arguments only for particular stages, you can use the
4671: <code class="varname">CMAKE_CONFIGURE_ARGS</code>,
4672: <code class="varname">CMAKE_BUILD_ARGS</code>, and
4673: <code class="varname">CMAKE_INSTALL_ARGS</code> variables.
4674: You can set the <code class="varname">CONFIGURE_DIRS</code> variable to the
4675: directories in which CMake should be run, relative to
4676: <code class="varname">WRKSRC</code>. This defaults to to <span class="quote">“<span class="quote">.</span>”</span>.
4677: </p>
1.299 rillig 4678: <p>If there is no configure step at all, set
4679: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 4680: </div>
1.148 asau 4681: <div class="sect1">
1.75 rillig 4682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4683: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301 rillig 4684: <p>For building a package, a rough equivalent of the following
4685: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4686: <code class="literal">do-build</code> for the exact definition.</p>
1.97 rillig 4687: <pre class="programlisting">
1.301 rillig 4688: .for dir in ${BUILD_DIRS}
4689: cd ${WRKSRC} && cd ${dir} \
1.299 rillig 4690: && env ${MAKE_ENV} \
1.301 rillig 4691: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299 rillig 4692: -f ${MAKE_FILE} \
4693: ${BUILD_TARGET}
4694: .endfor
1.97 rillig 4695: </pre>
1.299 rillig 4696: <p><code class="varname">BUILD_DIRS</code> (default:
4697: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4698: <code class="varname">WRKSRC</code>. In each of these directories,
4699: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4700: <code class="varname">MAKE_ENV</code> and arguments
4701: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4702: <code class="varname">MAKE_ENV</code>,
4703: <code class="varname">BUILD_MAKE_FLAGS</code>,
4704: <code class="varname">MAKE_FILE</code> and
4705: <code class="varname">BUILD_TARGET</code> may all be changed by the
4706: package.</p>
4707: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4708: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4709: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4710: default value of <code class="varname">MAKE_FILE</code> is
4711: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4712: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4713: <p>If there is no build step at all, set
4714: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.97 rillig 4715: </div>
1.148 asau 4716: <div class="sect1">
1.97 rillig 4717: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4718: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4719: <p>[TODO]</p>
1.75 rillig 4720: </div>
1.148 asau 4721: <div class="sect1">
1.75 rillig 4722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4723: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4724: <p>Once the build stage has completed, the final step is to
4725: install the software in public directories, so users can
4726: access the programs and files.</p>
1.301 rillig 4727: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4728: of the following code is executed; see
4729: <code class="filename">mk/install/install.mk</code>, target
4730: <code class="literal">do-install</code> for the exact definition. Additionally,
4731: before and after this code, several consistency checks are run
4732: against the files-to-be-installed, see
4733: <code class="filename">mk/check/*.mk</code> for details.</p>
4734: <pre class="programlisting">
4735: .for dir in ${INSTALL_DIRS}
4736: cd ${WRKSRC} && cd ${dir} \
4737: && env ${INSTALL_ENV} ${MAKE_ENV} \
4738: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4739: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299 rillig 4740: .endfor
1.220 wiz 4741: </pre>
1.299 rillig 4742: <p>The variable's meanings are analogous to the ones in the
4743: <span class="emphasis"><em>build</em></span> phase.
4744: <code class="varname">INSTALL_DIRS</code> defaults to
4745: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4746: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4747: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4748: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4749: defined.</p>
4750: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4751: variables are useful. They are all variations of the
1.360 leot 4752: <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.299 rillig 4753: permissions preset. <code class="varname">INSTALL</code> is the plain
4754: install command. The specialized variants, together with their
4755: intended use, are:</p>
4756: <div class="variablelist"><dl class="variablelist">
4757: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4758: <dd><p>directories that contain
4759: binaries</p></dd>
4760: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4761: <dd><p>directories that contain
4762: scripts</p></dd>
4763: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4764: <dd><p>directories that contain shared and static
4765: libraries</p></dd>
4766: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4767: <dd><p>directories that contain data
4768: files</p></dd>
4769: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4770: <dd><p>directories that contain man
4771: pages</p></dd>
4772: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4773: <dd><p>directories that contain data files for games
4774: </p></dd>
4775: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4776: <dd><p>binaries that can be stripped from debugging
4777: symbols</p></dd>
4778: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4779: <dd><p>binaries that cannot be
4780: stripped</p></dd>
4781: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4782: <dd><p>game
4783: binaries</p></dd>
4784: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4785: <dd><p>shared and static
4786: libraries</p></dd>
4787: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4788: <dd><p>data files</p></dd>
4789: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4790: <dd><p>data files for
4791: games</p></dd>
4792: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4793: <dd><p>man pages</p></dd>
4794: </dl></div>
4795: <p>Some other variables are:</p>
4796: <div class="variablelist"><dl class="variablelist">
4797: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.360 leot 4798: <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.299 rillig 4799: when installing binaries. Any debugging sections and symbols present in
4800: binaries will be preserved.
4801: </p></dd>
4802: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4803: <dd><p>A list of directories relative to
4804: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4805: beginning of the <span class="emphasis"><em>install</em></span> phase.
4806: The package is supposed to create all needed directories itself
4807: before installing files to it and list all other directories here.
4808: </p></dd>
4809: </dl></div>
4810: <p>In the rare cases that a package shouldn't install anything,
4811: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4812: mostly relevant for packages in the <code class="filename">regress</code>
4813: category.</p>
1.75 rillig 4814: </div>
1.148 asau 4815: <div class="sect1">
1.75 rillig 4816: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4817: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4818: <p>Once the install stage has completed, a binary package of
4819: the installed files can be built. These binary packages can be
4820: used for quick installation without previous compilation, e.g. by
4821: the <span class="command"><strong>make bin-install</strong></span> or by using
4822: <span class="command"><strong>pkg_add</strong></span>.</p>
4823: <p>By default, the binary packages are created in
4824: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4825: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4826: one for each category in the <code class="varname">CATEGORIES</code>
4827: variable. <code class="varname">PACKAGES</code> defaults to
4828: <code class="filename">pkgsrc/packages</code>.</p>
1.75 rillig 4829: </div>
1.148 asau 4830: <div class="sect1">
1.75 rillig 4831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4832: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4833: <p>Once you're finished with a package, you can clean the work
4834: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4835: to clean the work directories of all dependencies too, use
4836: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 4837: </div>
1.148 asau 4838: <div class="sect1">
1.75 rillig 4839: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4840: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148 asau 4841: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4842: <dt><span class="term">pre/post-*</span></dt>
4843: <dd>
4844: <p>For any of the main targets described in the previous
4845: section (configure, build, install, etc.), two auxiliary
4846: targets exist with
4847: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4848: prefix for the main target's name. These targets are
4849: invoked before and after the main target is called,
4850: allowing extra configuration or installation steps be
4851: performed from a package's Makefile, for example, which
4852: a program's configure script or install target
4853: omitted.</p>
4854: <p>About 5% of the pkgsrc packages define their custom
4855: post-extract target, another 5% define pre-configure, and 10%
4856: define post-install. The other pre/post-* targets are defined
4857: even less often.</p>
4858: </dd>
4859: <dt><span class="term">do-*</span></dt>
1.75 rillig 4860: <dd>
1.299 rillig 4861: <p>Should one of the main targets do the wrong thing,
4862: and should there be no variable to fix this, you can
4863: redefine it with the do-* target. (Note that redefining
4864: the target itself instead of the do-* target is a bad
4865: idea, as the pre-* and post-* targets won't be called
4866: anymore, etc.)</p>
4867: <p>About 15% of the pkgsrc packages override the default
4868: do-install, the other do-* targets are overridden even less
4869: often.</p>
1.75 rillig 4870: </dd>
1.299 rillig 4871: <dt><span class="term">reinstall</span></dt>
1.75 rillig 4872: <dd>
1.299 rillig 4873: <p>If you did a <span class="command"><strong>make install</strong></span> and
4874: you noticed some file was not installed properly, you
4875: can repeat the installation with this target, which will
4876: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4877: <p>This is the default value of
4878: <code class="varname">DEPENDS_TARGET</code> except in the case of
4879: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4880: package</strong></span>, where the defaults are
4881: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4882: respectively.</p>
1.75 rillig 4883: </dd>
1.299 rillig 4884: <dt><span class="term">deinstall</span></dt>
4885: <dd>
1.360 leot 4886: <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.299 rillig 4887: current directory, effectively de-installing the
4888: package. The following variables can be used to tune the
4889: behaviour:</p>
4890: <div class="variablelist"><dl class="variablelist">
4891: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.360 leot 4892: <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.299 rillig 4893: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4894: <dd><p>Remove all packages that require (depend on)
4895: the given package. This can be used to remove any
4896: packages that may have been pulled in by a given
4897: package, e.g. if <span class="command"><strong>make deinstall
4898: DEINSTALLDEPENDS=1</strong></span> is done in
4899: <code class="filename">pkgsrc/x11/kde</code>, this is
4900: likely to remove whole KDE. Works by adding
1.360 leot 4901: <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.299 rillig 4902: command line.</p></dd>
4903: </dl></div>
4904: </dd>
4905: <dt><span class="term">bin-install</span></dt>
4906: <dd><p>Install a binary package from local disk and via FTP
4907: from a list of sites (see the
4908: <code class="varname">BINPKG_SITES</code> variable), and do a
4909: <span class="command"><strong>make package</strong></span> if no binary package is
4910: available anywhere. The arguments given to
4911: <span class="command"><strong>pkg_add</strong></span> can be set via
4912: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4913: operation, etc.</p></dd>
4914: <dt><span class="term">install-clean</span></dt>
4915: <dd><p>This target removes the state files for the "install" and later
4916: phases so that the "install" target may be re-invoked. This can be
4917: used after editing the PLIST to install the package without
4918: rebuilding it.</p></dd>
4919: <dt><span class="term">build-clean</span></dt>
4920: <dd><p>This target removes the state files for the "build" and later
4921: phases so that the "build" target may be re-invoked.</p></dd>
4922: <dt><span class="term">update</span></dt>
4923: <dd>
4924: <p>This target causes the current package to be
4925: updated to the latest version. The package and all
4926: depending packages first get de-installed, then current
4927: versions of the corresponding packages get compiled and
4928: installed. This is similar to manually noting which
4929: packages are currently installed, then performing a
4930: series of <span class="command"><strong>make deinstall</strong></span> and
4931: <span class="command"><strong>make install</strong></span> (or whatever
4932: <code class="varname">UPDATE_TARGET</code> is set to) for these
4933: packages.</p>
4934: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4935: resume package updating in case a previous <span class="command"><strong>make
4936: update</strong></span> was interrupted for some reason.
4937: However, in this case, make sure you don't call
4938: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4939: list of dependent packages in <code class="varname">WRKDIR</code>.
4940: Otherwise, you lose the ability to automatically update
4941: the current package along with the dependent packages
4942: you have installed.</p>
4943: <p>Resuming an interrupted <span class="command"><strong>make
4944: update</strong></span> will only work as long as the package
4945: tree remains unchanged. If the source code for one of
4946: the packages to be updated has been changed, resuming
4947: <span class="command"><strong>make update</strong></span> will most certainly
4948: fail!</p>
4949: <p>The following variables can be used either on the
4950: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4951: alter the behaviour of <span class="command"><strong>make
4952: update</strong></span>:</p>
4953: <div class="variablelist"><dl class="variablelist">
4954: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4955: <dd><p>Install target to recursively use for the
4956: updated package and the dependent packages.
4957: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4958: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4959: <span class="command"><strong>make update</strong></span>. Other good
4960: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4961: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4962: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4963: endless loop!</p></dd>
4964: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4965: <dd><p>Don't clean up after updating. Useful if
4966: you want to leave the work sources of the updated
4967: packages around for inspection or other purposes.
4968: Be sure you eventually clean up the source tree
4969: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4970: or you may run into troubles with old source code
4971: still lying around on your next
4972: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4973: update</strong></span>.</p></dd>
4974: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4975: <dd><p>Deinstall each package before installing
4976: (making <code class="varname">DEPENDS_TARGET</code>). This
4977: may be necessary if the
4978: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4979: called after interrupting a running <span class="command"><strong>make
4980: update</strong></span>.</p></dd>
4981: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4982: <dd><p>Allows you to disable recursion and hardcode
4983: the target for packages. The default is
4984: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4985: facilitating a recursive update of prerequisite
4986: packages. Only set
4987: <code class="varname">DEPENDS_TARGET</code> if you want to
4988: disable recursive updates. Use
4989: <code class="varname">UPDATE_TARGET</code> instead to just
4990: set a specific target for each package to be
4991: installed during <span class="command"><strong>make update</strong></span>
4992: (see above).</p></dd>
4993: </dl></div>
4994: </dd>
4995: <dt><span class="term">clean-update</span></dt>
4996: <dd>
4997: <p>Clean the source tree for all packages that would
4998: get updated if <span class="command"><strong>make update</strong></span> was called
4999: from the current directory. This target should not be
5000: used if the current package (or any of its depending
5001: packages) have already been de-installed (e.g., after
5002: calling <span class="command"><strong>make update</strong></span>) or you may lose
5003: some packages you intended to update. As a rule of
5004: thumb: only use this target <span class="emphasis"><em>before</em></span>
5005: the first time you run <span class="command"><strong>make update</strong></span>
5006: and only if you have a dirty package tree (e.g., if you
5007: used <code class="varname">NOCLEAN</code>).</p>
5008: <p>If you are unsure about whether your tree is
5009: clean, you can either perform a <span class="command"><strong>make
5010: clean</strong></span> at the top of the tree, or use the
5011: following sequence of commands from the directory of the
5012: package you want to update (<span class="emphasis"><em>before</em></span>
5013: running <span class="command"><strong>make update</strong></span> for the first
5014: time, otherwise you lose all the packages you wanted to
5015: update!):</p>
5016: <pre class="screen">
5017: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
5018: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
5019: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
5020: </pre>
5021: <p>The following variables can be used either on the
5022: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
5023: <span class="command"><strong>make clean-update</strong></span>:</p>
5024: <div class="variablelist"><dl class="variablelist">
5025: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
5026: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
5027: reconstruct the list of directories to update for
5028: this package. Only use this if <span class="command"><strong>make
5029: update</strong></span> successfully installed all
5030: packages you wanted to update. Normally, this is
5031: done automatically on <span class="command"><strong>make
5032: update</strong></span>, but may have been suppressed by
5033: the <code class="varname">NOCLEAN</code> variable (see
5034: above).</p></dd>
5035: </dl></div>
5036: </dd>
5037: <dt><span class="term">replace</span></dt>
5038: <dd>
5039: <p>Update the installation of the current package. This
5040: differs from update in that it does not replace dependent
1.322 leot 5041: 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.299 rillig 5042: target to work.</p>
5043: <p><span class="emphasis"><em>Be careful when using this
5044: target!</em></span> There are no guarantees that dependent
5045: packages will still work, in particular they will most
5046: certainly break if you <span class="command"><strong>make replace</strong></span> a
5047: library package whose shared library major version changed
5048: between your installed version and the new one. For this
5049: reason, this target is not officially supported and only
5050: recommended for advanced users.</p>
5051: </dd>
5052: <dt><span class="term">info</span></dt>
1.360 leot 5053: <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.299 rillig 5054: package. You can use this to check which version of a
5055: package is installed.</p></dd>
5056: <dt><span class="term">index</span></dt>
5057: <dd>
5058: <p>This is a top-level command, i.e. it should be used in
5059: the <code class="filename">pkgsrc</code> directory. It creates a
5060: database of all packages in the local pkgsrc tree, including
5061: dependencies, comment, maintainer, and some other useful
5062: information. Individual entries are created by running
5063: <span class="command"><strong>make describe</strong></span> in the packages'
5064: directories. This index file is saved as
5065: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
5066: verbose format by running <span class="command"><strong>make
5067: print-index</strong></span>. You can search in it with
5068: <span class="command"><strong>make search
5069: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
5070: extract a list of all packages that depend on a particular
5071: one by running <span class="command"><strong>make show-deps
5072: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
5073: <p>Running this command takes a very long time, some
5074: hours even on fast machines!</p>
5075: </dd>
5076: <dt><span class="term">readme</span></dt>
5077: <dd>
5078: <p>This target generates a
1.314 nia 5079: <code class="filename">index.html</code> file, which can be
1.322 leot 5080: 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.299 rillig 5081: contain references to any packages which are in the
5082: <code class="varname">PACKAGES</code> directory on the local
5083: host. The generated files can be made to refer to URLs
5084: based on <code class="varname">FTP_PKG_URL_HOST</code> and
5085: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314 nia 5086: wanted to generate <code class="filename">index.html</code>
1.299 rillig 5087: files which pointed to binary packages on the local
5088: machine, in the directory
5089: <code class="filename">/usr/packages</code>, set
5090: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
5091: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
5092: <code class="varname">${PACKAGES}</code> directory and its
5093: subdirectories will be searched for all the binary
5094: packages.</p>
5095: <p>The target can be run at the toplevel or in category
5096: directories, in which case it descends recursively.</p>
5097: </dd>
5098: <dt><span class="term">readme-all</span></dt>
5099: <dd><p>This is a top-level command, run it in
5100: <code class="filename">pkgsrc</code>. Use this target to create a
5101: file <code class="filename">README-all.html</code> which contains a
5102: list of all packages currently available in the NetBSD
5103: Packages Collection, together with the category they belong
5104: to and a short description. This file is compiled from the
1.314 nia 5105: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299 rillig 5106: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
5107: readme</strong></span>.</p></dd>
5108: <dt><span class="term">cdrom-readme</span></dt>
5109: <dd><p>This is very much the same as the
5110: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
5111: used when generating a pkgsrc tree to be written to a
5112: CD-ROM. This target also produces
1.314 nia 5113: <code class="filename">index.html</code> files, and can be made
1.299 rillig 5114: to refer to URLs based on
5115: <code class="varname">CDROM_PKG_URL_HOST</code> and
5116: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
5117: <dt><span class="term">show-distfiles</span></dt>
5118: <dd><p>This target shows which distfiles and patchfiles
5119: are needed to build the package
5120: (<code class="varname">ALLFILES</code>, which contains all
5121: <code class="varname">DISTFILES</code> and
5122: <code class="varname">PATCHFILES</code>, but not
5123: <code class="filename">patches/*</code>).</p></dd>
5124: <dt><span class="term">show-downlevel</span></dt>
5125: <dd><p>This target shows nothing if the package is not
5126: installed. If a version of this package is installed,
5127: but is not the version provided in this version of
5128: pkgsrc, then a warning message is displayed. This target
5129: can be used to show which of your installed packages are
5130: downlevel, and so the old versions can be deleted, and
5131: the current ones added.</p></dd>
5132: <dt><span class="term">show-pkgsrc-dir</span></dt>
5133: <dd><p>This target shows the directory in the pkgsrc
5134: hierarchy from which the package can be built and
5135: installed. This may not be the same directory as the one
5136: from which the package was installed. This target is
5137: intended to be used by people who may wish to upgrade
5138: many packages on a single host, and can be invoked from
5139: the top-level pkgsrc Makefile by using the
5140: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
5141: <dt><span class="term">show-installed-depends</span></dt>
5142: <dd><p>This target shows which installed packages match
5143: the current package's <code class="varname">DEPENDS</code>. Useful
5144: if out of date dependencies are causing build
5145: problems.</p></dd>
5146: <dt><span class="term">print-build-depends-list</span></dt>
5147: <dd><p>This target shows the list of packages that the current package
5148: depends on for building.</p></dd>
5149: <dt><span class="term">print-run-depends-list</span></dt>
5150: <dd><p>This target shows the list of packages that the current package
5151: depends on for running.</p></dd>
5152: <dt><span class="term">check-shlibs</span></dt>
5153: <dd><p>After a package is installed, check all its
5154: binaries and (on ELF platforms) shared libraries to see
5155: if they find the shared libs they need. Run by default
5156: 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>
5157: <dt><span class="term">print-PLIST</span></dt>
5158: <dd>
5159: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5160: upgraded pkg, this prints out an attempt to generate a
5161: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5162: -newer work/.extract_done</strong></span>. An attempt is made
5163: to care for shared libs etc., but it is
5164: <span class="emphasis"><em>strongly</em></span> recommended to review the
5165: result before putting it into
5166: <code class="filename">PLIST</code>. On upgrades, it's useful to
5167: diff the output of this command against an already
5168: existing <code class="filename">PLIST</code> file.</p>
1.360 leot 5169: <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.299 rillig 5170: other methods that don't update file access times, be
5171: sure to add these files manually to your
5172: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5173: -newer</span>”</span> command used by this target won't catch
5174: them!</p>
5175: <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
5176: information on this target.</p>
5177: </dd>
5178: </dl></div>
5179: </div>
5180: </div>
5181: <div class="chapter">
5182: <div class="titlepage"><div><div><h2 class="title">
5183: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5184: <div class="toc">
5185: <p><b>Table of Contents</b></p>
5186: <dl class="toc">
5187: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5188: <dd><dl>
1.334 nia 5189: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
5190: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
5191: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.299 rillig 5192: </dl></dd>
5193: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5194: <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>
5195: </dl>
5196: </div>
5197: <p>When you find a package that is not yet in pkgsrc, you
5198: most likely have a URL from where you can download the source
5199: code. Starting with this URL, creating a package involves only a
5200: few steps.</p>
5201: <div class="procedure"><ol class="procedure" type="1">
5202: <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
5203: enable the basic quality checks.</p></li>
5204: <li class="step">
1.322 leot 5205: <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.299 rillig 5206: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5207: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5208: <span class="command"><strong>mkpatches</strong></span>:</p>
5209: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5210: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5211: </li>
5212: <li class="step">
5213: <p>Choose one of the top-level directories as the category in
5214: which you want to place your package. You can also create a directory of
1.334 nia 5215: your own (maybe called <code class="filename">local</code>). Change into that
5216: category directory:</p>
5217: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em></code></strong></pre>
1.299 rillig 5218: </li>
5219: <li class="step">
1.334 nia 5220: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
5221: argument the URL of the distribution file (in most cases a
5222: <code class="filename">.tar.gz</code> file). This will download the distribution
5223: file and create the necessary files of the package, based on what's in
5224: the distribution file:</p>
1.299 rillig 5225: <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>
5226: </li>
5227: <li class="step">
5228: <p>Examine the extracted files to determine the dependencies of
5229: your package. Ideally, this is mentioned in some
5230: <code class="filename">README</code> file, but things may differ. For each of
5231: these dependencies, look where it exists in pkgsrc, and if there is a
5232: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5233: line to your package <code class="filename">Makefile</code> which includes that
5234: file just before the last line. If the
5235: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5236: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5237: that the package's include files and libraries are provided.</p>
1.334 nia 5238: <p>If you just need binaries from a dependent package, add a
1.299 rillig 5239: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5240: version of the dependency and where it can be found in pkgsrc. This line
5241: should be placed in the third paragraph. If the dependency is only
5242: needed for building the package, but not when using it, use
5243: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5244: instead of <code class="varname">DEPENDS</code>.
5245: The difference between <code class="varname">TOOL_DEPENDS</code> and
5246: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5247: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.334 nia 5248: packages, i.e. packages for the platform where the package is built;
1.299 rillig 5249: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.334 nia 5250: packages, i.e. packages for the platform for which the package
5251: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
5252: specifies a dependency used only for testing the resulting package
5253: built, using the upstream project's included test suite, on the native
5254: platform.
1.299 rillig 5255: Your package may then look like this:</p>
5256: <pre class="programlisting">
5257: [...]
5258:
5259: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5260: DEPENDS+= screen-[0-9]*:../../misc/screen
5261: DEPENDS+= screen>=4.0:../../misc/screen
5262:
5263: [...]
5264:
5265: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5266: .include "../../devel/glib2/buildlink3.mk"
5267: .include "../../mk/bsd.pkg.mk"
5268: </pre>
5269: </li>
5270: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5271: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5272: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5273: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5274: additional explanations.</p></li>
5275: <li class="step"><p>In many cases the package is not yet ready to build. You can
5276: 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
5277: over there, you can hopefully continue here.</p></li>
5278: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5279: directory from the extracted files. Besides these files, a lot of cache
1.334 nia 5280: files and other system information have been saved in the working
5281: directory, which may have become outdated after you edited the
1.299 rillig 5282: <code class="filename">Makefile</code>.</p></li>
5283: <li class="step">
5284: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5285: 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.334 nia 5286: <p>If the extracted files from the package need to be fixed, run
5287: multiple rounds of these commands:</p>
5288: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.299 rillig 5289: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5290: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.334 nia 5291: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
5292: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.299 rillig 5293: </li>
5294: <li class="step"><p>When the package builds fine, the next step is to install
5295: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5296: everything works.</p></li>
5297: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5298: contains a list of the files that are installed by the package, is
5299: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5300: >PLIST</strong></span> to generate a probably correct list. Check
5301: the file using your preferred text editor to see if the list of
5302: files looks plausible.</p></li>
5303: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5304: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5305: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5306: had been registered in the database of installed files, but with an
5307: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5308: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5309: registered with the list of files from
5310: <code class="filename">PLIST</code>.</p></li>
5311: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5312: from above again in a single step, making sure that the PLIST is correct
5313: and the whole package is created as intended.</p></li>
1.334 nia 5314: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
5315: left to do.</p></li>
1.299 rillig 5316: <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>
5317: </ol></div>
5318: <div class="sect1">
5319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5320: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5321: <div class="sect2">
5322: <div class="titlepage"><div><div><h3 class="title">
1.334 nia 5323: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.299 rillig 5324: <p>Python modules and programs packages are easily created using a
5325: set of predefined variables.</p>
5326: <p>
5327: If some Python versions are not supported by the software, set the
5328: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5329: that are not supported, e.g.
5330: </p>
5331: <pre class="programlisting">
5332: PYTHON_VERSIONS_INCOMPATIBLE= 27
5333: </pre>
5334: <p>
1.363 gutterid 5335: If the packaged software is a Python module, include
1.362 wiz 5336: <code class="filename">../../lang/python/wheel.mk</code>.
1.330 wiz 5337: </p>
1.362 wiz 5338: <p>The package directory should be called
1.299 rillig 5339: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5340: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5341: </p>
5342: <pre class="programlisting">
5343: DISTNAME= foopymodule-1.2.10
5344: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5345: </pre>
1.341 gutterid 5346: <p>
5347: For software in PyPi, the name should match what PyPi specifies for
5348: "pip install software".
5349: </p>
1.299 rillig 5350: <p>If it is an application, include
5351: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5352: In order to correctly set the path to the Python interpreter, use the
5353: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5354: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5355: For example:
5356: </p>
5357: <pre class="programlisting">
5358: REPLACE_PYTHON= *.py
5359: </pre>
5360: <p>Some Python modules have separate distributions for Python-2.x
5361: and Python-3.x support. In pkgsrc this is handled by the
5362: <code class="filename">versioned_dependencies.mk</code> file. Set
5363: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
5364: packages that should be depended upon and include
5365: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
5366: then the pkgsrc infrastructure will depend on the appropriate package
5367: version. For example:
5368: </p>
5369: <pre class="programlisting">
5370: PYTHON_VERSIONED_DEPENDENCIES=dialog
5371: </pre>
5372: <p>
5373: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
5374: of supported packages.</p>
5375: </div>
5376: <div class="sect2">
5377: <div class="titlepage"><div><div><h3 class="title">
1.334 nia 5378: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.299 rillig 5379: <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>
5380: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.322 leot 5381: 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.299 rillig 5382: Individual packages (and optionally their dependencies) may be created
5383: and updated. R packages generally follow the same form, and most of
5384: the relevant information needed is contained in a
5385: <code class="filename">DESCRIPTION</code> file as part of each R package on
5386: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5387: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5388: creates or updates a package in the canonical form. The resulting
5389: package should be reviewed for correctness.</p>
5390: </div>
5391: <div class="sect2">
5392: <div class="titlepage"><div><div><h3 class="title">
1.334 nia 5393: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.299 rillig 5394: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.322 leot 5395: <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.299 rillig 5396: <p>If the TeXlive package name is not known, it may be useful to
5397: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5398: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5399: 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
5400: archive</a>.</p>
5401: <p>If the TeXlive package name is known, download the files from
5402: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5403: archive</a>. For package <code class="filename">foo</code>, you will need
5404: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5405: also have associated documentation packages, so download
5406: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5407: should be placed in the appropriate category directory, which is often
5408: but not always <code class="filename">print</code>. Then run the following
5409: command in the category directory.</p>
5410: <pre class="programlisting">
5411: texlive2pkg foo.tar.xz foo.doc.tar.xz
5412: </pre>
5413: <p>This will create two packages, <code class="filename">tex-foo</code> and
5414: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5415: are correct.</p>
5416: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5417: currently does not include version information in package filenames
5418: and changes their contents periodically when updates occur.
5419: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5420: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5421: main one and the corresponding documentation, upload the distfiles
5422: with the following command in each package directory.</p>
5423: <pre class="programlisting">
5424: make upload-distfiles
5425: </pre>
5426: </div>
5427: </div>
5428: <div class="sect1">
5429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5430: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5431: <div class="sect2">
5432: <div class="titlepage"><div><div><h3 class="title">
5433: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5434: <div class="sect3">
5435: <div class="titlepage"><div><div><h4 class="title">
5436: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5437: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5438: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5439: pkgsrc. As the description says it has to do with the web, the obvious
5440: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5441: <pre class="programlisting">
5442: <code class="prompt">$</code> mkdir www/nvu
5443: <code class="prompt">$</code> cd www/nvu
5444: </pre>
5445: <p>The web site says that the sources are available as a tar file, so
5446: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5447: <pre class="programlisting">
5448: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5449: </pre>
5450: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5451: below the <code class="varname">DISTNAME</code> line, as the package name should
5452: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5453: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5454: <code class="varname">COMMENT</code> fields. Then the package
5455: <code class="filename">Makefile</code> looked like that:</p>
5456: <pre class="programlisting">
5457: # $NetBSD $
5458: #
5459:
5460: DISTNAME= nvu-1.0-sources
5461: PKGNAME= nvu-1.0
5462: CATEGORIES= www
5463: MASTER_SITES= http://cvs.nvu.com/download/
5464: EXTRACT_SUFX= .tar.bz2
5465:
5466: MAINTAINER= rillig@NetBSD.org
5467: HOMEPAGE= http://cvs.nvu.com/
5468: COMMENT= Web Authoring System
5469:
5470: # url2pkg-marker (please do not remove this line.)
5471: .include "../../mk/bsd.pkg.mk"
5472: </pre>
5473: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5474: this is a workaround to prevent CVS expanding to the filename of the
5475: guide.</p>
5476: <p>Then, I quit the editor and watched pkgsrc downloading a large
5477: source archive:</p>
5478: <pre class="programlisting">
5479: url2pkg> Running "make makesum" ...
5480: => Required installed package digest>=20010302: digest-20060826 found
5481: => Fetching nvu-1.0-sources.tar.bz2
5482: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5483: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5484: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5485: url2pkg> Running "make extract" ...
5486: => Required installed package digest>=20010302: digest-20060826 found
5487: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5488: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5489: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5490: ===> Installing dependencies for nvu-1.0
5491: ===> Overriding tools for nvu-1.0
5492: ===> Extracting for nvu-1.0
5493: url2pkg> Adjusting the Makefile.
5494:
5495: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5496:
5497: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5498: </pre>
5499: </div>
5500: <div class="sect3">
5501: <div class="titlepage"><div><div><h4 class="title">
5502: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5503: <p>Now that the package has been extracted, let's see what's inside
5504: it. The package has a <code class="filename">README.txt</code>, but that only
5505: says something about mozilla, so it's probably useless for seeing what
5506: dependencies this package has. But since there is a GNU configure script
5507: in the package, let's hope that it will complain about everything it
5508: needs.</p>
5509: <pre class="programlisting">
5510: <code class="prompt">$</code> bmake
5511: => Required installed package digest>=20010302: digest-20060826 found
5512: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5513: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5514: ===> Patching for nvu-1.0
5515: ===> Creating toolchain wrappers for nvu-1.0
5516: ===> Configuring for nvu-1.0
5517: [...]
5518: configure: error: Perl 5.004 or higher is required.
5519: [...]
5520: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5521: [...]
5522: </pre>
5523: <p>That worked quite well. So I opened the package Makefile in my
5524: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5525: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5526: package have changed now, and since a perl wrapper is automatically
5527: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5528: from scratch.</p>
5529: <pre class="programlisting">
5530: <code class="prompt">$</code> bmake clean
5531: ===> Cleaning for nvu-1.0
5532: <code class="prompt">$</code> bmake
5533: [...]
5534: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5535: GNU Make. You will not be able to build Mozilla without GNU Make.
5536: [...]
5537: </pre>
5538: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5539: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5540: <pre class="programlisting">
5541: [...]
5542: checking for GTK - version >= 1.2.0... no
5543: *** Could not run GTK test program, checking why...
5544: [...]
5545: </pre>
5546: <p>Now to the other dependencies. The first question is: Where is the
5547: GTK package hidden in pkgsrc?</p>
5548: <pre class="programlisting">
5549: <code class="prompt">$</code> echo ../../*/gtk*
5550: [many packages ...]
5551: <code class="prompt">$</code> echo ../../*/gtk
5552: ../../x11/gtk
5553: <code class="prompt">$</code> echo ../../*/gtk2
5554: ../../x11/gtk2
5555: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5556: ../../x11/gtk2/buildlink3.mk
5557: </pre>
5558: <p>The first try was definitely too broad. The second one had exactly
5559: one result, which is very good. But there is one pitfall with GNOME
5560: packages. Before GNOME 2 had been released, there were already many
5561: GNOME 1 packages in pkgsrc. To be able to continue to use these
5562: packages, the GNOME 2 packages were imported as separate packages, and
5563: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5564: whether this was the case here, and indeed it was.</p>
5565: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5566: file, adding the dependency is very easy. I just inserted an
5567: <code class="literal">.include</code> line before the last line of the package
5568: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5569: <pre class="programlisting">
5570: [...]
5571: .include "../../x11/gtk2/buildlink3.mk"
5572: .include "../../mk/bsd.pkg.mk
5573: </pre>
5574: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5575: was:</p>
1.75 rillig 5576: <pre class="programlisting">
1.299 rillig 5577: [...]
5578: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5579: checking for GTK - version >= 1.2.0... no
5580: *** Could not run GTK test program, checking why...
5581: *** The test program failed to compile or link. See the file config.log for the
5582: *** exact error that occured. This usually means GTK was incorrectly installed
5583: *** or that you have moved GTK since it was installed. In the latter case, you
5584: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5585: configure: error: Test for GTK failed.
5586: [...]
1.222 sevan 5587: </pre>
1.299 rillig 5588: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5589: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5590: told me that this package really wanted to have the GNOME 1 version of
5591: GTK. If the package had looked for GTK2, it would have looked for
5592: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5593: So I changed the <code class="literal">x11/gtk2</code> to
5594: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5595: and tried again.</p>
1.119 mishka 5596: <pre class="programlisting">
1.299 rillig 5597: [...]
5598: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5599: In file included from xpidl.c:42:
5600: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5601: In file included from xpidl.c:42:
5602: xpidl.h:132: error: parse error before "IDL_ns"
5603: [...]
1.222 sevan 5604: </pre>
1.299 rillig 5605: <p>The package still does not find all of its dependencies. Now the
5606: question is: Which package provides the
5607: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119 mishka 5608: <pre class="programlisting">
1.299 rillig 5609: <code class="prompt">$</code> echo ../../*/*idl*
5610: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5611: <code class="prompt">$</code> echo ../../*/*IDL*
5612: ../../net/libIDL
1.222 sevan 5613: </pre>
1.299 rillig 5614: <p>Let's take the one from the second try. So I included the
5615: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5616: again. But the error didn't change. After digging through some of the
5617: code, I concluded that the build process of the package was broken and
5618: couldn't have ever worked, but since the Mozilla source tree is quite
5619: large, I didn't want to fix it. So I added the following to the package
5620: <code class="filename">Makefile</code> and tried again:</p>
1.197 wiz 5621: <pre class="programlisting">
1.299 rillig 5622: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5623: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.222 sevan 5624: </pre>
1.299 rillig 5625: <p>The latter line is needed because the package expects the library
5626: <code class="filename">libIDL.so</code>, but only
5627: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5628: wrapper to rewrite that on the fly.</p>
5629: <p>The next problem was related to a recent change of the FreeType
1.322 leot 5630: 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.299 rillig 5631: which patch files were relevant for this issue and copied them to the
5632: <code class="filename">patches</code> directory. Then I retried, fixed the
5633: patches so that they applied cleanly and retried again. This time,
5634: everything worked.</p>
1.197 wiz 5635: </div>
1.299 rillig 5636: <div class="sect3">
5637: <div class="titlepage"><div><div><h4 class="title">
5638: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87 wiz 5639: <pre class="programlisting">
1.299 rillig 5640: <code class="prompt">$</code> bmake CHECK_FILES=no install
5641: [...]
5642: <code class="prompt">$</code> bmake print-PLIST >PLIST
5643: <code class="prompt">$</code> bmake deinstall
5644: <code class="prompt">$</code> bmake install
1.222 sevan 5645: </pre>
1.299 rillig 5646: </div>
5647: </div>
1.75 rillig 5648: </div>
5649: </div>
1.148 asau 5650: <div class="chapter">
1.75 rillig 5651: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 5652: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 5653: <div class="toc">
5654: <p><b>Table of Contents</b></p>
1.210 leot 5655: <dl class="toc">
1.299 rillig 5656: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5657: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5658: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5659: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5660: <dd><dl>
5661: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5662: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5663: <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>
5664: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344 gutterid 5665: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.75 rillig 5666: </dl></dd>
5667: </dl>
5668: </div>
1.299 rillig 5669: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5670: each of which forms a well-defined part of the pkgsrc system. Using
1.360 leot 5671: 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.299 rillig 5672: like pkgsrc requires some discipline to keep the code correct and
5673: understandable.</p>
5674: <p>The basic ingredients for <code class="filename">Makefile</code>
5675: programming are variables and shell
5676: commands. Among these shell commands may even be more complex ones
1.360 leot 5677: 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.299 rillig 5678: as intended it is necessary to quote all variables correctly when they
5679: are used.</p>
5680: <p>This chapter describes some patterns that appear quite often in
5681: <code class="filename">Makefile</code>s, including the pitfalls that come along
5682: with them.</p>
1.148 asau 5683: <div class="sect1">
1.75 rillig 5684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5685: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5686: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5687: <p>When you are creating a file as a
5688: target of a rule, always write the data to a temporary file first
5689: and finally rename that file. Otherwise there might occur an error
5690: in the middle of generating the file, and when the user runs
1.360 leot 5691: <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.299 rillig 5692: regenerated properly. Example:</p>
1.75 rillig 5693: <pre class="programlisting">
1.299 rillig 5694: wrong:
5695: @echo "line 1" > ${.TARGET}
5696: @echo "line 2" >> ${.TARGET}
5697: @false
5698:
5699: correct:
5700: @echo "line 1" > ${.TARGET}.tmp
5701: @echo "line 2" >> ${.TARGET}.tmp
5702: @false
5703: @mv ${.TARGET}.tmp ${.TARGET}
1.100 rillig 5704: </pre>
1.299 rillig 5705: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5706: <code class="filename">wrong</code> will exist, although there was an error
5707: message in the first run. On the other hand, running <span class="command"><strong>make
5708: correct</strong></span> gives an error message twice, as expected.</p>
1.360 leot 5709: <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.299 rillig 5710: <code class="literal">${.TARGET}</code> in case of error, but this only
5711: happens when it is interrupted, for example by pressing
5712: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.360 leot 5713: 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.299 rillig 5714: </li></ul></div>
5715: </div>
5716: <div class="sect1">
5717: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5718: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5719: <p><code class="filename">Makefile</code> variables contain strings that
5720: can be processed using the five operators <code class="code">=</code>,
5721: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.360 leot 5722: <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.299 rillig 5723: page.</p>
5724: <p>When a variable's value is parsed from a
5725: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5726: the backslash character <code class="code">\</code> are handled specially. If a
5727: backslash is the last character in a line, that backslash is removed
5728: from the line and the line continues with the next line of the file.</p>
5729: <p>The <code class="code">#</code> character starts a comment that reaches
5730: until the end of the line. To get an actual <code class="code">#</code> character,
5731: such as in a URL, write <code class="code">\#</code> instead.</p>
5732: <p>The evaluation of variables either happens immediately or lazy.
5733: It happens immediately when the variable occurs on the right-hand
5734: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5735: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5736: In the other cases, it is evaluated lazily.</p>
5737: <p>Some of the modifiers split the string into words and then
5738: operate on the words, others operate on the string as a whole. When a
5739: string is split into words, double quotes and single quotes are
1.360 leot 5740: 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.299 rillig 5741: <div class="sect2">
5742: <div class="titlepage"><div><div><h3 class="title">
5743: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5744: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5745: <li class="listitem"><p>All variable names starting with an underscore
5746: are reserved for use by the pkgsrc infrastructure. They shall
5747: not be used by packages.</p></li>
5748: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5749: lowercase variable names for the iteration
5750: variables.</p></li>
5751: <li class="listitem"><p>All list variables should have a plural name,
5752: such as <code class="varname">PKG_OPTIONS</code> or
5753: <code class="varname">DISTFILES</code>.</p></li>
5754: </ul></div>
5755: </div>
5756: </div>
5757: <div class="sect1">
5758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5759: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5760: <div class="sect2">
5761: <div class="titlepage"><div><div><h3 class="title">
5762: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5763: <p>When adding a string that possibly contains whitespace or quotes to
5764: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5765: modifier.</p>
5766: <p>When adding another list to a list (example 2), it must not be
5767: quoted, since its elements are already quoted.</p>
1.75 rillig 5768: <pre class="programlisting">
1.299 rillig 5769: STRING= foo * bar `date`
5770: LIST= # empty
5771: ANOTHER_LIST= a=b c=d
5772:
5773: LIST+= ${STRING:Q} # 1
5774: LIST+= ${ANOTHER_LIST} # 2
1.100 rillig 5775: </pre>
1.299 rillig 5776: </div>
5777: <div class="sect2">
5778: <div class="titlepage"><div><div><h3 class="title">
5779: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5780: <p>Echoing a string containing special characters needs special
5781: work.</p>
1.75 rillig 5782: <pre class="programlisting">
1.299 rillig 5783: STRING= foo bar < > * `date` $$HOME ' "
5784: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5785:
5786: all:
5787: echo ${STRING} # 1
5788: echo ${STRING:Q} # 2
5789: printf '%s\n' ${STRING:Q}'' # 3
5790: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.100 rillig 5791: </pre>
1.299 rillig 5792: <p>Example 1 leads to a syntax error in the shell, as the characters
5793: are just copied.</p>
5794: <p>Example 2 quotes the string so that the shell interprets it
5795: correctly. But the echo command may additionally interpret strings with a
5796: leading dash or those containing backslashes.</p>
1.360 leot 5797: <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.299 rillig 5798: interprets the format string, but not the next argument. The trailing
5799: single quotes handle the case when the string is empty. In that case, the
5800: :Q modifier would result in an empty string too, which would then be
1.360 leot 5801: 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.299 rillig 5802: but other programs may care.</p>
5803: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5804: need to be quoted because the quoting has already been done
5805: when adding elements to the list.</p>
1.75 rillig 5806: </div>
1.148 asau 5807: <div class="sect2">
1.75 rillig 5808: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 5809: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5810: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5811: GNU-style configure script (especially those that call other configure
5812: scripts), it must not have leading or trailing whitespace, since
5813: otherwise the configure script gets confused. To trim leading and
5814: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5815: following example:</p>
1.75 rillig 5816: <pre class="programlisting">
1.299 rillig 5817: CPPFLAGS= # empty
5818: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5819: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 grant 5820:
1.299 rillig 5821: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 grant 5822:
1.299 rillig 5823: all:
5824: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5825: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5826: </pre>
5827: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5828: trailing whitespace because the <code class="code">+=</code> operator always adds a
5829: space.</p>
5830: </div>
5831: <div class="sect2">
5832: <div class="titlepage"><div><div><h3 class="title">
5833: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5834: <p>When a possibly empty variable is used in a shell program, it may
5835: lead to a syntax error.</p>
5836: <pre class="programlisting">
5837: EGFILES= # empty
1.87 wiz 5838:
1.299 rillig 5839: install-examples: # produces a syntax error in the shell
5840: for egfile in ${EGFILES}; do \
5841: echo "Installing $$egfile"; \
5842: done
5843: </pre>
5844: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.360 leot 5845: <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.299 rillig 5846: To fix this syntax error, use one of the snippets below.</p>
5847: <pre class="programlisting">
1.344 gutterid 5848: EGFILES= # empty
1.87 wiz 5849:
1.299 rillig 5850: install-examples:
5851: for egfile in ${EGFILES} ""; do \
5852: [ -n "$$egfile" ] || continue; \
5853: echo "Installing $$egfile"; \
5854: done
5855: </pre>
5856: <p>In this case, an empty string is appended to the iteration list (to
5857: prevent the syntax error) and filtered out later.</p>
5858: <pre class="programlisting">
5859: EGFILES= # empty
1.87 wiz 5860:
1.299 rillig 5861: install-examples:
5862: .for egfile in ${EGFILES}
5863: echo "Installing ${egfile}"
5864: .endfor
1.100 rillig 5865: </pre>
1.299 rillig 5866: <p>If one of the filenames contains special characters, it should be
5867: enclosed in single or double quotes.</p>
5868: <p>To have a shell command test whether a make variable is empty, use
5869: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5870: </div>
1.344 gutterid 5871: <div class="sect2">
5872: <div class="titlepage"><div><div><h3 class="title">
5873: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
5874: <p>When a variable can have the values <code class="literal">yes</code> or
5875: <code class="literal">no</code>, use the following pattern to test the variable:</p>
5876: <pre class="programlisting">
5877: .if ${VAR:U:tl} == "yes"
5878: # do something
5879: .endif
5880: </pre>
5881: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
5882: can be undefined. If the variable is guaranteed to be defined, the
5883: <code class="literal">:U</code> can be omitted.</p>
5884: <p>The <code class="literal">:tl</code> modifier converts the variable value to
5885: lowercase, allowing for the values <code class="literal">yes</code>,
5886: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
5887: </div>
1.299 rillig 5888: </div>
5889: </div>
5890: <div class="chapter">
5891: <div class="titlepage"><div><div><h2 class="title">
5892: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5893: <div class="toc">
5894: <p><b>Table of Contents</b></p>
5895: <dl class="toc">
5896: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5897: <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>
5898: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5899: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5900: </dl>
1.75 rillig 5901: </div>
1.299 rillig 5902: <p>Many packages have the ability to be built to support different
5903: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5904: in pkgsrc that provides generic handling of those options that
5905: determine different ways in which the packages can be built. It's
5906: possible for the user to specify exactly which sets of options will be
5907: built into a package or to allow a set of global default options
5908: apply.</p>
5909: <p>There are two broad classes of behaviors that one might want to
5910: control via options. One is whether some particular feature is
5911: enabled in a program that will be built anyway, often by including or
5912: not including a dependency on some other package. The other is
5913: whether or not an additional program will be built as part of the
5914: package. Generally, it is better to make a split package for such
5915: additional programs instead of using options, because it enables
5916: binary packages to be built which can then be added separately. For
5917: example, the foo package might have minimal dependencies (those
5918: packages without which foo doesn't make sense), and then the foo-gfoo
5919: package might include the GTK frontend program gfoo. This is better
5920: than including a gtk option to foo that adds gfoo, because either that
5921: option is default, in which case binary users can't get foo without
5922: gfoo, or not default, in which case they can't get gfoo. With split
5923: packages, they can install foo without having GTK, and later decide to
5924: install gfoo (pulling in GTK at that time). This is an advantage to
5925: source users too, avoiding the need for rebuilds.</p>
5926: <p>Plugins with widely varying dependencies should usually be split
5927: instead of options.</p>
5928: <p>It is often more work to maintain split packages, especially if
5929: the upstream package does not support this. The decision of split
5930: vs. option should be made based on the likelihood that users will want
5931: or object to the various pieces, the size of the dependencies that are
5932: included, and the amount of work.</p>
5933: <p>A further consideration is licensing. Non-free parts, or parts
5934: that depend on non-free dependencies (especially plugins) should
5935: almost always be split if feasible.</p>
5936: <div class="sect1">
5937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5938: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5939: <p>Global default options are listed in
5940: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5941: that should be built into every package if that option is supported.
5942: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 5943: </div>
1.148 asau 5944: <div class="sect1">
1.75 rillig 5945: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5946: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5947: </h2></div></div></div>
5948: <p>The following example shows how
5949: <code class="filename">bsd.options.mk</code> should be used
5950: by the hypothetical ``wibble'' package, either in the package
5951: <code class="filename">Makefile</code>, or in a file,
5952: e.g. <code class="filename">options.mk</code>, that is included by the
5953: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 5954: <pre class="programlisting">
1.299 rillig 5955: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5956: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5957: PKG_OPTIONS_OPTIONAL_GROUPS= database
5958: PKG_OPTIONS_GROUP.database= mysql pgsql
5959: PKG_SUGGESTED_OPTIONS= wibble-foo
5960: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5961: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5962:
5963: .include "../../mk/bsd.prefs.mk"
5964:
5965: # this package was previously named wibble2
5966: .if defined(PKG_OPTIONS.wibble2)
5967: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5968: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5969: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5970: .endif
5971:
5972: .include "../../mk/bsd.options.mk"
5973:
5974: # Package-specific option-handling
1.100 rillig 5975:
1.299 rillig 5976: ###
5977: ### FOO support
5978: ###
5979: .if !empty(PKG_OPTIONS:Mwibble-foo)
5980: CONFIGURE_ARGS+= --enable-foo
5981: .endif
1.100 rillig 5982:
1.299 rillig 5983: ###
5984: ### LDAP support
5985: ###
5986: .if !empty(PKG_OPTIONS:Mldap)
5987: . include "../../databases/openldap-client/buildlink3.mk"
5988: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5989: .endif
1.100 rillig 5990:
1.299 rillig 5991: ###
5992: ### database support
5993: ###
5994: .if !empty(PKG_OPTIONS:Mmysql)
5995: . include "../../mk/mysql.buildlink3.mk"
5996: .endif
5997: .if !empty(PKG_OPTIONS:Mpgsql)
5998: . include "../../mk/pgsql.buildlink3.mk"
5999: .endif
6000: </pre>
6001: <p>The first section contains the information about which build
6002: options are supported by the package, and any default options settings
6003: if needed.</p>
6004: <div class="orderedlist"><ol class="orderedlist" type="1">
6005: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.360 leot 6006: <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.299 rillig 6007: options. It should be set to
6008: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6009: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6010: at the point where the options are processed.</p></li>
6011: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6012: build options supported by the package.</p></li>
6013: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6014: list of names of groups of mutually exclusive options. The options in
6015: each group are listed in
6016: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6017: The most specific setting of any option from the group takes
6018: precedence over all other options in the group. Options from the
6019: groups will be automatically added to
6020: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6021: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6022: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6023: packages will fail if no option from the group is
6024: selected.</p></li>
6025: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6026: of names of sets of options. At least one option from each set must
6027: be selected. The options in each set are listed in
6028: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6029: Options from the sets will be automatically added to
6030: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6031: fail if no option from the set is selected.</p></li>
6032: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6033: build options which are enabled by default.</p></li>
6034: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6035: of
6036: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
6037: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
6038: their option counterparts. Pairs should be added with
6039: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
6040: warning will be issued if the user uses a legacy
6041: variable.</p></li>
6042: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6043: of
6044: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
6045: pairs that map options that have been renamed to their new
6046: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
6047: the listing of global legacy options. A warning will be issued if
6048: the user uses a legacy option.</p></li>
6049: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6050: options implied by deprecated variables used. This can be used for
6051: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6052: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6053: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6054: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6055: a list of warnings about deprecated variables or options used, and
6056: what to use instead.</p></li>
6057: </ol></div>
6058: <p>A package should never modify
6059: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6060: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6061: To suggest a default set of options, use
6062: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6063: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6064: including <code class="filename">bsd.options.mk</code>. If none of
6065: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6066: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6067: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6068: happen with platform-specific options if none of them is supported on
6069: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6070: empty list and the package is otherwise treated as not using the
6071: options framework.</p>
6072: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6073: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6074: build options, properly filtered to remove unsupported and duplicate
6075: options.</p>
6076: <p>The remaining sections contain the logic that is specific to
6077: each option. The correct way to check for an option is to check
6078: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6079: <pre class="programlisting">
6080: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100 rillig 6081: </pre>
1.75 rillig 6082: </div>
1.299 rillig 6083: <div class="sect1">
6084: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6085: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
6086: <p>Options that enable similar features in different packages (like
6087: optional support for a library) should use a common name in all
6088: packages that support it (like the name of the library). If another
6089: package already has an option with the same meaning, use the same
6090: name.</p>
6091: <p>Options that enable features specific to one package, where it's
6092: unlikely that another (unrelated) package has the same (or a similar)
6093: optional feature, should use a name prefixed with
6094: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6095: <p>If a group of related packages share an optional feature
6096: specific to that group, prefix it with the name of the
6097: <span class="quote">“<span class="quote">main</span>”</span> package
6098: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6099: <p>For new options, add a line to
6100: <code class="filename">mk/defaults/options.description</code>. Lines have two
6101: fields, separated by tab. The first field is the option name, the
6102: second its description. The description should be a whole sentence
6103: (starting with an uppercase letter and ending with a period) that
6104: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6105: support.</span>”</span> The file is sorted by option names.</p>
6106: </div>
6107: <div class="sect1">
6108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6109: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
6110: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6111: different dependencies based on the options with which the package was
6112: built. For querying these options, the file
6113: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6114: typical example looks like this:</p>
1.87 wiz 6115: <pre class="programlisting">
1.299 rillig 6116: pkgbase := libpurple
6117: .include "../../mk/pkg-build-options.mk"
6118:
6119: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6120: ...
6121: .endif
1.229 sevan 6122: </pre>
1.299 rillig 6123: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6124: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6125: options of the libpurple package, which can then be queried like
6126: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6127: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6128: details.</p>
1.75 rillig 6129: </div>
6130: </div>
1.148 asau 6131: <div class="chapter">
1.75 rillig 6132: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 6133: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 6134: <div class="toc">
6135: <p><b>Table of Contents</b></p>
1.210 leot 6136: <dl class="toc">
1.299 rillig 6137: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
6138: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
6139: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75 rillig 6140: </dl>
6141: </div>
1.299 rillig 6142: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6143: by pkgsrc and also for individual packages to define what commands
6144: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6145: or for later run-time of an installed packaged (such as
6146: <code class="varname">DEPENDS</code>).
6147: If the native system provides an adequate tool, then in many cases, a pkgsrc
6148: package will not be used.</p>
6149: <p>When building a package, the replacement tools are
6150: made available in a directory (as symlinks or wrapper scripts)
6151: that is early in the executable search path. Just like the buildlink
6152: system, this helps with consistent builds.</p>
6153: <p>A tool may be needed to help build a specific package. For example,
6154: perl, GNU make (gmake) or yacc may be needed.</p>
6155: <p>Also a tool may be needed, for example, because the native system's supplied
6156: tool may be inefficient for building a package with pkgsrc.
6157: For example, a package may need GNU awk, bison (instead of
6158: yacc) or a better sed.</p>
6159: <p>The tools used by a package can be listed by running
6160: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 6161: <div class="sect1">
1.75 rillig 6162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6163: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6164: <p>The default set of tools used by pkgsrc is defined in
6165: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6166: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6167: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6168: These can be seen by running:
6169: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6170: <p>If a package needs a specific program to build
6171: then the <code class="varname">USE_TOOLS</code> variable can be used
6172: to define the tools needed.</p>
1.75 rillig 6173: </div>
1.299 rillig 6174: <div class="sect1">
6175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6176: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6177: <p>In the following examples, the :run means that it is needed at
6178: run-time (and becomes a DEPENDS).
6179: The default is a build dependency which can be set with
6180: :build. (So in this example, it is the same as gmake:build
6181: and pkg-config:build.)</p>
1.75 rillig 6182: <pre class="programlisting">
1.299 rillig 6183: USE_TOOLS+= gmake perl:run pkg-config
1.1 grant 6184: </pre>
1.299 rillig 6185: <p>When using the tools framework, a
6186: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6187: which contains the full path to the appropriate tool. For example,
6188: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6189: on Linux systems.</p>
6190: <p>If you always need a pkgsrc version of the
6191: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6192: </p>
1.75 rillig 6193: </div>
1.299 rillig 6194: <div class="sect1">
6195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6196: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6197: <p>When improving or porting pkgsrc to a new platform, have a look
6198: at (or create) the corresponding platform specific make file fragment under
6199: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6200: the name of the common tools. For example:</p>
1.75 rillig 6201: <pre class="programlisting">
1.299 rillig 6202: .if exists(/usr/bin/bzcat)
6203: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6204: .elif exists(/usr/bin/bzip2)
6205: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6206: .endif
6207:
6208: TOOLS_PLATFORM.true?= true # shell builtin
1.1 grant 6209: </pre>
1.75 rillig 6210: </div>
6211: </div>
1.299 rillig 6212: <div class="chapter">
6213: <div class="titlepage"><div><div><h2 class="title">
6214: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6215: <div class="toc">
6216: <p><b>Table of Contents</b></p>
6217: <dl class="toc">
6218: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6219: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6220: <dd><dl>
6221: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6222: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6223: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6224: and
6225: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6226: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6227: </dl></dd>
6228: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.355 rillig 6229: <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.299 rillig 6230: </dl>
1.75 rillig 6231: </div>
1.299 rillig 6232: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6233: are seen by a package's configure and build processes. This is implemented
6234: in a two step process:</p>
6235: <div class="orderedlist"><ol class="orderedlist" type="1">
6236: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6237: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6238: of <code class="varname">WRKDIR</code>.</p></li>
6239: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6240: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6241: <code class="option">-L${LOCALBASE}/lib</code> into references to
6242: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6243: native compiler on some operating systems look like GCC, so that
6244: packages that expect GCC won't require modifications to build with
6245: those native compilers.</p></li>
6246: </ol></div>
6247: <p>This normalizes the environment in which a package is built so that the
6248: package may be built consistently despite what other software may be
6249: installed. Please note that the normal system header and library paths,
6250: e.g. <code class="filename">/usr/include</code>,
6251: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6252: designed to insulate the package build from non-system-supplied
6253: software.</p>
1.148 asau 6254: <div class="sect1">
1.75 rillig 6255: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6256: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6257: <p>The process of converting packages to use the buildlink3
6258: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6259: The things to keep in mind are:</p>
1.128 wiz 6260: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299 rillig 6261: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6262: instead of the actual toolchain. Some packages are tricky,
6263: and the only way to know for sure is the check
6264: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6265: wrappers are being invoked.</p></li>
6266: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6267: the package Makefile, e.g. Java VMs, standalone shells,
6268: etc., because the code to symlink files into
6269: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6270: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6271: </p></li>
6272: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6273: <code class="filename">buildlink3.mk</code> files that you list in a
6274: package's Makefile are added as dependencies for that package.
6275: </p></li>
6276: </ol></div>
6277: <p>If a dependency on a particular package is required for its libraries and
6278: headers, then we replace:</p>
6279: <pre class="programlisting">
6280: DEPENDS+= foo>=1.1.0:../../category/foo
6281: </pre>
6282: <p>with</p>
6283: <pre class="programlisting">
6284: .include "../../category/foo/buildlink3.mk"
6285: </pre>
6286: <p>The buildlink3.mk files usually define the required dependencies.
6287: If you need a newer version of the dependency when using buildlink3.mk
6288: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 6289: <pre class="programlisting">
1.299 rillig 6290: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6291: .include "../../category/foo/buildlink3.mk"
1.1 grant 6292: </pre>
1.299 rillig 6293: <p>There are several <code class="filename">buildlink3.mk</code>
6294: files in <code class="filename">pkgsrc/mk</code>
6295: that handle special package issues:</p>
6296: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6297: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6298: the native or a pkgsrc Berkeley DB implementation based on
6299: the values of <code class="varname">BDB_ACCEPTED</code> and
6300: <code class="varname">BDB_DEFAULT</code>.</p></li>
6301: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6302: comes with neither Curses nor NCurses, this will take care
1.322 leot 6303: 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.299 rillig 6304: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6305: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6306: adding a dependency on Heimdal or MIT-krb5 for packages that
6307: require a Kerberos 5 implementation.</p></li>
6308: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6309: system-provided Motif installation or adds a dependency on
1.322 leot 6310: <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.299 rillig 6311: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6312: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6313: to choose which Motif version will be used.</p></li>
6314: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6315: system-provided GNU readline or editline (libedit) installation,
1.322 leot 6316: 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>,
6317: <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.299 rillig 6318: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6319: If your package really needs GNU readline library, its Makefile
6320: should include <code class="filename">devel/readline/buildlink3.mk</code>
6321: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6322: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6323: variables that may be used by packages that use the
6324: Open Sound System (OSS) API.</p></li>
6325: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6326: any of the Postgres versions in the variable
6327: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6328: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6329: the file for more information.</p></li>
6330: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6331: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.322 leot 6332: 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.299 rillig 6333: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6334: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6335: library.</p></li>
6336: </ul></div>
6337: <p>The comments in those <code class="filename">buildlink3.mk</code>
6338: files provide a more complete
6339: description of how to use them properly.</p>
1.75 rillig 6340: </div>
1.148 asau 6341: <div class="sect1">
1.75 rillig 6342: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6343: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6344: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6345: included by Makefiles to indicate the need to compile and link
6346: against header files and libraries provided by the package. A
6347: <code class="filename">buildlink3.mk</code> file should always provide
6348: enough information to add the correct type of dependency
6349: relationship and include any other
6350: <code class="filename">buildlink3.mk</code> files that it needs to find
6351: headers and libraries that it needs in turn.</p>
6352: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.322 leot 6353: 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.299 rillig 6354: package is highly recommended. For most packages, the following
6355: command will generate a good starting point for
6356: <code class="filename">buildlink3.mk</code> files:</p>
6357: <pre class="screen">
6358: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6359: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6360: </pre>
1.148 asau 6361: <div class="sect2">
1.75 rillig 6362: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6363: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6364: <p>The following real-life example
6365: <code class="filename">buildlink3.mk</code> is taken
6366: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 6367: <pre class="programlisting">
1.299 rillig 6368: BUILDLINK_TREE+= tiff
6369:
6370: .if !defined(TIFF_BUILDLINK3_MK)
6371: TIFF_BUILDLINK3_MK:=
6372:
6373: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6374: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6375: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6376:
6377: .include "../../devel/zlib/buildlink3.mk"
6378: .include "../../graphics/jpeg/buildlink3.mk"
6379: .endif # TIFF_BUILDLINK3_MK
6380:
6381: BUILDLINK_TREE+= -tiff
1.1 grant 6382: </pre>
1.299 rillig 6383: <p>The header and footer manipulate
6384: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6385: <code class="filename">buildlink3.mk</code> files and is used to track
6386: the dependency tree.</p>
6387: <p>The main section is protected from multiple inclusion
6388: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6389: added. Several important variables are set in the section:</p>
6390: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6391: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6392: is the dependency version recorded in the installed
1.299 rillig 6393: package; this should always be set using
6394: <span class="command"><strong>+=</strong></span> to ensure that
6395: we're appending to any pre-existing list of values. This
1.300 wiz 6396: variable should be set to the last version of the
1.299 rillig 6397: package that had an backwards-incompatible API change.
6398: </p></li>
6399: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6400: is the location of the <em class="replaceable"><code>pkg</code></em>
6401: pkgsrc directory.</p></li>
6402: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6403: (not shown above) controls whether we use
1.350 gutterid 6404: <code class="varname">BUILD_DEPENDS</code> or
1.299 rillig 6405: <code class="varname">DEPENDS</code> to add the dependency on
6406: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6407: selected by setting
6408: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.350 gutterid 6409: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.299 rillig 6410: used.</p></li>
6411: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6412: and
6413: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6414: (not shown above) are lists of subdirectories of
6415: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6416: to add to the header and library search paths. These
6417: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6418: respectively.</p></li>
6419: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6420: (not shown above) is the list of preprocessor flags to add
6421: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6422: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6423: should be avoided and instead be handled using
6424: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6425: above.</p></li>
6426: </ul></div>
6427: <p>The following variables are all optionally defined within
6428: this second section (protected against multiple inclusion) and
6429: control which package files are symlinked into
6430: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6431: transformed during the symlinking:</p>
6432: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6433: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6434: (not shown above) is a shell glob pattern relative to
6435: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6436: to be symlinked into
6437: <code class="filename">${BUILDLINK_DIR}</code>,
6438: e.g. <code class="filename">include/*.h</code>.</p></li>
6439: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6440: (not shown above) is a shell pipeline that
6441: outputs to stdout a list of files relative to
6442: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6443: The resulting files are to be symlinked
6444: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6445: this takes the <code class="filename">+CONTENTS</code> of a
6446: <em class="replaceable"><code>pkg</code></em> and filters it through
6447: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6448: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6449: (not shown above) is a filter command that filters
6450: <code class="filename">+CONTENTS</code> input into a list of files
6451: relative to
6452: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6453: on stdout. By default,
6454: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6455: outputs the contents of the <code class="filename">include</code>
6456: and <code class="filename">lib</code> directories in the package
6457: <code class="filename">+CONTENTS</code>.</p></li>
6458: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6459: (not shown above) is a list of sed arguments used to
6460: transform the name of the source filename into a
6461: destination filename, e.g. <span class="command"><strong>-e
6462: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6463: </ul></div>
6464: <p>This section can additionally include any
6465: <code class="filename">buildlink3.mk</code> needed for
6466: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6467: Including these <code class="filename">buildlink3.mk</code> files
6468: means that the headers and libraries for these
6469: dependencies are also symlinked into
6470: <code class="filename">${BUILDLINK_DIR}</code>
6471: whenever the <em class="replaceable"><code>pkg</code></em>
6472: <code class="filename">buildlink3.mk</code>
6473: file is included. Dependencies are only added for directly
6474: include <code class="filename">buildlink3.mk</code> files.</p>
6475: <p>When providing a <code class="filename">buildlink3.mk</code> and
6476: including other <code class="filename">buildlink3.mk</code> files in it,
6477: please only add necessary ones, i.e., those whose libraries or
6478: header files are automatically exposed when the package is
6479: use.</p>
6480: <p>In particular, if only an executable
6481: (<code class="filename">bin/foo</code>) is linked against a library, that
6482: library does not need to be propagated in the
6483: <code class="filename">buildlink3.mk</code> file.</p>
6484: <p>The following steps should help you decide if a
6485: <code class="filename">buildlink3.mk</code> file needs to be included:
6486: </p>
6487: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6488: <li class="listitem"><p>Look at the installed header files: What
6489: headers do they include? The packages providing these files
6490: must be buildlinked.</p></li>
6491: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6492: libraries and look against what other libraries they link.
6493: Some of the packages providing these probably need to be
6494: buildlinked; however, it's not automatic, since e.g. GTK on
6495: some systems pulls in the X libraries, so they will show up in
6496: the <code class="filename">ldd</code> output, while on others (like OS
6497: X) it won't. <code class="filename">ldd</code> output can thus only be
6498: used as a hint.</p></li>
6499: </ul></div>
6500: <p>
6501: </p>
6502: </div>
1.148 asau 6503: <div class="sect2">
1.75 rillig 6504: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6505: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6506: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6507: and
6508: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6509: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300 wiz 6510: <p>Both variables set lower bounds for a version of this package.
6511: The two variables differ in that one describes source
1.299 rillig 6512: compatibility (API) and the other binary compatibility (ABI).
6513: The difference is that a change in the API breaks compilation of
6514: programs while changes in the ABI stop compiled programs from
6515: running.</p>
1.300 wiz 6516: <p>The
6517: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6518: variable in a <code class="filename">buildlink3.mk</code> should be
6519: changed very rarely. (One possible scenario: If all packages
6520: using this package need a higher version than defined in the
6521: <code class="filename">buildlink3.mk</code>,
1.299 rillig 6522: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6523: could be updated to that higher version.)</p>
6524: <p>On the other hand, changes to
1.299 rillig 6525: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6526: are more common. The variable will need to be updated every
6527: time the major version of one of its shared libraries is changed,
6528: or any other change where a binary built against the previous
6529: version of the package will not run against the new version any
6530: longer.</p>
6531: <p>In such a case, the package's
1.299 rillig 6532: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6533: must be increased to require the new package version. Then the
6534: <code class="varname">PKGREVISION</code> of all packages
6535: <em class="replaceable"><code>foo</code></em> that depend on this package need
6536: to be increased, and if they have
6537: <code class="filename">buildlink3.mk</code> files,
6538: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6539: in their <code class="filename">buildlink3.mk</code> files must be
6540: increased to the new version as well. This is required so that a
6541: package will pull in the versions of the packages that use the
6542: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6543: uniquely identify the packages built against the new ABI. The
1.322 leot 6544: <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.300 wiz 6545: help with these updates.</p>
6546: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6547: about dependencies on other packages, including the
6548: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299 rillig 6549: <p>Please take careful consideration before adjusting
6550: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6551: or
6552: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6553: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6554: cause unneeded package deletions and rebuilds. In many cases,
6555: new versions of packages work just fine with older
6556: dependencies.</p>
1.326 gutterid 6557: <p>Also, it is not needed to set
1.299 rillig 6558: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6559: when it is identical to
1.326 gutterid 6560: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
6561: <p>Note there is also the distinction that users are able to disable
6562: enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
6563: variable, but there is no equivalent option for API dependencies.</p>
1.75 rillig 6564: </div>
6565: </div>
1.148 asau 6566: <div class="sect1">
1.75 rillig 6567: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6568: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6569: <p>Some packages in pkgsrc install headers and libraries that
6570: coincide with headers and libraries present in the base system.
6571: Aside from a <code class="filename">buildlink3.mk</code> file, these
6572: packages should also include a <code class="filename">builtin.mk</code>
6573: file that includes the necessary checks to decide whether using
6574: the built-in software or the pkgsrc software is
6575: appropriate.</p>
6576: <p>The only requirements of a builtin.mk file for
6577: <em class="replaceable"><code>pkg</code></em> are:</p>
6578: <div class="orderedlist"><ol class="orderedlist" type="1">
6579: <li class="listitem"><p>It should set
6580: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6581: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6582: after it is included.</p></li>
6583: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6584: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6585: which is already set before the
6586: <code class="filename">builtin.mk</code> file is included.</p></li>
6587: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6588: is <span class="emphasis"><em>very</em></span> important and takes careful
6589: attention to <code class="filename">Makefile</code> coding.</p></li>
6590: </ol></div>
6591: <div class="sect2">
6592: <div class="titlepage"><div><div><h3 class="title">
6593: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6594: <p>The following is the recommended template for builtin.mk
6595: files:</p>
1.75 rillig 6596: <pre class="programlisting">
1.299 rillig 6597: .if !defined(IS_BUILTIN.foo)
6598: #
6599: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6600: # genuinely exists in the system or not.
6601: #
6602: IS_BUILTIN.foo?= no
1.100 rillig 6603:
1.299 rillig 6604: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6605: # version can be determined.
6606: #
6607: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6608: BUILTIN_PKG.foo?= foo-1.0
6609: . endif
6610: .endif # IS_BUILTIN.foo
1.100 rillig 6611:
1.299 rillig 6612: .if !defined(USE_BUILTIN.foo)
6613: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6614: . if defined(BUILTIN_PKG.foo)
6615: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6616: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6617: USE_BUILTIN.foo!= \
6618: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6619: && ${ECHO} "yes" || ${ECHO} "no"
6620: . endif
6621: . endfor
6622: . endif
6623: .endif # USE_BUILTIN.foo
1.100 rillig 6624:
1.299 rillig 6625: CHECK_BUILTIN.foo?= no
6626: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6627: #
6628: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6629: # "yes" or "no".
6630: #
6631: .endif # CHECK_BUILTIN.foo
1.75 rillig 6632: </pre>
1.299 rillig 6633: <p>The first section sets
6634: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6635: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6636: in the base system. This should not be a base system software
6637: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6638: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6639: included as part of the base system. This variable is only
6640: used internally within the <code class="filename">builtin.mk</code>
6641: file.</p>
6642: <p>The second section sets
6643: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6644: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6645: system if it exists (if
6646: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6647: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6648: within the <code class="filename">builtin.mk</code> file.</p>
6649: <p>The third section sets
6650: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6651: and is <span class="emphasis"><em>required</em></span> in all
6652: <code class="filename">builtin.mk</code> files. The code in this
6653: section must make the determination whether the built-in
6654: software is adequate to satisfy the dependencies listed in
6655: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6656: This is typically done by comparing
6657: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6658: against each of the dependencies in
6659: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6660: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6661: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6662: end of the <code class="filename">builtin.mk</code> file. Note that
6663: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6664: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6665: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6666: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6667: that the built-in version of the software is similar enough to
6668: be used as a replacement.</p>
6669: <p>The last section is guarded by
6670: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6671: and includes code that uses the value of
6672: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6673: set in the previous section. This typically includes, e.g.,
6674: adding additional dependency restrictions and listing additional
6675: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6676: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6677: </div>
1.107 rillig 6678: </div>
1.75 rillig 6679: </div>
1.148 asau 6680: <div class="chapter">
1.75 rillig 6681: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 6682: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75 rillig 6683: <div class="toc">
6684: <p><b>Table of Contents</b></p>
1.210 leot 6685: <dl class="toc">
1.299 rillig 6686: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6687: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6688: <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>
6689: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6690: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6691: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6692: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6693: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6694: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75 rillig 6695: </dl>
6696: </div>
1.299 rillig 6697: <p>The <code class="filename">PLIST</code> file contains a package's
6698: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6699: the package (relative to the <code class="filename">${PREFIX}</code>
6700: directory it's been installed in) plus some additional statements
1.360 leot 6701: - 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.299 rillig 6702: This chapter addresses some issues that need attention when
6703: dealing with the <code class="filename">PLIST</code> file (or files, see
6704: below!).</p>
1.148 asau 6705: <div class="sect1">
1.75 rillig 6706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6707: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6708: <p>Be sure to add a RCS ID line as the first thing in any
6709: <code class="filename">PLIST</code> file you write:</p>
6710: <pre class="programlisting">
6711: @comment $NetBSD $
6712: </pre>
6713: <p>An artificial space has been added between NetBSD and $, this is a
6714: workaround here to prevent CVS expanding to the filename of the guide. When
6715: adding the RCS ID the space should be omitted.</p>
1.75 rillig 6716: </div>
1.148 asau 6717: <div class="sect1">
1.75 rillig 6718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6719: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6720: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6721: to output a PLIST that matches any new files since the package
6722: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6723: more information on this target.</p>
1.75 rillig 6724: </div>
1.148 asau 6725: <div class="sect1">
1.75 rillig 6726: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6727: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6728: </h2></div></div></div>
6729: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6730: of AWK patterns and actions that are used to filter the output of
6731: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6732: scripting you like to it, but be careful with quoting.</p>
6733: <p>For example, to get all files inside the
6734: <code class="filename">libdata/foo</code> directory removed from the
6735: resulting PLIST:</p>
1.88 wiz 6736: <pre class="programlisting">
1.299 rillig 6737: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.100 rillig 6738: </pre>
1.300 wiz 6739: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6740: evaluated after the file list and directory list are sorted.
6741: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6742: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6743: list and directory list are sorted.</p>
1.299 rillig 6744: </div>
6745: <div class="sect1">
6746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6747: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6748: <p>A number of variables are substituted automatically in
6749: PLISTs when a package is installed on a system. This includes the
6750: following variables:</p>
6751: <div class="variablelist"><dl class="variablelist">
6752: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6753: <dd>
6754: <p>Some packages like emacs and perl embed information
6755: about which architecture they were built on into the
6756: pathnames where they install their files. To handle this
6757: case, PLIST will be preprocessed before actually used, and
6758: the symbol
6759: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6760: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6761: same is done if the string
6762: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6763: PLIST somewhere - use this on packages that have GNU
6764: autoconf-created configure scripts.</p>
6765: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6766: <h3 class="title">Legacy note</h3>
6767: <p>There used to be a symbol
6768: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6769: was replaced by the output of <span class="command"><strong>uname
6770: -m</strong></span>, but that's no longer supported and has
6771: been removed.</p>
6772: </div>
6773: </dd>
6774: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6775: <dd>
6776: <p>Some packages want to embed the OS name and version
6777: into some paths. To do this, use these variables in the
6778: <code class="filename">PLIST</code>:
6779: </p>
6780: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6781: <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>
6782: <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>
6783: <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>
6784: </ul></div>
6785: </dd>
6786: </dl></div>
6787: <p>For a list of values which are replaced by
6788: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6789: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6790: <code class="varname">PLIST_SUBST</code> should help.</p>
6791: <p>If you want to change other variables not listed above, you
6792: can add variables and their expansions to this variable in the
6793: 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.81 rillig 6794: <pre class="programlisting">
1.299 rillig 6795: PLIST_SUBST+= SOMEVAR="somevalue"
1.100 rillig 6796: </pre>
1.299 rillig 6797: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6798: in the <code class="filename">PLIST</code> with
6799: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6800: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6801: the common case of conditionally including some
6802: <code class="filename">PLIST</code> entries. It can be done by adding
6803: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6804: setting the corresponding <code class="varname">PLIST.foo</code> variable
6805: to <code class="literal">yes</code> if the entry should be included.
6806: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6807: in the <code class="filename">PLIST</code> with either
6808: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6809: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6810: For example, in <code class="filename">Makefile</code>:</p>
1.174 asau 6811: <pre class="programlisting">
1.299 rillig 6812: PLIST_VARS+= foo
6813: .if <em class="replaceable"><code>condition</code></em>
6814: PLIST.foo= yes
6815: .else
1.174 asau 6816: </pre>
1.299 rillig 6817: <p>And then in <code class="filename">PLIST</code>:</p>
1.81 rillig 6818: <pre class="programlisting">
1.299 rillig 6819: @comment $NetBSD $
6820: bin/bar
6821: man/man1/bar.1
6822: ${PLIST.foo}bin/foo
6823: ${PLIST.foo}man/man1/foo.1
6824: ${PLIST.foo}share/bar/foo.data
1.100 rillig 6825: </pre>
1.299 rillig 6826: <p>An artificial space has been added between NetBSD and $, this is a
6827: workaround here to prevent CVS expanding to the filename of the guide. When
1.309 gutterid 6828: adding the RCS ID the space should be omitted.</p>
1.81 rillig 6829: </div>
1.299 rillig 6830: <div class="sect1">
6831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6832: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6833: <p>Man pages should be installed in compressed form if
6834: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6835: and uncompressed otherwise. To handle this in the
6836: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6837: appended/removed automatically for man pages according to
6838: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6839: or not, see above for details. This modification of the
6840: <code class="filename">PLIST</code> file is done on a copy of it, not
6841: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 6842: </div>
1.148 asau 6843: <div class="sect1">
1.75 rillig 6844: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6845: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6846: </h2></div></div></div>
6847: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6848: in generating the binary package, set the variable
6849: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.360 leot 6850: 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.299 rillig 6851: important. The default for <code class="varname">PLIST_SRC</code> is
6852: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 6853: </div>
1.148 asau 6854: <div class="sect1">
1.75 rillig 6855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6856: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6857: <p>Some packages decide to install a different set of files based on
6858: the operating system being used. These differences can be
6859: automatically handled by using the following files:</p>
6860: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6861: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6862: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6863: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6864: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6865: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6866: </ul></div>
1.75 rillig 6867: </div>
1.148 asau 6868: <div class="sect1">
1.75 rillig 6869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6870: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6871: <p>Some packages decide to generate hard-to-guess file names
6872: during installation that are hard to wire down.</p>
6873: <p>In such cases, you can set the
6874: <code class="varname">GENERATE_PLIST</code> variable to shell code
6875: terminated (with a semicolon) that will output PLIST entries which
6876: will be appended to the PLIST</p>
6877: <p>You can find one example in editors/xemacs:</p>
6878: <pre class="programlisting">
6879: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6880: </pre>
6881: <p>which will append something like
6882: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6883: <code class="filename">PLIST</code>.
6884: </p>
1.75 rillig 6885: </div>
1.148 asau 6886: <div class="sect1">
1.75 rillig 6887: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6888: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6889: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6890: multiple (and unrelated) packages install files. These
6891: directories were problematic because you had to add special
6892: tricks in the PLIST to conditionally remove them, or have some
6893: centralized package handle them.</p>
6894: <p>In pkgsrc, it is now easy: Each package should create
6895: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6896: will remove any directories left empty after uninstalling a
6897: package.</p>
6898: <p>If a package needs an empty directory to work, create
6899: the directory during installation as usual, and also add an
6900: entry to the PLIST:
6901:
6902: </p>
6903: <pre class="programlisting">
6904: @pkgdir path/to/empty/directory
6905: </pre>
6906: <p>
6907:
6908: or take a look at <code class="varname">MAKE_DIRS</code> and
6909: <code class="varname">OWN_DIRS</code>.
1.88 wiz 6910: </p>
1.75 rillig 6911: </div>
1.299 rillig 6912: </div>
6913: <div class="chapter">
6914: <div class="titlepage"><div><div><h2 class="title">
6915: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6916: <div class="toc">
6917: <p><b>Table of Contents</b></p>
6918: <dl class="toc">
6919: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6920: <dd><dl>
6921: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6922: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6923: </dl></dd>
6924: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6925: <dd><dl>
6926: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6927: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.353 dholland 6928: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
6929: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
6930: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299 rillig 6931: </dl></dd>
6932: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6933: <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>
6934: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6935: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6936: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6937: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6938: <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>
6939: </dl>
6940: </div>
6941: <p>This chapter describes the framework known as
6942: <code class="literal">pkginstall</code>, whose key features are:</p>
6943: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6944: <li class="listitem"><p>Generic installation and manipulation of directories and files
6945: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6946: <li class="listitem"><p>Automatic handling of configuration files during installation,
6947: provided that packages are correctly designed.</p></li>
6948: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6949: <li class="listitem"><p>Registration of system users and groups.</p></li>
6950: <li class="listitem"><p>Registration of system shells.</p></li>
6951: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6952: </ul></div>
6953: <p>The following sections inspect each of the above points in detail.</p>
6954: <p>You may be thinking that many of the things described here could be
6955: easily done with simple code in the package's post-installation target
6956: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6957: as the code in them is only executed when building from source. Machines
6958: using binary packages could not benefit from it at all (as the code itself
6959: could be unavailable). Therefore, the only way to achieve any of the items
6960: described above is by means of the installation scripts, which are
6961: automatically generated by pkginstall.</p>
1.148 asau 6962: <div class="sect1">
1.75 rillig 6963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6964: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6965: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6966: of files and directories that belong to a package. The names used in it
6967: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6968: which means that it cannot register files outside this directory (absolute
6969: path names are not allowed). Despite this restriction, some packages need
6970: to install files outside this location; e.g., under
6971: <code class="filename">${VARBASE}</code> or
6972: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6973: is to create such files during installation time by using
6974: installation scripts.</p>
6975: <p>The generic installation scripts are shell scripts that can
6976: contain arbitrary code. The list of scripts to execute is taken from
6977: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6978: <code class="filename">INSTALL</code>. A similar variable exists for package
6979: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6980: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6981: commands, so they have the potential to create and manage files
6982: anywhere in the file system.</p>
6983: <p>Using these general installation files is not recommended, but
6984: may be needed in some special cases. One reason for avoiding them is
6985: that the user has to trust the packager that there is no unwanted or
6986: simply erroneous code included in the installation script. Also,
6987: previously there were many similar scripts for the same functionality,
6988: and fixing a common error involved finding and changing all of
6989: them.</p>
6990: <p>The pkginstall framework offers another, standardized way. It
6991: provides generic scripts to abstract the manipulation of such files
6992: and directories based on variables set in the package's
6993: <code class="filename">Makefile</code>. The rest of this section describes
6994: these variables.</p>
6995: <div class="sect2">
6996: <div class="titlepage"><div><div><h3 class="title">
6997: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
6998: <p>The following variables can be set to request the creation of
6999: directories anywhere in the file system:</p>
7000: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7001: <li class="listitem">
7002: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
7003: contain a list of directories that should be created and should attempt
7004: to be destroyed by the installation scripts. The difference between
7005: the two is that the latter prompts the administrator to remove any
7006: directories that may be left after deinstallation (because they were
7007: not empty), while the former does not. Example:</p>
7008: <pre class="programlisting">
7009: MAKE_DIRS+= ${VARBASE}/foo/private
7010: </pre>
7011: </li>
7012: <li class="listitem">
7013: <p><code class="varname">MAKE_DIRS_PERMS</code> and
7014: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
7015: which directories should be created and should attempt to be destroyed
7016: by the installation scripts. Each tuple holds the following values,
7017: separated by spaces: the directory name, its owner, its group and its
7018: numerical mode. For example:</p>
7019: <pre class="programlisting">
7020: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
7021: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
7022: </pre>
7023: <p>The difference between the two is exactly the same as their
7024: non-<code class="varname">PERMS</code> counterparts.</p>
7025: </li>
7026: </ul></div>
1.75 rillig 7027: </div>
1.299 rillig 7028: <div class="sect2">
7029: <div class="titlepage"><div><div><h3 class="title">
7030: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
7031: <p>Creating non-empty files outside the installation prefix is tricky
7032: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.353 dholland 7033: To overcome this problem, the only solution is to extract the file in a
1.299 rillig 7034: known place (i.e., inside the installation prefix) and copy it to the
7035: appropriate location during installation (done by the installation scripts
1.353 dholland 7036: generated by pkginstall). We will call the former the <span class="emphasis"><em>reference
1.299 rillig 7037: file</em></span> in the following paragraphs, which describe the variables
7038: that can be used to automatically and consistently handle files outside the
7039: installation prefix:</p>
7040: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.353 dholland 7041: <li class="listitem"><p><code class="varname">REQD_FILES</code> is a list of pairs of reference
7042: and target files. At installation time, the reference file is copied
7043: to the target if and only if the latter does not exist. Upon
7044: deinstallation, the reference file is removed provided that it was
7045: not modified by the installation.</p></li>
1.299 rillig 7046: <li class="listitem">
1.353 dholland 7047: <p><code class="varname">REQD_FILES_PERMS</code> contains tuples describing
7048: reference files and targets, including owner, group, and numeric
7049: permissions that should be set. For example:</p>
1.88 wiz 7050: <pre class="programlisting">
1.299 rillig 7051: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
7052: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100 rillig 7053: </pre>
1.299 rillig 7054: </li>
1.353 dholland 7055: <li class="listitem"><p><code class="varname">CONF_FILES</code> and
7056: <code class="varname">CONF_FILES_PERMS</code> have the same syntax as
7057: <code class="varname">REQD_FILES</code> and
7058: <code class="varname">REQD_FILES_PERMS</code> respectively. The difference
7059: is that these variables are specifically intended for handling
7060: configuration files, for which additional conventions and
7061: constraints apply. See <a class="xref" href="#conf-files" title="20.2. Configuration files">Section 20.2, “Configuration files”</a> for further
7062: discussion. Note in particular that while handling of
7063: 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
7064: <code class="varname">REQD_FILES</code> and
7065: <code class="varname">REQD_FILES_PERMS</code>.</p></li>
1.299 rillig 7066: </ul></div>
1.353 dholland 7067: <p>To install an empty file, one can use these macros and
7068: <code class="filename">/dev/null</code> as the reference file.</p>
1.299 rillig 7069: </div>
1.75 rillig 7070: </div>
1.148 asau 7071: <div class="sect1">
1.75 rillig 7072: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7073: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
1.353 dholland 7074: <p>There are two principles that govern the handling of
7075: configuration files in pkgsrc: first, the user's configuration must
7076: not be lost or overwritten by upgrades or reinstallations; and second,
7077: the default configuration should always be available for reference.
7078: To that end, pkgsrc has a framework specifically for handling
7079: configuration files. In general, configuration files are installed
7080: into <code class="filename">${PREFIX}/share/examples</code>, and copied from
7081: there to the pertinent <code class="filename">etc</code> directory as a
7082: separate step and only as needed.</p>
7083: <p>To make this work, there are three things that need to happen,
7084: any of which may require patching. First, the package must be told to
7085: read its configuration from the correct place at runtime; this place
7086: is <code class="filename">${PKG_SYSCONFDIR}</code> (or possibly a subdirectory
7087: of it) which is often but not always
7088: <code class="filename">${PREFIX}/etc</code>. Second, the package must be
7089: taught to install its default configuration files in
7090: <code class="filename">${PREFIX}/share/examples/${PKGBASE}</code>; this is the
7091: point at which patching often becomes required because it is not the
7092: same place as the runtime location. Third, the configuration files
7093: need to be declared in the package makefile; this is the easy part.
7094: </p>
7095: <p>With those elements in place, the right things will happen: the
7096: package install phase and resulting binary package will not touch
7097: <code class="filename">${PKG_SYSCONFDIR}</code>, and the default configuration
7098: will be copied into place by the pkgsrc framework only if not already
7099: present. Similarly, upon deinstall the configuration will not be
7100: removed if it has been modified. (This means that in the case of
7101: reinstallation and upgrades, unmodified configuration files are
7102: updated but modifications are never discarded.)</p>
7103: <p>The following sections describe how to make these things happen
7104: and document other relevant knobs available in the pkgsrc
7105: infrastructure.</p>
1.299 rillig 7106: <div class="sect2">
7107: <div class="titlepage"><div><div><h3 class="title">
7108: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7109: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7110: specifies where configuration files shall be installed. Its contents are
7111: set based upon the following variables:</p>
7112: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7113: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7114: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.353 dholland 7115: be overridden by the user to point to their preferred location (e.g.,
1.299 rillig 7116: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7117: Packages must not use it directly.</p></li>
7118: <li class="listitem">
7119: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7120: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7121: for the package being built shall be installed. The definition of this
7122: variable only makes sense in the package's
7123: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7124: <p>As an example, consider the Apache package,
1.322 leot 7125: <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.299 rillig 7126: configuration files under the
7127: <code class="filename">httpd/</code> subdirectory of
7128: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7129: Makefile.</p>
7130: </li>
7131: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7132: variable that holds this package's configuration directory (if
7133: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7134: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7135: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7136: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7137: directory where the configuration files for the package identified by
7138: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7139: </ul></div>
7140: <p>Based on the above variables, pkginstall determines the value of
7141: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
1.353 dholland 7142: variable that may be used within a package to refer to its configuration
1.299 rillig 7143: directory. The algorithm used to set its value is basically the
7144: following:</p>
7145: <div class="orderedlist"><ol class="orderedlist" type="1">
7146: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7147: its value is used.</p></li>
7148: <li class="listitem"><p>If the previous variable is not defined but
7149: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7150: <code class="filename">Makefile</code>, the resulting value is
7151: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7152: <li class="listitem"><p>Otherwise, it is set to
7153: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7154: </ol></div>
7155: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.353 dholland 7156: automatically added to <code class="filename">OWN_DIRS</code>. This causes it
7157: 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
7158: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>; they must be manually
7159: created with <code class="varname">OWN_DIRS</code> or
7160: <code class="varname">MAKE_DIRS</code>.</p>
1.299 rillig 7161: </div>
7162: <div class="sect2">
7163: <div class="titlepage"><div><div><h3 class="title">
7164: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7165: <p>Given that pkgsrc (and users!) expect configuration files to be in a
1.353 dholland 7166: known place, you need to teach each package where to install its files. In
7167: some cases you will have to patch the package Makefiles to achieve it. If
7168: you are lucky, though, it may be as easy as passing an extra flag to the
7169: configuration script. This is the case for packages using GNU
7170: autoconf:</p>
1.75 rillig 7171: <pre class="programlisting">
1.299 rillig 7172: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100 rillig 7173: </pre>
1.299 rillig 7174: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
1.353 dholland 7175: for</em></span> its configuration files, not where they will be installed.
7176: Fortunately, there is a different way to specify the latter, as seen
1.354 gutterid 7177: in the next section, although the combination is rather confusing at
1.353 dholland 7178: first glance.</p>
1.75 rillig 7179: </div>
1.299 rillig 7180: <div class="sect2">
7181: <div class="titlepage"><div><div><h3 class="title">
1.353 dholland 7182: <a name="conf-files-patching"></a>20.2.3. Patching installation</h3></div></div></div>
7183: <p>As discussed above, <span class="strong"><strong>packages themselves must not
1.299 rillig 7184: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7185: directly</strong></span>. Bad news is that many software installation scripts
7186: will, out of the box, mess with the contents of that directory. So what is
7187: the correct procedure to fix this issue?</p>
7188: <p>You must teach the package (usually by manually patching it) to
7189: install any configuration files under the examples hierarchy,
7190: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7191: <code class="filename">PLIST</code> registers them and the administrator always
7192: has the original copies available.</p>
1.353 dholland 7193: <p>It turns out that for packages using GNU autoconf it is possible
7194: to create the desired effect by setting <code class="varname">sysconfdir</code>
7195: on the make command line at install time. Consider this example taken
7196: 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>
7197: <pre class="programlisting">
7198: EGDIR= ${PREFIX}/share/examples/mutt
7199: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
7200: </pre>
7201: <p>Note that the <code class="varname">EGDIR</code> variable, though commonly
7202: used for this purpose, is local to that package and has no meaning
7203: outside it.</p>
7204: </div>
7205: <div class="sect2">
7206: <div class="titlepage"><div><div><h3 class="title">
7207: <a name="conf-files-declare"></a>20.2.4. Declaring configuration files</h3></div></div></div>
1.299 rillig 7208: <p>Once the required configuration files are in place (i.e., under the
1.353 dholland 7209: examples hierarchy), the pkginstall framework can use them as reference copies
1.299 rillig 7210: during the package installation to update what is in
7211: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7212: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.353 dholland 7213: 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
7214: information about their syntax and their purpose. Here is an example,
7215: 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>
7216: <pre class="programlisting">
7217: EGDIR= ${PREFIX}/share/examples/mutt
7218: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7219: </pre>
7220: <p>Note that (as in the previous section's example) the
7221: <code class="varname">EGDIR</code> variable is specific to the package and has
7222: no meaning outside it.</p>
7223: <p>For reference, the complete example from Mutt is as follows:</p>
1.88 wiz 7224: <pre class="programlisting">
1.353 dholland 7225: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
7226: EGDIR= ${PREFIX}/share/examples/mutt
7227: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7228: INSTALLATION_DIRS+= ${EGDIR}
7229: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.100 rillig 7230: </pre>
1.75 rillig 7231: </div>
1.299 rillig 7232: <div class="sect2">
7233: <div class="titlepage"><div><div><h3 class="title">
1.353 dholland 7234: <a name="conf-files-disable"></a>20.2.5. Disabling handling of configuration files</h3></div></div></div>
1.299 rillig 7235: <p>The automatic copying of config files can be toggled by setting the
7236: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7237: installation.</p>
1.88 wiz 7238: </div>
1.75 rillig 7239: </div>
1.148 asau 7240: <div class="sect1">
1.75 rillig 7241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7242: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7243: <p>System startup scripts are special files because they must be
7244: installed in a place known by the underlying OS, usually outside the
7245: 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
7246: can be used. However, pkginstall provides a special mechanism to handle
7247: these files.</p>
7248: <p>In order to provide system startup scripts, the package has
7249: to:</p>
7250: <div class="orderedlist"><ol class="orderedlist" type="1">
7251: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7252: the <code class="literal">.sh</code> suffix appended. Considering the
1.338 nia 7253: <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
7254: has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.299 rillig 7255: <li class="listitem">
7256: <p>Tell pkginstall to handle it, appending the name of the script,
7257: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7258: Continuing the previous example:</p>
7259: <pre class="programlisting">
7260: RCD_SCRIPTS+= cupsd
7261: </pre>
7262: </li>
7263: </ol></div>
7264: <p>Once this is done, pkginstall will do the following steps for each
7265: script in an automated fashion:</p>
7266: <div class="orderedlist"><ol class="orderedlist" type="1">
7267: <li class="listitem"><p>Process the file found in the files directory applying all the
7268: substitutions described in the <code class="filename">FILES_SUBST</code>
7269: variable.</p></li>
7270: <li class="listitem"><p>Copy the script from the files directory to the examples
7271: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.353 dholland 7272: that this reference file must be explicitly registered in the
1.299 rillig 7273: <code class="filename">PLIST</code>.</p></li>
7274: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7275: from the examples hierarchy into the system-wide startup scripts
7276: directory.</p></li>
7277: </ol></div>
7278: <div class="sect2">
7279: <div class="titlepage"><div><div><h3 class="title">
7280: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7281: <p>The automatic copying of config files can be toggled by setting the
7282: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7283: installation. Note that the scripts will be always copied inside the
7284: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7285: matter what the value of this variable is.</p>
1.75 rillig 7286: </div>
7287: </div>
1.299 rillig 7288: <div class="sect1">
7289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7290: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7291: <p>If a package needs to create special users and/or groups during
7292: installation, it can do so by using the pkginstall framework.</p>
7293: <p>Users can be created by adding entries to the
7294: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7295: syntax:</p>
7296: <pre class="programlisting">
7297: user:group
7298: </pre>
7299: <p>Further specification of user details may be done by setting
7300: per-user variables.
7301: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7302: numeric UID for the user.
7303: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7304: user's description or comment.
7305: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7306: user's home directory, and defaults to
7307: <code class="filename">/nonexistent</code> if not specified.
7308: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7309: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7310: not specified.</p>
7311: <p>Similarly, groups can be created by adding entries to the
7312: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7313: <pre class="programlisting">
7314: group
7315: </pre>
7316: <p>The numeric GID of the group may be set by defining
7317: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7318: <p>If a package needs to create the users and groups at an earlier
7319: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7320: <code class="literal">configure</code>,<code class="literal">build</code>, or
7321: <code class="literal">pre-install</code> to indicate the phase before which the
7322: users and groups are created. In this case, the numeric UIDs and GIDs
7323: of the created users and groups are automatically hardcoded into the
7324: final installation scripts.</p>
1.75 rillig 7325: </div>
1.148 asau 7326: <div class="sect1">
1.75 rillig 7327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7328: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7329: <p>Packages that install system shells should register them in the shell
7330: database, <code class="filename">/etc/shells</code>, to make things easier to the
7331: administrator. This must be done from the installation scripts to keep
7332: binary packages working on any system. pkginstall provides an easy way to
7333: accomplish this task.</p>
7334: <p>When a package provides a shell interpreter, it has to set the
7335: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7336: add some hooks to the installation scripts to handle it. Consider the
1.322 leot 7337: 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.299 rillig 7338: <pre class="programlisting">
7339: PKG_SHELL= ${PREFIX}/bin/zsh
7340: </pre>
7341: <div class="sect2">
7342: <div class="titlepage"><div><div><h3 class="title">
7343: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7344: <p>The automatic registration of shell interpreters can be disabled by
7345: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7346: environment variable to <code class="literal">NO</code>.</p>
7347: </div>
1.75 rillig 7348: </div>
1.148 asau 7349: <div class="sect1">
1.75 rillig 7350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7351: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7352: <p>Packages that install X11 fonts should update the database files
7353: that index the fonts within each fonts directory. This can easily be
7354: accomplished within the pkginstall framework.</p>
7355: <p>When a package installs X11 fonts, it must list the directories in
7356: which fonts are installed in the
7357: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7358: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7359: <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
7360: installation scripts to run the appropriate commands to update the fonts
7361: database files within each of those directories. For convenience, if the
7362: directory path is relative, it is taken to be relative to the package's
1.322 leot 7363: 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.75 rillig 7364: <pre class="programlisting">
1.299 rillig 7365: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75 rillig 7366: </pre>
1.299 rillig 7367: <div class="sect2">
7368: <div class="titlepage"><div><div><h3 class="title">
7369: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7370: <p>The automatic update of fonts databases can be disabled by
7371: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7372: environment variable to <code class="literal">NO</code>.</p>
1.75 rillig 7373: </div>
7374: </div>
7375: </div>
1.148 asau 7376: <div class="chapter">
1.75 rillig 7377: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 7378: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75 rillig 7379: <div class="toc">
7380: <p><b>Table of Contents</b></p>
1.210 leot 7381: <dl class="toc">
1.267 rillig 7382: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75 rillig 7383: <dd><dl>
1.267 rillig 7384: <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>
7385: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7386: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7387: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7388: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7389: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7390: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7391: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7392: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7393: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7394: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7395: </dl></dd>
7396: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7397: <dd><dl>
7398: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7399: <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>
7400: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7401: </dl></dd>
7402: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7403: <dd><dl>
7404: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7405: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7406: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338 nia 7407: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.267 rillig 7408: </dl></dd>
7409: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7410: <dd><dl>
7411: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7412: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 7413: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338 nia 7414: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
7415: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
7416: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
7417: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267 rillig 7418: </dl></dd>
7419: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7420: <dd><dl>
7421: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7422: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 7423: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7424: <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>
7425: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 7426: </dl></dd>
7427: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7428: <dd><dl>
7429: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7430: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7431: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7432: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7433: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 7434: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 7435: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
7436: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 7437: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
7438: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
7439: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
7440: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
7441: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
7442: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
7443: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 7444: emulation</a></span></dt>
1.318 nia 7445: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
7446: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.75 rillig 7447: </dl></dd>
1.267 rillig 7448: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7449: </dl>
7450: </div>
1.148 asau 7451: <div class="sect1">
1.75 rillig 7452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 7453: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78 rillig 7454: <p>One appealing feature of pkgsrc is that it runs on many
1.218 rillig 7455: different platforms. As a result, it is important to ensure,
7456: where possible, that packages in pkgsrc are portable. This
7457: chapter mentions some particular details you should pay
7458: attention to while working on pkgsrc.</p>
1.148 asau 7459: <div class="sect2">
1.78 rillig 7460: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7461: <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.93 rillig 7462: </h3></div></div></div>
1.78 rillig 7463: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7464: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7465: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7466: want to use those variables in the preprocessor directives of
1.360 leot 7467: <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.87 wiz 7468: <code class="literal">.for</code>), you need to include the file
7469: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7470: loads the user preferences.</p>
1.78 rillig 7471: <p>But note that some variables may not be completely defined
1.219 rillig 7472: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7473: included, as they may contain references to variables that are
7474: not yet defined. In shell commands (the lines in
7475: <code class="filename">Makefile</code> that are indented with a tab) this
7476: is no problem, since variables are only expanded when they are
7477: used. But in the preprocessor directives mentioned above and in
7478: dependency lines (of the form <code class="literal">target:
7479: dependencies</code>) the variables are expanded at load
7480: time.</p>
1.148 asau 7481: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7482: <h3 class="title">Note</h3>
1.218 rillig 7483: <p>To check whether a variable can be used at load time,
7484: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78 rillig 7485: </div>
7486: </div>
1.148 asau 7487: <div class="sect2">
1.78 rillig 7488: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7489: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88 wiz 7490: <p>Occasionally, packages require interaction from the user,
7491: and this can be in a number of ways:</p>
1.148 asau 7492: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7493: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7494: interaction such as entering username/password or accepting a
7495: license on a web page.</p></li>
1.128 wiz 7496: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7497: passwords.</p></li>
1.128 wiz 7498: <li class="listitem"><p>help to configure the package before it is built</p></li>
7499: <li class="listitem"><p>help during the build process</p></li>
7500: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7501: </ul></div>
1.218 rillig 7502: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7503: variable to define which stages need interaction. This should be
7504: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7505: <pre class="programlisting">
1.100 rillig 7506: INTERACTIVE_STAGE= configure install
1.222 sevan 7507: </pre>
1.88 wiz 7508: <p>The user can then decide to skip this package by setting the
1.218 rillig 7509: <code class="varname">BATCH</code> variable. Packages that require interaction
7510: are also excluded from bulk builds.</p>
1.75 rillig 7511: </div>
1.148 asau 7512: <div class="sect2">
1.75 rillig 7513: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7514: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222 sevan 7515: <p>Authors of software can choose the licence under which software
7516: can be copied. The Free Software Foundation has declared some
7517: licenses "Free", and the Open Source Initiative has a definition of
7518: "Open Source".</p>
7519: <p>By default, pkgsrc allows packages with Free or Open Source
7520: licenses to be built. To allow packages with other licenses to be
7521: built as well, the pkgsrc user needs to add these licenses to the
7522: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7523: that this variable only affects which packages may be
7524: <span class="emphasis"><em>built</em></span>, while the license terms often also
7525: restrict the actual use of the package and its redistribution.</p>
1.98 wiz 7526: <p>One might want to only install packages with a BSD license,
1.218 rillig 7527: or the GPL, and not the other. The free licenses are added to the
1.222 sevan 7528: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.121 jnemeth 7529: user can override the default by setting the
7530: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222 sevan 7531: of "+=". The licenses accepted by default are defined in the
7532: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7533: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78 rillig 7534: <p>The license tag mechanism is intended to address
1.87 wiz 7535: copyright-related issues surrounding building, installing and
7536: using a package, and not to address redistribution issues (see
7537: <code class="varname">RESTRICTED</code> and
1.222 sevan 7538: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121 jnemeth 7539: Packages with redistribution restrictions should set these
7540: tags.</p>
1.98 wiz 7541: <p>Denoting that a package may be copied according to a
7542: particular license is done by placing the license in
1.87 wiz 7543: <code class="filename">pkgsrc/licenses</code> and setting the
7544: <code class="varname">LICENSE</code> variable to a string identifying the
1.322 leot 7545: 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.87 wiz 7546: <pre class="programlisting">
1.100 rillig 7547: LICENSE= xv-license
1.222 sevan 7548: </pre>
1.87 wiz 7549: <p>When trying to build, the user will get a notice that the
1.98 wiz 7550: package is covered by a license which has not been placed in the
7551: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7552: <pre class="programlisting">
1.100 rillig 7553: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7554: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7555: ===> To view the license, enter "/usr/bin/make show-license".
7556: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7557: ===> ACCEPTABLE_LICENSES+=xv-license
7558: *** Error code 1
1.222 sevan 7559: </pre>
1.110 hubertf 7560: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7561: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7562: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7563: convey to pkgsrc that it should not in the future fail because of
7564: that license:</p>
1.78 rillig 7565: <pre class="programlisting">
1.100 rillig 7566: ACCEPTABLE_LICENSES+=xv-license
1.222 sevan 7567: </pre>
7568: <p>The use of <code class="varname">LICENSE=shareware</code>,
7569: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7570: is deprecated because it does not crisply refer to a particular
7571: license text. Another problem with such usage is that it does not
7572: enable a user to tell pkgsrc to proceed for a single package
7573: without also telling pkgsrc to proceed for all packages with that
7574: tag.</p>
7575: <div class="sect3">
7576: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7577: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154 rodent 7578: <p>When adding a package with a new license, the following steps
7579: are required:</p>
7580: <div class="orderedlist"><ol class="orderedlist" type="1">
7581: <li class="listitem">
1.284 rillig 7582: <p>Check whether the license qualifies as Free or Open Source by
7583: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7584: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222 sevan 7585: Open Source Initiative</a>. If this is the case, the filename in
7586: <code class="filename">pkgsrc/licenses/</code> does not need the
7587: <code class="filename">-license</code> suffix, and the license name should be
7588: added to:</p>
1.154 rodent 7589: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7590: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7591: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7592: <li class="listitem"><p>default_acceptable_licenses in
7593: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154 rodent 7594: </ul></div>
7595: </li>
1.284 rillig 7596: <li class="listitem"><p>The license text should be added to
7597: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7598: licenses can be seen in this directory.</p></li>
1.154 rodent 7599: </ol></div>
1.222 sevan 7600: </div>
7601: <div class="sect3">
7602: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7603: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98 wiz 7604: <p>When the license changes (in a way other than formatting),
1.222 sevan 7605: make sure that the new license has a different name (e.g.,
1.98 wiz 7606: append the version number if it exists, or the date). Just
7607: because a user told pkgsrc to build programs under a previous
7608: version of a license does not mean that pkgsrc should build
1.99 rillig 7609: programs under the new licenses. The higher-level point is that
1.98 wiz 7610: pkgsrc does not evaluate licenses for reasonableness; the only
7611: test is a mechanistic test of whether a particular text has been
1.222 sevan 7612: approved by either of two bodies (FSF or OSI).</p>
7613: </div>
1.75 rillig 7614: </div>
1.148 asau 7615: <div class="sect2">
1.75 rillig 7616: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7617: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75 rillig 7618: <p>Some licenses restrict how software may be re-distributed.
1.222 sevan 7619: By declaring the restrictions, package tools can
1.98 wiz 7620: automatically refrain from e.g. placing binary packages on FTP
7621: sites.</p>
1.222 sevan 7622: <p>There are four possible restrictions, which are
1.98 wiz 7623: the cross product of sources (distfiles) and binaries not being
7624: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7625: language in any license, and because non-Free licenses tend to be
7626: different from each other, pkgsrc adopts a definition of FTP and
1.222 sevan 7627: CD-ROM.
7628:
7629: "FTP" means making the source or binary file available over the
7630: Internet at no charge.
7631:
7632: "CD-ROM" means making the source or binary available on some kind of
7633: media, together with other source and binary packages, which is sold
7634: for a distribution charge.
1.98 wiz 7635: </p>
7636: <p>In order to encode these restrictions, the package system
1.87 wiz 7637: defines five make variables that can be set to note these
7638: restrictions:</p>
1.148 asau 7639: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7640: <li class="listitem">
1.75 rillig 7641: <p><code class="varname">RESTRICTED</code></p>
7642: <p>This variable should be set whenever a restriction
1.87 wiz 7643: exists (regardless of its kind). Set this variable to a
1.98 wiz 7644: string containing the reason for the restriction. It should
7645: be understood that those wanting to understand the restriction
7646: will have to read the license, and perhaps seek advice of
7647: counsel.</p>
1.75 rillig 7648: </li>
1.128 wiz 7649: <li class="listitem">
1.75 rillig 7650: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7651: <p>Binaries may not be placed on CD-ROM containing other
7652: binary packages, for which a distribution charge may be made.
7653: In this case, set this variable to
7654: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7655: </li>
1.128 wiz 7656: <li class="listitem">
1.75 rillig 7657: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7658: <p>Binaries may not made available on the Internet without
7659: charge. In this case, set this variable to
7660: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7661: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7662: </li>
1.128 wiz 7663: <li class="listitem">
1.75 rillig 7664: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7665: <p>Distfiles may not be placed on CD-ROM, together with
7666: other distfiles, for which a fee may be charged. In this
7667: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7668: </p>
1.75 rillig 7669: </li>
1.128 wiz 7670: <li class="listitem">
1.75 rillig 7671: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7672: <p>Distfiles may not made available via FTP at no charge.
7673: In this case, set this variable to
7674: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7675: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7676: </li>
7677: </ul></div>
1.222 sevan 7678: <p>Please note that packages will be removed from pkgsrc when the
7679: distfiles are not distributable and cannot be obtained for a period
7680: of one full quarter branch. Packages with manual/interactive fetch
7681: must have a maintainer and it is his/her responsibility to ensure
7682: this.</p>
1.75 rillig 7683: </div>
1.148 asau 7684: <div class="sect2">
1.75 rillig 7685: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7686: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290 gutterid 7687: <p>Your package may depend on some other package being present,
7688: and there are various ways of expressing this dependency.
7689: pkgsrc supports the <code class="varname">DEPENDS</code>,
7690: <code class="varname">BUILD_DEPENDS</code>,
7691: <code class="varname">TOOL_DEPENDS</code>, and
7692: <code class="varname">TEST_DEPENDS</code> definitions, the
1.88 wiz 7693: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7694: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7695: to handle dependencies, and which uses the variables named above.
1.299 rillig 7696: See <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a> for more information.</p>
1.290 gutterid 7697: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7698: definition registers that pre-requisite in the binary package so it
7699: will be pulled in when the binary package is later installed, whilst
7700: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7701: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7702: dependency that is only needed for building or testing the resulting
1.299 rillig 7703: 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.75 rillig 7704: <p>This means that if you only need a package present whilst
1.290 gutterid 7705: you are building or testing, it should be noted as a
7706: <code class="varname">TOOL_DEPENDS</code>,
7707: <code class="varname">BUILD_DEPENDS</code>, or
7708: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.269 leot 7709: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7710: packages, i.e. packages for the architecture where the package
7711: is built;
7712: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290 gutterid 7713: packages, i.e., packages for the architecture for which the package
1.269 leot 7714: is built.</p>
1.290 gutterid 7715: <p>The format for a <code class="varname">DEPENDS</code>,
7716: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7717: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75 rillig 7718: <pre class="programlisting">
1.100 rillig 7719: <pre-req-package-name>:../../<category>/<pre-req-package>
1.222 sevan 7720: </pre>
1.128 wiz 7721: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7722: may include any of the wildcard version numbers recognized by
1.360 leot 7723: <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.128 wiz 7724: <div class="orderedlist"><ol class="orderedlist" type="1">
7725: <li class="listitem">
1.75 rillig 7726: <p>If your package needs another package's binaries or
1.160 wiz 7727: libraries to build and run, and if that package has a
1.87 wiz 7728: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7729: <pre class="programlisting">
1.100 rillig 7730: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7731: </pre>
1.75 rillig 7732: </li>
1.128 wiz 7733: <li class="listitem">
1.160 wiz 7734: <p>If your package needs another package's binaries or
7735: libraries only for building, and if that package has a
7736: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7737: <pre class="programlisting">
7738: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7739: </pre>
1.160 wiz 7740: <p>but set
7741: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7742: to make it a build dependency only. This case is rather
7743: rare.</p>
7744: </li>
7745: <li class="listitem">
1.132 spz 7746: <p>If your package needs binaries from another package to build,
1.269 leot 7747: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75 rillig 7748: <pre class="programlisting">
1.269 leot 7749: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222 sevan 7750: </pre>
1.75 rillig 7751: </li>
1.269 leot 7752: <li class="listitem"><p>If your package needs static libraries to link against, header
7753: files to include, etc. from another package to build,
7754: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132 spz 7755: <li class="listitem"><p>If your package needs a library with which to link and
7756: there is no <code class="filename">buildlink3.mk</code> file
7757: available, create one. Using
7758: <code class="varname">DEPENDS</code> won't be sufficient because the
7759: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7760: <li class="listitem">
1.132 spz 7761: <p>If your package needs some executable to be able to run
7762: correctly and if there's no
7763: <code class="filename">buildlink3.mk</code> file, this is specified
7764: using the <code class="varname">DEPENDS</code> variable. The
1.322 leot 7765: <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.242 wiz 7766: be able to execute the latex binary from the tex-latex-bin package
1.132 spz 7767: when it runs, and that is specified:</p>
1.75 rillig 7768: <pre class="programlisting">
1.242 wiz 7769: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222 sevan 7770: </pre>
1.132 spz 7771: </li>
1.290 gutterid 7772: <li class="listitem"><p>If your package includes a test suite that has extra
7773: dependencies only required for this purpose (frequently this
7774: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7775: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132 spz 7776: <li class="listitem">
7777: <p>You can use wildcards in package dependencies. Note that
7778: such wildcard dependencies are retained when creating binary
7779: packages. The dependency is checked when installing the binary
7780: package and any package which matches the pattern will be
7781: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7782: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7783: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7784: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7785: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7786: <p>Wildcards can also be used to specify that a package
1.87 wiz 7787: will only build against a certain minimum version of a
7788: pre-requisite:</p>
1.75 rillig 7789: <pre class="programlisting">
1.132 spz 7790: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.222 sevan 7791: </pre>
1.132 spz 7792: <p>This means that the package will build using version 6.0
7793: of ImageMagick or newer. Such a dependency may be warranted
7794: if, for example, the command line options of an executable
7795: have changed.</p>
7796: <p>If you need to depend on minimum versions of libraries,
1.298 wiz 7797: set
7798: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7799: to the appropriate pattern before including its
7800: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7801: <pre class="programlisting">
7802: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7803: .include "../../graphics/jpeg/buildlink3.mk"
7804: </pre>
1.75 rillig 7805: <p>For security fixes, please update the package
1.267 rillig 7806: 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.87 wiz 7807: information.</p>
1.75 rillig 7808: </li>
7809: </ol></div>
7810: <p>If your package needs files from another package to build,
1.87 wiz 7811: add the relevant distribution files to
7812: <code class="varname">DISTFILES</code>, so they will be extracted
1.322 leot 7813: 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.87 wiz 7814: (It relies on the jpeg sources being present in source form
7815: during the build.)</p>
1.75 rillig 7816: </div>
1.148 asau 7817: <div class="sect2">
1.75 rillig 7818: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7819: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.341 gutterid 7820: <p>Your package may conflict with other packages users might
7821: already have installed on their system, e.g., if your package
1.88 wiz 7822: installs the same set of files as another package in the pkgsrc
1.342 wiz 7823: tree.</p>
1.322 leot 7824: <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>
7825: 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.255 leot 7826: install the same shared library, thus you set in
7827: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7828: <pre class="programlisting">
7829: CONFLICTS= Xaw-Xpm-[0-9]*
1.352 wiz 7830: </pre>
1.255 leot 7831: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7832: <pre class="programlisting">
7833: CONFLICTS= libXaw3d-[0-9]*
1.352 wiz 7834: </pre>
1.360 leot 7835: <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.255 leot 7836: that conflict with existing packages and abort. However, in many
7837: situations this is too late in the process. Binary package managers
7838: will not know about the conflict until they attempt to install the
7839: package after already downloading it and all its dependencies.
7840: Users may also waste time building a package and its dependencies
7841: only to find out at the end that it conflicts with another package
7842: they have installed.</p>
7843: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7844: should be added in all cases where it is known that packages conflict
7845: with each other. These <code class="varname">CONFLICTS</code> entries are
1.360 leot 7846: 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.255 leot 7847: managers to inform users that packages cannot be installed onto
7848: the target system.</p>
1.75 rillig 7849: </div>
1.148 asau 7850: <div class="sect2">
1.75 rillig 7851: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7852: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7853: <p>There are several reasons why a package might be
1.88 wiz 7854: instructed to not build under certain circumstances. If the
1.87 wiz 7855: package builds and runs on most platforms, the exceptions
1.193 dholland 7856: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7857: the package builds and runs on a small handful of platforms,
7858: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7859: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7860: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7861: (OS-version-platform) that can use glob-style
7862: wildcards.</p>
7863: <p>If a package is not appropriate for some platforms (as
1.225 maya 7864: opposed to merely broken), a different set of variables should be
1.193 dholland 7865: used as this affects failure reporting and statistics.
7866: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7867: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 dholland 7868: the package is appropriate for only a small handful of platforms
7869: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7870: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7871: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7872: (OS-version-platform) that can use glob-style
7873: wildcards.</p>
1.88 wiz 7874: <p>Some packages are tightly bound to a specific version of an
1.322 leot 7875: 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.88 wiz 7876: backwards compatible with other versions of the OS, and should be
7877: uploaded to a version specific directory on the FTP server. Mark
7878: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7879: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7880: the package system internals, but may be used in the
7881: future.</p>
1.75 rillig 7882: <p>If the package should be skipped (for example, because it
1.87 wiz 7883: provides functionality already provided by the system), set
1.88 wiz 7884: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7885: the package should fail because some preconditions are not met,
7886: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7887: message.</p>
1.75 rillig 7888: </div>
1.148 asau 7889: <div class="sect2">
1.75 rillig 7890: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7891: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7892: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7893: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7894: be set in the package Makefile. This will be carried into any
7895: binary package that is made from this pkgsrc entry. A
1.128 wiz 7896: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.360 leot 7897: 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.128 wiz 7898: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7899: </div>
1.148 asau 7900: <div class="sect2">
1.75 rillig 7901: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7902: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7903: <p>When a vulnerability is found, this should be noted in
1.361 wiz 7904: <code class="filename">pkgsrc/doc/pkg-vulnerabilities</code>.
1.320 wiz 7905: Entries in that file consist of three parts:</p>
7906: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7907: <li class="listitem"><p>package version pattern</p></li>
7908: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
7909: <li class="listitem"><p>URL providing additional information about the issue</p></li>
7910: </ul></div>
7911: <p>For the package version pattern please always use `<' to
7912: mark an upper bound (not `<='!). This will avoid possible
7913: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
7914: related to security fixes. Lower bounds can be added too, using
7915: '>' or '>='. For example,
1.321 wiz 7916: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.320 wiz 7917: versions 1.0 (included) to 1.2 (excluded) of
7918: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
7919: issue.</p>
7920: <p>Entries should always be added at the bottom of the file.</p>
7921: <p>When fixing packages, please modify the upper bound of the
7922: corresponding entry. To continue the previous example, if a fix
7923: was backported to version 1.1nb2, change the previous pattern to
1.321 wiz 7924: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.320 wiz 7925: <p>To locally test a package version pattern against a
7926: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
7927: pmatch</strong></span> command.</p>
7928: <p>The URL should be as permanent as possible and provide as
7929: much information about the issue as possible. CVE entries are
7930: preferred.</p>
7931: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.138 wiz 7932: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7933: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7934: <code class="varname">PKGREVISION</code> should be increased (this is of
7935: course not necessary if the problem is fixed by using a newer
7936: release of the software), and the pattern in the
7937: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7938: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7939: branch, be sure to submit a pullup request!</p>
1.75 rillig 7940: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7941: semi-automatically by a weekly cron job.</p>
1.320 wiz 7942: <p>In case a security issue is disputed, please contact
7943: pkgsrc-security@NetBSD.org.</p>
1.75 rillig 7944: </div>
1.148 asau 7945: <div class="sect2">
1.75 rillig 7946: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7947: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75 rillig 7948: <p>When making fixes to an existing package it can be useful
1.87 wiz 7949: to change the version number in <code class="varname">PKGNAME</code>. To
7950: avoid conflicting with future versions by the original author, a
1.128 wiz 7951: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.87 wiz 7952: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7953: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7954: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7955: <pre class="programlisting">
1.100 rillig 7956: DISTNAME= foo-17.42
7957: PKGREVISION= 9
1.222 sevan 7958: </pre>
1.75 rillig 7959: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7960: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7961: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7962: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7963: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7964: <p>When a new release of the package is released, the
1.87 wiz 7965: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7966: minor release of the above package, things should be like:</p>
1.75 rillig 7967: <pre class="programlisting">
1.100 rillig 7968: DISTNAME= foo-17.43
1.222 sevan 7969: </pre>
1.87 wiz 7970: <p><code class="varname">PKGREVISION</code> should be incremented for any
7971: non-trivial change in the resulting binary package. Without a
7972: <code class="varname">PKGREVISION</code> bump, someone with the previous
7973: version installed has no way of knowing that their package is out
7974: of date. Thus, changes without increasing
7975: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7976: trivial that no reasonable person would want to upgrade", and this
7977: is the rough test for when increasing
7978: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7979: changes that do not merit increasing
7980: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 7981: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7982: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284 rillig 7983: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7984: comments in Makefile.</p></li>
7985: <li class="listitem"><p>Changing build variables if the resulting binary
7986: package is the same.</p></li>
7987: <li class="listitem"><p>Changing
7988: <code class="filename">DESCR</code>.</p></li>
7989: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7990: default options don't change.</p></li>
1.100 rillig 7991: </ul></div>
1.87 wiz 7992: <p>Examples of changes that do merit an increase to
7993: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 7994: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7995: <li class="listitem"><p>Security fixes</p></li>
7996: <li class="listitem"><p>Changes or additions to a patch
7997: file</p></li>
7998: <li class="listitem"><p>Changes to the
7999: <code class="filename">PLIST</code></p></li>
8000: <li class="listitem"><p>A dependency is changed or
8001: renamed.</p></li>
1.100 rillig 8002: </ul></div>
1.78 rillig 8003: <p>PKGREVISION must also be incremented when dependencies have ABI
8004: changes.</p>
1.75 rillig 8005: </div>
1.148 asau 8006: <div class="sect2">
1.79 rillig 8007: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8008: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.295 rillig 8009: <p>When you want to replace the same text in multiple files, or
8010: multiple times in the same file, it is cumbersome to maintain a patch
8011: file for this. This is where the SUBST framework steps in. It provides an
8012: easy-to-use interface for replacing text in files. It just needs the
8013: following information:</p>
8014: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8015: <li class="listitem"><p>In which phase of the package build cycle should the
8016: replacement happen?</p></li>
8017: <li class="listitem"><p>In which files should the replacement
1.287 rillig 8018: happen?</p></li>
1.295 rillig 8019: <li class="listitem"><p>Which text should be replaced with
8020: what?</p></li>
1.287 rillig 8021: </ul></div>
8022: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295 rillig 8023: variables. A minimal example is:</p>
8024: <pre class="programlisting">
8025: SUBST_CLASSES+= paths
8026: SUBST_STAGE.paths= pre-configure
8027: SUBST_FILES.paths= src/*.c
8028: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
8029: </pre>
8030: <p>Translated into English, it means: In the pre-configure stage (that
8031: is, after applying the patches from the patches/ directory and before
8032: running the configure script and the portability check), replace the text
8033: <code class="literal">/usr/local</code> with the content of the variable
8034: <code class="varname">PREFIX</code>.</p>
8035: <p>Each SUBST block starts by appending an identifier to
8036: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
8037: identifier can be chosen freely by the package. If there should ever be
8038: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
8039: early, so don't worry about name collisions.</p>
8040: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
8041: SUBST block are parameterized using this identifier. In the remainder of
8042: this section, these parameterized variables are written as
8043: <code class="varname">SUBST_STAGE.*</code>.</p>
8044: <pre class="programlisting">
8045: SUBST_CLASSES+= paths
8046: SUBST_STAGE.paths= pre-configure
8047: SUBST_MESSAGE.paths= Fixing absolute paths.
8048: SUBST_FILES.paths= src/*.c
8049: SUBST_FILES.paths+= scripts/*.sh
8050: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
8051: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8052: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
8053: </pre>
8054: <p>To get a complete picture about the SUBST substitutions, run
8055: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
8056: expected, run pkglint on the package, which detects several typical
8057: mistakes surrounding the SUBST blocks. For any questions that might
8058: remain after this, have a look at
8059: <code class="filename">mk/subst.mk</code>.</p>
8060: <div class="sect3">
8061: <div class="titlepage"><div><div><h4 class="title">
8062: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
8063: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
8064: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
8065: <code class="literal">pre-configure</code> is used most often, by far. The most
8066: popular stages are, in chronological order:</p>
8067: <div class="variablelist"><dl class="variablelist">
8068: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
8069: <dd>
8070: <p>The substitutions are applied immediately after the
8071: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
8072: package will leave no traces of the original files.</p>
8073: <p>When the substitution applies to files for which there is also a
8074: patch in the <code class="filename">patches/</code> directory, this means that the
8075: patches will be computed based on the result of the substitution. When
8076: these patches are sent to the upstream maintainer later, to be fixed in
8077: the upstream package, these patches may no longer match what the upstream
8078: author is used to. Because of this, <code class="literal">pre-configure</code> is
8079: often a better choice.</p>
8080: </dd>
8081: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
8082: <dd>
8083: <p>The substitutions are applied after the patches from the
8084: <code class="filename">patches/</code> directory. This makes it possible to run
8085: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.322 leot 8086: 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.295 rillig 8087: <p>When updating the patches, it is helpful to explicitly separate the
8088: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
8089: configure</strong></span>, and to only edit the patches between these commands.
8090: Otherwise the substitutions from the SUBST block will end up in the patch
8091: file. When this happens in really obvious ways, pkglint will complain
8092: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
8093: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
8094: can only detect these really obvious
8095: cases.</p>
8096: </dd>
8097: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
8098: <dd><p>This stage should only be used if the package defines a
8099: <code class="literal">pre-configure</code> action itself, and the substitution must
8100: happen after that. Typical examples are packages that use the
8101: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
8102: script from
8103: <code class="filename">configure.ac</code>.</p></dd>
8104: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
8105: <dd><p>This stage is used to fix up any mistakes by the
8106: configure stage.</p></dd>
8107: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
8108: <dd><p>This stage should only be used for substitutions that are
8109: clearly related to building the package, not for fixing the
8110: configuration. Substitutions for pathnames (such as replacing
8111: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
8112: user names (such as replacing <code class="literal">@MY_USER@</code> with the
8113: actual username) belong in pre-configure or post-configure
8114: instead.</p></dd>
8115: <dt><span class="term"><code class="literal">post-build</code></span></dt>
8116: <dd>
8117: <p>Just as with pre-build, this stage should only be used
8118: for substitutions that are clearly related to building the package, not
8119: for fixing the configuration. Substitutions for pathnames (such as
8120: replacing <code class="filename">/usr/local</code> with
8121: <code class="literal">${PREFIX}</code>) or user names (such as replacing
8122: <code class="literal">@MY_USER@</code> with the actual username) belong in
8123: pre-configure or post-configure instead.</p>
8124: <p>A typical use is to update pkg-config files to include the rpath
8125: compiler options.</p>
8126: </dd>
8127: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8128: <dd><p>In general, the install phase should be as simple as
8129: possible. As with the pre-build and post-build stages, it should not be
8130: used to fix pathnames or user names, these belong in pre-configure
8131: instead. There are only few legitimate use cases for applying
8132: substitutions in this stage.</p></dd>
8133: </dl></div>
8134: </div>
8135: <div class="sect3">
8136: <div class="titlepage"><div><div><h4 class="title">
1.296 rillig 8137: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295 rillig 8138: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8139: filename patterns. These patterns are relative to
8140: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8141: A typical example is:</p>
8142: <pre class="programlisting">
8143: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8144: </pre>
8145: <p>The above patterns, especially the last, are quite broad. The SUBST
8146: implementation checks that each filename pattern that is mentioned here
8147: has an effect. For example, if none of the
8148: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8149: and substituted, that filename pattern is redundant and should be left
1.296 rillig 8150: out. By default, the SUBST framework will complain with an error message.
8151: If the text to be substituted occurs in some of the files from a single
8152: pattern, but not in all of them, that is totally ok, and the SUBST
1.295 rillig 8153: framework will only print an INFO message for those files.</p>
8154: <p>If there is a good reason for having redundant filename patterns,
1.296 rillig 8155: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295 rillig 8156: <p>Another popular way of choosing the files for the substitutions is
8157: via a shell command, like this:</p>
8158: <pre class="programlisting">
1.296 rillig 8159: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.295 rillig 8160: SUBST_FILES.path= ${C_FILES_CMD:sh}
8161: </pre>
8162: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8163: freely chosen and independent of the SUBST framework.</p>
8164: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8165: lists each file individually. Thereby chances are higher that there are
8166: filename patterns in which no substitution happens. Since the SUBST
8167: framework cannot know whether the filename patterns in
8168: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8169: Makefile (where any redundant filename pattern would be suspicious) or
8170: been generated by a shell command (in which redundant filename patterns
8171: are more likely and to be expected), it will complain about these
8172: redundant filename patterns. Therefore, SUBST blocks that use a shell
8173: command to generate the list of filename patterns often need to set
8174: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8175: </div>
8176: <div class="sect3">
8177: <div class="titlepage"><div><div><h4 class="title">
8178: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8179: <p>In most cases, the substitutions are given using one or more
1.360 leot 8180: <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.295 rillig 8181: <pre class="programlisting">
8182: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8183: </pre>
8184: <p>Each of the sed commands needs to be preceded by the
8185: <code class="literal">-e</code> option and should be specified on a line of its
8186: own, to avoid hiding short sed commands at the end of a line.</p>
8187: <p>Since the sed commands often contain shell metacharacters as the
8188: separator (the <code class="literal">|</code> in the above example), it is common
8189: to enclose them in single quotes.</p>
8190: <p>A common substitution is to replace placeholders of the form
8191: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8192: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8193: <pre class="programlisting">
8194: SUBST_VARS.path= PREFIX
8195: </pre>
8196: <p>This type of substitutions is typically done by the GNU configure
1.296 rillig 8197: scripts during the do-configure stage, but in some cases these need to be
8198: overridden. The same pattern is also used when a package defines patches
8199: that replace previously hard-coded paths like
8200: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8201: placeholder first, which then gets substituted by the actual
8202: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8203: cases, it works equally well to just use the SUBST framework to directly
8204: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8205: thereby omitting the intermediate patch file.</p>
1.295 rillig 8206: <p>If the above is not flexible enough, it is possible to not use sed
8207: at all for the substitution but to specify an entirely different command,
8208: like this:</p>
1.87 wiz 8209: <pre class="programlisting">
1.295 rillig 8210: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8211: </pre>
8212: <p>This is used for the few remaining packages in which the
8213: distributed files use Windows-style line endings that need to be
8214: converted to UNIX-style line endings.</p>
8215: </div>
8216: <div class="sect3">
8217: <div class="titlepage"><div><div><h4 class="title">
8218: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8219: <p>When a SUBST block is applied during a package build, a message is
8220: logged. The default message is fine for most purposes but can be
8221: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8222: message.</p>
8223: </div>
1.79 rillig 8224: </div>
1.75 rillig 8225: </div>
1.148 asau 8226: <div class="sect1">
1.75 rillig 8227: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8228: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 8229: <div class="sect2">
1.75 rillig 8230: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8231: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75 rillig 8232: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8233: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8234: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8235: with the name of each file to download as an argument, expecting
8236: it to output the URL of the directory from which to download
1.322 leot 8237: 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.87 wiz 8238: example of this usage.</p>
1.75 rillig 8239: <p>If the download can't be automated, because the user must
1.87 wiz 8240: submit personal information to apply for a password, or must pay
8241: for the source, or whatever, you can set
8242: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8243: displayed to the user before aborting the build. Example:</p>
8244: <pre class="programlisting">
1.100 rillig 8245: FETCH_MESSAGE= "Please download the files"
8246: FETCH_MESSAGE+= " "${DISTFILES:Q}
8247: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222 sevan 8248: </pre>
1.75 rillig 8249: </div>
1.148 asau 8250: <div class="sect2">
1.75 rillig 8251: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8252: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75 rillig 8253: <p>Sometimes authors of a software package make some
1.87 wiz 8254: modifications after the software was released, and they put up a
8255: new distfile without changing the package's version number. If a
8256: package is already in pkgsrc at that time, the checksum will
8257: no longer match. The contents of the new distfile should be
8258: compared against the old one before changing anything, to make
8259: sure the distfile was really updated on purpose, and that
8260: no trojan horse or so crept in.
1.97 rillig 8261: Please mention that the distfiles were compared and what was found
1.159 rodent 8262: in your commit message.</p>
1.220 wiz 8263: <p>Then, the correct way to work around this is to set
8264: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8265: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8266: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8267: a variable prefix). All <code class="varname">DISTFILES</code> and
1.93 rillig 8268: <code class="varname">PATCHFILES</code> for this package will be put in that
1.267 rillig 8269: 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.87 wiz 8270: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220 wiz 8271: including the <code class="filename">nbX</code> suffix) or a date stamp can
8272: be appended, like
8273: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284 rillig 8274: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8275: name does not contain a version and the distfile is apt to change. In
8276: cases where the likelihood of this is very small,
8277: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8278: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8279: distfile name changes, even if a package is being moved or
8280: renamed.</p>
1.159 rodent 8281: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8282: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8283: path in the filenames.
1.159 rodent 8284: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8285: Furthermore, a mail to the package's authors seems appropriate
8286: telling them that changing distfiles after releases without
8287: changing the file names is not good practice.</p>
1.75 rillig 8288: </div>
1.199 tnn 8289: <div class="sect2">
8290: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8291: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284 rillig 8292: <p>Helper methods exist for packages hosted on github.com which
8293: will often have distfile names that clash with other packages, for
8294: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8295: from below:</p>
1.199 tnn 8296: <div class="sect3">
8297: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8298: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284 rillig 8299: <p>If your distfile URL looks similar to
1.303 bacon 8300: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284 rillig 8301: then you are packaging a tagged release.</p>
1.199 tnn 8302: <pre class="programlisting">
1.303 bacon 8303: DISTNAME= example-1.0
1.200 tnn 8304: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8305: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8306: GITHUB_TAG= v${PKGVERSION_NOREV}
1.199 tnn 8307: EXTRACT_SUFX= .zip
8308: </pre>
1.345 gutterid 8309: <p>Here, DISTNAME combined with use of GITHUB_TAG leads the
8310: file fetching infrastructure to save the resulting file locally as
8311: <code class="literal">example-1.0.zip</code>.</p>
1.199 tnn 8312: </div>
8313: <div class="sect3">
8314: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8315: <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>
8316: <p>If your distfile looks similar to
8317: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8318: release, then set the package version to 0.0.0.N, where N is the number
8319: of commits to the repository, and set GITHUB_TAG to the commit hash.
8320: This will (almost) ensure that the first tagged release will have a
8321: version greater than this one so that package upgrades will function
8322: properly.</p>
8323: <pre class="programlisting">
8324: DISTNAME= example-0.0.0.347
8325: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8326: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8327: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8328: </pre>
8329: </div>
8330: <div class="sect3">
8331: <div class="titlepage"><div><div><h4 class="title">
8332: <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>
8333: <p>If your distfile looks similar to
8334: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8335: then include the last release version and the commit count since that
8336: release in the package version and set GITHUB_TAG to the commit hash.
8337: The latest release and commit count are shown in the output of
8338: "git describe --tags":
8339: </p>
8340: <pre class="screen">
8341: # git clone https://github.com/username/example
8342: # cd example
8343: # git describe --tags
8344: 1.2.3-5-g988881a
8345: </pre>
1.199 tnn 8346: <pre class="programlisting">
1.303 bacon 8347: DISTNAME= example-1.2.3.5
8348: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8349: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8350: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222 sevan 8351: </pre>
1.199 tnn 8352: </div>
8353: <div class="sect3">
8354: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8355: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284 rillig 8356: <p>If your distfile URL looks similar to
1.303 bacon 8357: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284 rillig 8358: then you are packaging a release.</p>
1.199 tnn 8359: <pre class="programlisting">
8360: DISTNAME= offensive-1.6
1.200 tnn 8361: PKGNAME= ${DISTNAME:S/offensive/proper/}
8362: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8363: GITHUB_PROJECT= example
1.200 tnn 8364: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8365: EXTRACT_SUFX= .zip
1.222 sevan 8366: </pre>
1.199 tnn 8367: </div>
8368: </div>
1.75 rillig 8369: </div>
1.148 asau 8370: <div class="sect1">
1.75 rillig 8371: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8372: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 8373: <div class="sect2">
1.75 rillig 8374: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8375: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8376: <p>pkgsrc supports many different machines, with different
1.87 wiz 8377: object formats like a.out and ELF, and varying abilities to do
8378: shared library and dynamic loading at all. To accompany this,
8379: varying commands and options have to be passed to the
8380: compiler, linker, etc. to get the Right Thing, which can be
8381: pretty annoying especially if you don't have all the machines
8382: at your hand to test things. The
1.322 leot 8383: <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.128 wiz 8384: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8385: both static and dynamic libraries from a set of source files,
8386: thus being platform-independent.</p>
8387: <p>Here's how to use libtool in a package in seven simple
8388: steps:</p>
1.128 wiz 8389: <div class="orderedlist"><ol class="orderedlist" type="1">
8390: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8391: Makefile.</p></li>
1.128 wiz 8392: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8393: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8394: add it to the definition of <code class="varname">CC</code>, if only
8395: libraries are being built in a given Makefile. This one command
8396: will build both PIC and non-PIC library objects, so you need not
8397: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8398: <li class="listitem">
1.75 rillig 8399: <p>For the linking of the library, remove any
1.128 wiz 8400: <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
8401: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8402: <pre class="programlisting">
1.100 rillig 8403: ${LIBTOOL} --mode=link \
8404: ${CC} -o ${.TARGET:.a=.la} \
8405: ${OBJS:.o=.lo} \
8406: -rpath ${PREFIX}/lib \
8407: -version-info major:minor
1.222 sevan 8408: </pre>
1.75 rillig 8409: <p>Note that the library is changed to have a
1.87 wiz 8410: <code class="filename">.la</code> extension, and the objects are
8411: changed to have a <code class="filename">.lo</code>
8412: extension. Change <code class="varname">OBJS</code> as
8413: necessary. This automatically creates all of the
8414: <code class="filename">.a</code>,
8415: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8416: necessary) in the build directory. Be sure to include
1.128 wiz 8417: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8418: minor are zero, as libtool will otherwise strip off the
8419: shared library version.</p>
1.75 rillig 8420: <p>From the libtool manual:</p>
8421: <pre class="programlisting">
1.100 rillig 8422: So, libtool library versions are described by three integers:
1.69 rillig 8423:
1.100 rillig 8424: CURRENT
8425: The most recent interface number that this library implements.
1.69 rillig 8426:
1.100 rillig 8427: REVISION
8428: The implementation number of the CURRENT interface.
1.69 rillig 8429:
1.100 rillig 8430: AGE
8431: The difference between the newest and oldest interfaces that
8432: this library implements. In other words, the library implements
8433: all the interface numbers in the range from number `CURRENT -
8434: AGE' to `CURRENT'.
1.1 grant 8435:
1.100 rillig 8436: If two libraries have identical CURRENT and AGE numbers, then the
8437: dynamic linker chooses the library with the greater REVISION number.
1.222 sevan 8438: </pre>
1.128 wiz 8439: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8440: different results for a.out and ELF (excluding symlinks)
8441: in only one case. An ELF library of the form
1.128 wiz 8442: <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.87 wiz 8443: will have a symlink of
1.128 wiz 8444: <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.87 wiz 8445: on an a.out platform. This is handled
8446: automatically.</p>
1.128 wiz 8447: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8448: directory of the library being built.</p>
1.76 rillig 8449: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8450: <code class="filename">.la</code> file, the other files will be
8451: added automatically.</p>
1.75 rillig 8452: </li>
1.128 wiz 8453: <li class="listitem">
1.76 rillig 8454: <p>When linking shared object (<code class="filename">.so</code>)
1.360 leot 8455: 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.128 wiz 8456: shared libraries, use <span class="quote">“<span class="quote">-module
8457: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8458: tacked on.</p>
1.76 rillig 8459: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8460: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8461: </li>
1.128 wiz 8462: <li class="listitem">
1.75 rillig 8463: <p>When linking programs that depend on these libraries
1.87 wiz 8464: <span class="emphasis"><em>before</em></span> they are installed, preface
1.360 leot 8465: 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.128 wiz 8466: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8467: libraries (static or shared), but please be aware that
8468: libtool will not allow you to specify a relative path in
1.128 wiz 8469: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8470: expects you to change that argument to be the
8471: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8472: <pre class="programlisting">
1.100 rillig 8473: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222 sevan 8474: </pre>
1.75 rillig 8475: <p>should be changed to:</p>
8476: <pre class="programlisting">
1.100 rillig 8477: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222 sevan 8478: </pre>
1.75 rillig 8479: <p>and it will do the right thing with the libraries.</p>
8480: </li>
1.128 wiz 8481: <li class="listitem">
1.360 leot 8482: <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>
8483: 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.128 wiz 8484: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8485: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8486: <pre class="programlisting">
1.126 jakllsch 8487: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222 sevan 8488: </pre>
1.76 rillig 8489: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8490: shared library, any needed symlinks, and run
1.360 leot 8491: <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.75 rillig 8492: </li>
1.128 wiz 8493: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8494: the <code class="filename">.la</code>
8495: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8496: </ol></div>
8497: </div>
1.148 asau 8498: <div class="sect2">
1.75 rillig 8499: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8500: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8501: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8502: package Makefile. This will override the package's own libtool
8503: in most cases. For older libtool using packages, libtool is
8504: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8505: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8506: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8507: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8508: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8509: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8510: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8511: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8512: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8513: libraries built and installed, then use
8514: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8515: <p>If your package makes use of the platform-independent library
1.87 wiz 8516: for loading dynamic shared objects, that comes with libtool
8517: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8518: <p>Some packages use libtool incorrectly so that the package
8519: may not work or build in some circumstances. Some of the more
8520: common errors are:</p>
1.148 asau 8521: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8522: <li class="listitem">
1.75 rillig 8523: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8524: executable or library. This in itself isn't a problem if one of two things
8525: has been done:</p>
1.128 wiz 8526: <div class="orderedlist"><ol class="orderedlist" type="1">
8527: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8528: <code class="filename">libfoo.la</code>, not
8529: <code class="filename">foo.la</code></p></li>
1.128 wiz 8530: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8531: </ol></div>
8532: </li>
1.128 wiz 8533: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8534: The function lt_dlinit() should be called and the macro
8535: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8536: executables.</p></li>
1.75 rillig 8537: </ul></div>
8538: </div>
1.148 asau 8539: <div class="sect2">
1.75 rillig 8540: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8541: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8542: <p>If a package needs GNU autoconf or automake to be executed
1.338 nia 8543: to regenerate the
8544: <code class="filename">configure</code>
8545: script and <code class="filename">Makefile.in</code> makefile
8546: templates from <code class="filename">configure.ac</code> and
8547: <code class="filename">Makefile.am</code>,
8548: then they should be executed in a pre-configure target:</p>
1.75 rillig 8549: <pre class="programlisting">
1.338 nia 8550: USE_TOOLS+= autoconf automake autoreconf
8551: GNU_CONFIGURE= yes
1.100 rillig 8552: ...
1.1 grant 8553:
1.100 rillig 8554: pre-configure:
1.338 nia 8555: set -e; cd ${WRKSRC} && autoreconf -fi
1.100 rillig 8556: ...
1.222 sevan 8557: </pre>
1.338 nia 8558: <p>Packages which use GNU Automake will sometimes
8559: require GNU Make (<code class="literal">gmake</code> in
8560: <code class="varname">USE_TOOLS</code>),
8561: but not always. Note that autoreconf
8562: only needs to be executed if <code class="filename">configure.ac</code>
8563: or Makefiles are modified, or <code class="filename">configure</code>
8564: is not present.</p>
1.75 rillig 8565: <p>There are times when the configure process makes
1.87 wiz 8566: additional changes to the generated files, which then causes
8567: the build process to try to re-execute the automake sequence.
8568: This is prevented by touching various files in the configure
8569: stage. If this causes problems with your package you can set
8570: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8571: Makefile.</p>
1.75 rillig 8572: </div>
1.338 nia 8573: <div class="sect2">
8574: <div class="titlepage"><div><div><h3 class="title">
8575: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
8576: <p>Packages using Meson to configure need to include:
8577:
8578: </p>
8579: <pre class="programlisting">
8580: .include "../../devel/meson/build.mk"
8581: </pre>
8582: <p>In nearly all cases (any program with dependencies),
8583: pkg-config needs to be added to
8584: <code class="varname">USE_TOOLS</code>. If the package installs
8585: translation files for non-English languages, also
8586: add msgfmt and xgettext:
8587:
8588: </p>
8589: <pre class="programlisting">
8590: USE_TOOLS+= pkg-config msgfmt xgettext
8591: </pre>
8592: <p>If any options need to be passed to Meson, use
8593: <code class="varname">MESON_ARGS</code> instead of
8594: <code class="varname">CONFIGURE_ARGS</code>:
8595:
8596: </p>
8597: <pre class="programlisting">
8598: MESON_ARGS+= -Dx11=false
8599: </pre>
8600: </div>
1.75 rillig 8601: </div>
1.148 asau 8602: <div class="sect1">
1.75 rillig 8603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8604: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148 asau 8605: <div class="sect2">
1.87 wiz 8606: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8607: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.358 gutterid 8608: <p>Compilers for the C and C++ languages come with
1.87 wiz 8609: the NetBSD base system. By default, pkgsrc assumes that a package
8610: is written in C and will hide all other compilers (via the wrapper
1.299 rillig 8611: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.357 gutterid 8612: <p>To declare which languages should be made available through
8613: pkgsrc's compiler wrappers, use
1.87 wiz 8614: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.327 wiz 8615: currently are:
1.352 wiz 8616: </p>
1.327 wiz 8617: <pre class="programlisting">
1.358 gutterid 8618: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.352 wiz 8619: </pre>
1.327 wiz 8620: <p>
8621: (and any combination). The default is
1.128 wiz 8622: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8623: written in C++, usually need a C compiler for the configure
1.358 gutterid 8624: phase.</p>
1.364 jnemeth 8625: <p>To declare which features a package requires from the
1.357 gutterid 8626: compiler, set either <code class="varname">USE_CC_FEATURES</code>
8627: or <code class="varname">USE_CXX_FEATURES</code>. Allowed values for
8628: <code class="varname">USE_CC_FEATURES</code> are currently:
8629: </p>
8630: <pre class="programlisting">
8631: c11, c99, has_include
8632: </pre>
8633: <p>
8634: Allowed values for <code class="varname">USE_CXX_FEATURES</code> are
8635: currently:
8636: </p>
8637: <pre class="programlisting">
8638: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
8639: charconv, parallelism_ts, unique_ptr, put_time,
8640: is_trivially_copy_constructible
8641: </pre>
8642: <p>
1.365 gutterid 8643: Note at present these variables only affect use of GCC, not other
8644: compilers.
1.357 gutterid 8645: </p>
1.358 gutterid 8646: <p>Language variants like <code class="literal">gnu99</code> and
8647: <code class="literal">c++11</code> can be specified in <code class="varname">FORCE_C_STD</code>
8648: and <code class="varname">FORCE_CXX_STD</code> if the package does not explicitly set
8649: <code class="literal">-std=...</code> when compiling (i.e. the package
8650: assumes the compiler defaults to C++11 or some other standard).
8651: This is a common bug in upstream build systems.</p>
8652: <p>Allowed values for <code class="varname">FORCE_C_STD</code> are
8653: currently:
8654: </p>
8655: <pre class="programlisting">
8656: c90, c99, c11, gnu90, gnu99, gnu11
8657: </pre>
8658: <p>
8659: </p>
8660: <p>Allowed values for <code class="varname">FORCE_CXX_STD</code> are
8661: currently:
8662: </p>
8663: <pre class="programlisting">
8664: c++03, c++11, c++14, c++17, c++20,
8665: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
8666: </pre>
8667: <p>
1.365 gutterid 8668: Note at present these variables only affect use of GCC and Clang.
1.358 gutterid 8669: </p>
1.87 wiz 8670: </div>
1.148 asau 8671: <div class="sect2">
1.87 wiz 8672: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8673: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87 wiz 8674: <p>If a program is written in Java, use the Java framework in
8675: pkgsrc. The package must include
8676: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8677: provides the following variables:</p>
1.148 asau 8678: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8679: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8680: dependency on the JDK is added. If
1.128 wiz 8681: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8682: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8683: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8684: JDK.</p></li>
1.128 wiz 8685: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8686: a package needs a Java2 implementation. The supported values
1.128 wiz 8687: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8688: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8689: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8690: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8691: above. This variable is not set by default.</p></li>
1.130 wiz 8692: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8693: automatically set to the runtime location of the used Java
8694: implementation dependency. It may be used to set
8695: <code class="varname">JAVA_HOME</code> to a good value if the program
8696: needs this variable to be defined.
8697: </p></li>
1.87 wiz 8698: </ul></div>
8699: </div>
1.148 asau 8700: <div class="sect2">
1.87 wiz 8701: <div class="titlepage"><div><div><h3 class="title">
1.320 wiz 8702: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
8703: <p>If a program is written in Go and has any dependencies on
8704: other Go modules, have the package include
8705: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8706: <div class="orderedlist"><ol class="orderedlist" type="1">
8707: <li class="listitem"><p>Generate a list of those dependencies with
8708: <span class="command"><strong>make clean && make patch && make show-go-modules >
8709: go-modules.mk</strong></span>.</p></li>
1.338 nia 8710: <li class="listitem"><p>Prepend
8711: <code class="literal">.include "go-modules.mk"</code> to any other
8712: <code class="literal">.include</code>s.</p></li>
8713: <li class="listitem"><p>Incorporate these modules in
8714: <code class="filename">distinfo</code> with <span class="command"><strong>make
8715: makesum</strong></span>.</p></li>
8716: </ol></div>
8717: </div>
8718: <div class="sect2">
8719: <div class="titlepage"><div><div><h3 class="title">
8720: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
8721: <p>If a program is written in Rust and uses Cargo to build,
8722: have the package include
8723: <code class="filename">../../lang/rust/cargo.mk</code>.</p>
8724: <div class="orderedlist"><ol class="orderedlist" type="1">
8725: <li class="listitem"><p>Generate a list of those dependencies with
8726: <span class="command"><strong>make CARGO_ARGS="build --release" build &&
8727: make print-cargo-depends > cargo-depends.mk</strong></span>.</p></li>
8728: <li class="listitem"><p>Prepend
8729: <code class="literal">.include "cargo-depends.mk"</code> to any other
8730: <code class="literal">.include</code>s.</p></li>
1.320 wiz 8731: <li class="listitem"><p>Incorporate these modules in
8732: <code class="filename">distinfo</code> with <span class="command"><strong>make
8733: makesum</strong></span>.</p></li>
8734: </ol></div>
8735: </div>
8736: <div class="sect2">
8737: <div class="titlepage"><div><div><h3 class="title">
1.338 nia 8738: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.318 nia 8739: <p>If your package contains interpreted Perl scripts, add
1.128 wiz 8740: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8741: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8742: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8743: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8744: that you want adjusted. Every occurrence of
8745: <code class="filename">*/bin/perl</code> in a she-bang line will be
1.325 gutterid 8746: replaced with the full path to the Perl executable.</p>
8747: <p>If a particular version of Perl is needed, set the
1.87 wiz 8748: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8749: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.318 nia 8750: <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.325 gutterid 8751: about handling Perl modules.</p>
8752: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
8753: for the language now known as Raku.</p>
1.87 wiz 8754: </div>
1.148 asau 8755: <div class="sect2">
1.87 wiz 8756: <div class="titlepage"><div><div><h3 class="title">
1.338 nia 8757: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.147 wiz 8758: <p><code class="varname">REPLACE_SH</code>,
8759: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8760: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.340 gutterid 8761: she-bangs in files. Please use the appropriate one, preferring
8762: <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.183 wiz 8763: Each should contain a list of scripts, relative to
8764: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8765: occurrence of the matching shell in a she-bang line will be
8766: replaced with the full path to the shell executable.
1.147 wiz 8767: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8768: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8769: </div>
1.148 asau 8770: <div class="sect2">
1.147 wiz 8771: <div class="titlepage"><div><div><h3 class="title">
1.338 nia 8772: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.325 gutterid 8773: <p>There are further similar REPLACE variables available, e.g.,
8774: <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
8775: and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.326 gutterid 8776: noted above, have their actions defined centrally in
1.325 gutterid 8777: <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.326 gutterid 8778: languages define the actions of these variables within their own
8779: dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
1.359 gutterid 8780: actioned in <code class="filename">lang/php/replace.mk</code>, and
1.326 gutterid 8781: <code class="varname">REPLACE_PYTHON</code> is actioned in
1.325 gutterid 8782: <code class="filename">lang/python/application.mk</code>. For other languages,
8783: consult the mk files found within their specific directories (the
1.331 gutterid 8784: naming convention varies), or check the list found in
8785: <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.325 gutterid 8786: <p>Currently, special handling for other languages varies
1.87 wiz 8787: in pkgsrc. If a compiler package provides a
8788: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8789: just add a (build) dependency on the appropriate compiler
8790: package.</p>
8791: </div>
8792: </div>
1.148 asau 8793: <div class="sect1">
1.87 wiz 8794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8795: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8796: <p>The most common failures when building a package are that
8797: some platforms do not provide certain header files, functions or
8798: libraries, or they provide the functions in a library that the
8799: original package author didn't know. To work around this, you
8800: can rewrite the source code in most cases so that it does not
8801: use the missing functions or provides a replacement function.</p>
1.148 asau 8802: <div class="sect2">
1.77 rillig 8803: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8804: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8805: <p>If a package already comes with a GNU configure script, the
8806: preferred way to fix the build failure is to change the
8807: configure script, not the code. In the other cases, you can
8808: utilize the C preprocessor, which defines certain macros
8809: depending on the operating system and hardware architecture it
8810: compiles for. These macros can be queried using for example
8811: <code class="varname">#if defined(__i386)</code>. Almost every operating
8812: system, hardware architecture and compiler has its own macro.
8813: For example, if the macros <code class="varname">__GNUC__</code>,
8814: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8815: are all defined, you know that you are using NetBSD on an i386
8816: compatible CPU, and your compiler is GCC.</p>
8817: <p>The list of the following macros for hardware and
8818: operating system depends on the compiler that is used. For
8819: example, if you want to conditionally compile code on Solaris,
8820: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8821: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8822: <div class="sect3">
1.75 rillig 8823: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8824: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.338 nia 8825: <p>To distinguish between specific NetBSD versions,
8826: you should use the following code.</p>
8827: <pre class="programlisting">
8828: #ifdef __NetBSD__
8829: #include <sys/param.h>
8830: #if __NetBSD_Prereq__(9,99,17)
8831: /* use a newer feature */
8832: #else
8833: /* older code */
8834: #endif
8835: #endif
8836:
8837: #ifndef _WIN32
8838: /* Unix-like specific code */
8839: #endif
8840: </pre>
1.75 rillig 8841: <p>To distinguish between 4.4 BSD-derived systems and the
8842: rest of the world, you should use the following code.</p>
8843: <pre class="programlisting">
1.100 rillig 8844: #include <sys/param.h>
8845: #if (defined(BSD) && BSD >= 199306)
8846: /* BSD-specific code goes here */
8847: #else
8848: /* non-BSD-specific code goes here */
8849: #endif
1.75 rillig 8850: </pre>
1.338 nia 8851: <p>You can also test for the following macros:</p>
1.75 rillig 8852: <pre class="programlisting">
1.151 obache 8853: Cygwin __CYGWIN__
8854: DragonFly __DragonFly__
1.100 rillig 8855: FreeBSD __FreeBSD__
1.151 obache 8856: Haiku __HAIKU__
1.100 rillig 8857: Interix __INTERIX
8858: IRIX __sgi (TODO: get a definite source for this)
1.338 nia 8859: Linux __linux
1.193 dholland 8860: Mac OS X __APPLE__
1.151 obache 8861: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8862: Minix3 __minix
1.100 rillig 8863: NetBSD __NetBSD__
8864: OpenBSD __OpenBSD__
8865: Solaris sun, __sun
1.75 rillig 8866: </pre>
8867: </div>
1.148 asau 8868: <div class="sect3">
1.75 rillig 8869: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8870: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75 rillig 8871: <pre class="programlisting">
1.100 rillig 8872: i386 i386, __i386, __i386__
1.338 nia 8873: x86-64 __amd64__, __x86_64__
8874: ARM __arm__
1.100 rillig 8875: MIPS __mips
8876: SPARC sparc, __sparc
1.338 nia 8877: PowerPC __powerpc
1.75 rillig 8878: </pre>
8879: </div>
1.148 asau 8880: <div class="sect3">
1.75 rillig 8881: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8882: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75 rillig 8883: <pre class="programlisting">
1.100 rillig 8884: GCC __GNUC__ (major version), __GNUC_MINOR__
8885: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8886: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8887: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8888: </pre>
8889: </div>
8890: </div>
1.148 asau 8891: <div class="sect2">
1.78 rillig 8892: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8893: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8894: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8895: combinations of compiler version and architecture and almost
8896: always relation to optimisation being enabled. Common symptoms
8897: are gcc internal errors or never finishing compiling a
1.78 rillig 8898: file.</p>
8899: <p>Typically, a workaround involves testing the
8900: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8901: optimisation for that combination of file,
1.198 tnn 8902: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8903: <p>This used to be a big problem in the past, but is rarely
8904: needed now as compiler technology has matured. If you still need
8905: to add a compiler specific workaround, please do so in the file
8906: <code class="filename">hacks.mk</code> and describe the symptom and
8907: compiler version as detailed as possible.</p>
1.78 rillig 8908: </div>
1.148 asau 8909: <div class="sect2">
1.78 rillig 8910: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 8911: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8912: <p>Compilation sometimes fails with an error message like this:</p>
8913: <pre class="programlisting">
8914: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8915: fatal error: pango/pango.h: No such file or directory
8916: </pre>
8917: <p>The proper way to fix this problem depends on the type of the
8918: header, which is described in the following sections.</p>
8919: <div class="sect3">
8920: <div class="titlepage"><div><div><h4 class="title">
8921: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8922: <p>If the header name looks like it comes from a different package,
8923: that other package should be included via the buildlink3
8924: framework.</p>
8925: <p>First, look whether the header is somewhere in the buildlink3
8926: directory below <code class="varname">WRKDIR</code>. In the above case of
8927: the missing Pango header:</p>
8928: <pre class="programlisting">
8929: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8930: </pre>
8931: <p>In the case of Pango, the output is:</p>
8932: <pre class="programlisting">
8933: work/.buildlink/include/pango-1.0/pango/pango.h
8934: </pre>
8935: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8936: in the <code class="filename">.buildlink</code> directory, it would have been
8937: found automatically. There is an extra <code class="filename">pango-1.0</code>
8938: path component though, which means that the compiler command line must
8939: contain an option of the form
8940: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8941: most cases this option is generated by the configure script, which can be examined using:</p>
8942: <pre class="programlisting">
8943: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8944: -I/usr/pkg/include/pango-1.0
8945: -I/usr/pkg/include/pango-1.0
8946: -I/usr/pkg/include/pango-1.0
8947: -I/usr/pkg/include/pango-1.0
8948: -I/usr/pkg/include/pango-1.0
8949: </pre>
8950: <p>This looks good. These options are transformed by the buildlink
8951: wrapper to refer to the correct path inside
8952: <code class="filename">work/.buildlink</code>.</p>
8953: <p>Since the compilation fails though, examine the compiler command
8954: lines in <code class="filename">work/.work.log</code> to see whether the
8955: <code class="literal">-I</code> option is included in the particular command
8956: line.</p>
8957: <p>To further analyze the situation, run <span class="command"><strong>bmake
8958: build-env</strong></span>, which sets up an interactive, realistic environment
8959: including all the pkgsrc wrapper commands and environment variables. From
8960: there, try to compile some simple example programs that use the
8961: header.</p>
8962: </div>
8963: <div class="sect3">
8964: <div class="titlepage"><div><div><h4 class="title">
8965: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8966: <p>If the name of the header seems to come from the package itself,
8967: and if the build is run with parallel jobs, the package may have some
8968: undeclared dependencies between the <code class="filename">.c</code> and the
8969: <code class="filename">.h</code> files, and a C file is compiled before its
8970: required header is generated.</p>
8971: <p>To see whether the build runs with parallel jobs, run
8972: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8973: like this:</p>
8974: <pre class="programlisting">
8975: usr MAKE_JOBS= 7
8976: pkg MAKE_JOBS_SAFE # undefined
8977: def _MAKE_JOBS_N= 7
8978: </pre>
8979: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8980: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8981: package could have disabled parallel builds by setting
8982: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8983: in this case it hasn't.</p>
8984: <p>To see whether the build failure is caused by parallel builds,
8985: first save the exact error message and a bit of context, maybe you need
8986: it later for reporting a bug. Next, run:</p>
8987: <pre class="programlisting">
8988: MAKE_JOBS_SAFE=no bmake clean build
8989: </pre>
8990: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8991: report</a> against the pkgsrc package, including the exact error
8992: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8993: </div>
1.288 rillig 8994: <div class="sect3">
8995: <div class="titlepage"><div><div><h4 class="title">
8996: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
8997: <p>Pkgsrc does not work reliably if any of
8998: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
8999: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
9000: bootstrap program prevents installing pkgsrc in symlink-based
9001: directories. Existing pkgsrc installations are not checked for symlinks
9002: though.</p>
9003: <p>The "No such file or directory" error messages are a typical
9004: symptom of symlinks, and it's quite difficult to find out that this is
9005: the actual cause.</p>
9006: </div>
9007: <div class="sect3">
9008: <div class="titlepage"><div><div><h4 class="title">
9009: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
9010: <p>When building a hierarchy of packages, it may happen that one
9011: package is built and then pkgsrc is updated. This situation can provoke
9012: various hard to diagnose build errors. To clean up the situation:</p>
9013: <pre class="programlisting">
1.338 nia 9014: <code class="prompt">$</code> (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.288 rillig 9015: </pre>
1.338 nia 9016: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
9017: prevent running this command in the wrong directory.)</p>
1.288 rillig 9018: <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
9019: that directory as well.</p>
9020: </div>
9021: <div class="sect3">
9022: <div class="titlepage"><div><div><h4 class="title">
9023: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
9024: <p>On platforms other than BSD, third-party packages are installed in
9025: <code class="filename">/usr/include</code>, together with the base system. This
9026: means that pkgsrc cannot distinguish between headers provided by the base
9027: system (which it needs) and headers from third-party packages (which are
9028: often included in pkgsrc as well). This can lead to subtle version
9029: mismatches.</p>
9030: <p>In pkgsrc installations that have been active for several years, it
9031: may happen that some files are manually deleted. To exclude this unlikely
9032: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
9033: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
9034: check/fix dependencies.</p>
9035: <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>
9036: for contact information. Be prepared to describe what you have tried so
9037: far and what any error messages were.</p>
9038: </div>
1.287 rillig 9039: </div>
9040: <div class="sect2">
9041: <div class="titlepage"><div><div><h3 class="title">
9042: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.128 wiz 9043: </h3></div></div></div>
1.92 rillig 9044: <p>This error message often means that a package did not
1.78 rillig 9045: link to a shared library it needs. The following functions are
9046: known to cause this error message over and over.</p>
9047: <div class="informaltable">
1.216 tnn 9048: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78 rillig 9049: <colgroup>
9050: <col>
9051: <col>
9052: <col>
9053: </colgroup>
9054: <thead><tr>
9055: <th>Function</th>
9056: <th>Library</th>
9057: <th>Affected platforms</th>
9058: </tr></thead>
9059: <tbody>
9060: <tr>
9061: <td>accept, bind, connect</td>
9062: <td>-lsocket</td>
9063: <td>Solaris</td>
9064: </tr>
9065: <tr>
9066: <td>crypt</td>
9067: <td>-lcrypt</td>
9068: <td>DragonFly, NetBSD</td>
9069: </tr>
9070: <tr>
9071: <td>dlopen, dlsym</td>
9072: <td>-ldl</td>
9073: <td>Linux</td>
9074: </tr>
9075: <tr>
9076: <td>gethost*</td>
9077: <td>-lnsl</td>
9078: <td>Solaris</td>
9079: </tr>
9080: <tr>
9081: <td>inet_aton</td>
9082: <td>-lresolv</td>
9083: <td>Solaris</td>
9084: </tr>
9085: <tr>
9086: <td>nanosleep, sem_*, timer_*</td>
9087: <td>-lrt</td>
9088: <td>Solaris</td>
9089: </tr>
9090: <tr>
9091: <td>openpty</td>
9092: <td>-lutil</td>
9093: <td>Linux</td>
9094: </tr>
9095: </tbody>
9096: </table>
9097: </div>
1.338 nia 9098: <p>To fix these linker errors, it is often sufficient to add
1.87 wiz 9099: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
9100: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.338 nia 9101: <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.87 wiz 9102: bmake</strong></span>.</p>
1.148 asau 9103: <div class="sect3">
1.92 rillig 9104: <div class="titlepage"><div><div><h4 class="title">
1.338 nia 9105: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.92 rillig 9106: <p>When you are using the SunPro compiler, there is another
9107: possibility. That compiler cannot handle the following code:</p>
9108: <pre class="programlisting">
1.100 rillig 9109: extern int extern_func(int);
1.93 rillig 9110:
1.100 rillig 9111: static inline int
9112: inline_func(int x)
9113: {
1.92 rillig 9114: return extern_func(x);
1.100 rillig 9115: }
1.93 rillig 9116:
1.100 rillig 9117: int main(void)
9118: {
1.92 rillig 9119: return 0;
1.100 rillig 9120: }
1.92 rillig 9121: </pre>
9122: <p>It generates the code for <code class="function">inline_func</code> even if
9123: that function is never used. This code then refers to
9124: <code class="function">extern_func</code>, which can usually not be resolved. To
9125: solve this problem you can try to tell the package to disable inlining
9126: of functions.</p>
9127: </div>
1.343 gutterid 9128: <div class="sect3">
9129: <div class="titlepage"><div><div><h4 class="title">
9130: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
9131: <p>When building for older machine architectures (e.g., i386, PowerPC),
9132: builds may fail because the package expects modern 64-bit atomic functions
9133: which the underlying hardware either doesn't support, or will only support
9134: with specific compiler flags. This is generally handled via inclusion of
9135: mk/atomic64.mk.</p>
9136: </div>
1.87 wiz 9137: </div>
1.148 asau 9138: <div class="sect2">
1.87 wiz 9139: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 9140: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87 wiz 9141: <p>Sometimes packages fail to build because the compiler runs
9142: into an operating system specific soft limit. With the
9143: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.338 nia 9144: to unlimit the resources. The allowed values are any combination of
9145: <span class="quote">“<span class="quote">cputime</span>”</span>,
9146: <span class="quote">“<span class="quote">datasize</span>”</span>,
9147: <span class="quote">“<span class="quote">memorysize</span>”</span>,
9148: <span class="quote">“<span class="quote">stacksize</span>”</span> and
9149: <span class="quote">“<span class="quote">virtualsize</span>”</span>.
1.87 wiz 9150: Setting this variable is similar to running the shell builtin
1.110 hubertf 9151: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 9152: segment size or maximum stack size of a process, respectively, to
9153: their hard limits.</p>
1.78 rillig 9154: </div>
1.75 rillig 9155: </div>
1.148 asau 9156: <div class="sect1">
1.75 rillig 9157: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9158: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 9159: <div class="sect2">
1.75 rillig 9160: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9161: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 9162: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 9163: with some operating systems cannot create more than one
9164: directory at a time. As such, you should call
9165: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
9166: <pre class="programlisting">
1.100 rillig 9167: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
9168: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222 sevan 9169: </pre>
1.338 nia 9170: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
9171: directly, you can also append <span class="quote">“<span class="quote"><code class="literal">dir1
9172: dir2</code></span>”</span> to the <code class="varname">INSTALLATION_DIRS</code>
9173: variable, which will automatically do the right thing.</p>
1.75 rillig 9174: </div>
1.148 asau 9175: <div class="sect2">
1.75 rillig 9176: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9177: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 9178: <p>In general, documentation should be installed into
1.87 wiz 9179: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.338 nia 9180: <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.87 wiz 9181: includes the version number of the package).</p>
1.84 wiz 9182: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 9183: directory where HTML documentation is installed with the
1.338 nia 9184: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag is
9185: needed because otherwise the documentation ends up in
9186: <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
9187: pkgsrc, the HTML documentation should go into the package-specific
9188: directory, just like any other documentation.</p>
1.87 wiz 9189: <p>An exception to the above is that library API documentation
1.322 leot 9190: 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.87 wiz 9191: browsers (devhelp) should be left at their default location, which
9192: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
9193: documentation can be recognized from files ending in
9194: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
9195: (It is also acceptable to install such files in
9196: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
9197: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
9198: <code class="filename">.devhelp*</code> file must be directly in that
9199: directory then, no additional subdirectory level is allowed in
9200: this case. This is usually achieved by using
1.128 wiz 9201: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 9202: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
9203: though.)</p>
1.75 rillig 9204: </div>
1.148 asau 9205: <div class="sect2">
1.75 rillig 9206: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9207: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 9208: <p>Certain packages, most of them in the games category, install
1.87 wiz 9209: a score file that allows all users on the system to record their
9210: highscores. In order for this to work, the binaries need to be
9211: installed setgid and the score files owned by the appropriate
1.142 wiz 9212: group and/or owner (traditionally the "games" user/group). Set
9213: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 9214: following variables, documented in more detail in
9215: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 9216: behaviour: <code class="varname">GAMEDATAMODE</code>,
9217: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210 leot 9218: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
9219: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
9220: <code class="varname">GAMEDATA_PERMS</code> and
9221: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
9222: <p>An example that illustrates some of the variables described above is
9223: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
9224: used to properly set directory permissions of the directory where the
9225: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
9226: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
9227: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
9228: binary:</p>
9229: <pre class="programlisting">
1.223 rillig 9230: USE_GAMESGROUP= yes
1.210 leot 9231:
1.223 rillig 9232: BUILD_DEFS+= VARBASE
1.210 leot 9233:
1.223 rillig 9234: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
9235: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
9236: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222 sevan 9237: </pre>
1.210 leot 9238: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
9239: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
9240: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
9241: needed to be accessed by setgid games and
9242: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114 jmcneill 9243: <p>A package should therefore never hard code file ownership or
1.210 leot 9244: access permissions but rely on <code class="varname">*_PERMS</code> as described above
9245: or alternatively on <code class="varname">INSTALL_GAME</code>,
9246: <code class="varname">INSTALL_GAME_DATA</code> and
9247: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75 rillig 9248: </div>
1.148 asau 9249: <div class="sect2">
1.75 rillig 9250: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9251: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 9252: <p><code class="varname">DESTDIR</code> support means that a package
9253: installs into a staging directory, not the final location of the
9254: files. Then a binary package is created which can be used for
9255: installation as usual. There are two ways: Either the package must
1.128 wiz 9256: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9257: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 9258: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9259: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224 leot 9260: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
9261: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145 wiz 9262: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9263: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 9264: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9265: the inclusion.</p></li>
1.128 wiz 9266: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 9267: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 9268: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 9269: automatically. Many manual rules and pre/post-install often are
9270: incorrect; fix them.</p></li>
1.128 wiz 9271: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 9272: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 9273: <li class="listitem"><p>In general, packages should support
1.103 wiz 9274: <code class="varname">UNPRIVILEGED</code> to be able to use
9275: DESTDIR.</p></li>
9276: </ul></div>
9277: </div>
1.148 asau 9278: <div class="sect2">
1.103 wiz 9279: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9280: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 9281: <p>Your package may also contain scripts with hardcoded paths to
1.318 nia 9282: other interpreters besides (or as well as) Perl. To correct the
1.87 wiz 9283: full pathname to the script interpreter, you need to set the
9284: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 9285: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 9286: <pre class="programlisting">
1.100 rillig 9287: REPLACE_INTERPRETER+= tcl
9288: REPLACE.tcl.old= .*/bin/tclsh
9289: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9290: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9291: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222 sevan 9292: </pre>
1.75 rillig 9293: </div>
1.148 asau 9294: <div class="sect2">
1.75 rillig 9295: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9296: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.75 rillig 9297: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 9298: the Makefile fragment
9299: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 9300: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 9301: configuration for such modules as well as various hooks to tune
9302: this configuration. See comments in this file for
9303: details.</p>
1.75 rillig 9304: <p>Perl5 modules will install into different places depending
1.87 wiz 9305: on the version of perl used during the build process. To
9306: address this, pkgsrc will append lines to the
9307: <code class="filename">PLIST</code> corresponding to the files listed in
9308: the installed <code class="filename">.packlist</code> file generated by
9309: most perl5 modules. This is invoked by defining
9310: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 9311: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9312: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9313: e.g.:</p>
1.75 rillig 9314: <pre class="programlisting">
1.153 wiz 9315: PERL5_PACKLIST= auto/Pg/.packlist
1.222 sevan 9316: </pre>
1.153 wiz 9317: <p>The perl5 config variables
9318: <code class="varname">installarchlib</code>,
9319: <code class="varname">installscript</code>,
9320: <code class="varname">installvendorbin</code>,
9321: <code class="varname">installvendorscript</code>,
9322: <code class="varname">installvendorarch</code>,
9323: <code class="varname">installvendorlib</code>,
9324: <code class="varname">installvendorman1dir</code>, and
9325: <code class="varname">installvendorman3dir</code> represent those
9326: locations in which components of perl5 modules may be installed,
9327: provided as variable with uppercase and prefixed with
9328: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9329: and may be used by perl5 packages that don't have a packlist.
9330: These variables are also substituted for in the
9331: <code class="filename">PLIST</code> as uppercase prefixed with
9332: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 9333: </div>
1.148 asau 9334: <div class="sect2">
1.75 rillig 9335: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9336: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 9337: <p>Some packages install info files or use the
1.128 wiz 9338: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 9339: commands. <code class="varname">INFO_FILES</code> should be defined in
9340: the package Makefile so that <code class="filename">INSTALL</code> and
9341: <code class="filename">DEINSTALL</code> scripts will be generated to
9342: handle registration of the info files in the Info directory
1.128 wiz 9343: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 9344: files registration is either provided by the system, or by a
9345: special purpose package automatically added as dependency if
9346: needed.</p>
1.75 rillig 9347: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 9348: <code class="filename">${PREFIX}</code> where info files are primarily
9349: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 9350: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 9351: <p>The info files for the package should be listed in the
1.87 wiz 9352: package <code class="filename">PLIST</code>; however any split info files
9353: need not be listed.</p>
1.128 wiz 9354: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9355: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 9356: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 9357: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 9358: should be noted with the <code class="varname">TEXINFO_REQD</code>
9359: variable in the package <code class="filename">Makefile</code>. By
9360: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 9361: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 9362: does not match the required minimum, a build dependency on the
1.322 leot 9363: <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.87 wiz 9364: be added automatically.</p>
1.75 rillig 9365: <p>The build and installation process of the software provided
1.87 wiz 9366: by the package should not use the
1.110 hubertf 9367: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 9368: info files is the task of the package
9369: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 9370: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 9371: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 9372: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9373: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 9374: in <code class="varname">PATH</code>.</p>
1.110 hubertf 9375: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 9376: no effect except the logging of a message. The script overriding
1.110 hubertf 9377: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 9378: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 9379: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 9380: </div>
1.148 asau 9381: <div class="sect2">
1.75 rillig 9382: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9383: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 9384: <p>All packages that install manual pages should install them
1.87 wiz 9385: into the same directory, so that there is one common place to look
9386: for them. In pkgsrc, this place is
9387: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9388: should be used in packages. The default for
9389: <code class="varname">PKGMANDIR</code> is
1.128 wiz 9390: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9391: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 9392: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9393: <h3 class="title">Note</h3>
1.87 wiz 9394: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9395: is far from complete.</p>
1.75 rillig 9396: </div>
1.81 rillig 9397: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 9398: <code class="filename">man/</code> as the top level directory for the man
9399: page file entries, and the pkgsrc framework will convert as
9400: needed. In all other places, the correct
9401: <code class="varname">PKGMANDIR</code> must be used.</p>
9402: <p>Packages that are
9403: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 9404: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 9405: <code class="filename">./configure</code>
9406: --mandir switch to set where the man pages should be installed.
9407: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9408: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9409: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9410: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 9411: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 9412: Or if the <code class="filename">./configure</code> script uses
9413: a non-standard use of --mandir, you can set
9414: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299 rillig 9415: <p>See <a class="xref" href="#manpage-compression" title="19.5. Man page compression">Section 19.5, “Man page compression”</a> for
1.87 wiz 9416: information on installation of compressed manual pages.</p>
1.75 rillig 9417: </div>
1.148 asau 9418: <div class="sect2">
1.75 rillig 9419: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9420: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9421: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9422: the fonts database in the directory where they get installed at
9423: installation and deinstallation time. This can be automatically
9424: done by using the pkginstall framework.</p>
1.75 rillig 9425: <p>You can list the directories where fonts are installed in the
1.87 wiz 9426: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9427: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 9428: <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.87 wiz 9429: Also make sure that the database file
9430: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9431: <p>Note that you should not create new directories for fonts;
1.87 wiz 9432: instead use the standard ones to avoid that the user needs to
9433: manually configure his X server to find them.</p>
1.75 rillig 9434: </div>
1.148 asau 9435: <div class="sect2">
1.75 rillig 9436: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9437: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9438: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9439: registered in system-wide catalogs (like DTDs, sub-catalogs,
9440: etc.), you need to take some extra steps:</p>
1.128 wiz 9441: <div class="orderedlist"><ol class="orderedlist" type="1">
9442: <li class="listitem"><p>Include
1.87 wiz 9443: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9444: your <code class="filename">Makefile</code>, which takes care of
9445: registering those files in system-wide catalogs at
9446: installation and deinstallation time.</p></li>
1.128 wiz 9447: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9448: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9449: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9450: any XML catalogs installed by the package.</p></li>
1.128 wiz 9451: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9452: to be added to the SGML catalog. These come in groups of
9453: three strings; see xmlcatmgr(1) for more information
9454: (specifically, arguments recognized by the 'add' action).
9455: Note that you will normally not use this variable.</p></li>
1.128 wiz 9456: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9457: to be added to the XML catalog. These come in groups of three
9458: strings; see xmlcatmgr(1) for more information (specifically,
9459: arguments recognized by the 'add' action). Note that you will
9460: normally not use this variable.</p></li>
1.75 rillig 9461: </ol></div>
9462: </div>
1.148 asau 9463: <div class="sect2">
1.75 rillig 9464: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9465: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9466: <p>If a package provides extensions to the MIME database by
1.87 wiz 9467: installing <code class="filename">.xml</code> files inside
9468: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9469: need to take some extra steps to ensure that the database is kept
9470: consistent with respect to these new files:</p>
1.128 wiz 9471: <div class="orderedlist"><ol class="orderedlist" type="1">
9472: <li class="listitem"><p>Include
1.87 wiz 9473: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9474: (avoid using the <code class="filename">buildlink3.mk</code> file from
9475: this same directory, which is reserved for inclusion from
9476: other <code class="filename">buildlink3.mk</code> files). It takes
9477: care of rebuilding the MIME database at installation and
9478: deinstallation time, and disallows any access to it directly
9479: from the package.</p></li>
1.128 wiz 9480: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9481: <code class="filename">share/mime</code> directory,
9482: <span class="emphasis"><em>except</em></span> for files saved under
9483: <code class="filename">share/mime/packages</code>. The former are
9484: handled automatically by
9485: the update-mime-database program, but the latter are
9486: package-dependent and must be removed by the package that
9487: installed them in the first place.</p></li>
1.128 wiz 9488: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9489: from the PLIST. They will be handled by the shared-mime-info
9490: package.</p></li>
1.75 rillig 9491: </ol></div>
9492: </div>
1.148 asau 9493: <div class="sect2">
1.75 rillig 9494: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9495: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.93 rillig 9496: <p>If a package uses intltool during its build, add
9497: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9498: which forces it to use the intltool package provided by pkgsrc,
9499: instead of the one bundled with the distribution file.</p>
1.75 rillig 9500: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9501: latest available version; this way, the package benefits of any
9502: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9503: </div>
1.148 asau 9504: <div class="sect2">
1.75 rillig 9505: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9506: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9507: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9508: the startup directory by default, but you can enable it, by adding
9509: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9510: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9511: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9512: it will automatically remove the scripts when the package is
9513: deinstalled.</p>
1.75 rillig 9514: </div>
1.148 asau 9515: <div class="sect2">
1.75 rillig 9516: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9517: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9518: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9519: the <code class="filename">ls-R</code> database of the tree needs to be
9520: updated.</p>
1.148 asau 9521: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9522: <h3 class="title">Note</h3>
1.125 wiz 9523: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9524: packages should install files
1.125 wiz 9525: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9526: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9527: </div>
1.128 wiz 9528: <div class="orderedlist"><ol class="orderedlist" type="1">
9529: <li class="listitem"><p>Include
1.125 wiz 9530: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9531: takes care of rebuilding the <code class="filename">ls-R</code>
9532: database at installation and deinstallation time.</p></li>
1.128 wiz 9533: <li class="listitem">
1.75 rillig 9534: <p>If your package installs files into a texmf
1.87 wiz 9535: tree other than the one
1.125 wiz 9536: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9537: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9538: trees that need database update.</p>
1.75 rillig 9539: <p>If your package also installs font map files that need
1.110 hubertf 9540: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9541: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9542: set <code class="varname">TEX_MAP_FILES</code> and/or
9543: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9544: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9545: be run automatically at installation/deinstallation to
9546: enable/disable font map files for TeX output
9547: drivers.</p>
1.75 rillig 9548: </li>
1.128 wiz 9549: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9550: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9551: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9552: </ol></div>
9553: </div>
1.148 asau 9554: <div class="sect2">
1.85 jmmv 9555: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9556: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.87 wiz 9557: emulation</h3></div></div></div>
9558: <p>There are some packages that provide libraries and
9559: executables for running binaries from a one operating system
9560: on a different one (if the latter supports it). One example
9561: is running Linux binaries on NetBSD.</p>
1.322 leot 9562: <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.87 wiz 9563: helps in extracting and packaging Linux rpm packages.</p>
9564: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9565: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9566: if all libraries for each installed executable can be found by
9567: the dynamic linker. Since the standard dynamic linker is run,
9568: this fails for emulation packages, because the libraries used
9569: by the emulation are not in the standard directories.</p>
9570: </div>
1.299 rillig 9571: <div class="sect2">
9572: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9573: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.299 rillig 9574: <p>If a package installs images under the
9575: <code class="filename">share/icons/hicolor</code> and/or updates the
9576: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9577: database, you need to take some extra steps to make sure that the
9578: shared theme directory is handled appropriately and that the cache
9579: database is rebuilt:</p>
9580: <div class="orderedlist"><ol class="orderedlist" type="1">
9581: <li class="listitem"><p>Include
9582: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9583: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9584: entry that refers to the theme cache.</p></li>
9585: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9586: directories from the <code class="filename">share/icons/hicolor</code>
9587: hierarchy because they will be handled automatically.</p></li>
9588: </ol></div>
9589: <p>The best way to verify that the PLIST is correct with
9590: respect to the last two points is to regenerate it using
9591: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9592: </div>
9593: <div class="sect2">
9594: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9595: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.299 rillig 9596: <p>If a package installs <code class="filename">.desktop</code> files
9597: under <code class="filename">share/applications</code> and these include
9598: MIME information (MimeType key), you need to take extra steps to
9599: ensure that they are registered into the MIME database:</p>
9600: <div class="orderedlist"><ol class="orderedlist" type="1">
9601: <li class="listitem"><p>Include
9602: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9603: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9604: <code class="filename">share/applications/mimeinfo.cache</code> file.
9605: It will be handled automatically.</p></li>
9606: </ol></div>
9607: <p>The best way to verify that the PLIST is correct with
9608: respect to the last point is to regenerate it using <span class="command"><strong>make
9609: print-PLIST</strong></span>.</p>
9610: </div>
9611: </div>
9612: <div class="sect1">
9613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9614: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9615: <p>In some cases one does not have the time to solve a problem
9616: immediately. In this case, one can plainly mark a package as broken. For
9617: this, one just sets the variable <code class="varname">BROKEN</code> to the
9618: reason why the package is broken (similar to the
9619: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9620: the package will immediately be shown this message, and the build
9621: will not be even tried.</p>
9622: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9623: intervals.</p>
9624: </div>
9625: </div>
9626: <div class="chapter">
9627: <div class="titlepage"><div><div><h2 class="title">
9628: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9629: <div class="toc">
9630: <p><b>Table of Contents</b></p>
9631: <dl class="toc">
9632: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9633: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9634: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9635: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9636: </dl>
9637: </div>
9638: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9639: site</a>:</p>
9640: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9641: environment, an intuitive and attractive desktop for users, and the
9642: GNOME development platform, an extensive framework for building
9643: applications that integrate into the rest of the desktop.</p></blockquote></div>
9644: <p>pkgsrc provides a seamless way to automatically build and install
9645: a complete GNOME environment <span class="emphasis"><em>under many different
9646: platforms</em></span>. We can say with confidence that pkgsrc is one of
9647: the most advanced build and packaging systems for GNOME due to its
9648: included technologies buildlink3, the wrappers and tools framework and
9649: automatic configuration file management. Lots of efforts are put into
9650: achieving a completely clean deinstallation of installed software
9651: components.</p>
9652: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9653: the above also means that great efforts are put into making GNOME work
1.316 cirnatda 9654: under this operating system.</p>
1.299 rillig 9655: <p>This chapter is aimed at pkgsrc developers and other people
9656: interested in helping our GNOME porting and packaging efforts. It
9657: provides instructions on how to manage the existing packages and some
9658: important information regarding their internals.</p>
9659: <div class="sect1">
9660: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9661: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9662: <p>pkgsrc includes three GNOME-related meta packages:</p>
9663: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 9664: <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.299 rillig 9665: the core GNOME desktop environment. It only includes the necessary
9666: bits to get it to boot correctly, although it may lack important
9667: functionality for daily operation. The idea behind this package is
9668: to let end users build their own configurations on top of this one,
9669: first installing this meta package to achieve a functional setup and
9670: then adding individual applications.</p></li>
1.322 leot 9671: <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.299 rillig 9672: complete installation of the GNOME platform and desktop as defined
9673: by the GNOME project; this is based on the components distributed in
9674: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9675: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9676: official FTP server. Developer-only tools found in those
9677: directories are not installed unless required by some other
9678: component to work properly. Similarly, packages from the bindings
9679: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9680: in unless required as a dependency for an end-user component. This
1.322 leot 9681: 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>
9682: <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.299 rillig 9683: Installs all the tools required to build a GNOME component when
9684: fetched from the CVS repository. These are required to let the
9685: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9686: </ul></div>
9687: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9688: sorted in a way that eases updates: a package may depend on other
9689: packages listed before it but not on any listed after it. It is very
9690: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9691: change it to alphabetical sorting!</em></span></p>
9692: </div>
9693: <div class="sect1">
9694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9695: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9696: <p>Almost all GNOME applications are written in C and use a common
9697: set of tools as their build system. Things get different with the new
9698: bindings to other languages (such as Python), but the following will
9699: give you a general idea on the minimum required tools:</p>
9700: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9701: <li class="listitem">
9702: <p>Almost all GNOME applications use the GNU Autotools as their
9703: build system. As a general rule you will need to tell this to your
9704: package:</p>
9705: <pre class="programlisting">
1.338 nia 9706: GNU_CONFIGURE= yes
9707: USE_LIBTOOL= yes
9708: USE_TOOLS+= gmake
1.299 rillig 9709: </pre>
9710: </li>
9711: <li class="listitem">
9712: <p>If the package uses pkg-config to detect dependencies, add this
9713: tool to the list of required utilities:</p>
9714: <pre class="programlisting">
1.338 nia 9715: USE_TOOLS+= pkg-config
1.299 rillig 9716: </pre>
1.322 leot 9717: <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.299 rillig 9718: the end of the build process to ensure that you did not miss to
9719: specify any dependency in your package and that the version
9720: requirements are all correct.</p>
9721: </li>
9722: <li class="listitem"><p>If the package uses intltool, be sure to add
9723: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9724: to handle dependencies and to force the package to use the latest
9725: available version.</p></li>
9726: <li class="listitem">
9727: <p>If the package uses gtk-doc (a documentation generation
9728: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9729: tool is rather big and the distfile should come with pregenerated
9730: documentation anyway; if it does not, it is a bug that you ought to
9731: report. For such packages you should disable gtk-doc (unless it is
9732: the default):</p>
9733: <pre class="programlisting">
1.338 nia 9734: CONFIGURE_ARGS+= --disable-gtk-doc
1.299 rillig 9735: </pre>
9736: <p>The default location of installed HTML files
9737: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9738: and should not be changed unless the package insists on installing
9739: them somewhere else. Otherwise programs as
9740: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9741: do that with an entry similar to:</p>
9742: <pre class="programlisting">
1.338 nia 9743: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.299 rillig 9744: </pre>
9745: </li>
9746: </ul></div>
9747: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9748: files under the installation prefix to maintain databases. In this
9749: context, shared means that those exact same directories and files are
9750: used among several different packages, leading to conflicts in the
9751: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9752: handle the most common cases, so you have to forget about using
9753: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9754: omitting shared files from them. If you find yourself doing those,
9755: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9756: <p>The following table lists the common situations that result in
9757: using shared directories or files. For each of them, the appropriate
9758: solution is given. After applying the solution be sure to
9759: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9760: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9761: <div class="table">
9762: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9763: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9764: <colgroup>
9765: <col>
9766: <col>
9767: </colgroup>
9768: <thead><tr>
9769: <th>If the package...</th>
9770: <th>Then...</th>
9771: </tr></thead>
9772: <tbody>
9773: <tr>
9774: <td>Installs icons under the
9775: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9776: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.318 nia 9777: <td>See <a class="xref" href="#hicolor-theme" title="21.6.16. Packages installing hicolor icons">Section 21.6.16, “Packages installing hicolor icons”</a>.</td>
1.299 rillig 9778: </tr>
9779: <tr>
9780: <td>Installs files under
9781: <code class="filename">share/mime/packages</code>.</td>
1.318 nia 9782: <td>See <a class="xref" href="#mime-database" title="21.6.11. Packages installing extensions to the MIME database">Section 21.6.11, “Packages installing extensions to the MIME database”</a>.</td>
1.299 rillig 9783: </tr>
9784: <tr>
9785: <td>Installs <code class="filename">.desktop</code> files under
9786: <code class="filename">share/applications</code> and these include MIME
9787: information.</td>
1.318 nia 9788: <td>See <a class="xref" href="#desktop-files" title="21.6.17. Packages installing desktop files">Section 21.6.17, “Packages installing desktop files”</a>.</td>
1.299 rillig 9789: </tr>
9790: </tbody>
9791: </table></div>
1.75 rillig 9792: </div>
1.299 rillig 9793: <br class="table-break">
1.75 rillig 9794: </div>
1.148 asau 9795: <div class="sect1">
1.87 wiz 9796: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 9797: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9798: <p>When seeing GNOME as a whole, there are two kinds of
9799: updates:</p>
9800: <div class="variablelist"><dl class="variablelist">
9801: <dt><span class="term">Major update</span></dt>
9802: <dd>
9803: <p>Given that there is still a very long way for GNOME 3 (if it
9804: ever appears), we consider a major update one that goes from a
9805: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9806: where <code class="literal">Y</code> is even and greater than
9807: <code class="literal">X</code>. These are hard to achieve because they
9808: introduce lots of changes in the components' code and almost all
9809: GNOME distfiles are updated to newer versions. Some of them can
9810: even break API and ABI compatibility with the previous major
9811: version series. As a result, the update needs to be done all at
9812: once to minimize breakage.</p>
9813: <p>A major update typically consists of around 80 package
9814: updates and the addition of some new ones.</p>
9815: </dd>
9816: <dt><span class="term">Minor update</span></dt>
9817: <dd>
9818: <p>We consider a minor update one that goes from a
9819: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9820: one where <code class="literal">Y</code> is greater than
9821: <code class="literal">X</code>. These are easy to achieve because they do
9822: not update all GNOME components, can be done in an incremental way
9823: and do not break API nor ABI compatibility.</p>
9824: <p>A minor update typically consists of around 50 package
9825: updates, although the numbers here may vary a lot.</p>
9826: </dd>
9827: </dl></div>
9828: <p>In order to update the GNOME components in pkgsrc to a new stable
9829: release (either major or minor), the following steps should be
9830: followed:</p>
9831: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128 wiz 9832: <li class="listitem">
1.299 rillig 9833: <p>Get a list of all the tarballs that form the new release by
9834: using the following commands. These will leave the full list of the
9835: components' distfiles into the <code class="filename">list.txt</code>
9836: file:</p>
9837: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9838: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9839: awk '{ print $9 }' >list.txt</code></strong>
9840: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9841: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9842: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.75 rillig 9843: </li>
1.299 rillig 9844: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9845: bump their version to the release you are updating them to. The
9846: three meta packages should be always consistent with versioning.
9847: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9848: in them.</p></li>
1.128 wiz 9849: <li class="listitem">
1.299 rillig 9850: <p>For each meta package, update all its
9851: <code class="varname">DEPENDS</code> lines to match the latest versions as
9852: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9853: newer version (even if found in the FTP) because the meta packages
9854: are supposed to list the exact versions that form a specific GNOME
9855: release. Exceptions are permitted here if a newer version solves a
9856: serious issue in the overall desktop experience; these typically
9857: come in the form of a revision bump in pkgsrc, not in newer versions
9858: from the developers.</p>
9859: <p>Packages not listed in the <code class="filename">list.txt</code> file
9860: should be updated to the latest version available (if found in
9861: pkgsrc). This is the case, for example, of the dependencies on the
1.322 leot 9862: 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.75 rillig 9863: </li>
1.128 wiz 9864: <li class="listitem">
1.299 rillig 9865: <p>Generate a patch from the modified meta packages and extract the
9866: list of "new" lines. This will provide you an outline on what
9867: packages need to be updated in pkgsrc and in what order:</p>
9868: <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.75 rillig 9869: </li>
1.299 rillig 9870: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9871: installed packages and start over from scratch at this point.</p></li>
9872: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9873: of <code class="filename">todo.txt</code> and update the packages listed in
9874: it in order. For major desktop updates none of these should be
9875: committed until the entire set is completed because there are chances
9876: of breaking not-yet-updated packages.</p></li>
9877: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9878: the tree one by one with appropriate log messages. At the end,
9879: commit the three meta package updates and all the corresponding
9880: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9881: <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>
9882: </ol></div>
9883: </div>
9884: <div class="sect1">
9885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9886: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9887: <p>GNOME is a very big component in pkgsrc which approaches 100
9888: packages. Please, it is very important that you always, always,
9889: <span class="strong"><strong>always</strong></span> feed back any portability
9890: 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
9891: their attention on portability issues and to ensure that future versions
9892: can be built out-of-the box on NetBSD. The less custom patches in
9893: pkgsrc, the easier further updates are. Those developers in charge of
9894: issuing major GNOME updates will be grateful if you do that.</p>
1.315 cirnatda 9895: <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
9896: GitLab</a>. Not all components use these to track bugs, but most
1.299 rillig 9897: of them do. Do not be short on your reports: always provide detailed
9898: explanations of the current failure, how it can be improved to achieve
1.315 cirnatda 9899: maximum portability and, if at all possible, provide a patch against the
9900: main Git branch. The more verbose you are, the higher chances of your
9901: patch being accepted.</p>
1.299 rillig 9902: <p>Also, please avoid using preprocessor magic to fix portability
9903: issues. While the FreeBSD GNOME people are doing a great job in porting
9904: GNOME to their operating system, the official GNOME sources are now
9905: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9906: and similar macros. This hurts portability. Please see our patching
9907: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9908: details.</p>
9909: </div>
1.75 rillig 9910: </div>
1.148 asau 9911: <div class="chapter">
1.75 rillig 9912: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9913: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75 rillig 9914: <div class="toc">
9915: <p><b>Table of Contents</b></p>
1.210 leot 9916: <dl class="toc">
1.267 rillig 9917: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9918: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9919: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9920: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9921: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9922: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9923: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9924: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9925: </dl>
9926: </div>
1.148 asau 9927: <div class="sect1">
1.75 rillig 9928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9929: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9930: <p>Our policy is that we accept binaries only from pkgsrc
9931: developers to guarantee that the packages don't contain any
9932: trojan horses etc. This is not to annoy anyone but rather to
9933: protect our users! You're still free to put up your home-made
9934: binary packages and tell the world where to get them. NetBSD
9935: developers doing bulk builds and wanting to upload them please
1.267 rillig 9936: 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.174 asau 9937: builds)</i></a>.</p>
1.75 rillig 9938: </div>
1.148 asau 9939: <div class="sect1">
1.75 rillig 9940: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9941: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.333 nia 9942: <p>Firstly, you can import new packages into
9943: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
9944: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
9945: for details.</p>
9946: <p>Next, check that your package is complete, compiles and
1.299 rillig 9947: 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.333 nia 9948: 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>
9949: tool and fix any errors that appear.</p>
9950: <p>Finally, send a report to the pkgsrc bug tracking system,
1.360 leot 9951: 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.87 wiz 9952: that, go to the web page
1.289 leot 9953: <a class="ulink" href="https://www.NetBSD.org/support/send-pr.html" target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
1.124 snj 9954: which contains some instructions and a link to a form where you
9955: can submit packages. The
1.322 leot 9956: <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.124 snj 9957: also available as a substitute for either of the above two tools.
9958: </p>
1.87 wiz 9959: <p>In the form of the problem report, the category should be
1.128 wiz 9960: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9961: and version number, and the description field should contain a
9962: short description of your package (contents of the COMMENT
1.333 nia 9963: variable or DESCR file are OK).</p>
1.75 rillig 9964: </div>
1.148 asau 9965: <div class="sect1">
1.75 rillig 9966: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9967: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9968: <p>Please note all package additions, updates, moves, and
1.93 rillig 9969: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9970: important to keep this file up to date and conforming to the
9971: existing format, because it will be used by scripts to
1.289 leot 9972: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9973: sites. Additionally, check the
1.76 rillig 9974: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9975: for the package you updated or removed, in case it was mentioned
9976: there.</p>
9977: <p>When the <code class="varname">PKGREVISION</code> of a package is
9978: bumped, the change should appear in
1.93 rillig 9979: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9980: related or otherwise relevant. Mass bumps that result from a
9981: dependency being updated should not be mentioned. In all other
9982: cases it's the developer's decision.</p>
9983: <p>There is a make target that helps in creating proper
1.110 hubertf 9984: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9985: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9986: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9987: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9988: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9989: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9990: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9991: For new packages, or package moves or removals, set the
9992: <code class="varname">CTYPE</code> variable on the command line to "Added",
9993: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9994: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9995: not the same as your NetBSD login name. The target also automatically
9996: removes possibly existing entries for the package in the
9997: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9998: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9999: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 10000: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
10001: makes the cvs commands use the main repository.
10002: </p>
1.75 rillig 10003: </div>
1.148 asau 10004: <div class="sect1">
1.75 rillig 10005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10006: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243 wiz 10007: <p>For several years, there have been mirrors of pkgsrc in
10008: fossil, git, and hg. Standard practise when using these tools is to
10009: make the first line of a commit message function as a summary that
10010: can be read without the rest, such as is commonly done with "git log
10011: --oneline". For this reason, we have the following guidelines for
10012: pkgsrc commit messages:</p>
10013: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10014: <li class="listitem"><p>Start the commit message with a line that explains the
1.244 wiz 10015: big picture in 65 characters or less. When a commit is for one
1.243 wiz 10016: package, include the name of the package. For updates, include the
10017: version to which it is updated.</p></li>
10018: <li class="listitem"><p>Leave the next line empty.</p></li>
10019: <li class="listitem"><p>Then come the details for the commit (changes in that
10020: package, reason for a change) and any relevant PRs. Wrap this
10021: section.</p></li>
10022: </ul></div>
10023: <p>Here is an example:
1.352 wiz 10024: </p>
1.243 wiz 10025: <pre class="programlisting">
1.352 wiz 10026: libxslt: update to 1.0.30
1.243 wiz 10027:
1.352 wiz 10028: Changes since 1.0.29:
10029: ...
10030: </pre>
1.243 wiz 10031: <p>
10032: </p>
10033: <p>Here is another example:
1.352 wiz 10034: </p>
1.243 wiz 10035: <pre class="programlisting">
1.352 wiz 10036: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.243 wiz 10037:
1.352 wiz 10038: (rationale)
10039: </pre>
1.243 wiz 10040: <p>
10041: </p>
10042: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
10043: allowed on the pkgsrc repository to change commit messages.</p>
10044: </div>
10045: <div class="sect1">
10046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10047: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 10048: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 10049: access to the pkgsrc repository.</p>
10050: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
10051: Start by adding the directory and then files in the directory. Don't
10052: forget to add the new package to the category's
10053: <code class="filename">Makefile</code>. Make sure you don't forget any files;
10054: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
10055: <pre class="programlisting">
10056: <code class="prompt">$</code> cd .../pkgsrc/category
10057: <code class="prompt">$</code> cvs add pkgname
10058: <code class="prompt">$</code> cd pkgname
10059: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
10060: <code class="prompt">$</code> cvs add patches/p*
10061: <code class="prompt">$</code> cvs status | less
1.141 wiz 10062: <code class="prompt">$</code> cvs commit
1.140 wiz 10063: <code class="prompt">$</code> cd ..
1.350 gutterid 10064: <code class="prompt">$</code> vi Makefile # add SUBDIR+=pkgname line
1.141 wiz 10065: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 10066: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 10067: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 10068: </pre>
1.87 wiz 10069: <p>The commit message of the initial import should include part of the
1.76 rillig 10070: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 10071: what the package is/does.</p>
1.140 wiz 10072: <p>Also mention the new package in
10073: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
10074: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
10075: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 10076: </div>
1.148 asau 10077: <div class="sect1">
1.75 rillig 10078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10079: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 10080: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 10081: changes between old and new versions into the commit log when updating
1.87 wiz 10082: a package. There are various reasons for this:</p>
1.148 asau 10083: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10084: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 10085: or its information may be overwritten by newer information.</p></li>
1.128 wiz 10086: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 10087: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 10088: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 10089: repository is very useful for people who read the pkgsrc-changes mailing
10090: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 10091: the package.</p></li>
1.75 rillig 10092: </ul></div>
1.87 wiz 10093: <p>Please also recognize that, just because a new version of a package
1.75 rillig 10094: has been released, it should not automatically be upgraded in the CVS
10095: repository. We prefer to be conservative in the packages that are
10096: included in pkgsrc - development or beta packages are not really the
10097: best thing for most places in which pkgsrc is used. Please use your
10098: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 10099: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 10100: </div>
1.148 asau 10101: <div class="sect1">
1.75 rillig 10102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10103: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122 reed 10104: <p>Renaming packages is not recommended.</p>
1.290 gutterid 10105: <p>When renaming packages, be sure to fix any references to the old name
1.122 reed 10106: in other Makefiles, options, buildlink files, etc.</p>
1.282 leot 10107: <p>
1.290 gutterid 10108: Also, when renaming a package, please add
1.282 leot 10109: the package name and version pattern(s) of the previous package
10110: to <code class="varname">SUPERSEDES</code>.
1.122 reed 10111: This may be repeated for multiple renames.
10112: The new package would be an exact replacement.
1.282 leot 10113: Example:
1.122 reed 10114: </p>
1.282 leot 10115: <pre class="programlisting">
10116: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
10117: SUPERSEDES+= optcomp-[0-9]*
10118: </pre>
1.128 wiz 10119: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 10120: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
10121: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
10122: not be an exact replacement but is a suggestion for the replaced
10123: functionality.</p>
10124: </div>
1.148 asau 10125: <div class="sect1">
1.122 reed 10126: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10127: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122 reed 10128: <p>It is preferred that packages are not renamed or moved, but if needed
10129: please follow these steps.
10130: </p>
1.128 wiz 10131: <div class="orderedlist"><ol class="orderedlist" type="1">
10132: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
10133: <li class="listitem">
1.75 rillig 10134: <p>Remove all CVS dirs.</p>
1.87 wiz 10135: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 10136: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87 wiz 10137: <p>and use that for further work.</p>
1.75 rillig 10138: </li>
1.128 wiz 10139: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
10140: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
10141: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
10142: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 10143: <code class="varname">PREV_PKGPATH</code> to the previous category/package
10144: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
10145: for doing an update using pkgsrc building; for example, it can
1.360 leot 10146: 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.122 reed 10147: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
10148: new <code class="varname">PKGPATH</code> for that moved package. Note that
10149: it may have multiple matches, so the tool should also check on the
10150: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
10151: probably has no value unless <code class="varname">SUPERSEDES</code> is not
10152: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.351 gutterid 10153: <li class="listitem"><p><span class="command"><strong>cvs add</strong></span> the modified package in the new
1.75 rillig 10154: place.</p></li>
1.128 wiz 10155: <li class="listitem">
1.75 rillig 10156: <p>Check if any package depends on it:
10157: </p>
10158: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
10159: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
10160: </li>
1.128 wiz 10161: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
10162: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
10163: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
10164: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
10165: <li class="listitem">
1.75 rillig 10166: <p>Commit the changed and removed files:</p>
10167: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87 wiz 10168: <p>(and any packages from step 5, of course).</p>
1.75 rillig 10169: </li>
10170: </ol></div>
10171: </div>
10172: </div>
1.148 asau 10173: <div class="chapter">
1.75 rillig 10174: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 10175: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 10176: <p>This section contains the answers to questions that may
10177: arise when you are writing a package. If you don't find your
10178: question answered here, first have a look in the other chapters,
10179: and if you still don't have the answer, ask on the
10180: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 10181: <div class="qandaset">
1.289 leot 10182: <a name="devfaq.qandaset"></a><dl>
1.267 rillig 10183: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 10184: MAKEFLAGS, .MAKEFLAGS and
10185: MAKE_FLAGS?</a>
10186: </dt>
1.267 rillig 10187: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 10188: MAKE, GMAKE and
10189: MAKE_PROGRAM?</a>
10190: </dt>
1.267 rillig 10191: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 10192: CC, PKG_CC and
10193: PKGSRC_COMPILER?</a>
10194: </dt>
1.338 nia 10195: <dt>24.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 10196: VARNAME=BUILDLINK_PREFIX.foo
10197: say it's empty?</a>
10198: </dt>
1.338 nia 10199: <dt>24.5. <a href="#devfaq.master_sites">What does
1.78 rillig 10200: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
10201: don't understand the := inside
10202: it.</a>
10203: </dt>
1.338 nia 10204: <dt>24.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 10205: developers?</a>
10206: </dt>
1.338 nia 10207: <dt>24.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 10208: documentation?</a>
10209: </dt>
1.338 nia 10210: <dt>24.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.289 leot 10211: What shall I do?</a>
1.92 rillig 10212: </dt>
1.75 rillig 10213: </dl>
1.148 asau 10214: <table border="0" style="width: 100%;">
10215: <colgroup>
1.75 rillig 10216: <col align="left" width="1%">
1.128 wiz 10217: <col>
1.148 asau 10218: </colgroup>
1.75 rillig 10219: <tbody>
1.148 asau 10220: <tr class="question">
1.75 rillig 10221: <td align="left" valign="top">
1.289 leot 10222: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75 rillig 10223: </td>
10224: <td align="left" valign="top"><p>What is the difference between
10225: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10226: <code class="varname">MAKE_FLAGS</code>?</p></td>
10227: </tr>
10228: <tr class="answer">
1.91 rillig 10229: <td align="left" valign="top"></td>
1.338 nia 10230: <td align="left" valign="top">
10231: <p><code class="varname">MAKEFLAGS</code> are the flags passed
1.360 leot 10232: 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.338 nia 10233: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
10234: passed to the <code class="varname">MAKE_PROGRAM</code> when building the
10235: package.</p>
10236: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
10237: <span class="command"><strong>bmake</strong></span> and should not be used by
10238: packages.</p>
10239: </td>
1.75 rillig 10240: </tr>
1.148 asau 10241: <tr class="question">
1.75 rillig 10242: <td align="left" valign="top">
1.289 leot 10243: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75 rillig 10244: </td>
10245: <td align="left" valign="top"><p>What is the difference between
10246: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10247: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10248: </tr>
10249: <tr class="answer">
1.91 rillig 10250: <td align="left" valign="top"></td>
1.338 nia 10251: <td align="left" valign="top">
10252: <p><code class="varname">MAKE</code> is the path to the
1.360 leot 10253: <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.338 nia 10254: infrastructure.</p>
10255: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
10256: need to say <code class="varname">USE_TOOLS+=gmake</code> to use
10257: that.</p>
10258: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
10259: program that is used for building the package.</p>
10260: </td>
1.75 rillig 10261: </tr>
1.148 asau 10262: <tr class="question">
1.75 rillig 10263: <td align="left" valign="top">
1.289 leot 10264: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75 rillig 10265: </td>
10266: <td align="left" valign="top"><p>What is the difference between
10267: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10268: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10269: </tr>
10270: <tr class="answer">
1.91 rillig 10271: <td align="left" valign="top"></td>
1.75 rillig 10272: <td align="left" valign="top">
1.338 nia 10273: <p><code class="varname">CC</code> is the path to the real C
10274: compiler, which can be configured by the pkgsrc user.</p>
10275: <p><code class="varname">PKG_CC</code> is the path to the compiler
10276: wrapper.</p>
10277: <p><code class="varname">PKGSRC_COMPILER</code> is
10278: <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
10279: compiler that should be used. See
10280: <code class="filename">mk/compiler.mk</code> for more information about
10281: the latter variable.</p>
1.75 rillig 10282: </td>
10283: </tr>
1.148 asau 10284: <tr class="question">
1.75 rillig 10285: <td align="left" valign="top">
1.338 nia 10286: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.4.</b></p>
1.75 rillig 10287: </td>
1.110 hubertf 10288: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 10289: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10290: say it's empty?</p></td>
10291: </tr>
10292: <tr class="answer">
1.91 rillig 10293: <td align="left" valign="top"></td>
1.75 rillig 10294: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 10295: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10296: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 10297: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 10298: command.</p></td>
10299: </tr>
1.148 asau 10300: <tr class="question">
1.78 rillig 10301: <td align="left" valign="top">
1.338 nia 10302: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.5.</b></p>
1.78 rillig 10303: </td>
10304: <td align="left" valign="top"><p>What does
1.220 wiz 10305: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10306: don't understand the <code class="code">:=</code> inside
1.78 rillig 10307: it.</p></td>
10308: </tr>
10309: <tr class="answer">
1.91 rillig 10310: <td align="left" valign="top"></td>
1.338 nia 10311: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
10312: assignment operator, even though it may look like one.
1.78 rillig 10313: Instead, it is a degenerate form of
1.220 wiz 10314: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.360 leot 10315: 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.220 wiz 10316: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78 rillig 10317: case of <code class="varname">MASTER_SITE_*</code>,
10318: <em class="replaceable"><code>old_string</code></em> is the empty string and
10319: <em class="replaceable"><code>new_string</code></em> is
1.220 wiz 10320: <code class="code">package/</code>. That's where the
10321: <code class="code">:</code> and the <code class="code">=</code> fall
1.78 rillig 10322: together.</p></td>
10323: </tr>
1.148 asau 10324: <tr class="question">
1.78 rillig 10325: <td align="left" valign="top">
1.338 nia 10326: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.6.</b></p>
1.78 rillig 10327: </td>
10328: <td align="left" valign="top"><p>Which mailing lists are there for package
10329: developers?</p></td>
10330: </tr>
10331: <tr class="answer">
1.91 rillig 10332: <td align="left" valign="top"></td>
1.148 asau 10333: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289 leot 10334: <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.78 rillig 10335: <dd><p>This is a list for technical discussions related
10336: to pkgsrc development, e.g. soliciting feedback for changes to
10337: pkgsrc infrastructure, proposed new features, questions related
10338: to porting pkgsrc to a new platform, advice for maintaining a
10339: package, patches that affect many packages, help requests moved
10340: from pkgsrc-users when an infrastructure bug is found,
10341: etc.</p></dd>
1.289 leot 10342: <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.78 rillig 10343: <dd><p>All bug reports in category "pkg" sent with
1.360 leot 10344: <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.78 rillig 10345: directly; use one of the other mailing
10346: lists.</p></dd>
10347: </dl></div></td>
10348: </tr>
1.148 asau 10349: <tr class="question">
1.80 rillig 10350: <td align="left" valign="top">
1.338 nia 10351: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.7.</b></p>
1.80 rillig 10352: </td>
10353: <td align="left" valign="top"><p>Where is the pkgsrc
10354: documentation?</p></td>
10355: </tr>
10356: <tr class="answer">
1.91 rillig 10357: <td align="left" valign="top"></td>
1.80 rillig 10358: <td align="left" valign="top">
10359: <p>There are many places where you can find
10360: documentation about pkgsrc:</p>
1.148 asau 10361: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10362: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 10363: of chapters that explain large parts of pkgsrc, but some
10364: chapters tend to be outdated. Which ones they are is hard to
10365: say.</p></li>
1.289 leot 10366: <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.80 rillig 10367: about certain features, announcements of new parts of the pkgsrc
10368: infrastructure and sometimes even announcements that a certain
10369: feature has been marked as obsolete. The benefit here is that
10370: each message has a date appended to it.</p></li>
1.128 wiz 10371: <li class="listitem"><p>Many of the files in the
1.80 rillig 10372: <code class="filename">mk/</code> directory start with a comment that
10373: describes the purpose of the file and how it can be used by the
1.92 rillig 10374: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 10375: documentation is to run <span class="command"><strong>bmake
1.92 rillig 10376: help</strong></span>.</p></li>
1.128 wiz 10377: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 10378: information, but they tend to be highly abbreviated, especially
10379: for actions that occur often. Some contain a detailed
10380: description of what has changed, but they are geared towards the
10381: other pkgsrc developers, not towards an average pkgsrc user.
10382: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10383: don't know what has been before, these messages may not be worth
10384: too much to you.</p></li>
1.128 wiz 10385: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10386: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 10387: mind of the developer who wrote the code. To get this
1.110 hubertf 10388: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 10389: to see who has written it and ask on the
10390: <code class="literal">tech-pkg</code> mailing list, so that others can
10391: find your questions later (see above). To be sure that the
10392: developer in charge reads the mail, you may CC him or
10393: her.</p></li>
10394: </ul></div>
1.299 rillig 10395: </td>
10396: </tr>
10397: <tr class="question">
10398: <td align="left" valign="top">
1.338 nia 10399: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.8.</b></p>
1.299 rillig 10400: </td>
1.338 nia 10401: <td align="left" valign="top"><p>I have a little time to kill.
1.299 rillig 10402: What shall I do?</p></td>
10403: </tr>
10404: <tr class="answer">
10405: <td align="left" valign="top"></td>
10406: <td align="left" valign="top">
10407: <p>This is not really an FAQ yet, but here's the answer
10408: anyway.</p>
1.148 asau 10409: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 10410: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.322 leot 10411: <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.299 rillig 10412: will tell you about newer versions of installed packages that are
10413: available, but not yet updated in pkgsrc.</p></li>
10414: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10415: — it contains a list of suggested new packages and a list of
10416: cleanups and enhancements for pkgsrc that would be nice to
10417: have.</p></li>
10418: <li class="listitem"><p>Review packages for which review was requested on
10419: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10420: mailing list.</p></li>
1.85 jmmv 10421: </ul></div>
1.299 rillig 10422: </td>
1.85 jmmv 10423: </tr>
10424: </tbody>
1.299 rillig 10425: </table>
1.85 jmmv 10426: </div>
10427: </div>
1.75 rillig 10428: </div>
1.148 asau 10429: <div class="part">
1.75 rillig 10430: <div class="titlepage"><div><div><h1 class="title">
10431: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10432: <div class="partintro">
1.75 rillig 10433: <div></div>
10434: <p>This part of the guide deals with everything
10435: from the infrastructure that is behind the interfaces described
10436: in the developer's guide. A casual package maintainer should not
10437: need anything from this part.</p>
10438: <div class="toc">
10439: <p><b>Table of Contents</b></p>
1.210 leot 10440: <dl class="toc">
1.299 rillig 10441: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10442: <dd><dl>
1.299 rillig 10443: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10444: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10445: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.75 rillig 10446: <dd><dl>
1.299 rillig 10447: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10448: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.75 rillig 10449: </dl></dd>
1.299 rillig 10450: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10451: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10452: <dd><dl>
1.299 rillig 10453: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10454: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81 rillig 10455: </dl></dd>
1.299 rillig 10456: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10457: <dd><dl>
1.299 rillig 10458: <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>
10459: <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.75 rillig 10460: </dl></dd>
10461: </dl></dd>
1.299 rillig 10462: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 10463: <dd><dl>
1.299 rillig 10464: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10465: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10466: <dd><dl>
1.299 rillig 10467: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10468: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10469: </dl></dd>
10470: </dl></dd>
1.299 rillig 10471: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10472: <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.75 rillig 10473: </dl>
10474: </div>
10475: </div>
1.148 asau 10476: <div class="chapter">
1.75 rillig 10477: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10478: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10479: <div class="toc">
10480: <p><b>Table of Contents</b></p>
1.210 leot 10481: <dl class="toc">
1.299 rillig 10482: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10483: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10484: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81 rillig 10485: <dd><dl>
1.299 rillig 10486: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10487: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81 rillig 10488: </dl></dd>
1.299 rillig 10489: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10490: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10491: <dd><dl>
1.299 rillig 10492: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10493: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 10494: </dl></dd>
1.299 rillig 10495: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10496: <dd><dl>
1.299 rillig 10497: <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>
10498: <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.75 rillig 10499: </dl></dd>
10500: </dl>
10501: </div>
10502: <p>The pkgsrc infrastructure consists of many small Makefile
10503: fragments. Each such fragment needs a properly specified
10504: interface. This chapter explains how such an interface looks
10505: like.</p>
1.148 asau 10506: <div class="sect1">
1.75 rillig 10507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10508: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10509: <p>Whenever a variable is defined in the pkgsrc
10510: infrastructure, the location and the way of definition provide
10511: much information about the intended use of that variable.
10512: Additionally, more documentation may be found in a header
10513: comment or in this pkgsrc guide.</p>
10514: <p>A special file is
10515: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10516: variables that are intended to be user-defined. They are either
10517: defined using the <code class="literal">?=</code> operator or they are
10518: left undefined because defining them to anything would
1.128 wiz 10519: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10520: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10521: file.</p>
10522: <p>Outside this file, the following conventions apply:
10523: Variables that are defined using the <code class="literal">?=</code>
10524: operator may be overridden by a package.</p>
10525: <p>Variables that are defined using the <code class="literal">=</code>
10526: operator may be used read-only at run-time.</p>
10527: <p>Variables whose name starts with an underscore must not be
10528: accessed outside the pkgsrc infrastructure at all. They may
10529: change without further notice.</p>
1.148 asau 10530: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10531: <h3 class="title">Note</h3>
10532: <p>These conventions are currently not applied
10533: consistently to the complete pkgsrc
10534: infrastructure.</p>
10535: </div>
10536: </div>
1.148 asau 10537: <div class="sect1">
1.81 rillig 10538: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10539: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10540: <p>All variables that contain lists of things should default
10541: to being empty. Two examples that do not follow this rule are
10542: <code class="varname">USE_LANGUAGES</code> and
10543: <code class="varname">DISTFILES</code>. These variables cannot simply be
10544: modified using the <code class="literal">+=</code> operator in package
10545: <code class="filename">Makefile</code>s (or other files included by
10546: them), since there is no guarantee whether the variable is
10547: already set or not, and what its value is. In the case of
1.128 wiz 10548: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10549: the default value and just define it as in the following
10550: example.</p>
10551: <pre class="programlisting">
1.100 rillig 10552: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10553: </pre>
10554: <p>Because of the selection of this default value, the same
10555: value appears in many package Makefiles. Similarly for
10556: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10557: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10558: doesn't stand out. Nevertheless it is mentioned in many
10559: files.</p>
10560: </div>
1.148 asau 10561: <div class="sect1">
1.81 rillig 10562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10563: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.148 asau 10564: <div class="sect2">
1.75 rillig 10565: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10566: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.75 rillig 10567: <p>Variable evaluation takes place either at load time or at
10568: runtime, depending on the context in which they occur. The
10569: contexts where variables are evaluated at load time are:</p>
1.148 asau 10570: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10571: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10572: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10573: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10574: <code class="literal">.for</code>,</p></li>
1.128 wiz 10575: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10576: </ul></div>
10577: <p>A special exception are references to the iteration
10578: variables of <code class="literal">.for</code> loops, which are expanded
10579: inline, no matter in which context they appear.</p>
10580: <p>As the values of variables may change during load time,
10581: care must be taken not to evaluate them by accident. Typical
10582: examples for variables that should not be evaluated at load time
10583: are <code class="varname">DEPENDS</code> and
10584: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10585: clear, here is an example:</p>
10586: <pre class="programlisting">
1.100 rillig 10587: CONFIGURE_ARGS= # none
10588: CFLAGS= -O
10589: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10590:
1.100 rillig 10591: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10592:
1.100 rillig 10593: CFLAGS+= -Wall
1.222 sevan 10594: </pre>
1.75 rillig 10595: <p>This code shows how the use of the <code class="literal">:=</code>
10596: operator can quickly lead to unexpected results. The first
10597: paragraph is fairly common code. The second paragraph evaluates
10598: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10599: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10600: <code class="literal">-Wall</code> is appended to the
10601: <code class="varname">CFLAGS</code>, but this addition will not appear in
10602: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10603: paragraphs from above typically occur in completely unrelated
10604: files.</p>
10605: </div>
1.148 asau 10606: <div class="sect2">
1.75 rillig 10607: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10608: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.75 rillig 10609: <p>After all the files have been loaded, the values of the
10610: variables cannot be changed anymore. Variables that are used in
10611: the shell commands are expanded at this point.</p>
10612: </div>
10613: </div>
1.148 asau 10614: <div class="sect1">
1.75 rillig 10615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10616: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10617: <p>There are many ways in which the definition and use of a
1.218 rillig 10618: variable can be restricted in order to detect bugs and violations
10619: of the (mostly unwritten) policies. A package can be checked with
10620: <code class="literal">pkglint -Wall</code> to see whether it meets these
10621: rules.</p>
1.78 rillig 10622: </div>
1.148 asau 10623: <div class="sect1">
1.78 rillig 10624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10625: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10626: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10627: of the following classes. Cases where a file falls into more
10628: than one class should be avoided as it often leads to subtle
10629: bugs.</p>
1.148 asau 10630: <div class="sect2">
1.75 rillig 10631: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10632: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10633: <p>In a traditional imperative programming language some of
1.76 rillig 10634: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10635: procedures. They take some input parameters and—after
10636: inclusion—provide a result in output parameters. Since all
1.76 rillig 10637: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10638: care must be taken not to use parameter names that have already
10639: another meaning. For example, <code class="varname">PKGNAME</code> is a
10640: bad choice for a parameter name.</p>
10641: <p>Procedures are completely evaluated at preprocessing time.
10642: That is, when calling a procedure all input parameters must be
10643: completely resolvable. For example,
10644: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10645: parameter since it is very likely that further text will be
10646: added after calling the procedure, which would effectively apply
10647: the procedure to only a part of the variable. Also, references
1.218 rillig 10648: to other variables will be modified after calling the
1.75 rillig 10649: procedure.</p>
10650: <p>A procedure can declare its output parameters either as
10651: suitable for use in preprocessing directives or as only
10652: available at runtime. The latter alternative is for variables
10653: that contain references to other runtime variables.</p>
10654: <p>Procedures shall be written such that it is possible to
10655: call the procedure more than once. That is, the file must not
10656: contain multiple-inclusion guards.</p>
10657: <p>Examples for procedures are
1.76 rillig 10658: <code class="filename">mk/bsd.options.mk</code> and
10659: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10660: that the parameters are evaluated at load time, they should be
10661: assigned using the <code class="literal">:=</code> operator, which should
10662: be used only for this purpose.</p>
10663: </div>
1.148 asau 10664: <div class="sect2">
1.75 rillig 10665: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10666: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10667: <p>Action files take some input parameters and may define
10668: runtime variables. They shall not define loadtime variables.
10669: There are action files that are included implicitly by the
10670: pkgsrc infrastructure, while other must be included
10671: explicitly.</p>
10672: <p>An example for action files is
1.76 rillig 10673: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10674: </div>
10675: </div>
1.148 asau 10676: <div class="sect1">
1.81 rillig 10677: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10678: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10679: <p>Package <code class="filename">Makefile</code>s usually consist of
10680: a set of variable definitions, and include the file
10681: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10682: Before that, they may also include various other
10683: <code class="filename">*.mk</code> files if they need to query the
10684: availability of certain features like the type of compiler or
10685: the X11 implementation. Due to the heavy use of preprocessor
10686: directives like <code class="literal">.if</code> and
10687: <code class="literal">.for</code>, the order in which the files are loaded
10688: matters.</p>
10689: <p>This section describes at which point the various files
10690: are loaded and gives reasons for that order.</p>
1.148 asau 10691: <div class="sect2">
1.81 rillig 10692: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10693: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10694: </h3></div></div></div>
10695: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10696: is to define some essential variables like
10697: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10698: <code class="varname">MACHINE_ARCH</code>.</p>
10699: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10700: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104 rillig 10701: After that, those variables
1.81 rillig 10702: that have not been overridden by the user are loaded from
10703: <code class="filename">mk/defaults/mk.conf</code>.</p>
10704: <p>After the user settings, the system settings and platform
10705: settings are loaded, which may override the user
10706: settings.</p>
10707: <p>Then, the tool definitions are loaded. The tool wrappers
10708: are not yet in effect. This only happens when building a
10709: package, so the proper variables must be used instead of the
10710: direct tool names.</p>
10711: <p>As the last steps, some essential variables from the
10712: wrapper and the package system flavor are loaded, as well as the
10713: variables that have been cached in earlier phases of a package
10714: build.</p>
10715: </div>
1.148 asau 10716: <div class="sect2">
1.81 rillig 10717: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10718: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10719: </h3></div></div></div>
1.81 rillig 10720: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10721: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10722: loaded, which fill default values for those variables that have
1.93 rillig 10723: not been defined by the package. These variables may later
1.81 rillig 10724: be used even in unrelated files.</p>
10725: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10726: provides the target <code class="literal">error-check</code> that is added
10727: as a special dependency to all other targets that use
10728: <code class="varname">DELAYED_ERROR_MSG</code> or
10729: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10730: <p>Then, the package-specific hacks from
10731: <code class="filename">hacks.mk</code> are included.</p>
10732: <p>Then, various other files follow. Most of them don't have
10733: any dependencies on what they need to have included before or
10734: after them, though some do.</p>
10735: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10736: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10737: restricts the use of these variables to all the files that have
10738: been included before. Appearances in later files will be
10739: silently ignored.</p>
10740: <p>Then, the files for the main targets are included, in the
10741: order of later execution, though the actual order should not
10742: matter.</p>
10743: <p>At last, some more files are included that don't set any
10744: interesting variables but rather just define make targets to be
10745: executed.</p>
10746: </div>
10747: </div>
1.75 rillig 10748: </div>
1.148 asau 10749: <div class="chapter">
1.75 rillig 10750: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10751: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.75 rillig 10752: <div class="toc">
10753: <p><b>Table of Contents</b></p>
1.210 leot 10754: <dl class="toc">
1.299 rillig 10755: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10756: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10757: <dd><dl>
1.299 rillig 10758: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10759: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10760: </dl></dd>
10761: </dl>
10762: </div>
10763: <p>The pkgsrc infrastructure consists of a large codebase,
10764: and there are many corners where every little bit of a file is
10765: well thought out, making pkgsrc likely to fail as soon as
10766: anything is changed near those parts. To prevent most changes
10767: from breaking anything, a suite of regression tests should go
10768: along with every important part of the pkgsrc infrastructure.
10769: This chapter describes how regression tests work in pkgsrc and
10770: how you can add new tests.</p>
1.148 asau 10771: <div class="sect1">
1.75 rillig 10772: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10773: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.322 leot 10774: <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.110 hubertf 10775: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10776: can simply run that command, which will run all tests in the
1.283 rillig 10777: <code class="filename">regress/</code> directory.</p>
1.75 rillig 10778: </div>
1.148 asau 10779: <div class="sect1">
1.75 rillig 10780: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10781: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.283 rillig 10782: <p>Every directory in the <code class="filename">regress/</code>
10783: directory that contains a file called <code class="filename">spec</code>
1.75 rillig 10784: is considered a regression test. This file is a shell program
1.110 hubertf 10785: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10786: The following functions can be overridden to suit your
10787: needs.</p>
1.148 asau 10788: <div class="sect2">
1.75 rillig 10789: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10790: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.218 rillig 10791: <p>These functions do not take any parameters. Although they
10792: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.289 leot 10793: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218 rillig 10794: question</a> for details.</p>
1.148 asau 10795: <div class="variablelist"><dl class="variablelist">
1.218 rillig 10796: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75 rillig 10797: <dd><p>This function prepares the environment for the
10798: test. By default it does nothing.</p></dd>
1.218 rillig 10799: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10800: <dd>
10801: <p>This function runs the actual test. By default,
1.75 rillig 10802: it calls <code class="varname">TEST_MAKE</code> with the arguments
10803: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10804: error messages into the file
1.218 rillig 10805: <code class="varname">TEST_OUTFILE</code>.</p>
10806: <p>When defining this function, make sure that all output that
10807: needs to be checked is written to the correct output file.
10808: Example:</p>
10809: <pre class="programlisting">
10810: do_test() {
1.223 rillig 10811: echo "Example output"
1.218 rillig 10812: } 1>$TEST_OUTFILE 2>&1
10813: </pre>
10814: </dd>
10815: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10816: <dd>
10817: <p>This function is run after the test and is
1.75 rillig 10818: typically used to compare the actual output from the one that is
10819: expected. It can make use of the various helper functions from
1.218 rillig 10820: the next section. Example:</p>
10821: <pre class="programlisting">
10822: check_result() {
1.223 rillig 10823: exit_status 0
10824: output_require "Example"
10825: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10826: output_prohibit "no such file or directory"
1.283 rillig 10827: regress_fail "expected $expected but got $actual for input $input"
1.218 rillig 10828: }
10829: </pre>
10830: </dd>
10831: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75 rillig 10832: <dd><p>This function cleans everything up after the
10833: test has been run. By default it does nothing.</p></dd>
10834: </dl></div>
10835: </div>
1.148 asau 10836: <div class="sect2">
1.75 rillig 10837: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10838: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.148 asau 10839: <div class="variablelist"><dl class="variablelist">
1.283 rillig 10840: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10841: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218 rillig 10842: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75 rillig 10843: <dd><p>This function compares the exitcode of the
1.218 rillig 10844: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75 rillig 10845: If they differ, the test will fail.</p></dd>
1.218 rillig 10846: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10847: <dd>
10848: <p>This function checks for each of its parameters
10849: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75 rillig 10850: extended regular expression. If it does not, the test will
1.218 rillig 10851: fail. Example:</p>
10852: <pre class="programlisting">
1.219 rillig 10853: output_require "looks fine"
10854: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218 rillig 10855: </pre>
10856: </dd>
1.292 leot 10857: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75 rillig 10858: <dd><p>This function checks for each of its parameters
1.110 hubertf 10859: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10860: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10861: If any of the regular expressions matches, the test will
10862: fail.</p></dd>
10863: </dl></div>
10864: </div>
10865: </div>
10866: </div>
1.148 asau 10867: <div class="chapter">
1.75 rillig 10868: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10869: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10870: <div class="toc">
10871: <p><b>Table of Contents</b></p>
1.299 rillig 10872: <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.75 rillig 10873: </div>
10874: <p>The pkgsrc system has already been ported to many
10875: operating systems, hardware architectures and compilers. This
10876: chapter explains the necessary steps to make pkgsrc even more
10877: portable.</p>
1.148 asau 10878: <div class="sect1">
1.75 rillig 10879: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10880: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10881: <p>To port pkgsrc to a new operating system (called
10882: <code class="literal">MyOS</code> in this example), you need to touch the
10883: following files:</p>
1.148 asau 10884: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10885: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75 rillig 10886: <dd><p>This file contains some basic definitions, for
10887: example the name of the C
10888: compiler.</p></dd>
1.76 rillig 10889: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10890: <dd><p>Insert code that defines the variables
10891: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.327 wiz 10892: <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.75 rillig 10893: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10894: <code class="varname">APPEND_ELF</code>, and the other variables that
10895: appear in this file.</p></dd>
1.93 rillig 10896: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10897: <dd><p>This file contains the platform-specific
10898: definitions that are used by pkgsrc. Start by copying one of the
10899: other files and edit it to your
10900: needs.</p></dd>
1.93 rillig 10901: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10902: <dd><p>This file defines the paths to all the tools
10903: that are needed by one or the other package in pkgsrc, as well
10904: as by pkgsrc itself. Find out where these tools are on your
10905: platform and add them.</p></dd>
10906: </dl></div>
10907: <p>Now, you should be able to build some basic packages, like
1.322 leot 10908: <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.75 rillig 10909: </div>
10910: </div>
10911: </div>
1.148 asau 10912: <div class="appendix">
10913: <div class="titlepage"><div><div><h1 class="title">
10914: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10915: <div class="toc">
10916: <p><b>Table of Contents</b></p>
1.210 leot 10917: <dl class="toc">
1.75 rillig 10918: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10919: <dd><dl>
10920: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10921: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10922: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287 rillig 10923: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 10924: </dl></dd>
10925: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10926: </dl>
10927: </div>
10928: <p>We checked to find a piece of software that wasn't in the packages
10929: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10930: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10931: present in the tree is beyond us, but it's useful for the purposes of
10932: this exercise.</p>
1.148 asau 10933: <div class="sect1">
1.75 rillig 10934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10935: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10936: <div class="sect2">
1.75 rillig 10937: <div class="titlepage"><div><div><h3 class="title">
10938: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10939: <pre class="programlisting">
1.100 rillig 10940: # $NetBSD$
10941: #
1.1 grant 10942:
1.100 rillig 10943: DISTNAME= bison-1.25
10944: CATEGORIES= devel
1.286 rillig 10945: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 grant 10946:
1.136 dholland 10947: MAINTAINER= pkgsrc-users@NetBSD.org
1.289 leot 10948: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.100 rillig 10949: COMMENT= GNU yacc clone
1.1 grant 10950:
1.100 rillig 10951: GNU_CONFIGURE= yes
1.152 wiz 10952: INFO_FILES= yes
1.1 grant 10953:
1.100 rillig 10954: .include "../../mk/bsd.pkg.mk"
1.1 grant 10955: </pre>
1.75 rillig 10956: </div>
1.148 asau 10957: <div class="sect2">
1.75 rillig 10958: <div class="titlepage"><div><div><h3 class="title">
10959: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10960: <pre class="programlisting">
1.100 rillig 10961: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.360 leot 10962: 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.100 rillig 10963: of the NetBSD source tree is beyond me.
1.1 grant 10964: </pre>
1.75 rillig 10965: </div>
1.148 asau 10966: <div class="sect2">
1.75 rillig 10967: <div class="titlepage"><div><div><h3 class="title">
10968: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10969: <pre class="programlisting">
1.100 rillig 10970: @comment $NetBSD$
10971: bin/bison
10972: man/man1/bison.1.gz
10973: share/bison.simple
10974: share/bison.hairy
1.1 grant 10975: </pre>
1.75 rillig 10976: </div>
1.148 asau 10977: <div class="sect2">
1.75 rillig 10978: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 10979: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75 rillig 10980: <p>The NetBSD package system comes with
1.322 leot 10981: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75 rillig 10982: which helps to check the contents of these
10983: files. After installation it is quite easy to use, just change to the
1.286 rillig 10984: directory of the package you wish to examine and run
1.110 hubertf 10985: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10986: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286 rillig 10987: ERROR: Makefile: Each package must define its LICENSE.
10988: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10989: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10990: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10991: 1 error, 2 warnings and 1 note found.
10992: (Run "pkglint -e" to show explanations.)
10993: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287 rillig 10994: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75 rillig 10995: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285 rillig 10996: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75 rillig 10997: -Wall</strong></span> for a very thorough check.</p>
10998: </div>
10999: </div>
1.148 asau 11000: <div class="sect1">
1.75 rillig 11001: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11002: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
11003: <p>Create the directory where the package lives,
11004: plus any auxiliary directories:</p>
11005: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
11006: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
11007: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
11008: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 11009: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299 rillig 11010: <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.75 rillig 11011: then continue with fetching the distfile:</p>
11012: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 11013: >> bison-1.25.tar.gz doesn't seem to exist on this system.
11014: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
11015: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11016: ftp: Error retrieving file: 500 Internal error
11017:
11018: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
11019: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11020: ftp: Error retrieving file: 500 Internal error
11021:
11022: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
11023: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 11024: Successfully retrieved file.</pre>
11025: <p>Generate the checksum of the distfile into
1.76 rillig 11026: <code class="filename">distinfo</code>:</p>
1.88 wiz 11027: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 11028: <p>Now compile:</p>
11029: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 11030: >> Checksum OK for bison-1.25.tar.gz.
11031: ===> Extracting for bison-1.25
11032: ===> Patching for bison-1.25
11033: ===> Ignoring empty patch directory
11034: ===> Configuring for bison-1.25
11035: creating cache ./config.cache
11036: checking for gcc... cc
11037: checking whether we are using GNU C... yes
11038: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
11039: checking how to run the C preprocessor... cc -E
11040: checking for minix/config.h... no
11041: checking for POSIXized ISC... no
11042: checking whether cross-compiling... no
11043: checking for ANSI C header files... yes
11044: checking for string.h... yes
11045: checking for stdlib.h... yes
11046: checking for memory.h... yes
11047: checking for working const... yes
11048: checking for working alloca.h... no
11049: checking for alloca... yes
11050: checking for strerror... yes
11051: updating cache ./config.cache
11052: creating ./config.status
11053: creating Makefile
11054: ===> Building for bison-1.25
11055: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
11056: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
11057: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
11058: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
11059: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 11060: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\" -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -g ./files.c
1.1 grant 11061: 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
11062: 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
11063: 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
11064: 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
11065: 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
11066: 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
11067: 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
11068: 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
11069: 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
11070: 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
11071: 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
11072: 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
11073: 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
11074: 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
11075: 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
11076: 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
11077: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
11078: rm -f bison.s1
1.75 rillig 11079: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
11080: <p>Everything seems OK, so install the files:</p>
11081: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 11082: >> Checksum OK for bison-1.25.tar.gz.
11083: ===> Installing for bison-1.25
11084: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
11085: rm -f /usr/pkg/bin/bison
11086: cd /usr/pkg/share; rm -f bison.simple bison.hairy
11087: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
11088: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
11089: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
11090: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
11091: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
11092: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 11093: ===> Registering installation for bison-1.25</pre>
11094: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 11095: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 11096: binary package, do this now:</p>
11097: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 11098: >> Checksum OK for bison-1.25.tar.gz.
11099: ===> Building package for bison-1.25
11100: Creating package bison-1.25.tgz
11101: Registering depends:.
1.75 rillig 11102: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
11103: <p>Now that you don't need the source and object files
11104: any more, clean up:</p>
11105: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
11106: ===> Cleaning for bison-1.25</pre>
11107: </div>
11108: </div>
1.148 asau 11109: <div class="appendix">
11110: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 11111: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.75 rillig 11112: <div class="toc">
11113: <p><b>Table of Contents</b></p>
1.210 leot 11114: <dl class="toc">
1.322 leot 11115: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
11116: <dd><dl>
11117: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
11118: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
11119: </dl></dd>
11120: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
11121: <dd><dl>
11122: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
11123: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
11124: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
11125: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
11126: </dl></dd>
11127: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
11128: <dd><dl>
11129: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
11130: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
11131: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
11132: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
11133: </dl></dd>
1.75 rillig 11134: </dl>
11135: </div>
1.322 leot 11136: <p>
11137: A number of mechanisms are available in pkgsrc to improve the security of the
11138: resulting system. This page describes the mechanisms, and gives hints
11139: about detecting and fixing problems.
11140: </p>
11141: <p>
11142: Mechanisms can be enabled individually in
11143: <code class="filename">mk.conf</code>, and are
11144: individually described below.
11145: </p>
11146: <p>
11147: Typically, a feature will cause some programs to fail to build or work
11148: when first enabled. This can be due to latent problems in the
11149: program, and can be due to other reasons. After enough testing to
11150: have confidence that user problems will be quite rare, individual
11151: mechanisms will be enabled by default.
11152: </p>
11153: <p>
11154: For each mechanism, see the Caveats section below for an explanation
11155: of what might go wrong at compile time and at run time, and how to
11156: notice and address these problems.
11157: </p>
1.148 asau 11158: <div class="sect1">
1.75 rillig 11159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11160: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
11161: <div class="sect2">
11162: <div class="titlepage"><div><div><h3 class="title">
11163: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
11164: <div class="sect3">
11165: <div class="titlepage"><div><div><h4 class="title">
11166: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
11167: <p>
11168: This allows substitute wrappers to be used for some commonly used
11169: library functions that do not have built-in bounds checking - but
11170: could in some cases.
11171: </p>
11172: <p>
11173: Two mitigation levels are available:
11174: </p>
11175: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11176: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
11177: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
11178: </ul></div>
11179: <p>
11180: "strong" has been enabled by default since pkgsrc-2017Q3.
11181: </p>
11182: </div>
11183: <div class="sect3">
11184: <div class="titlepage"><div><div><h4 class="title">
11185: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
11186: <p>
11187: This enables a stack-smashing protection mitigation. It is done by adding a
11188: guard variable to functions with vulnerable objects. The guards are initialized
11189: when a function is entered and then checked when the function exits. The guard
11190: check will fail and the program forcibly exited if the variable was modified in
11191: the meantime. This can happen in case of buffer overflows or memory corruption,
11192: and therefore exposing these bugs.
11193: </p>
11194: <p>
11195: Different mitigation levels are available:
11196: </p>
11197: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11198: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
11199: by the compiler;</p></li>
11200: <li class="listitem"><p>"all", which will protect every function;</p></li>
11201: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
11202: two settings above.</p></li>
11203: </ul></div>
11204: <p>
11205: This mitigation is supported by both GCC and clang. It may be supported in
11206: additional compilers, possibly under a different name. It is particularly useful
11207: for unsafe programming languages, such as C/C++.
11208: </p>
11209: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11210: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
11211: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
11212: </ul></div>
11213: <p>More details can be found here:</p>
11214: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11215: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
11216: </p></li></ul></div>
11217: </div>
11218: <div class="sect3">
11219: <div class="titlepage"><div><div><h4 class="title">
11220: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
11221: <p>
11222: This requests the creation of PIE (Position Independent Executables) for all
11223: executables. The PIE mechanism is normally used for shared libraries, so that
11224: they can be loaded at differing addresses at runtime. PIE itself does not have
11225: useful security properties; however, it is necessary to fully leverage some,
11226: such as ASLR. Some operating systems support Address Space Layout Randomization
11227: (ASLR), which causes different addresses to be used each time a program is run.
11228: This makes it more difficult for an attacker to guess addresses and thus makes
11229: exploits harder to construct. With PIE, ASLR can really be applied to the entire
11230: program, instead of the stack and heap only.
11231: </p>
11232: <p>
11233: PIE executables will only be built for toolchains that are known to support PIE.
11234: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
11235: </p>
11236: <p>
11237: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
11238: </p>
1.75 rillig 11239: </div>
1.325 gutterid 11240: <div class="sect3">
11241: <div class="titlepage"><div><div><h4 class="title">
1.334 nia 11242: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.322 leot 11243: <p>
11244: This also makes the exploitation of some security vulnerabilities more
11245: difficult in some cases.
11246: </p>
11247: <p>Two different mitigation levels are available:</p>
11248: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11249: <li class="listitem"><p>
1.334 nia 11250: partial (the default): the ELF sections are reordered so that internal data sections
1.322 leot 11251: precede the program's own data sections, and non-PLT GOT is read-only;
11252: </p></li>
11253: <li class="listitem"><p>
11254: full: in addition to partial RELRO, every relocation is performed immediately
1.333 nia 11255: when starting the program, allowing the entire GOT to be read-only. This
11256: can greatly slow down startup of large programs.
1.322 leot 11257: </p></li>
11258: </ul></div>
11259: <p>
11260: This is currently supported by GCC. Many software distributions now enable this
1.335 nia 11261: feature by default, at the "partial" level.
1.322 leot 11262: </p>
11263: <p>
11264: More details can be found here:
11265: </p>
11266: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11267: <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>
11268: </p></li></ul></div>
1.75 rillig 11269: </div>
1.334 nia 11270: </div>
11271: <div class="sect2">
11272: <div class="titlepage"><div><div><h3 class="title">
11273: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
11274: <div class="sect3">
11275: <div class="titlepage"><div><div><h4 class="title">
11276: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
11277: <p>
11278: With this option, pkgsrc will try to build packages reproducibly. This allows
11279: packages built from the same tree and with the same options, to produce
11280: identical results bit by bit. This option should be combined with ASLR and
11281: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
11282: attackers attempting to exploit security vulnerabilities.
11283: </p>
11284: <p>
11285: More details can be found here:
11286: </p>
11287: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11288: <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>
11289: </p></li></ul></div>
11290: <p>
11291: More work likely needs to be done before pkgsrc is fully reproducible.
11292: </p>
11293: </div>
1.322 leot 11294: <div class="sect3">
11295: <div class="titlepage"><div><div><h4 class="title">
1.334 nia 11296: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.322 leot 11297: <p>
11298: This uses <code class="literal">-fstack-check</code> with GCC for
11299: another stack protection mitigation.
11300: </p>
11301: <p>
11302: It asks the compiler to generate code verifying that it does not corrupt the
11303: stack. According to GCC's manual page, this is really only useful for
11304: multi-threaded programs.
11305: </p>
1.76 rillig 11306: </div>
11307: </div>
11308: </div>
1.148 asau 11309: <div class="sect1">
1.76 rillig 11310: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11311: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
11312: <div class="sect2">
11313: <div class="titlepage"><div><div><h3 class="title">
11314: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
11315: <div class="sect3">
11316: <div class="titlepage"><div><div><h4 class="title">
11317: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
11318: <p>
11319: A number of packages may fail to build with this option enabled. The
11320: failures are often related to the absence of the <code class="literal">-fPIC</code>
11321: compilation flag when building libraries or executables (or ideally
11322: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
11323: <code class="varname">CFLAGS</code> already, but requires the package to
11324: actually support it.
11325: </p>
11326: <div class="sect4">
11327: <div class="titlepage"><div><div><h5 class="title">
11328: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
11329: <p>
11330: These instructions are meant as a reference only; they likely need to be adapted
11331: for many packages individually.
11332: </p>
11333: <p>
11334: For packages using <code class="filename">Makefiles</code>:
11335: </p>
11336: <pre class="programlisting">
11337: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
11338: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
11339: </pre>
11340: <p>
11341: For packages using <code class="filename">Imakefiles</code>:
11342: </p>
11343: <pre class="programlisting">
11344: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
11345: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
11346: </pre>
11347: </div>
11348: </div>
11349: <div class="sect3">
11350: <div class="titlepage"><div><div><h4 class="title">
11351: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
11352: <p>
11353: Some programs may fail to run, or crash at random times once built as PIE. Two
11354: scenarios are essentially possible. This is nearly always due to a bug in
11355: the program being exposed due to ASLR.
11356: </p>
11357: </div>
11358: <div class="sect3">
11359: <div class="titlepage"><div><div><h4 class="title">
11360: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
11361: <p>
11362: Ideally, packages should be fixed for compatibility with MKPIE.
11363: However, in some cases this is very difficult, due to complex build systems,
11364: packages using non-standard toolchains, or programming languages with odd
11365: bootstrapping mechanisms.
11366: </p>
11367: <p>
11368: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
11369: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
11370: <code class="filename">bsd.prefs.mk</code> is included.
11371: </p>
11372: </div>
11373: </div>
11374: <div class="sect2">
11375: <div class="titlepage"><div><div><h3 class="title">
11376: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
11377: <div class="sect3">
11378: <div class="titlepage"><div><div><h4 class="title">
11379: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
11380: <p>
11381: This feature makes use of pre-processing directives to look for hardened,
11382: alternative implementations of essential library calls. Some programs may fail
11383: to build as a result; this usually happens for those trying too hard to be
11384: portable, or otherwise abusing definitions in the standard library.
11385: </p>
11386: </div>
11387: <div class="sect3">
11388: <div class="titlepage"><div><div><h4 class="title">
11389: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
11390: <p>
11391: This feature may cause some programs to crash, usually indicating an
11392: actual bug in the program. The fix will typically involve patching the
11393: original program's source code.
11394: </p>
11395: </div>
11396: <div class="sect3">
11397: <div class="titlepage"><div><div><h4 class="title">
11398: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
11399: <p>
11400: At least in the case of GCC, FORTIFY will only be applied if optimization is
11401: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
11402: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
11403: optimization level. This cannot easily be applied globally, as some packages
11404: may require specific optimization levels.
11405: </p>
11406: </div>
11407: <div class="sect3">
11408: <div class="titlepage"><div><div><h4 class="title">
11409: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
11410: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11411: <h3 class="title">Note</h3>
11412: <p>FORTIFY should not be disabled to work around runtime crashes in
11413: the program! This is a very bad idea and will expose you to security
11414: vulnerabilities.
11415: </p>
11416: </div>
11417: <p>
11418: To disable FORTIFY on a per-package basis, set the following
11419: in the package's <code class="filename">Makefile</code>
11420: before <code class="filename">bsd.prefs.mk</code> is included:
11421: </p>
11422: <pre class="programlisting">
11423: FORTIFY_SUPPORTED= no
11424: </pre>
11425: </div>
11426: </div>
11427: <div class="sect2">
11428: <div class="titlepage"><div><div><h3 class="title">
11429: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
11430: <div class="sect3">
11431: <div class="titlepage"><div><div><h4 class="title">
11432: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
11433: <p>
11434: For better protection, full RELRO requires every symbol to be resolved when the
11435: program starts, rather than simply when required at run-time. This will have
11436: more impact on programs using a lot of symbols, or linked to libraries exposing
11437: a lot of symbols. Therefore, daemons or programs otherwise running in
11438: background are affected only when started. Programs loading plug-ins at
11439: run-time are affected when loading the plug-ins.
11440: </p>
11441: <p>
11442: The impact is not expected to be noticeable on modern hardware, except in some
11443: cases for big programs.
11444: </p>
11445: </div>
11446: <div class="sect3">
11447: <div class="titlepage"><div><div><h4 class="title">
11448: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
11449: <p>
11450: Some programs handle plug-ins and dependencies in a way that conflicts with
11451: RELRO: for instance, with an initialization routine listing any other plug-in
11452: required. With full RELRO, the missing symbols are resolved before the
11453: initialization routine can run, and the dynamic loader will not be able to find
11454: them directly and abort as a result. Unfortunately, this is how Xorg loads its
11455: drivers. Partial RELRO can be applied instead in this case.
11456: </p>
11457: </div>
11458: <div class="sect3">
11459: <div class="titlepage"><div><div><h4 class="title">
11460: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
11461: <p>
11462: To disable RELRO on a per-package basis, set the following
11463: in the package's <code class="filename">Makefile</code>
11464: before <code class="filename">bsd.prefs.mk</code> is included:
11465: </p>
11466: <pre class="programlisting">
11467: RELRO_SUPPORTED= no
11468: </pre>
1.324 nia 11469: <p>
11470: It is also possible to at most enable partial RELRO, by
11471: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
11472: </p>
1.322 leot 11473: </div>
11474: </div>
11475: <div class="sect2">
11476: <div class="titlepage"><div><div><h3 class="title">
11477: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
11478: <div class="sect3">
11479: <div class="titlepage"><div><div><h4 class="title">
11480: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
11481: <p>
11482: The stack-smashing protection provided by this option does not work for some
11483: programs. The most common situation in which this happens is when the program
11484: allocates variables on the stack, with the size determined at run-time.
11485: </p>
11486: </div>
11487: <div class="sect3">
11488: <div class="titlepage"><div><div><h4 class="title">
11489: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
11490: <p>
11491: Again, this feature may cause some programs to crash via a
11492: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
11493: </p>
11494: <p>
11495: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
11496: messages are sent and - by default -
11497: appended to <code class="filename">/var/log/messages</code>, e.g.:
11498: </p>
11499: <pre class="programlisting">
11500: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
11501: </pre>
11502: <p>
11503: (where <code class="literal">hostname</code> is the hostname(1) and
11504: <code class="literal">program</code> is the basename(1) of the program crashed).
11505: </p>
11506: <p>
11507: Patching the original program is then required.
11508: </p>
11509: <p>
11510: Rebuilding the package via:
11511: </p>
11512: <pre class="programlisting">
11513: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
11514: </pre>
11515: <p>
11516: and inspecting the backtrace of the coredump via the debugger
11517: should point out the problematic call by inspecting the frame
11518: calling the _chk() (SSP) function.
11519: </p>
11520: </div>
11521: <div class="sect3">
11522: <div class="titlepage"><div><div><h4 class="title">
11523: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
11524: <p>
11525: The compiler emits extra code when using this feature: a check for buffer
11526: overflows is performed when entering and exiting functions, requiring an extra
11527: variable on the stack. The level of protection can otherwise be adjusted to
11528: affect only those functions considered more sensitive by the compiler (with
11529: -fstack-protector instead of -fstack-protector-all).
11530: </p>
11531: <p>
11532: The impact is not expected to be noticeable on modern hardware. However,
11533: programs with a hard requirement to run at the fastest possible speed should
11534: avoid using this feature, or using libraries built with this feature.
11535: </p>
11536: </div>
11537: <div class="sect3">
11538: <div class="titlepage"><div><div><h4 class="title">
11539: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
11540: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11541: <h3 class="title">Note</h3>
11542: <p>SSP should not be disabled to work around runtime crashes in
11543: the program! This is a very bad idea and will expose you to security
11544: vulnerabilities.</p>
11545: </div>
11546: <p>
11547: To disable SSP on a per-package basis, set the following
11548: in the package's <code class="filename">Makefile</code>
11549: before <code class="filename">bsd.prefs.mk</code> is included:
11550: </p>
11551: <pre class="programlisting">
11552: SSP_SUPPORTED= no
11553: </pre>
11554: </div>
11555: </div>
11556: </div>
11557: <div class="sect1">
11558: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11559: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
11560: <p>
11561: The illusion of security is worse than having no security at all. This section
11562: lists a number of ways to ensure the security features requested are actually
11563: effective.
11564: </p>
11565: <p>
11566: These instructions were obtained and tested on a system derived from NetBSD 7
11567: (amd64). YMMV.
11568: </p>
11569: <div class="sect2">
11570: <div class="titlepage"><div><div><h3 class="title">
11571: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
11572: <p>
11573: The ELF executable type in use changes for binaries built as PIE; without:
11574: </p>
11575: <pre class="programlisting">
11576: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
11577: /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
11578: </pre>
11579: <p>as opposed to the following binary, built as PIE:</p>
11580: <pre class="programlisting">
11581: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
11582: /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
11583: </pre>
11584: <p>
11585: The latter result is then what is expected.
11586: </p>
11587: </div>
11588: <div class="sect2">
11589: <div class="titlepage"><div><div><h3 class="title">
11590: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
11591: <p>
11592: The following command should list a section called RELRO:
11593: </p>
11594: <pre class="programlisting">
11595: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
11596:
11597: /path/to/bin/ary: file format elf64-x86-64
11598:
11599: Program Header:
11600: [...]
11601: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
11602: </pre>
11603: <p>
11604: This check is now performed automatically if
11605: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
11606: </p>
11607: </div>
11608: <div class="sect2">
11609: <div class="titlepage"><div><div><h3 class="title">
11610: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
11611: <p>
11612: The dynamic loader will apply RELRO immediately when detecting the presence of
11613: the <code class="varname">BIND_NOW</code> flag:
11614: </p>
11615: <pre class="programlisting">
11616: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
11617:
11618: /path/to/bin/ary: file format elf64-x86-64
11619:
11620: Dynamic Section:
11621: [...]
11622: BIND_NOW 0x0000000000000000
11623: </pre>
11624: <p>
11625: This has to be combined with partial RELRO (see above) to be fully efficient.
11626: </p>
11627: <p>
11628: This check is now performed automatically (where supported) if
11629: <code class="varname">PKG_DEVELOPER</code> is set.
11630: </p>
11631: </div>
11632: <div class="sect2">
11633: <div class="titlepage"><div><div><h3 class="title">
11634: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.323 nia 11635: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11636: <h3 class="title">Note</h3>
11637: <p>
11638: Checking for SSP using this method only works where the operating system
11639: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
11640: on recent NetBSD/FreeBSD/Linux versions.
11641: </p>
11642: </div>
1.322 leot 11643: <p>
11644: Building objects, binaries and libraries with SSP will affect the presence of
11645: additional symbols in the resulting file:
11646: </p>
11647: <pre class="programlisting">
11648: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
11649: [...]
11650: U __stack_chk_fail
11651: 0000000000600ea0 B __stack_chk_guard
11652: </pre>
11653: <p>
11654: This is an indicator that the program was indeed built with support for SSP.
11655: </p>
11656: <p>
11657: This check is now performed automatically (where supported) if
11658: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
11659: </p>
11660: </div>
11661: </div>
11662: </div>
11663: <div class="appendix">
11664: <div class="titlepage"><div><div><h1 class="title">
11665: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
11666: <div class="toc">
11667: <p><b>Table of Contents</b></p>
11668: <dl class="toc">
11669: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
11670: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
11671: </dl>
11672: </div>
11673: <div class="sect1">
11674: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11675: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
11676: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11677: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11678: => figlet221.tar.gz doesn't seem to exist on this system.
11679: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11680: => [172219 bytes]
11681: Connected to ftp.plig.net.
11682: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11683: 331 Guest login ok, send your complete e-mail address as password.
11684: 230-You are user #5 of 500 simultaneous users allowed.
11685: 230-
11686: 230- ___ _ _ _
11687: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11688: 230- | _| _| . |_| . | | | . |_| . | _| . |
11689: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11690: 230- |_| |_| |___| |___|
11691: 230-
11692: 230-** Welcome to ftp.plig.org **
11693: 230-
11694: 230-Please note that all transfers from this FTP site are logged. If you
11695: 230-do not like this, please disconnect now.
11696: 230-
11697: 230-This archive is available via
11698: 230-
11699: 230-HTTP: http://ftp.plig.org/
11700: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11701: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11702: 230-
11703: 230-Please email comments, bug reports and requests for packages to be
11704: 230-mirrored to ftp-admin@plig.org.
11705: 230-
11706: 230-
11707: 230 Logged in anonymously.
11708: Remote system type is UNIX.
11709: Using binary mode to transfer files.
11710: 200 Type okay.
11711: 250 "/pub" is new cwd.
11712: 250-"/pub/figlet" is new cwd.
11713: 250-
11714: 250-Welcome to the figlet archive at ftp.figlet.org
11715: 250-
11716: 250- ftp://ftp.figlet.org/pub/figlet/
11717: 250-
11718: 250-The official FIGlet web page is:
11719: 250- http://www.figlet.org/
11720: 250-
11721: 250-If you have questions, please mailto:info@figlet.org. If you want to
11722: 250-contribute a font or something else, you can email us.
11723: 250
11724: 250 "/pub/figlet/program" is new cwd.
11725: 250 "/pub/figlet/program/unix" is new cwd.
11726: local: figlet221.tar.gz remote: figlet221.tar.gz
11727: 502 Unimplemented command.
11728: 227 Entering Passive Mode (195,40,6,41,246,104)
11729: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11730: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11731: 226 Transfer completed.
11732: 172219 bytes received in 00:02 (75.99 KB/s)
11733: 221 Goodbye.
11734: => Checksum OK for figlet221.tar.gz.
11735: ===> Extracting for figlet-2.2.1nb2
11736: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11737: ===> Patching for figlet-2.2.1nb2
11738: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11739: ===> Overriding tools for figlet-2.2.1nb2
11740: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11741: ===> Configuring for figlet-2.2.1nb2
11742: ===> Building for figlet-2.2.1nb2
11743: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11744: chmod a+x figlet
11745: gcc -O2 -o chkfont chkfont.c
11746: => Unwrapping files-to-be-installed.
11747: <code class="prompt">#</code>
11748: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11749: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11750: ===> Installing for figlet-2.2.1nb2
11751: install -d -o root -g wheel -m 755 /usr/pkg/bin
11752: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11753: mkdir -p /usr/pkg/share/figlet
11754: cp figlet /usr/pkg/bin
11755: cp chkfont /usr/pkg/bin
11756: chmod 555 figlist showfigfonts
11757: cp figlist /usr/pkg/bin
11758: cp showfigfonts /usr/pkg/bin
11759: cp fonts/*.flf /usr/pkg/share/figlet
11760: cp fonts/*.flc /usr/pkg/share/figlet
11761: cp figlet.6 /usr/pkg/man/man6
11762: ===> Registering installation for figlet-2.2.1nb2
11763: <code class="prompt">#</code></pre>
11764: </div>
11765: <div class="sect1">
11766: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11767: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
11768: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11769: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11770: ===> Packaging figlet-2.2.1nb2
11771: ===> Building binary package for figlet-2.2.1nb2
11772: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11773: Using SrcDir value of /usr/pkg
11774: Registering depends:.
11775: <code class="prompt">#</code></pre>
11776: </div>
11777: </div>
11778: <div class="appendix">
11779: <div class="titlepage"><div><div><h1 class="title">
11780: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
11781: <div class="toc">
11782: <p><b>Table of Contents</b></p>
11783: <dl class="toc">
11784: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11785: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11786: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11787: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11788: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
11789: <code class="filename">stable</code>,
11790: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11791: source packages</a></span></dt>
11792: </dl>
11793: </div>
11794: <p>As in other big projects, the directory layout of pkgsrc
11795: is quite complex for newbies. This chapter explains where you
11796: find things on the FTP server. The base directory on
11797: <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>.
11798: On other servers it may be different, but inside this directory,
11799: everything should look the same, no matter on which server you
11800: are. This directory contains some subdirectories, which are
11801: explained below.</p>
11802: <div class="sect1">
11803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11804: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
11805: <p>The directory <code class="filename">distfiles</code> contains lots
11806: of archive files from all pkgsrc packages, which are mirrored
11807: here. The subdirectories are called after their package names
11808: and are used when the distributed files have names that don't
11809: explicitly contain a version number or are otherwise too generic
11810: (for example <code class="filename">release.tar.gz</code>).</p>
11811: </div>
11812: <div class="sect1">
11813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11814: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
11815: <p>This directory contains things that individual pkgsrc
11816: developers find worth publishing.</p>
11817: </div>
11818: <div class="sect1">
11819: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11820: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
11821: <p>This directory contains binary packages for the various
11822: platforms that are supported by pkgsrc.
11823: 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>
11824: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11825: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
11826: operating system for which the packages have been built. The
11827: name is taken from the output of the <span class="command"><strong>uname</strong></span>
11828: command, so it may differ from the one you are used to
11829: hear.</p></li>
11830: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
11831: architecture of the platform for which the packages have been
11832: built. It also includes the <code class="varname">ABI</code> (Application
11833: Binary Interface) for platforms that have several of
11834: them.</p></li>
11835: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
11836: the operating system. For version numbers that change often (for
11837: example NetBSD-current), the often-changing part should be
11838: replaced with an <code class="literal">x</code>, for example
11839: <code class="literal">4.99.x</code>.</p></li>
11840: <li class="listitem"><p><code class="varname">TAG</code> is either
11841: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11842: for a stable branch, or <code class="literal">head</code> for packages
11843: built from the HEAD branch. The latter should only be used when
11844: the packages are updated on a regular basis. Otherwise the date
11845: from checking out pkgsrc should be appended, for example
11846: <code class="literal">head_20071015</code>.</p></li>
11847: </ul></div>
11848: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11849: can quickly click through the directories on the
11850: server and find the best binary packages for their machines. Since they
11851: usually know the operating system and the hardware architecture, OPSYS
11852: and ARCH are placed first. After these choices, they can select the
11853: best combination of OSVERSION and TAG together, since it is usually the
11854: case that packages stay compatible between different version of the
11855: operating system.</p>
11856: <p>In each of these directories, there is a
11857: whole binary packages collection for a specific platform. It has a directory called
11858: <code class="filename">All</code> which contains all binary packages.
11859: Besides that, there are various category directories that
11860: contain symbolic links to the real binary packages.</p>
11861: </div>
11862: <div class="sect1">
11863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11864: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 11865: <p>Here are the reports from bulk builds, for those who want
11866: to fix packages that didn't build on some of the platforms. The
1.322 leot 11867: 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.108 rillig 11868: </div>
1.148 asau 11869: <div class="sect1">
1.108 rillig 11870: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11871: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.261 leot 11872: <code class="filename">stable</code>,
1.126 jakllsch 11873: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11874: source packages</h2></div></div></div>
1.128 wiz 11875: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 11876: that is the files that define how to create binary packages from
11877: source archives.</p>
1.262 leot 11878: <p>Each of the <code class="filename">current</code>,
11879: <code class="filename">stable</code> and
11880: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11881: directories share the same structure. They each contain a
11882: <code class="filename">pkgsrc</code> directory and
11883: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76 rillig 11884: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11885: snapshot of the CVS repository, which is updated regularly. The
1.262 leot 11886: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11887: as the directory, ready to be downloaded as a whole.</p>
11888: <p>The <code class="filename">current</code> directory contains files
11889: related to the HEAD branch of the CVS repository.
11890: In this directory there is an additional file called
11891: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11892: all pkgsrc <code class="filename">README</code>s with information about
11893: categories and packages.
11894: </p>
11895: <p>The <code class="filename">stable</code> directory is a symlink to
11896: the latest
11897: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11898: </p>
11899: <p>The
11900: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11901: directories contain files related to the
11902: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11903: stable branch of the CVS repository. In these directories there is
11904: an additional file called
11905: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.{bz,gz,xz}</code>,
1.76 rillig 11906: which contains the state of pkgsrc when it was branched.</p>
11907: </div>
1.75 rillig 11908: </div>
1.148 asau 11909: <div class="appendix">
11910: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 11911: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.267 rillig 11912: <p>
11913: The following list contains all help topics that are available
11914: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11915: </p>
1.269 leot 11916: <table border="0" summary="Simple list" class="simplelist">
11917: <tr>
11918: <td>#!</td>
11919: <td>-lintl</td>
11920: </tr>
11921: <tr>
1.320 wiz 11922: <td>32bit</td>
1.269 leot 11923: <td>64bit</td>
1.320 wiz 11924: </tr>
11925: <tr>
1.269 leot 11926: <td>ABI</td>
1.320 wiz 11927: <td>ACCEPTABLE_LICENSES</td>
1.269 leot 11928: </tr>
11929: <tr>
11930: <td>ACROREAD_FONTPATH</td>
1.320 wiz 11931: <td>ADDITIONAL</td>
1.269 leot 11932: </tr>
11933: <tr>
11934: <td>AFAIK</td>
1.320 wiz 11935: <td>AIX</td>
1.269 leot 11936: </tr>
11937: <tr>
1.357 gutterid 11938: <td>ALLOW_NEWER_COMPILER</td>
1.269 leot 11939: <td>ALLOW_VULNERABLE_PACKAGES</td>
11940: </tr>
11941: <tr>
1.357 gutterid 11942: <td>ALL_ENV</td>
1.367 ! gdt 11943: <td>ALSA_PC</td>
! 11944: </tr>
! 11945: <tr>
1.363 gutterid 11946: <td>ALTERNATIVES_SRC</td>
1.367 ! gdt 11947: <td>AMANDA_TMP</td>
1.360 leot 11948: </tr>
11949: <tr>
1.363 gutterid 11950: <td>AMANDA_USER</td>
1.367 ! gdt 11951: <td>AMANDA_VAR</td>
1.355 rillig 11952: </tr>
11953: <tr>
1.363 gutterid 11954: <td>APACHE_GROUP</td>
1.367 ! gdt 11955: <td>APACHE_MODULE_NAME</td>
1.352 wiz 11956: </tr>
11957: <tr>
1.363 gutterid 11958: <td>APACHE_MODULE_SRC</td>
1.367 ! gdt 11959: <td>APACHE_MODULE_SRCDIR</td>
1.348 wiz 11960: </tr>
11961: <tr>
1.363 gutterid 11962: <td>APACHE_PKG_PREFIX</td>
1.367 ! gdt 11963: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.342 wiz 11964: </tr>
11965: <tr>
1.363 gutterid 11966: <td>APACHE_SUEXEC_DOCROOT</td>
1.367 ! gdt 11967: <td>APACHE_USER</td>
1.338 nia 11968: </tr>
11969: <tr>
1.363 gutterid 11970: <td>APPEND_ABI</td>
1.367 ! gdt 11971: <td>APPEND_ELF</td>
1.332 rillig 11972: </tr>
11973: <tr>
1.363 gutterid 11974: <td>ARLA_CACHE</td>
1.367 ! gdt 11975: <td>AUDIT_PACKAGES_FLAGS</td>
1.329 leot 11976: </tr>
11977: <tr>
1.363 gutterid 11978: <td>AUTOCONF_REQD</td>
1.367 ! gdt 11979: <td>AUTOMAKE_OVERRIDE</td>
1.327 wiz 11980: </tr>
11981: <tr>
1.363 gutterid 11982: <td>AUTOMAKE_REQD</td>
1.367 ! gdt 11983: <td>AUTO_MKDIRS</td>
1.311 leot 11984: </tr>
11985: <tr>
1.363 gutterid 11986: <td>BDB185_DEFAULT</td>
1.367 ! gdt 11987: <td>BDBBASE</td>
1.292 leot 11988: </tr>
11989: <tr>
1.363 gutterid 11990: <td>BDB_ACCEPTED</td>
1.367 ! gdt 11991: <td>BDB_DEFAULT</td>
1.274 rillig 11992: </tr>
11993: <tr>
1.363 gutterid 11994: <td>BDB_LIBS</td>
1.367 ! gdt 11995: <td>BDB_TYPE</td>
1.269 leot 11996: </tr>
11997: <tr>
1.363 gutterid 11998: <td>BINCIMAP_GROUP</td>
1.367 ! gdt 11999: <td>BINCIMAP_USER</td>
1.269 leot 12000: </tr>
12001: <tr>
1.363 gutterid 12002: <td>BIND_DIR</td>
1.367 ! gdt 12003: <td>BIND_GROUP</td>
1.269 leot 12004: </tr>
12005: <tr>
1.363 gutterid 12006: <td>BIND_USER</td>
1.367 ! gdt 12007: <td>BINOWN</td>
1.269 leot 12008: </tr>
12009: <tr>
1.363 gutterid 12010: <td>BINPKG_SITES</td>
1.367 ! gdt 12011: <td>BIN_INSTALL_FLAGS</td>
1.269 leot 12012: </tr>
12013: <tr>
1.363 gutterid 12014: <td>BISON_PKGDATADIR</td>
1.367 ! gdt 12015: <td>BLAS</td>
1.269 leot 12016: </tr>
12017: <tr>
1.363 gutterid 12018: <td>BLAS_ACCEPTED</td>
1.367 ! gdt 12019: <td>BLAS_C_INTERFACE</td>
1.269 leot 12020: </tr>
12021: <tr>
1.363 gutterid 12022: <td>BLAS_INCLUDES</td>
1.367 ! gdt 12023: <td>BLAS_INDEX64</td>
1.269 leot 12024: </tr>
12025: <tr>
1.363 gutterid 12026: <td>BLAS_LIBS</td>
1.367 ! gdt 12027: <td>BLAS_PC</td>
1.269 leot 12028: </tr>
12029: <tr>
1.363 gutterid 12030: <td>BLAS_TYPE</td>
1.367 ! gdt 12031: <td>BOOTSTRAP_DEPENDS</td>
1.269 leot 12032: </tr>
12033: <tr>
1.363 gutterid 12034: <td>BROKEN</td>
1.367 ! gdt 12035: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.269 leot 12036: </tr>
12037: <tr>
1.363 gutterid 12038: <td>BROKEN_ON_PLATFORM</td>
1.367 ! gdt 12039: <td>BSDSRCDIR</td>
1.312 gdt 12040: </tr>
12041: <tr>
1.363 gutterid 12042: <td>BSDXSRCDIR</td>
1.367 ! gdt 12043: <td>BSD_MAKE_ENV</td>
1.344 gutterid 12044: </tr>
12045: <tr>
1.363 gutterid 12046: <td>BUILDLINK_AUTO_DIRS</td>
1.367 ! gdt 12047: <td>BUILDLINK_AUTO_VARS</td>
1.269 leot 12048: </tr>
12049: <tr>
1.363 gutterid 12050: <td>BUILDLINK_CFLAGS</td>
1.367 ! gdt 12051: <td>BUILDLINK_CONTENTS_FILTER</td>
1.269 leot 12052: </tr>
12053: <tr>
1.355 rillig 12054: <td>BUILDLINK_CPPFLAGS</td>
1.367 ! gdt 12055: <td>BUILDLINK_DEPMETHOD</td>
1.269 leot 12056: </tr>
12057: <tr>
1.357 gutterid 12058: <td>BUILDLINK_FILES</td>
1.331 gutterid 12059: <td>BUILDLINK_FILES_CMD</td>
1.320 wiz 12060: </tr>
12061: <tr>
1.357 gutterid 12062: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.331 gutterid 12063: <td>BUILDLINK_LDFLAGS</td>
1.269 leot 12064: </tr>
12065: <tr>
1.357 gutterid 12066: <td>BUILDLINK_LIBS</td>
1.331 gutterid 12067: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.269 leot 12068: </tr>
12069: <tr>
1.357 gutterid 12070: <td>BUILDLINK_PKGNAME</td>
1.331 gutterid 12071: <td>BUILDLINK_PREFIX</td>
1.269 leot 12072: </tr>
12073: <tr>
1.357 gutterid 12074: <td>BUILDLINK_RPATHDIRS</td>
1.331 gutterid 12075: <td>BUILDLINK_TREE</td>
1.269 leot 12076: </tr>
12077: <tr>
1.357 gutterid 12078: <td>BUILD_DEFS</td>
1.331 gutterid 12079: <td>BUILD_DEFS_EFFECTS</td>
1.269 leot 12080: </tr>
12081: <tr>
1.357 gutterid 12082: <td>BUILD_DEPENDS</td>
1.331 gutterid 12083: <td>BUILD_DIRS</td>
1.269 leot 12084: </tr>
12085: <tr>
1.357 gutterid 12086: <td>BUILD_ENV_SHELL</td>
1.331 gutterid 12087: <td>BUILD_MAKE_CMD</td>
1.269 leot 12088: </tr>
12089: <tr>
1.357 gutterid 12090: <td>BUILD_MAKE_FLAGS</td>
1.331 gutterid 12091: <td>BUILD_TARGET</td>
1.269 leot 12092: </tr>
12093: <tr>
1.357 gutterid 12094: <td>BUILTIN_FIND_FILES</td>
1.331 gutterid 12095: <td>BUILTIN_FIND_FILES_VAR</td>
1.269 leot 12096: </tr>
12097: <tr>
1.357 gutterid 12098: <td>BUILTIN_FIND_GREP</td>
1.331 gutterid 12099: <td>BUILTIN_FIND_HEADERS</td>
1.269 leot 12100: </tr>
12101: <tr>
1.357 gutterid 12102: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.331 gutterid 12103: <td>BUILTIN_FIND_PKGCONFIG</td>
1.269 leot 12104: </tr>
12105: <tr>
1.357 gutterid 12106: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.331 gutterid 12107: <td>BUILTIN_PKG</td>
1.309 gutterid 12108: </tr>
12109: <tr>
1.357 gutterid 12110: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.331 gutterid 12111: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.269 leot 12112: </tr>
12113: <tr>
1.357 gutterid 12114: <td>BUILTIN_VERSION_SCRIPT</td>
1.331 gutterid 12115: <td>BUILTIN_X11_TYPE</td>
1.269 leot 12116: </tr>
12117: <tr>
1.357 gutterid 12118: <td>BUILTIN_X11_VERSION</td>
1.331 gutterid 12119: <td>CACTI_GROUP</td>
1.269 leot 12120: </tr>
12121: <tr>
1.357 gutterid 12122: <td>CACTI_USER</td>
1.331 gutterid 12123: <td>CANNA_GROUP</td>
1.269 leot 12124: </tr>
12125: <tr>
1.357 gutterid 12126: <td>CANNA_USER</td>
1.331 gutterid 12127: <td>CAT</td>
1.269 leot 12128: </tr>
12129: <tr>
1.357 gutterid 12130: <td>CBLAS_LIBS</td>
1.344 gutterid 12131: <td>CBLAS_PC</td>
1.269 leot 12132: </tr>
12133: <tr>
1.357 gutterid 12134: <td>CCACHE_BASE</td>
1.303 bacon 12135: <td>CCACHE_DIR</td>
1.269 leot 12136: </tr>
12137: <tr>
1.357 gutterid 12138: <td>CCACHE_LOGFILE</td>
1.303 bacon 12139: <td>CC_VERSION</td>
1.269 leot 12140: </tr>
12141: <tr>
1.357 gutterid 12142: <td>CC_VERSION_STRING</td>
1.303 bacon 12143: <td>CDRECORD_CONF</td>
1.269 leot 12144: </tr>
12145: <tr>
1.357 gutterid 12146: <td>CDROM_PKG_URL_DIR</td>
1.303 bacon 12147: <td>CDROM_PKG_URL_HOST</td>
1.338 nia 12148: </tr>
12149: <tr>
1.357 gutterid 12150: <td>CHANGES</td>
1.367 ! gdt 12151: <td>CHECKOUT_DATE</td>
! 12152: </tr>
! 12153: <tr>
1.363 gutterid 12154: <td>CHECK_COMPILER</td>
1.367 ! gdt 12155: <td>CHECK_FAKEHOME</td>
1.360 leot 12156: </tr>
12157: <tr>
1.363 gutterid 12158: <td>CHECK_FILES</td>
1.367 ! gdt 12159: <td>CHECK_FILES_SKIP</td>
1.355 rillig 12160: </tr>
12161: <tr>
1.363 gutterid 12162: <td>CHECK_FILES_STRICT</td>
1.367 ! gdt 12163: <td>CHECK_HEADERS</td>
1.352 wiz 12164: </tr>
12165: <tr>
1.363 gutterid 12166: <td>CHECK_HEADERS_SKIP</td>
1.367 ! gdt 12167: <td>CHECK_INTERPRETER</td>
1.348 wiz 12168: </tr>
12169: <tr>
1.363 gutterid 12170: <td>CHECK_INTERPRETER_SKIP</td>
1.367 ! gdt 12171: <td>CHECK_PERMS</td>
1.342 wiz 12172: </tr>
12173: <tr>
1.363 gutterid 12174: <td>CHECK_PERMS_AUTOFIX</td>
1.367 ! gdt 12175: <td>CHECK_PERMS_SKIP</td>
1.332 rillig 12176: </tr>
12177: <tr>
1.363 gutterid 12178: <td>CHECK_PIE</td>
1.367 ! gdt 12179: <td>CHECK_PIE_SKIP</td>
1.329 leot 12180: </tr>
12181: <tr>
1.363 gutterid 12182: <td>CHECK_PIE_SUPPORTED</td>
1.367 ! gdt 12183: <td>CHECK_PORTABILITY</td>
1.327 wiz 12184: </tr>
12185: <tr>
1.363 gutterid 12186: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.367 ! gdt 12187: <td>CHECK_PORTABILITY_SKIP</td>
1.320 wiz 12188: </tr>
12189: <tr>
1.363 gutterid 12190: <td>CHECK_RELRO</td>
1.367 ! gdt 12191: <td>CHECK_RELRO_SKIP</td>
1.311 leot 12192: </tr>
12193: <tr>
1.363 gutterid 12194: <td>CHECK_RELRO_SUPPORTED</td>
1.367 ! gdt 12195: <td>CHECK_SHLIBS</td>
1.292 leot 12196: </tr>
12197: <tr>
1.363 gutterid 12198: <td>CHECK_SHLIBS_SKIP</td>
1.367 ! gdt 12199: <td>CHECK_SHLIBS_SUPPORTED</td>
1.274 rillig 12200: </tr>
12201: <tr>
1.363 gutterid 12202: <td>CHECK_SHLIBS_TOXIC</td>
1.367 ! gdt 12203: <td>CHECK_SSP</td>
1.331 gutterid 12204: </tr>
12205: <tr>
1.363 gutterid 12206: <td>CHECK_SSP_SKIP</td>
1.367 ! gdt 12207: <td>CHECK_SSP_SUPPORTED</td>
1.269 leot 12208: </tr>
12209: <tr>
1.363 gutterid 12210: <td>CHECK_STRIPPED</td>
1.367 ! gdt 12211: <td>CHECK_STRIPPED_SKIP</td>
1.269 leot 12212: </tr>
12213: <tr>
1.363 gutterid 12214: <td>CHECK_WRKREF</td>
1.367 ! gdt 12215: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.269 leot 12216: </tr>
12217: <tr>
1.363 gutterid 12218: <td>CHECK_WRKREF_SKIP</td>
1.367 ! gdt 12219: <td>CLAMAV_DBDIR</td>
1.269 leot 12220: </tr>
12221: <tr>
1.363 gutterid 12222: <td>CLAMAV_GROUP</td>
1.367 ! gdt 12223: <td>CLAMAV_USER</td>
1.269 leot 12224: </tr>
12225: <tr>
1.363 gutterid 12226: <td>CLANGBASE</td>
1.367 ! gdt 12227: <td>CLEANDEPENDS</td>
1.269 leot 12228: </tr>
12229: <tr>
1.363 gutterid 12230: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.367 ! gdt 12231: <td>CMAKE_INSTALL_NAME_DIR</td>
1.269 leot 12232: </tr>
12233: <tr>
1.363 gutterid 12234: <td>CMAKE_INSTALL_PREFIX</td>
1.367 ! gdt 12235: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.269 leot 12236: </tr>
12237: <tr>
1.363 gutterid 12238: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.367 ! gdt 12239: <td>CMAKE_PREFIX_PATH</td>
1.269 leot 12240: </tr>
12241: <tr>
1.355 rillig 12242: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.367 ! gdt 12243: <td>COMMON_LISP_DOCFILES</td>
! 12244: </tr>
! 12245: <tr>
! 12246: <td>COMMON_LISP_EXAMPLES</td>
! 12247: <td>COMMON_LISP_EXTRAFILES</td>
! 12248: </tr>
! 12249: <tr>
! 12250: <td>COMMON_LISP_PACKAGES</td>
! 12251: <td>COMMON_LISP_SYSTEM</td>
1.269 leot 12252: </tr>
12253: <tr>
1.357 gutterid 12254: <td>COMPILER_RPATH_FLAG</td>
1.341 gutterid 12255: <td>COMPILER_USE_SYMLINKS</td>
1.269 leot 12256: </tr>
12257: <tr>
1.357 gutterid 12258: <td>CONFIGURE_ARGS</td>
1.341 gutterid 12259: <td>CONFIGURE_DIRS</td>
1.269 leot 12260: </tr>
12261: <tr>
1.357 gutterid 12262: <td>CONFIGURE_ENV</td>
1.341 gutterid 12263: <td>CONFIGURE_ENV_SHELL</td>
1.269 leot 12264: </tr>
12265: <tr>
1.357 gutterid 12266: <td>CONFIGURE_HAS_INFODIR</td>
1.341 gutterid 12267: <td>CONFIGURE_HAS_MANDIR</td>
1.269 leot 12268: </tr>
12269: <tr>
1.357 gutterid 12270: <td>CONFIGURE_SCRIPT</td>
1.341 gutterid 12271: <td>CONFIG_SHELL</td>
1.269 leot 12272: </tr>
12273: <tr>
1.357 gutterid 12274: <td>CONFIG_SHELL_FLAGS</td>
1.341 gutterid 12275: <td>CONF_FILES</td>
1.269 leot 12276: </tr>
12277: <tr>
1.357 gutterid 12278: <td>CONF_FILES_MODE</td>
1.341 gutterid 12279: <td>CONF_FILES_PERMS</td>
1.269 leot 12280: </tr>
12281: <tr>
1.357 gutterid 12282: <td>CONSERVER_DEFAULTHOST</td>
1.341 gutterid 12283: <td>CONSERVER_DEFAULTPORT</td>
1.269 leot 12284: </tr>
12285: <tr>
1.357 gutterid 12286: <td>CP</td>
1.347 gutterid 12287: <td>CPE</td>
12288: </tr>
12289: <tr>
1.357 gutterid 12290: <td>CPE_EDITION</td>
1.347 gutterid 12291: <td>CPE_LANG</td>
12292: </tr>
12293: <tr>
1.357 gutterid 12294: <td>CPE_OTHER</td>
1.347 gutterid 12295: <td>CPE_PART</td>
12296: </tr>
12297: <tr>
1.357 gutterid 12298: <td>CPE_PRODUCT</td>
1.347 gutterid 12299: <td>CPE_SW_EDITION</td>
12300: </tr>
12301: <tr>
1.357 gutterid 12302: <td>CPE_TARGET_HW</td>
1.347 gutterid 12303: <td>CPE_TARGET_SW</td>
12304: </tr>
12305: <tr>
1.357 gutterid 12306: <td>CPE_UPDATE</td>
1.347 gutterid 12307: <td>CPE_URI</td>
12308: </tr>
12309: <tr>
1.357 gutterid 12310: <td>CPE_VENDOR</td>
1.347 gutterid 12311: <td>CPE_VERSION</td>
1.269 leot 12312: </tr>
12313: <tr>
1.357 gutterid 12314: <td>CPP</td>
1.347 gutterid 12315: <td>CPP_PRECOMP_FLAGS</td>
1.269 leot 12316: </tr>
12317: <tr>
1.357 gutterid 12318: <td>CREATE_WRKDIR_SYMLINK</td>
1.347 gutterid 12319: <td>CROSSBASE</td>
1.269 leot 12320: </tr>
12321: <tr>
1.357 gutterid 12322: <td>CTFCONVERT</td>
1.347 gutterid 12323: <td>CTF_FILES_SKIP</td>
1.269 leot 12324: </tr>
12325: <tr>
1.357 gutterid 12326: <td>CTF_SUPPORTED</td>
1.347 gutterid 12327: <td>CTYPE</td>
1.269 leot 12328: </tr>
12329: <tr>
1.357 gutterid 12330: <td>CUPS_GROUP</td>
1.347 gutterid 12331: <td>CUPS_SYSTEM_GROUPS</td>
1.292 leot 12332: </tr>
12333: <tr>
1.357 gutterid 12334: <td>CUPS_USER</td>
1.347 gutterid 12335: <td>CURSES_DEFAULT</td>
1.342 wiz 12336: </tr>
12337: <tr>
1.357 gutterid 12338: <td>CURSES_TYPE</td>
1.367 ! gdt 12339: <td>CVS_EXTRACTDIR</td>
! 12340: </tr>
! 12341: <tr>
! 12342: <td>CVS_MODULE</td>
! 12343: <td>CVS_PROJECT</td>
! 12344: </tr>
! 12345: <tr>
! 12346: <td>CVS_REPOSITORIES</td>
! 12347: <td>CVS_ROOT</td>
! 12348: </tr>
! 12349: <tr>
! 12350: <td>CVS_ROOT_GNU</td>
! 12351: <td>CVS_ROOT_NONGNU</td>
! 12352: </tr>
! 12353: <tr>
! 12354: <td>CVS_ROOT_SOURCEFORGE</td>
! 12355: <td>CVS_TAG</td>
! 12356: </tr>
! 12357: <tr>
1.363 gutterid 12358: <td>CXX</td>
1.367 ! gdt 12359: <td>CYRUS_GROUP</td>
1.360 leot 12360: </tr>
12361: <tr>
1.363 gutterid 12362: <td>CYRUS_IDLE</td>
1.367 ! gdt 12363: <td>CYRUS_USER</td>
1.352 wiz 12364: </tr>
12365: <tr>
1.363 gutterid 12366: <td>DAEMONTOOLS_GROUP</td>
1.367 ! gdt 12367: <td>DAEMONTOOLS_LOG_USER</td>
1.348 wiz 12368: </tr>
12369: <tr>
1.363 gutterid 12370: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.367 ! gdt 12371: <td>DARWIN_REQUIRES_FILTER</td>
1.332 rillig 12372: </tr>
12373: <tr>
1.363 gutterid 12374: <td>DBUS_GROUP</td>
1.367 ! gdt 12375: <td>DBUS_USER</td>
1.329 leot 12376: </tr>
12377: <tr>
1.363 gutterid 12378: <td>DEFANG_GROUP</td>
1.367 ! gdt 12379: <td>DEFANG_USER</td>
1.327 wiz 12380: </tr>
12381: <tr>
1.363 gutterid 12382: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.367 ! gdt 12383: <td>DEFAULT_DISTFILES</td>
1.320 wiz 12384: </tr>
12385: <tr>
1.363 gutterid 12386: <td>DEFAULT_IRC_SERVER</td>
1.367 ! gdt 12387: <td>DEFAULT_SERIAL_DEVICE</td>
1.311 leot 12388: </tr>
12389: <tr>
1.363 gutterid 12390: <td>DEF_UMASK</td>
1.367 ! gdt 12391: <td>DEINSTALLDEPENDS</td>
1.269 leot 12392: </tr>
12393: <tr>
1.363 gutterid 12394: <td>DEINSTALL_SRC</td>
1.367 ! gdt 12395: <td>DEINSTALL_TEMPLATES</td>
1.269 leot 12396: </tr>
12397: <tr>
1.363 gutterid 12398: <td>DELAYED_ERROR_MSG</td>
1.367 ! gdt 12399: <td>DELAYED_WARNING_MSG</td>
1.269 leot 12400: </tr>
12401: <tr>
1.363 gutterid 12402: <td>DEPENDS</td>
1.367 ! gdt 12403: <td>DEPENDS_TARGET</td>
1.309 gutterid 12404: </tr>
12405: <tr>
1.363 gutterid 12406: <td>DEPENDS_TYPE</td>
1.367 ! gdt 12407: <td>DESTDIR</td>
1.269 leot 12408: </tr>
12409: <tr>
1.363 gutterid 12410: <td>DESTDIR_VARNAME</td>
1.367 ! gdt 12411: <td>DIALER_GROUP</td>
1.269 leot 12412: </tr>
12413: <tr>
1.363 gutterid 12414: <td>DIGEST_REQD</td>
1.367 ! gdt 12415: <td>DISTDIR</td>
1.269 leot 12416: </tr>
12417: <tr>
1.363 gutterid 12418: <td>DISTFILES</td>
1.367 ! gdt 12419: <td>DISTINFO_FILE</td>
1.269 leot 12420: </tr>
12421: <tr>
1.363 gutterid 12422: <td>DISTNAME</td>
1.367 ! gdt 12423: <td>DIST_PATH</td>
1.269 leot 12424: </tr>
12425: <tr>
1.363 gutterid 12426: <td>DIST_SUBDIR</td>
1.367 ! gdt 12427: <td>DJBDNS_AXFR_USER</td>
1.269 leot 12428: </tr>
12429: <tr>
1.363 gutterid 12430: <td>DJBDNS_CACHE_USER</td>
1.367 ! gdt 12431: <td>DJBDNS_DJBDNS_GROUP</td>
1.269 leot 12432: </tr>
12433: <tr>
1.363 gutterid 12434: <td>DJBDNS_LOG_USER</td>
1.367 ! gdt 12435: <td>DJBDNS_RBL_USER</td>
1.269 leot 12436: </tr>
12437: <tr>
1.363 gutterid 12438: <td>DJBDNS_TINY_USER</td>
1.367 ! gdt 12439: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.269 leot 12440: </tr>
12441: <tr>
1.363 gutterid 12442: <td>DL_AUTO_VARS</td>
1.367 ! gdt 12443: <td>DL_CFLAGS</td>
1.269 leot 12444: </tr>
12445: <tr>
1.363 gutterid 12446: <td>DL_LDFLAGS</td>
1.367 ! gdt 12447: <td>DL_LIBS</td>
1.269 leot 12448: </tr>
12449: <tr>
1.363 gutterid 12450: <td>DNS</td>
1.367 ! gdt 12451: <td>DOCOWN</td>
1.269 leot 12452: </tr>
12453: <tr>
1.363 gutterid 12454: <td>DOWNLOADED_DISTFILE</td>
1.367 ! gdt 12455: <td>DQCACHE_GROUP</td>
1.269 leot 12456: </tr>
12457: <tr>
1.363 gutterid 12458: <td>DQCACHE_USER</td>
1.367 ! gdt 12459: <td>DT_LAYOUT</td>
1.269 leot 12460: </tr>
12461: <tr>
1.363 gutterid 12462: <td>DYNAMIC_SITES_CMD</td>
1.367 ! gdt 12463: <td>DYNAMIC_SITES_SCRIPT</td>
1.269 leot 12464: </tr>
12465: <tr>
1.363 gutterid 12466: <td>ECHO</td>
1.367 ! gdt 12467: <td>ECHO_N</td>
1.269 leot 12468: </tr>
12469: <tr>
1.363 gutterid 12470: <td>ELK_GUI</td>
1.367 ! gdt 12471: <td>EMACS_TYPE</td>
1.357 gutterid 12472: </tr>
12473: <tr>
1.363 gutterid 12474: <td>EMULDIR</td>
1.367 ! gdt 12475: <td>EMULSUBDIR</td>
1.333 nia 12476: </tr>
12477: <tr>
1.363 gutterid 12478: <td>EMULSUBDIRSLASH</td>
1.367 ! gdt 12479: <td>EMUL_ARCH</td>
1.269 leot 12480: </tr>
12481: <tr>
1.363 gutterid 12482: <td>EMUL_DISTRO</td>
1.367 ! gdt 12483: <td>EMUL_EXEC_FMT</td>
1.269 leot 12484: </tr>
12485: <tr>
1.363 gutterid 12486: <td>EMUL_IS_NATIVE</td>
1.367 ! gdt 12487: <td>EMUL_MODULES</td>
1.269 leot 12488: </tr>
12489: <tr>
1.363 gutterid 12490: <td>EMUL_OPSYS</td>
1.367 ! gdt 12491: <td>EMUL_PKG_FMT</td>
1.269 leot 12492: </tr>
12493: <tr>
1.363 gutterid 12494: <td>EMUL_PLATFORM</td>
1.367 ! gdt 12495: <td>EMUL_PLATFORMS</td>
1.269 leot 12496: </tr>
12497: <tr>
1.363 gutterid 12498: <td>EMUL_PREFER</td>
1.367 ! gdt 12499: <td>EMUL_REQD</td>
1.269 leot 12500: </tr>
12501: <tr>
1.363 gutterid 12502: <td>EMUL_TYPE</td>
1.367 ! gdt 12503: <td>ERROR_MSG</td>
1.269 leot 12504: </tr>
12505: <tr>
1.363 gutterid 12506: <td>EXIM_GROUP</td>
1.367 ! gdt 12507: <td>EXIM_USER</td>
1.269 leot 12508: </tr>
12509: <tr>
1.363 gutterid 12510: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.367 ! gdt 12511: <td>EXTRACTOR</td>
1.269 leot 12512: </tr>
12513: <tr>
1.363 gutterid 12514: <td>EXTRACT_CMD</td>
1.367 ! gdt 12515: <td>EXTRACT_CMD_DEFAULT</td>
1.269 leot 12516: </tr>
12517: <tr>
1.363 gutterid 12518: <td>EXTRACT_DIR</td>
1.367 ! gdt 12519: <td>EXTRACT_ELEMENTS</td>
1.269 leot 12520: </tr>
12521: <tr>
1.363 gutterid 12522: <td>EXTRACT_ENV</td>
1.367 ! gdt 12523: <td>EXTRACT_ONLY</td>
1.269 leot 12524: </tr>
12525: <tr>
1.363 gutterid 12526: <td>EXTRACT_OPTS</td>
1.367 ! gdt 12527: <td>EXTRACT_SUFX</td>
1.269 leot 12528: </tr>
12529: <tr>
1.363 gutterid 12530: <td>EXTRACT_USING</td>
1.367 ! gdt 12531: <td>FAIL</td>
1.338 nia 12532: </tr>
12533: <tr>
1.363 gutterid 12534: <td>FAILOVER_FETCH</td>
1.367 ! gdt 12535: <td>FAIL_MSG</td>
1.269 leot 12536: </tr>
12537: <tr>
1.363 gutterid 12538: <td>FAKE_NCURSES</td>
1.367 ! gdt 12539: <td>FAM</td>
1.269 leot 12540: </tr>
12541: <tr>
1.363 gutterid 12542: <td>FAM_ACCEPTED</td>
1.367 ! gdt 12543: <td>FAM_DEFAULT</td>
1.269 leot 12544: </tr>
12545: <tr>
1.363 gutterid 12546: <td>FAM_SERVER</td>
1.367 ! gdt 12547: <td>FCPATH</td>
1.269 leot 12548: </tr>
12549: <tr>
1.363 gutterid 12550: <td>FEATURE_CPPFLAGS</td>
1.367 ! gdt 12551: <td>FEATURE_LDFLAGS</td>
1.269 leot 12552: </tr>
12553: <tr>
1.363 gutterid 12554: <td>FEATURE_LIBS</td>
1.367 ! gdt 12555: <td>FETCH_AFTER_ARGS</td>
1.269 leot 12556: </tr>
12557: <tr>
1.363 gutterid 12558: <td>FETCH_BEFORE_ARGS</td>
1.367 ! gdt 12559: <td>FETCH_CMD</td>
1.269 leot 12560: </tr>
12561: <tr>
1.363 gutterid 12562: <td>FETCH_OUTPUT_ARGS</td>
1.367 ! gdt 12563: <td>FETCH_PROXY</td>
1.269 leot 12564: </tr>
12565: <tr>
1.363 gutterid 12566: <td>FETCH_RESUME_ARGS</td>
1.367 ! gdt 12567: <td>FETCH_TIMEOUT</td>
1.269 leot 12568: </tr>
12569: <tr>
1.363 gutterid 12570: <td>FETCH_USE_IPV4_ONLY</td>
1.367 ! gdt 12571: <td>FETCH_USING</td>
1.292 leot 12572: </tr>
12573: <tr>
1.363 gutterid 12574: <td>FILES_SUBST</td>
1.367 ! gdt 12575: <td>FILES_SUBST_SED</td>
1.355 rillig 12576: </tr>
12577: <tr>
1.357 gutterid 12578: <td>FIX_SYSTEM_HEADERS</td>
1.367 ! gdt 12579: <td>FONTDIR</td>
1.269 leot 12580: </tr>
12581: <tr>
1.341 gutterid 12582: <td>FONTS_DIRS</td>
1.357 gutterid 12583: <td>FONTS_VERBOSE</td>
1.292 leot 12584: </tr>
12585: <tr>
1.341 gutterid 12586: <td>FOO_HACKS_MK</td>
1.358 gutterid 12587: <td>FORCE_CXX_STD</td>
12588: </tr>
12589: <tr>
12590: <td>FORCE_C_STD</td>
1.367 ! gdt 12591: <td>FOSSIL_EXTRACTDIR</td>
! 12592: </tr>
! 12593: <tr>
! 12594: <td>FOSSIL_REPO</td>
! 12595: <td>FOSSIL_REPOSITORIES</td>
! 12596: </tr>
! 12597: <tr>
! 12598: <td>FOSSIL_VERSION</td>
1.357 gutterid 12599: <td>FOX_USE_XUNICODE</td>
1.269 leot 12600: </tr>
12601: <tr>
1.341 gutterid 12602: <td>FREEWNN_GROUP</td>
1.357 gutterid 12603: <td>FREEWNN_USER</td>
1.269 leot 12604: </tr>
12605: <tr>
1.341 gutterid 12606: <td>FTP_PKG_URL_DIR</td>
1.357 gutterid 12607: <td>FTP_PKG_URL_HOST</td>
1.269 leot 12608: </tr>
12609: <tr>
1.341 gutterid 12610: <td>GAMEDATAMODE</td>
1.357 gutterid 12611: <td>GAMEDATA_PERMS</td>
1.269 leot 12612: </tr>
12613: <tr>
1.341 gutterid 12614: <td>GAMEDIRMODE</td>
1.357 gutterid 12615: <td>GAMEDIR_PERMS</td>
1.269 leot 12616: </tr>
12617: <tr>
1.341 gutterid 12618: <td>GAMEGRP</td>
1.357 gutterid 12619: <td>GAMEMODE</td>
1.269 leot 12620: </tr>
12621: <tr>
1.341 gutterid 12622: <td>GAMEOWN</td>
1.357 gutterid 12623: <td>GAMES_GROUP</td>
1.269 leot 12624: </tr>
12625: <tr>
1.341 gutterid 12626: <td>GAMES_USER</td>
1.357 gutterid 12627: <td>GCC</td>
1.269 leot 12628: </tr>
12629: <tr>
1.341 gutterid 12630: <td>GCCBASE</td>
1.357 gutterid 12631: <td>GCC_REQD</td>
1.269 leot 12632: </tr>
12633: <tr>
1.341 gutterid 12634: <td>GCC_VERSION_SUFFIX</td>
1.357 gutterid 12635: <td>GEM_BUILD</td>
1.269 leot 12636: </tr>
12637: <tr>
1.341 gutterid 12638: <td>GEM_CLEANBUILD</td>
1.357 gutterid 12639: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.269 leot 12640: </tr>
12641: <tr>
1.341 gutterid 12642: <td>GEM_DOCDIR</td>
1.357 gutterid 12643: <td>GEM_EXTSDIR</td>
1.292 leot 12644: </tr>
12645: <tr>
1.341 gutterid 12646: <td>GEM_HOME</td>
1.357 gutterid 12647: <td>GEM_KEEPBUILD</td>
1.269 leot 12648: </tr>
12649: <tr>
1.341 gutterid 12650: <td>GEM_LIBDIR</td>
1.357 gutterid 12651: <td>GEM_NAME</td>
1.269 leot 12652: </tr>
12653: <tr>
1.341 gutterid 12654: <td>GEM_PATH</td>
1.357 gutterid 12655: <td>GEM_PLUGINSDIR</td>
1.269 leot 12656: </tr>
12657: <tr>
1.341 gutterid 12658: <td>GEM_SPECFILE</td>
1.357 gutterid 12659: <td>GENERATE_PLIST</td>
1.269 leot 12660: </tr>
12661: <tr>
1.341 gutterid 12662: <td>GHC</td>
1.357 gutterid 12663: <td>GHOSTSCRIPT_REQD</td>
1.292 leot 12664: </tr>
12665: <tr>
1.341 gutterid 12666: <td>GITHUB_PROJECT</td>
1.357 gutterid 12667: <td>GITHUB_RELEASE</td>
1.311 leot 12668: </tr>
12669: <tr>
1.341 gutterid 12670: <td>GITHUB_SUBMODULES</td>
1.357 gutterid 12671: <td>GITHUB_TAG</td>
1.269 leot 12672: </tr>
12673: <tr>
1.341 gutterid 12674: <td>GITHUB_TYPE</td>
1.357 gutterid 12675: <td>GITLAB_PROJECT</td>
1.338 nia 12676: </tr>
12677: <tr>
1.341 gutterid 12678: <td>GITLAB_RELEASE</td>
1.357 gutterid 12679: <td>GITLAB_SUBMODULES</td>
1.338 nia 12680: </tr>
12681: <tr>
1.341 gutterid 12682: <td>GITLAB_TAG</td>
1.357 gutterid 12683: <td>GITLAB_TYPE</td>
1.338 nia 12684: </tr>
12685: <tr>
1.367 ! gdt 12686: <td>GIT_BRANCH</td>
! 12687: <td>GIT_ENV</td>
! 12688: </tr>
! 12689: <tr>
! 12690: <td>GIT_EXTRACTDIR</td>
! 12691: <td>GIT_REPO</td>
! 12692: </tr>
! 12693: <tr>
! 12694: <td>GIT_REPOSITORIES</td>
! 12695: <td>GIT_REVISION</td>
! 12696: </tr>
! 12697: <tr>
! 12698: <td>GIT_TAG</td>
1.356 gutterid 12699: <td>GNU</td>
1.360 leot 12700: </tr>
12701: <tr>
1.367 ! gdt 12702: <td>GNU_CONFIGURE</td>
1.360 leot 12703: <td>GNU_CONFIGURE_INFODIR</td>
1.355 rillig 12704: </tr>
12705: <tr>
1.367 ! gdt 12706: <td>GNU_CONFIGURE_MANDIR</td>
1.360 leot 12707: <td>GNU_CONFIGURE_QUIET</td>
1.348 wiz 12708: </tr>
12709: <tr>
1.367 ! gdt 12710: <td>GNU_CONFIGURE_STRICT</td>
1.360 leot 12711: <td>GODEP_REDIRECTS</td>
1.269 leot 12712: </tr>
12713: <tr>
1.367 ! gdt 12714: <td>GO_BUILD_PATTERN</td>
1.360 leot 12715: <td>GO_DEPS</td>
1.269 leot 12716: </tr>
12717: <tr>
1.367 ! gdt 12718: <td>GO_DIST_BASE</td>
1.360 leot 12719: <td>GO_EXTRA_MOD_DIRS</td>
1.269 leot 12720: </tr>
12721: <tr>
1.367 ! gdt 12722: <td>GO_MODULE_FILES</td>
1.360 leot 12723: <td>GO_SRCPATH</td>
1.352 wiz 12724: </tr>
12725: <tr>
1.367 ! gdt 12726: <td>GROUP_SPECIFIC_PKGS</td>
1.360 leot 12727: <td>GRUB_NETWORK_CARDS</td>
1.276 leot 12728: </tr>
12729: <tr>
1.367 ! gdt 12730: <td>GRUB_PRESET_COMMAND</td>
1.360 leot 12731: <td>GRUB_SCAN_ARGS</td>
1.367 ! gdt 12732: </tr>
! 12733: <tr>
! 12734: <td>GZIP</td>
! 12735: <td>HASKELL_COMPILER</td>
1.269 leot 12736: </tr>
12737: <tr>
1.348 wiz 12738: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.357 gutterid 12739: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.332 rillig 12740: </tr>
12741: <tr>
1.337 gutterid 12742: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.357 gutterid 12743: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.341 gutterid 12744: </tr>
12745: <tr>
1.350 gutterid 12746: <td>HASKELL_ENABLE_TESTS</td>
1.357 gutterid 12747: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.335 nia 12748: </tr>
12749: <tr>
1.347 gutterid 12750: <td>HASKELL_PKG_NAME</td>
1.357 gutterid 12751: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
1.344 gutterid 12752: </tr>
12753: <tr>
1.341 gutterid 12754: <td>HEADER_TEMPLATES</td>
1.367 ! gdt 12755: <td>HG_REPO</td>
! 12756: </tr>
! 12757: <tr>
! 12758: <td>HG_REPOSITORIES</td>
! 12759: <td>HG_TAG</td>
! 12760: </tr>
! 12761: <tr>
1.363 gutterid 12762: <td>HOMEPAGE</td>
1.367 ! gdt 12763: <td>HOST_PKGTOOLS_ARGS</td>
1.329 leot 12764: </tr>
12765: <tr>
1.363 gutterid 12766: <td>HOST_SPECIFIC_PKGS</td>
1.367 ! gdt 12767: <td>HOWL_GROUP</td>
1.360 leot 12768: </tr>
12769: <tr>
1.363 gutterid 12770: <td>HOWL_USER</td>
1.367 ! gdt 12771: <td>ICCBASE</td>
1.355 rillig 12772: </tr>
12773: <tr>
1.363 gutterid 12774: <td>ICECAST_CHROOTDIR</td>
1.367 ! gdt 12775: <td>ICON_THEMES</td>
1.348 wiz 12776: </tr>
12777: <tr>
1.363 gutterid 12778: <td>IDOBASE</td>
1.367 ! gdt 12779: <td>IGNORE_CCACHE</td>
1.342 wiz 12780: </tr>
12781: <tr>
1.363 gutterid 12782: <td>IGNORE_INFO_DIRS</td>
1.367 ! gdt 12783: <td>IGNORE_INTERACTIVE_FETCH</td>
1.338 nia 12784: </tr>
12785: <tr>
1.363 gutterid 12786: <td>IMAKE</td>
1.367 ! gdt 12787: <td>IMAKEOPTS</td>
1.269 leot 12788: </tr>
12789: <tr>
1.363 gutterid 12790: <td>IMAKE_MAKE</td>
1.367 ! gdt 12791: <td>IMAKE_MANINSTALL</td>
1.305 bacon 12792: </tr>
12793: <tr>
1.363 gutterid 12794: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.367 ! gdt 12795: <td>IMDICTDIR</td>
1.269 leot 12796: </tr>
12797: <tr>
1.363 gutterid 12798: <td>INCOMPAT_CURSES</td>
1.367 ! gdt 12799: <td>INFO_DIR</td>
1.269 leot 12800: </tr>
12801: <tr>
1.363 gutterid 12802: <td>INFO_FILES</td>
1.367 ! gdt 12803: <td>INFO_MSG</td>
1.269 leot 12804: </tr>
12805: <tr>
1.363 gutterid 12806: <td>INIT_SYSTEM</td>
1.367 ! gdt 12807: <td>INN_DATA_DIR</td>
1.269 leot 12808: </tr>
12809: <tr>
1.363 gutterid 12810: <td>INN_GROUP</td>
1.367 ! gdt 12811: <td>INN_USER</td>
1.269 leot 12812: </tr>
12813: <tr>
1.363 gutterid 12814: <td>INSTALLATION_DIRS</td>
1.367 ! gdt 12815: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.269 leot 12816: </tr>
12817: <tr>
1.363 gutterid 12818: <td>INSTALL_ENV</td>
1.367 ! gdt 12819: <td>INSTALL_SH_OVERRIDE</td>
1.269 leot 12820: </tr>
12821: <tr>
1.363 gutterid 12822: <td>INSTALL_SRC</td>
1.367 ! gdt 12823: <td>INSTALL_TEMPLATES</td>
1.269 leot 12824: </tr>
12825: <tr>
1.363 gutterid 12826: <td>INSTALL_UNSTRIPPED</td>
1.367 ! gdt 12827: <td>IRCD_HYBRID_IRC_GROUP</td>
1.287 rillig 12828: </tr>
12829: <tr>
1.363 gutterid 12830: <td>IRCD_HYBRID_IRC_USER</td>
1.367 ! gdt 12831: <td>IRCD_HYBRID_MAXCONN</td>
1.269 leot 12832: </tr>
12833: <tr>
1.363 gutterid 12834: <td>IRCD_HYBRID_NICLEN</td>
1.367 ! gdt 12835: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.269 leot 12836: </tr>
12837: <tr>
1.363 gutterid 12838: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.367 ! gdt 12839: <td>IRCD_HYBRID_TOPICLEN</td>
1.269 leot 12840: </tr>
12841: <tr>
1.363 gutterid 12842: <td>IRIX</td>
1.367 ! gdt 12843: <td>IRRD_USE_PGP</td>
1.269 leot 12844: </tr>
12845: <tr>
1.363 gutterid 12846: <td>JABBERD_GROUP</td>
1.367 ! gdt 12847: <td>JABBERD_LOGDIR</td>
1.269 leot 12848: </tr>
12849: <tr>
1.363 gutterid 12850: <td>JABBERD_PIDDIR</td>
1.367 ! gdt 12851: <td>JABBERD_SPOOLDIR</td>
1.269 leot 12852: </tr>
12853: <tr>
1.357 gutterid 12854: <td>JABBERD_USER</td>
1.367 ! gdt 12855: <td>JAVA_APP_PATH</td>
1.269 leot 12856: </tr>
12857: <tr>
1.367 ! gdt 12858: <td>JAVA_APP_TARGETS</td>
1.354 gutterid 12859: <td>JAVA_BINPREFIX</td>
1.367 ! gdt 12860: </tr>
! 12861: <tr>
1.363 gutterid 12862: <td>JAVA_CLASSPATH</td>
1.367 ! gdt 12863: <td>JAVA_HOME</td>
1.360 leot 12864: </tr>
12865: <tr>
1.363 gutterid 12866: <td>JAVA_LD_LIBRARY_PATH</td>
1.367 ! gdt 12867: <td>JAVA_NAME</td>
1.269 leot 12868: </tr>
12869: <tr>
1.363 gutterid 12870: <td>JAVA_UNLIMIT</td>
1.367 ! gdt 12871: <td>JAVA_WRAPPERS</td>
1.348 wiz 12872: </tr>
12873: <tr>
1.363 gutterid 12874: <td>JPEG_ACCEPTED</td>
1.367 ! gdt 12875: <td>JPEG_DEFAULT</td>
1.292 leot 12876: </tr>
12877: <tr>
1.363 gutterid 12878: <td>KERBEROS</td>
1.367 ! gdt 12879: <td>KERMIT_SUID_UUCP</td>
1.342 wiz 12880: </tr>
12881: <tr>
1.363 gutterid 12882: <td>KJS_USE_PCRE</td>
1.367 ! gdt 12883: <td>KNEWS_DOMAIN_FILE</td>
1.311 leot 12884: </tr>
12885: <tr>
1.363 gutterid 12886: <td>KNEWS_DOMAIN_NAME</td>
1.367 ! gdt 12887: <td>KRB5_ACCEPTED</td>
1.269 leot 12888: </tr>
12889: <tr>
1.363 gutterid 12890: <td>KRB5_DEFAULT</td>
1.367 ! gdt 12891: <td>LANGUAGES</td>
1.332 rillig 12892: </tr>
12893: <tr>
1.363 gutterid 12894: <td>LAPACKE_LIBS</td>
1.367 ! gdt 12895: <td>LAPACKE_PC</td>
1.269 leot 12896: </tr>
12897: <tr>
1.363 gutterid 12898: <td>LAPACK_LIBS</td>
1.367 ! gdt 12899: <td>LAPACK_PC</td>
1.269 leot 12900: </tr>
12901: <tr>
1.363 gutterid 12902: <td>LATEX2HTML_ICONPATH</td>
1.367 ! gdt 12903: <td>LDCONFIG_ADD_CMD</td>
1.269 leot 12904: </tr>
12905: <tr>
1.363 gutterid 12906: <td>LDCONFIG_REMOVE_CMD</td>
1.367 ! gdt 12907: <td>LDD</td>
1.269 leot 12908: </tr>
12909: <tr>
1.363 gutterid 12910: <td>LEAFNODE_DATA_DIR</td>
1.367 ! gdt 12911: <td>LEAFNODE_GROUP</td>
1.292 leot 12912: </tr>
12913: <tr>
1.363 gutterid 12914: <td>LEAFNODE_USER</td>
1.367 ! gdt 12915: <td>LIBDVDCSS_HOMEPAGE</td>
1.271 brook 12916: </tr>
12917: <tr>
1.363 gutterid 12918: <td>LIBDVDCSS_MASTER_SITES</td>
1.367 ! gdt 12919: <td>LIBIMAGEQUANT_TYPE</td>
1.269 leot 12920: </tr>
12921: <tr>
1.363 gutterid 12922: <td>LIBRSVG_TYPE</td>
1.367 ! gdt 12923: <td>LIBTOOL</td>
1.269 leot 12924: </tr>
12925: <tr>
1.363 gutterid 12926: <td>LIBTOOLIZE_PLIST</td>
1.367 ! gdt 12927: <td>LIBTOOL_M4_OVERRIDE</td>
1.269 leot 12928: </tr>
12929: <tr>
1.363 gutterid 12930: <td>LIBUSB_TYPE</td>
1.367 ! gdt 12931: <td>LICENSE</td>
1.269 leot 12932: </tr>
12933: <tr>
1.363 gutterid 12934: <td>LINKER_RPATH_FLAG</td>
1.367 ! gdt 12935: <td>LINK_RPATH_FLAG</td>
1.320 wiz 12936: </tr>
12937: <tr>
1.367 ! gdt 12938: <td>LINUX_BASE_NODEPS</td>
! 12939: <td>LINUX_BASE_PREFERRED</td>
! 12940: </tr>
! 12941: <tr>
! 12942: <td>LINUX_BASE_REQUIRED</td>
1.356 gutterid 12943: <td>LINUX_LOCALES</td>
1.355 rillig 12944: </tr>
12945: <tr>
1.358 gutterid 12946: <td>LOCALBASE</td>
1.356 gutterid 12947: <td>LOCALBASE_LOCKTYPE</td>
1.269 leot 12948: </tr>
12949: <tr>
1.358 gutterid 12950: <td>LOCALPATCHES</td>
1.356 gutterid 12951: <td>LOVE_DATA</td>
1.352 wiz 12952: </tr>
12953: <tr>
1.358 gutterid 12954: <td>LOVE_GAME</td>
1.356 gutterid 12955: <td>LOVE_VERSION</td>
1.338 nia 12956: </tr>
12957: <tr>
1.358 gutterid 12958: <td>LP32PLATFORMS</td>
1.356 gutterid 12959: <td>LP64PLATFORMS</td>
1.269 leot 12960: </tr>
12961: <tr>
1.358 gutterid 12962: <td>LUA_BUSTED_ARGS</td>
1.356 gutterid 12963: <td>LUA_CDIR</td>
1.329 leot 12964: </tr>
12965: <tr>
1.358 gutterid 12966: <td>LUA_COMPILER</td>
1.356 gutterid 12967: <td>LUA_DOCDIR</td>
1.269 leot 12968: </tr>
12969: <tr>
1.358 gutterid 12970: <td>LUA_EXAMPLESDIR</td>
1.356 gutterid 12971: <td>LUA_INCDIR</td>
1.269 leot 12972: </tr>
12973: <tr>
1.358 gutterid 12974: <td>LUA_INTERPRETER</td>
1.356 gutterid 12975: <td>LUA_LDIR</td>
1.269 leot 12976: </tr>
12977: <tr>
1.358 gutterid 12978: <td>LUA_LINKER_MAGIC</td>
1.356 gutterid 12979: <td>LUA_PKGPREFIX</td>
1.336 nia 12980: </tr>
12981: <tr>
1.358 gutterid 12982: <td>LUA_SELF_CONFLICT</td>
1.356 gutterid 12983: <td>LUA_USE_BUSTED</td>
1.333 nia 12984: </tr>
12985: <tr>
1.358 gutterid 12986: <td>LUA_VERSIONS_ACCEPTED</td>
1.356 gutterid 12987: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.333 nia 12988: </tr>
12989: <tr>
1.358 gutterid 12990: <td>LUA_VERSION_DEFAULT</td>
1.356 gutterid 12991: <td>LUA_VERSION_REQD</td>
1.333 nia 12992: </tr>
12993: <tr>
1.358 gutterid 12994: <td>Lua</td>
1.356 gutterid 12995: <td>MACHINE_PLATFORM</td>
1.333 nia 12996: </tr>
12997: <tr>
1.358 gutterid 12998: <td>MAILAGENT_DOMAIN</td>
1.356 gutterid 12999: <td>MAILAGENT_EMAIL</td>
1.333 nia 13000: </tr>
13001: <tr>
1.358 gutterid 13002: <td>MAILAGENT_FQDN</td>
1.356 gutterid 13003: <td>MAILAGENT_ORGANIZATION</td>
1.333 nia 13004: </tr>
13005: <tr>
1.358 gutterid 13006: <td>MAJORDOMO_HOMEDIR</td>
1.367 ! gdt 13007: <td>MAJOR_OS_VERSION</td>
! 13008: </tr>
! 13009: <tr>
1.363 gutterid 13010: <td>MAKEINFO_ARGS</td>
1.367 ! gdt 13011: <td>MAKE_DIRS</td>
1.360 leot 13012: </tr>
13013: <tr>
1.363 gutterid 13014: <td>MAKE_DIRS_PERMS</td>
1.367 ! gdt 13015: <td>MAKE_ENV</td>
1.320 wiz 13016: </tr>
13017: <tr>
1.363 gutterid 13018: <td>MAKE_FILE</td>
1.367 ! gdt 13019: <td>MAKE_FLAGS</td>
1.348 wiz 13020: </tr>
13021: <tr>
1.363 gutterid 13022: <td>MAKE_JOBS</td>
1.367 ! gdt 13023: <td>MAKE_JOBS_SAFE</td>
1.342 wiz 13024: </tr>
13025: <tr>
1.363 gutterid 13026: <td>MAKE_PROGRAM</td>
1.367 ! gdt 13027: <td>MANCOMPRESSED_IF_MANZ</td>
1.269 leot 13028: </tr>
13029: <tr>
1.363 gutterid 13030: <td>MANINSTALL</td>
1.367 ! gdt 13031: <td>MANZ</td>
1.327 wiz 13032: </tr>
13033: <tr>
1.363 gutterid 13034: <td>MARIADB_VERSIONS_ALL</td>
1.367 ! gdt 13035: <td>MASTER_SITES</td>
1.269 leot 13036: </tr>
13037: <tr>
1.363 gutterid 13038: <td>MASTER_SITE_BACKUP</td>
1.367 ! gdt 13039: <td>MASTER_SITE_LOCAL</td>
1.269 leot 13040: </tr>
13041: <tr>
1.363 gutterid 13042: <td>MASTER_SITE_MOZILLA</td>
1.367 ! gdt 13043: <td>MASTER_SITE_OVERRIDE</td>
1.269 leot 13044: </tr>
13045: <tr>
1.363 gutterid 13046: <td>MASTER_SITE_PERL_CPAN</td>
1.367 ! gdt 13047: <td>MASTER_SORT</td>
1.303 bacon 13048: </tr>
13049: <tr>
1.363 gutterid 13050: <td>MASTER_SORT_RANDOM</td>
1.367 ! gdt 13051: <td>MASTER_SORT_REGEX</td>
1.269 leot 13052: </tr>
13053: <tr>
1.363 gutterid 13054: <td>MECAB_CHARSET</td>
1.367 ! gdt 13055: <td>MEDIATOMB_GROUP</td>
1.269 leot 13056: </tr>
13057: <tr>
1.363 gutterid 13058: <td>MEDIATOMB_USER</td>
1.367 ! gdt 13059: <td>MIPSPROBASE</td>
1.269 leot 13060: </tr>
13061: <tr>
1.363 gutterid 13062: <td>MIREDO_GROUP</td>
1.367 ! gdt 13063: <td>MIREDO_USER</td>
1.269 leot 13064: </tr>
13065: <tr>
1.363 gutterid 13066: <td>MISSING_FEATURES</td>
1.367 ! gdt 13067: <td>MKDIR</td>
1.269 leot 13068: </tr>
13069: <tr>
1.363 gutterid 13070: <td>MKPIE_SUPPORTED</td>
1.367 ! gdt 13071: <td>MLDONKEY_GROUP</td>
1.269 leot 13072: </tr>
13073: <tr>
1.363 gutterid 13074: <td>MLDONKEY_HOME</td>
1.367 ! gdt 13075: <td>MLDONKEY_USER</td>
1.269 leot 13076: </tr>
13077: <tr>
1.363 gutterid 13078: <td>MONOTONE_GROUP</td>
1.367 ! gdt 13079: <td>MONOTONE_USER</td>
1.269 leot 13080: </tr>
13081: <tr>
1.363 gutterid 13082: <td>MOTIFBASE</td>
1.367 ! gdt 13083: <td>MOTIF_TYPE</td>
1.269 leot 13084: </tr>
13085: <tr>
1.363 gutterid 13086: <td>MOTIF_TYPE_DEFAULT</td>
1.367 ! gdt 13087: <td>MPI_TYPE</td>
1.269 leot 13088: </tr>
13089: <tr>
1.363 gutterid 13090: <td>MSGFMT_STRIP_MSGCTXT</td>
1.367 ! gdt 13091: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.322 leot 13092: </tr>
13093: <tr>
1.347 gutterid 13094: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.367 ! gdt 13095: <td>MUST</td>
1.355 rillig 13096: </tr>
13097: <tr>
1.358 gutterid 13098: <td>MV</td>
1.355 rillig 13099: <td>MYSQL_CHARSET</td>
1.269 leot 13100: </tr>
13101: <tr>
1.358 gutterid 13102: <td>MYSQL_DATADIR</td>
1.355 rillig 13103: <td>MYSQL_EXTRA_CHARSET</td>
1.352 wiz 13104: </tr>
13105: <tr>
1.358 gutterid 13106: <td>MYSQL_GROUP</td>
1.355 rillig 13107: <td>MYSQL_USER</td>
1.338 nia 13108: </tr>
13109: <tr>
1.358 gutterid 13110: <td>MYSQL_VERSION</td>
1.355 rillig 13111: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.329 leot 13112: </tr>
13113: <tr>
1.358 gutterid 13114: <td>MYSQL_VERSION_DEFAULT</td>
1.356 gutterid 13115: <td>NAGIOSCMD_GROUP</td>
1.269 leot 13116: </tr>
13117: <tr>
1.358 gutterid 13118: <td>NAGIOSDIR</td>
1.356 gutterid 13119: <td>NAGIOS_GROUP</td>
1.320 wiz 13120: </tr>
13121: <tr>
1.358 gutterid 13122: <td>NAGIOS_USER</td>
1.356 gutterid 13123: <td>NATIVE_APPEND_ABI</td>
1.269 leot 13124: </tr>
13125: <tr>
1.358 gutterid 13126: <td>NATIVE_APPEND_ELF</td>
1.356 gutterid 13127: <td>NATIVE_EXEC_FMT</td>
1.269 leot 13128: </tr>
13129: <tr>
1.358 gutterid 13130: <td>NATIVE_MACHINE_PLATFORM</td>
1.356 gutterid 13131: <td>NATIVE_OBJECT_FMT</td>
1.269 leot 13132: </tr>
13133: <tr>
1.358 gutterid 13134: <td>NBPAX_PROGRAM_PREFIX</td>
1.356 gutterid 13135: <td>NETBSD_LOGIN_NAME</td>
1.309 gutterid 13136: </tr>
13137: <tr>
1.358 gutterid 13138: <td>NMH_EDITOR</td>
1.356 gutterid 13139: <td>NMH_MTA</td>
1.269 leot 13140: </tr>
13141: <tr>
1.358 gutterid 13142: <td>NMH_PAGER</td>
1.356 gutterid 13143: <td>NODE_VERSIONS_ACCEPTED</td>
1.269 leot 13144: </tr>
13145: <tr>
1.358 gutterid 13146: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.356 gutterid 13147: <td>NODE_VERSION_DEFAULT</td>
1.269 leot 13148: </tr>
13149: <tr>
1.358 gutterid 13150: <td>NODE_VERSION_REQD</td>
1.356 gutterid 13151: <td>NOLOGIN</td>
1.269 leot 13152: </tr>
13153: <tr>
1.358 gutterid 13154: <td>NOTE</td>
1.356 gutterid 13155: <td>NOT_FOR_PLATFORM</td>
1.269 leot 13156: </tr>
13157: <tr>
1.358 gutterid 13158: <td>NOT_PAX_ASLR_SAFE</td>
1.356 gutterid 13159: <td>NOT_PAX_MPROTECT_SAFE</td>
1.269 leot 13160: </tr>
13161: <tr>
1.358 gutterid 13162: <td>NO_BUILD</td>
1.356 gutterid 13163: <td>NO_CHECKSUM</td>
1.344 gutterid 13164: </tr>
13165: <tr>
1.358 gutterid 13166: <td>NO_CONFIGURE</td>
1.356 gutterid 13167: <td>NO_SKIP</td>
1.333 nia 13168: </tr>
13169: <tr>
1.358 gutterid 13170: <td>NS_PREFERRED</td>
1.356 gutterid 13171: <td>NULLMAILER_GROUP</td>
1.333 nia 13172: </tr>
13173: <tr>
1.358 gutterid 13174: <td>NULLMAILER_USER</td>
1.356 gutterid 13175: <td>OBJHOSTNAME</td>
1.293 rillig 13176: </tr>
13177: <tr>
1.358 gutterid 13178: <td>OBJMACHINE</td>
1.356 gutterid 13179: <td>OCAML_FINDLIB_DIRS</td>
1.269 leot 13180: </tr>
13181: <tr>
1.358 gutterid 13182: <td>OCAML_FINDLIB_REGISTER</td>
1.356 gutterid 13183: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.269 leot 13184: </tr>
13185: <tr>
1.358 gutterid 13186: <td>OCAML_SITELIBDIR</td>
1.356 gutterid 13187: <td>OMF</td>
1.269 leot 13188: </tr>
13189: <tr>
1.358 gutterid 13190: <td>ONLY_FOR_COMPILER</td>
1.356 gutterid 13191: <td>ONLY_FOR_PLATFORM</td>
1.269 leot 13192: </tr>
13193: <tr>
1.358 gutterid 13194: <td>OPENSSH_CHROOT</td>
1.356 gutterid 13195: <td>OPENSSH_GROUP</td>
1.269 leot 13196: </tr>
13197: <tr>
1.358 gutterid 13198: <td>OPENSSH_USER</td>
1.356 gutterid 13199: <td>OPSYS</td>
1.269 leot 13200: </tr>
13201: <tr>
1.358 gutterid 13202: <td>OPSYS_EMULDIR</td>
1.356 gutterid 13203: <td>OPSYS_VERSION</td>
1.269 leot 13204: </tr>
13205: <tr>
1.358 gutterid 13206: <td>OS</td>
1.356 gutterid 13207: <td>OSS_TYPE</td>
1.269 leot 13208: </tr>
13209: <tr>
1.358 gutterid 13210: <td>OSX</td>
1.367 ! gdt 13211: <td>OS_HAVE_ALSA</td>
! 13212: </tr>
! 13213: <tr>
! 13214: <td>OS_HAVE_RCD</td>
1.353 dholland 13215: <td>OS_VARIANT</td>
1.355 rillig 13216: </tr>
13217: <tr>
1.358 gutterid 13218: <td>OS_VERSION</td>
1.355 rillig 13219: <td>OTF_FONTS_DIR</td>
1.352 wiz 13220: </tr>
13221: <tr>
1.358 gutterid 13222: <td>OVERRIDE_DIRDEPTH</td>
1.355 rillig 13223: <td>OVERRIDE_GEMSPEC</td>
1.269 leot 13224: </tr>
13225: <tr>
1.358 gutterid 13226: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.367 ! gdt 13227: <td>OVERRIDE_ROCKSPEC</td>
! 13228: </tr>
! 13229: <tr>
1.363 gutterid 13230: <td>OWN_DIRS</td>
1.367 ! gdt 13231: <td>OWN_DIRS_PERMS</td>
1.360 leot 13232: </tr>
13233: <tr>
1.363 gutterid 13234: <td>P4GROUP</td>
1.367 ! gdt 13235: <td>P4PORT</td>
1.348 wiz 13236: </tr>
13237: <tr>
1.363 gutterid 13238: <td>P4ROOT</td>
1.367 ! gdt 13239: <td>P4USER</td>
1.329 leot 13240: </tr>
13241: <tr>
1.363 gutterid 13242: <td>PACKAGES</td>
1.367 ! gdt 13243: <td>PALMOS_DEFAULT_SDK</td>
1.342 wiz 13244: </tr>
13245: <tr>
1.363 gutterid 13246: <td>PAMBASE</td>
1.367 ! gdt 13247: <td>PAM_DEFAULT</td>
1.320 wiz 13248: </tr>
13249: <tr>
1.363 gutterid 13250: <td>PAPERSIZE</td>
1.367 ! gdt 13251: <td>PASSIVE_FETCH</td>
1.269 leot 13252: </tr>
13253: <tr>
1.363 gutterid 13254: <td>PATCHDIR</td>
1.367 ! gdt 13255: <td>PATCHFILES</td>
1.269 leot 13256: </tr>
13257: <tr>
1.363 gutterid 13258: <td>PATCH_ARGS</td>
1.367 ! gdt 13259: <td>PATCH_DEBUG</td>
1.269 leot 13260: </tr>
13261: <tr>
1.363 gutterid 13262: <td>PATCH_DIST_ARGS</td>
1.367 ! gdt 13263: <td>PATCH_DIST_CAT</td>
1.269 leot 13264: </tr>
13265: <tr>
1.363 gutterid 13266: <td>PATCH_DIST_STRIP</td>
1.367 ! gdt 13267: <td>PATCH_FUZZ_FACTOR</td>
1.269 leot 13268: </tr>
13269: <tr>
1.363 gutterid 13270: <td>PATCH_STRIP</td>
1.367 ! gdt 13271: <td>PATH</td>
1.269 leot 13272: </tr>
13273: <tr>
1.348 wiz 13274: <td>PCCBASE</td>
1.367 ! gdt 13275: <td>PEAR</td>
! 13276: </tr>
! 13277: <tr>
! 13278: <td>PEAR_CHANNEL</td>
! 13279: <td>PEAR_CHANNEL_ALIAS</td>
1.360 leot 13280: </tr>
13281: <tr>
1.367 ! gdt 13282: <td>PEAR_CHANNEL_VERSION</td>
1.358 gutterid 13283: <td>PEAR_CMD</td>
1.342 wiz 13284: </tr>
13285: <tr>
1.367 ! gdt 13286: <td>PEAR_LIB</td>
1.358 gutterid 13287: <td>PEAR_PACKAGE_XML</td>
1.269 leot 13288: </tr>
13289: <tr>
1.367 ! gdt 13290: <td>PERL5</td>
1.358 gutterid 13291: <td>PERL5_CONFIGURE</td>
1.332 rillig 13292: </tr>
13293: <tr>
1.367 ! gdt 13294: <td>PERL5_CONFIGURE_DIRS</td>
1.358 gutterid 13295: <td>PERL5_LDFLAGS</td>
1.320 wiz 13296: </tr>
13297: <tr>
1.367 ! gdt 13298: <td>PERL5_LICENSE</td>
1.358 gutterid 13299: <td>PERL5_MODULE_TYPE</td>
1.292 leot 13300: </tr>
13301: <tr>
1.367 ! gdt 13302: <td>PERL5_PACKLIST</td>
1.358 gutterid 13303: <td>PERL5_PACKLIST_DIR</td>
1.274 rillig 13304: </tr>
13305: <tr>
1.367 ! gdt 13306: <td>PERL5_PERLBASE</td>
1.358 gutterid 13307: <td>PERL5_SITEBASE</td>
1.274 rillig 13308: </tr>
13309: <tr>
1.367 ! gdt 13310: <td>PERL5_USE_PACKLIST</td>
1.358 gutterid 13311: <td>PERL5_VENDORBASE</td>
1.269 leot 13312: </tr>
13313: <tr>
1.367 ! gdt 13314: <td>PFCTL</td>
1.358 gutterid 13315: <td>PFVAR_H</td>
1.269 leot 13316: </tr>
13317: <tr>
1.367 ! gdt 13318: <td>PF_VERSION</td>
1.358 gutterid 13319: <td>PGGROUP</td>
1.269 leot 13320: </tr>
13321: <tr>
1.367 ! gdt 13322: <td>PGHOME</td>
1.358 gutterid 13323: <td>PGPKGSRCDIR</td>
1.269 leot 13324: </tr>
13325: <tr>
1.367 ! gdt 13326: <td>PGSQL_TYPE</td>
1.358 gutterid 13327: <td>PGSQL_VERSION</td>
1.269 leot 13328: </tr>
13329: <tr>
1.367 ! gdt 13330: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.358 gutterid 13331: <td>PGSQL_VERSION_DEFAULT</td>
1.269 leot 13332: </tr>
13333: <tr>
1.367 ! gdt 13334: <td>PGUSER</td>
1.358 gutterid 13335: <td>PG_LIB_EXT</td>
1.269 leot 13336: </tr>
13337: <tr>
1.367 ! gdt 13338: <td>PHP</td>
1.358 gutterid 13339: <td>PHPCOMMON_MK</td>
1.269 leot 13340: </tr>
13341: <tr>
1.367 ! gdt 13342: <td>PHPPKGSRCDIR</td>
1.358 gutterid 13343: <td>PHP_BASE_VERS</td>
1.269 leot 13344: </tr>
13345: <tr>
1.367 ! gdt 13346: <td>PHP_CHECK_INSTALLED</td>
1.358 gutterid 13347: <td>PHP_EXTENSION_DIR</td>
1.269 leot 13348: </tr>
13349: <tr>
1.367 ! gdt 13350: <td>PHP_INITIAL_TEENY</td>
1.358 gutterid 13351: <td>PHP_PKG_PREFIX</td>
1.269 leot 13352: </tr>
13353: <tr>
1.367 ! gdt 13354: <td>PHP_VERSION</td>
1.358 gutterid 13355: <td>PHP_VERSIONS_ACCEPTED</td>
1.269 leot 13356: </tr>
13357: <tr>
1.367 ! gdt 13358: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.358 gutterid 13359: <td>PHP_VERSION_DEFAULT</td>
1.269 leot 13360: </tr>
13361: <tr>
1.367 ! gdt 13362: <td>PHP_VERSION_REQD</td>
1.358 gutterid 13363: <td>PILRC_USE_GTK</td>
1.269 leot 13364: </tr>
13365: <tr>
1.367 ! gdt 13366: <td>PKGCONFIG_BASE</td>
1.358 gutterid 13367: <td>PKGCONFIG_FILE</td>
1.269 leot 13368: </tr>
13369: <tr>
1.367 ! gdt 13370: <td>PKGCONFIG_OVERRIDE</td>
1.358 gutterid 13371: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.269 leot 13372: </tr>
13373: <tr>
1.367 ! gdt 13374: <td>PKGDIR</td>
1.358 gutterid 13375: <td>PKGGNUDIR</td>
1.269 leot 13376: </tr>
13377: <tr>
1.367 ! gdt 13378: <td>PKGINFODIR</td>
1.358 gutterid 13379: <td>PKGLOCALEDIR</td>
1.269 leot 13380: </tr>
13381: <tr>
1.367 ! gdt 13382: <td>PKGMANDIR</td>
1.358 gutterid 13383: <td>PKGNAME</td>
1.269 leot 13384: </tr>
13385: <tr>
1.367 ! gdt 13386: <td>PKGNAME_REQD</td>
1.358 gutterid 13387: <td>PKGPATH</td>
1.269 leot 13388: </tr>
13389: <tr>
1.367 ! gdt 13390: <td>PKGREVISION</td>
1.358 gutterid 13391: <td>PKGSRC_BLAS_TYPES</td>
1.269 leot 13392: </tr>
13393: <tr>
1.367 ! gdt 13394: <td>PKGSRC_CHANGES</td>
1.358 gutterid 13395: <td>PKGSRC_COMPILER</td>
1.269 leot 13396: </tr>
13397: <tr>
1.367 ! gdt 13398: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.358 gutterid 13399: <td>PKGSRC_LOCKTYPE</td>
1.269 leot 13400: </tr>
13401: <tr>
1.367 ! gdt 13402: <td>PKGSRC_MAKE_ENV</td>
1.358 gutterid 13403: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.269 leot 13404: </tr>
13405: <tr>
1.367 ! gdt 13406: <td>PKGSRC_MKPIE</td>
1.358 gutterid 13407: <td>PKGSRC_MKREPRO</td>
1.292 leot 13408: </tr>
13409: <tr>
1.367 ! gdt 13410: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.358 gutterid 13411: <td>PKGSRC_RUN_TEST</td>
1.269 leot 13412: </tr>
13413: <tr>
1.367 ! gdt 13414: <td>PKGSRC_SETENV</td>
1.358 gutterid 13415: <td>PKGSRC_SLEEPSECS</td>
1.274 rillig 13416: </tr>
13417: <tr>
1.367 ! gdt 13418: <td>PKGSRC_TODO</td>
1.358 gutterid 13419: <td>PKGSRC_USE_CTF</td>
1.269 leot 13420: </tr>
13421: <tr>
1.367 ! gdt 13422: <td>PKGSRC_USE_FORTIFY</td>
1.358 gutterid 13423: <td>PKGSRC_USE_MKTOOLS</td>
1.269 leot 13424: </tr>
13425: <tr>
1.367 ! gdt 13426: <td>PKGSRC_USE_RELRO</td>
1.358 gutterid 13427: <td>PKGSRC_USE_SSP</td>
1.269 leot 13428: </tr>
13429: <tr>
1.367 ! gdt 13430: <td>PKGSRC_USE_STACK_CHECK</td>
1.358 gutterid 13431: <td>PKGTASKS_DATAFILE</td>
1.269 leot 13432: </tr>
13433: <tr>
1.367 ! gdt 13434: <td>PKGTOOLS_ARGS</td>
1.358 gutterid 13435: <td>PKGTOOLS_ENV</td>
1.269 leot 13436: </tr>
13437: <tr>
1.367 ! gdt 13438: <td>PKG_ALTERNATIVES</td>
1.358 gutterid 13439: <td>PKG_APACHE</td>
1.269 leot 13440: </tr>
13441: <tr>
1.367 ! gdt 13442: <td>PKG_APACHE_ACCEPTED</td>
1.358 gutterid 13443: <td>PKG_APACHE_DEFAULT</td>
1.269 leot 13444: </tr>
13445: <tr>
1.367 ! gdt 13446: <td>PKG_BEST_EXISTS</td>
1.358 gutterid 13447: <td>PKG_BUILD_OPTIONS</td>
1.269 leot 13448: </tr>
13449: <tr>
1.367 ! gdt 13450: <td>PKG_COMPRESSION</td>
1.358 gutterid 13451: <td>PKG_CONFIG</td>
1.269 leot 13452: </tr>
13453: <tr>
1.367 ! gdt 13454: <td>PKG_CONFIG_PERMS</td>
1.358 gutterid 13455: <td>PKG_CREATE_USERGROUP</td>
1.269 leot 13456: </tr>
13457: <tr>
1.367 ! gdt 13458: <td>PKG_DB_TMPDIR</td>
1.358 gutterid 13459: <td>PKG_DEBUG_LEVEL</td>
1.269 leot 13460: </tr>
13461: <tr>
1.367 ! gdt 13462: <td>PKG_DEFAULT_OPTIONS</td>
1.358 gutterid 13463: <td>PKG_DESTDIR_SUPPORT</td>
1.367 ! gdt 13464: </tr>
! 13465: <tr>
1.363 gutterid 13466: <td>PKG_DEVELOPER</td>
1.367 ! gdt 13467: <td>PKG_DISABLED_OPTIONS</td>
1.269 leot 13468: </tr>
13469: <tr>
1.363 gutterid 13470: <td>PKG_FATAL_ERRORS</td>
1.367 ! gdt 13471: <td>PKG_FC</td>
1.348 wiz 13472: </tr>
13473: <tr>
1.363 gutterid 13474: <td>PKG_FILELIST_CMD</td>
1.367 ! gdt 13475: <td>PKG_GECOS</td>
1.360 leot 13476: </tr>
13477: <tr>
1.363 gutterid 13478: <td>PKG_GID</td>
1.367 ! gdt 13479: <td>PKG_GROUPS</td>
1.269 leot 13480: </tr>
13481: <tr>
1.363 gutterid 13482: <td>PKG_GROUPS_VARS</td>
1.367 ! gdt 13483: <td>PKG_HOME</td>
1.269 leot 13484: </tr>
13485: <tr>
1.363 gutterid 13486: <td>PKG_INIT_SCRIPTS</td>
1.367 ! gdt 13487: <td>PKG_JAVA_HOME</td>
1.269 leot 13488: </tr>
13489: <tr>
1.363 gutterid 13490: <td>PKG_JVM</td>
1.367 ! gdt 13491: <td>PKG_JVMS_ACCEPTED</td>
1.269 leot 13492: </tr>
13493: <tr>
1.363 gutterid 13494: <td>PKG_JVM_DEFAULT</td>
1.367 ! gdt 13495: <td>PKG_LEGACY_OPTIONS</td>
1.269 leot 13496: </tr>
13497: <tr>
1.363 gutterid 13498: <td>PKG_LIBTOOL</td>
1.367 ! gdt 13499: <td>PKG_MKSYMLINKS</td>
1.269 leot 13500: </tr>
13501: <tr>
1.363 gutterid 13502: <td>PKG_OPTIONS</td>
1.367 ! gdt 13503: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.269 leot 13504: </tr>
13505: <tr>
1.363 gutterid 13506: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.367 ! gdt 13507: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.269 leot 13508: </tr>
13509: <tr>
1.363 gutterid 13510: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.367 ! gdt 13511: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.269 leot 13512: </tr>
13513: <tr>
1.363 gutterid 13514: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.367 ! gdt 13515: <td>PKG_OPTIONS_VAR</td>
1.341 gutterid 13516: </tr>
13517: <tr>
1.363 gutterid 13518: <td>PKG_PHP</td>
1.367 ! gdt 13519: <td>PKG_PHP_MAJOR_VERS</td>
1.269 leot 13520: </tr>
13521: <tr>
1.363 gutterid 13522: <td>PKG_PHP_VERSION</td>
1.367 ! gdt 13523: <td>PKG_RCD_SCRIPTS</td>
1.269 leot 13524: </tr>
13525: <tr>
1.363 gutterid 13526: <td>PKG_REFCOUNT_DBDIR</td>
1.367 ! gdt 13527: <td>PKG_REGISTER_SHELLS</td>
1.269 leot 13528: </tr>
13529: <tr>
1.363 gutterid 13530: <td>PKG_RESUME_TRANSFERS</td>
1.367 ! gdt 13531: <td>PKG_SHELL</td>
1.269 leot 13532: </tr>
13533: <tr>
1.363 gutterid 13534: <td>PKG_SUGGESTED_OPTIONS</td>
1.367 ! gdt 13535: <td>PKG_SUPPORTED_OPTIONS</td>
1.269 leot 13536: </tr>
13537: <tr>
1.363 gutterid 13538: <td>PKG_SYSCONFBASE</td>
1.367 ! gdt 13539: <td>PKG_SYSCONFBASEDIR</td>
1.269 leot 13540: </tr>
13541: <tr>
1.363 gutterid 13542: <td>PKG_SYSCONFDIR</td>
1.367 ! gdt 13543: <td>PKG_SYSCONFDIR_PERMS</td>
1.269 leot 13544: </tr>
13545: <tr>
1.363 gutterid 13546: <td>PKG_SYSCONFSUBDIR</td>
1.367 ! gdt 13547: <td>PKG_SYSCONFVAR</td>
1.269 leot 13548: </tr>
13549: <tr>
1.363 gutterid 13550: <td>PKG_TOOLS_BIN</td>
1.367 ! gdt 13551: <td>PKG_UID</td>
1.269 leot 13552: </tr>
13553: <tr>
1.363 gutterid 13554: <td>PKG_UPDATE_FONTS_DB</td>
1.367 ! gdt 13555: <td>PKG_USERS</td>
1.269 leot 13556: </tr>
13557: <tr>
1.363 gutterid 13558: <td>PKG_USERS_VARS</td>
1.367 ! gdt 13559: <td>PKG_VERBOSE</td>
1.269 leot 13560: </tr>
13561: <tr>
1.363 gutterid 13562: <td>PLEASE</td>
1.367 ! gdt 13563: <td>PLIST</td>
1.269 leot 13564: </tr>
13565: <tr>
1.363 gutterid 13566: <td>PLIST_AWK</td>
1.367 ! gdt 13567: <td>PLIST_AWK_ENV</td>
1.269 leot 13568: </tr>
13569: <tr>
1.363 gutterid 13570: <td>PLIST_SRC</td>
1.367 ! gdt 13571: <td>PLIST_SUBST</td>
1.269 leot 13572: </tr>
13573: <tr>
1.363 gutterid 13574: <td>PLIST_TYPE</td>
1.367 ! gdt 13575: <td>PLIST_VARS</td>
1.269 leot 13576: </tr>
13577: <tr>
1.363 gutterid 13578: <td>POPTOP_USE_MPPE</td>
1.367 ! gdt 13579: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.269 leot 13580: </tr>
13581: <tr>
1.363 gutterid 13582: <td>POST_FETCH_HOOK</td>
1.367 ! gdt 13583: <td>PREFER</td>
1.269 leot 13584: </tr>
13585: <tr>
1.363 gutterid 13586: <td>PREFER_NATIVE</td>
1.367 ! gdt 13587: <td>PREFER_NATIVE_PTHREADS</td>
1.269 leot 13588: </tr>
13589: <tr>
1.363 gutterid 13590: <td>PREFER_PKGSRC</td>
1.367 ! gdt 13591: <td>PREFIX</td>
1.269 leot 13592: </tr>
13593: <tr>
1.363 gutterid 13594: <td>PREPEND_PATH</td>
1.367 ! gdt 13595: <td>PRE_ROOT_CMD</td>
1.269 leot 13596: </tr>
13597: <tr>
1.363 gutterid 13598: <td>PRIVILEGED_STAGES</td>
1.367 ! gdt 13599: <td>PS</td>
1.269 leot 13600: </tr>
13601: <tr>
1.363 gutterid 13602: <td>PTHREAD_AUTO_VARS</td>
1.367 ! gdt 13603: <td>PTHREAD_CFLAGS</td>
1.269 leot 13604: </tr>
13605: <tr>
1.363 gutterid 13606: <td>PTHREAD_LDFLAGS</td>
1.367 ! gdt 13607: <td>PTHREAD_LIBS</td>
1.269 leot 13608: </tr>
13609: <tr>
1.363 gutterid 13610: <td>PTHREAD_OPTS</td>
1.367 ! gdt 13611: <td>PTHREAD_TYPE</td>
1.269 leot 13612: </tr>
13613: <tr>
1.363 gutterid 13614: <td>PVM_SSH</td>
1.367 ! gdt 13615: <td>PYPKGPREFIX</td>
1.269 leot 13616: </tr>
13617: <tr>
1.363 gutterid 13618: <td>PYTHON_FOR_BUILD_ONLY</td>
1.367 ! gdt 13619: <td>PYTHON_SELF_CONFLICT</td>
1.269 leot 13620: </tr>
13621: <tr>
1.363 gutterid 13622: <td>PYTHON_VERSION</td>
1.367 ! gdt 13623: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.269 leot 13624: </tr>
13625: <tr>
1.363 gutterid 13626: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.367 ! gdt 13627: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.269 leot 13628: </tr>
13629: <tr>
1.363 gutterid 13630: <td>PYTHON_VERSION_DEFAULT</td>
1.367 ! gdt 13631: <td>PYTHON_VERSION_REQD</td>
1.269 leot 13632: </tr>
13633: <tr>
1.363 gutterid 13634: <td>PYVERSSUFFIX</td>
1.367 ! gdt 13635: <td>QMAILDIR</td>
1.269 leot 13636: </tr>
13637: <tr>
1.363 gutterid 13638: <td>QMAIL_ALIAS_USER</td>
1.367 ! gdt 13639: <td>QMAIL_DAEMON_USER</td>
1.269 leot 13640: </tr>
13641: <tr>
1.363 gutterid 13642: <td>QMAIL_LOG_USER</td>
1.367 ! gdt 13643: <td>QMAIL_NOFILES_GROUP</td>
1.269 leot 13644: </tr>
13645: <tr>
1.363 gutterid 13646: <td>QMAIL_PASSWD_USER</td>
1.367 ! gdt 13647: <td>QMAIL_QMAIL_GROUP</td>
1.269 leot 13648: </tr>
13649: <tr>
1.363 gutterid 13650: <td>QMAIL_QUEUE_DIR</td>
1.367 ! gdt 13651: <td>QMAIL_QUEUE_EXTRA</td>
1.269 leot 13652: </tr>
13653: <tr>
1.363 gutterid 13654: <td>QMAIL_QUEUE_USER</td>
1.367 ! gdt 13655: <td>QMAIL_REMOTE_USER</td>
1.269 leot 13656: </tr>
13657: <tr>
1.363 gutterid 13658: <td>QMAIL_ROOT_USER</td>
1.367 ! gdt 13659: <td>QMAIL_SEND_USER</td>
1.269 leot 13660: </tr>
13661: <tr>
1.363 gutterid 13662: <td>QORE_LATEST_MODULE_API</td>
1.367 ! gdt 13663: <td>QORE_MODULE_API</td>
1.269 leot 13664: </tr>
13665: <tr>
1.363 gutterid 13666: <td>QORE_MODULE_DIR</td>
1.367 ! gdt 13667: <td>QORE_USER_MODULE_DIR</td>
1.269 leot 13668: </tr>
13669: <tr>
1.363 gutterid 13670: <td>QORE_VERSION</td>
1.367 ! gdt 13671: <td>QPOPPER_FAC</td>
1.269 leot 13672: </tr>
13673: <tr>
1.363 gutterid 13674: <td>QPOPPER_SPOOL_DIR</td>
1.367 ! gdt 13675: <td>QPOPPER_USER</td>
1.269 leot 13676: </tr>
13677: <tr>
1.363 gutterid 13678: <td>RAKE_NAME</td>
1.367 ! gdt 13679: <td>RASMOL_DEPTH</td>
! 13680: </tr>
! 13681: <tr>
! 13682: <td>RCD_DIR</td>
! 13683: <td>RCD_ORDER</td>
1.269 leot 13684: </tr>
13685: <tr>
1.363 gutterid 13686: <td>RCD_SCRIPTS</td>
1.367 ! gdt 13687: <td>RCD_SCRIPTS_DIR</td>
1.360 leot 13688: </tr>
13689: <tr>
1.363 gutterid 13690: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.367 ! gdt 13691: <td>RCD_SCRIPTS_MODE</td>
1.333 nia 13692: </tr>
13693: <tr>
1.363 gutterid 13694: <td>RCD_SCRIPTS_SHELL</td>
1.367 ! gdt 13695: <td>RCD_SCRIPT_SRC</td>
1.342 wiz 13696: </tr>
13697: <tr>
1.367 ! gdt 13698: <td>RCD_SUBR</td>
1.353 dholland 13699: <td>RDOC</td>
1.355 rillig 13700: </tr>
13701: <tr>
1.358 gutterid 13702: <td>READLINE_DEFAULT</td>
1.355 rillig 13703: <td>READLINE_TYPE</td>
1.329 leot 13704: </tr>
13705: <tr>
1.358 gutterid 13706: <td>REAL_ROOT_GROUP</td>
1.355 rillig 13707: <td>REAL_ROOT_USER</td>
1.320 wiz 13708: </tr>
13709: <tr>
1.358 gutterid 13710: <td>RECURSIVE_MAKE</td>
1.355 rillig 13711: <td>RELAY_CTRL_DIR</td>
1.338 nia 13712: </tr>
13713: <tr>
1.358 gutterid 13714: <td>RELRO_SUPPORTED</td>
1.355 rillig 13715: <td>REPLACE_AWK</td>
1.292 leot 13716: </tr>
13717: <tr>
1.358 gutterid 13718: <td>REPLACE_BASH</td>
1.355 rillig 13719: <td>REPLACE_CSH</td>
1.329 leot 13720: </tr>
13721: <tr>
1.358 gutterid 13722: <td>REPLACE_KSH</td>
1.355 rillig 13723: <td>REPLACE_LUA</td>
1.327 wiz 13724: </tr>
13725: <tr>
1.358 gutterid 13726: <td>REPLACE_NODEJS</td>
1.355 rillig 13727: <td>REPLACE_OCTAVE</td>
1.269 leot 13728: </tr>
13729: <tr>
1.358 gutterid 13730: <td>REPLACE_PERL</td>
1.355 rillig 13731: <td>REPLACE_PERL6</td>
1.320 wiz 13732: </tr>
13733: <tr>
1.358 gutterid 13734: <td>REPLACE_PHP</td>
1.355 rillig 13735: <td>REPLACE_PYTHON</td>
1.311 leot 13736: </tr>
13737: <tr>
1.358 gutterid 13738: <td>REPLACE_QORE</td>
1.355 rillig 13739: <td>REPLACE_R</td>
1.269 leot 13740: </tr>
13741: <tr>
1.358 gutterid 13742: <td>REPLACE_RUBY</td>
1.355 rillig 13743: <td>REPLACE_RUBY_DIRS</td>
1.333 nia 13744: </tr>
13745: <tr>
1.358 gutterid 13746: <td>REPLACE_RUBY_PAT</td>
1.355 rillig 13747: <td>REPLACE_SH</td>
1.269 leot 13748: </tr>
13749: <tr>
1.358 gutterid 13750: <td>REPLACE_TEXLUA</td>
1.355 rillig 13751: <td>REPLACE_WISH</td>
1.331 gutterid 13752: </tr>
13753: <tr>
1.358 gutterid 13754: <td>REQD_DIRS</td>
1.355 rillig 13755: <td>REQD_DIRS_PERMS</td>
1.269 leot 13756: </tr>
13757: <tr>
1.358 gutterid 13758: <td>REQD_FILES</td>
1.355 rillig 13759: <td>REQD_FILES_MODE</td>
1.333 nia 13760: </tr>
13761: <tr>
1.358 gutterid 13762: <td>REQD_FILES_PERMS</td>
1.355 rillig 13763: <td>RESOLV_AUTO_VARS</td>
1.269 leot 13764: </tr>
13765: <tr>
1.358 gutterid 13766: <td>RESOLV_LDFLAGS</td>
1.355 rillig 13767: <td>RESOLV_LIBS</td>
1.352 wiz 13768: </tr>
13769: <tr>
1.358 gutterid 13770: <td>RM</td>
1.367 ! gdt 13771: <td>ROCKSPEC_NAME</td>
! 13772: </tr>
! 13773: <tr>
! 13774: <td>ROCKSPEC_SPECFILE</td>
1.347 gutterid 13775: <td>ROOT_CMD</td>
1.355 rillig 13776: </tr>
13777: <tr>
1.358 gutterid 13778: <td>ROOT_GROUP</td>
1.355 rillig 13779: <td>ROOT_USER</td>
1.269 leot 13780: </tr>
13781: <tr>
1.358 gutterid 13782: <td>RPCGEN</td>
1.355 rillig 13783: <td>RPM</td>
1.269 leot 13784: </tr>
13785: <tr>
1.358 gutterid 13786: <td>RPM2PKG_PLIST</td>
1.355 rillig 13787: <td>RPM2PKG_PREFIX</td>
1.320 wiz 13788: </tr>
13789: <tr>
1.358 gutterid 13790: <td>RPM2PKG_STAGE</td>
1.355 rillig 13791: <td>RPM2PKG_STRIP</td>
1.332 rillig 13792: </tr>
13793: <tr>
1.358 gutterid 13794: <td>RPM2PKG_SUBPREFIX</td>
1.355 rillig 13795: <td>RPMFILES</td>
1.329 leot 13796: </tr>
13797: <tr>
1.358 gutterid 13798: <td>RPMIGNOREPATH</td>
1.355 rillig 13799: <td>RPM_DB_PREFIX</td>
1.327 wiz 13800: </tr>
13801: <tr>
1.358 gutterid 13802: <td>RSSH_CVS_PATH</td>
1.355 rillig 13803: <td>RSSH_RDIST_PATH</td>
1.269 leot 13804: </tr>
13805: <tr>
1.358 gutterid 13806: <td>RSSH_RSYNC_PATH</td>
1.355 rillig 13807: <td>RSSH_SCP_PATH</td>
1.311 leot 13808: </tr>
13809: <tr>
1.358 gutterid 13810: <td>RSSH_SFTP_SERVER_PATH</td>
1.355 rillig 13811: <td>RUBY</td>
1.269 leot 13812: </tr>
13813: <tr>
1.358 gutterid 13814: <td>RUBYGEM</td>
1.355 rillig 13815: <td>RUBYGEM_MANPAGES</td>
1.269 leot 13816: </tr>
13817: <tr>
1.358 gutterid 13818: <td>RUBYGEM_NAME</td>
1.355 rillig 13819: <td>RUBYGEM_OPTIONS</td>
1.269 leot 13820: </tr>
13821: <tr>
1.358 gutterid 13822: <td>RUBYGEM_USE_MANPAGES</td>
1.355 rillig 13823: <td>RUBYGEM_VERBOSE</td>
1.346 jnemeth 13824: </tr>
13825: <tr>
1.358 gutterid 13826: <td>RUBY_ABI_VERSION</td>
1.355 rillig 13827: <td>RUBY_ARCH</td>
1.269 leot 13828: </tr>
13829: <tr>
1.358 gutterid 13830: <td>RUBY_ARCHINC</td>
1.355 rillig 13831: <td>RUBY_ARCHLIB</td>
1.269 leot 13832: </tr>
13833: <tr>
1.358 gutterid 13834: <td>RUBY_BASE</td>
1.355 rillig 13835: <td>RUBY_BASERIDIR</td>
1.269 leot 13836: </tr>
13837: <tr>
1.358 gutterid 13838: <td>RUBY_BUILD_DOCUMENT</td>
1.355 rillig 13839: <td>RUBY_DLEXT</td>
1.269 leot 13840: </tr>
13841: <tr>
1.358 gutterid 13842: <td>RUBY_DOC</td>
1.355 rillig 13843: <td>RUBY_DYNAMIC_DIRS</td>
1.269 leot 13844: </tr>
13845: <tr>
1.358 gutterid 13846: <td>RUBY_EG</td>
1.355 rillig 13847: <td>RUBY_ENCODING_ARG</td>
1.269 leot 13848: </tr>
13849: <tr>
1.358 gutterid 13850: <td>RUBY_EXTCONF</td>
1.355 rillig 13851: <td>RUBY_EXTCONF_CHECK</td>
1.269 leot 13852: </tr>
13853: <tr>
1.358 gutterid 13854: <td>RUBY_EXTCONF_DEBUG</td>
1.355 rillig 13855: <td>RUBY_EXTCONF_MAKEFILE</td>
1.269 leot 13856: </tr>
13857: <tr>
1.358 gutterid 13858: <td>RUBY_GEM_ARCH</td>
1.355 rillig 13859: <td>RUBY_GEM_BASE</td>
1.269 leot 13860: </tr>
13861: <tr>
1.358 gutterid 13862: <td>RUBY_INC</td>
1.355 rillig 13863: <td>RUBY_LIB</td>
1.269 leot 13864: </tr>
13865: <tr>
1.358 gutterid 13866: <td>RUBY_LIB_BASE</td>
1.355 rillig 13867: <td>RUBY_NAME</td>
1.269 leot 13868: </tr>
13869: <tr>
1.358 gutterid 13870: <td>RUBY_NOVERSION</td>
1.355 rillig 13871: <td>RUBY_PKGPREFIX</td>
1.269 leot 13872: </tr>
13873: <tr>
1.358 gutterid 13874: <td>RUBY_RAILS</td>
13875: <td>RUBY_RAILS61_VERSION</td>
1.338 nia 13876: </tr>
13877: <tr>
1.356 gutterid 13878: <td>RUBY_RAILS70_VERSION</td>
1.365 gutterid 13879: <td>RUBY_RAILS71_VERSION</td>
1.269 leot 13880: </tr>
13881: <tr>
1.365 gutterid 13882: <td>RUBY_RAILS_ACCEPTED</td>
1.356 gutterid 13883: <td>RUBY_RAILS_DEFAULT</td>
1.269 leot 13884: </tr>
13885: <tr>
1.365 gutterid 13886: <td>RUBY_RAILS_REQD</td>
1.356 gutterid 13887: <td>RUBY_RAILS_STRICT_DEP</td>
1.269 leot 13888: </tr>
13889: <tr>
1.365 gutterid 13890: <td>RUBY_RIDIR</td>
1.356 gutterid 13891: <td>RUBY_SETUP</td>
1.269 leot 13892: </tr>
13893: <tr>
1.365 gutterid 13894: <td>RUBY_SHLIB</td>
1.356 gutterid 13895: <td>RUBY_SHLIBALIAS</td>
1.269 leot 13896: </tr>
13897: <tr>
1.365 gutterid 13898: <td>RUBY_SHLIBVER</td>
1.356 gutterid 13899: <td>RUBY_SIMPLE_INSTALL</td>
1.269 leot 13900: </tr>
13901: <tr>
1.365 gutterid 13902: <td>RUBY_SITEARCHLIB</td>
1.356 gutterid 13903: <td>RUBY_SITELIB</td>
1.269 leot 13904: </tr>
13905: <tr>
1.365 gutterid 13906: <td>RUBY_SITELIB_BASE</td>
1.356 gutterid 13907: <td>RUBY_SITERIDIR</td>
1.269 leot 13908: </tr>
13909: <tr>
1.365 gutterid 13910: <td>RUBY_SLEXT</td>
1.356 gutterid 13911: <td>RUBY_SRCDIR</td>
1.312 gdt 13912: </tr>
13913: <tr>
1.365 gutterid 13914: <td>RUBY_STATICLIB</td>
1.356 gutterid 13915: <td>RUBY_SUFFIX</td>
1.289 leot 13916: </tr>
13917: <tr>
1.365 gutterid 13918: <td>RUBY_SYSRIDIR</td>
1.356 gutterid 13919: <td>RUBY_USE_PTHREAD</td>
1.269 leot 13920: </tr>
13921: <tr>
1.365 gutterid 13922: <td>RUBY_VENDORARCHLIB</td>
1.356 gutterid 13923: <td>RUBY_VENDORLIB</td>
1.269 leot 13924: </tr>
13925: <tr>
1.365 gutterid 13926: <td>RUBY_VENDORLIB_BASE</td>
1.356 gutterid 13927: <td>RUBY_VER</td>
1.269 leot 13928: </tr>
13929: <tr>
1.365 gutterid 13930: <td>RUBY_VERSION</td>
1.356 gutterid 13931: <td>RUBY_VERSIONS_ACCEPTED</td>
1.269 leot 13932: </tr>
13933: <tr>
1.365 gutterid 13934: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.356 gutterid 13935: <td>RUBY_VERSION_DEFAULT</td>
1.269 leot 13936: </tr>
13937: <tr>
1.365 gutterid 13938: <td>RUBY_VERSION_REQD</td>
1.356 gutterid 13939: <td>RUBY_VER_DIR</td>
1.269 leot 13940: </tr>
13941: <tr>
1.365 gutterid 13942: <td>RUN</td>
1.356 gutterid 13943: <td>RUN_LDCONFIG</td>
1.269 leot 13944: </tr>
13945: <tr>
1.365 gutterid 13946: <td>RUST_TYPE</td>
1.356 gutterid 13947: <td>SCO</td>
1.269 leot 13948: </tr>
13949: <tr>
1.365 gutterid 13950: <td>SCREWS_GROUP</td>
1.356 gutterid 13951: <td>SCREWS_USER</td>
1.269 leot 13952: </tr>
13953: <tr>
1.365 gutterid 13954: <td>SCRIPTS_ENV</td>
1.356 gutterid 13955: <td>SCROLLKEEPER_DATADIR</td>
1.269 leot 13956: </tr>
13957: <tr>
1.365 gutterid 13958: <td>SCROLLKEEPER_REBUILDDB</td>
1.356 gutterid 13959: <td>SCROLLKEEPER_UPDATEDB</td>
1.269 leot 13960: </tr>
13961: <tr>
1.365 gutterid 13962: <td>SDIST_PAWD</td>
1.356 gutterid 13963: <td>SDL12_TYPE</td>
1.269 leot 13964: </tr>
13965: <tr>
1.365 gutterid 13966: <td>SERIAL_DEVICES</td>
1.356 gutterid 13967: <td>SETGIDGAME</td>
1.269 leot 13968: </tr>
13969: <tr>
1.365 gutterid 13970: <td>SETGID_GAMES_PERMS</td>
1.356 gutterid 13971: <td>SETUID_ROOT_PERMS</td>
1.269 leot 13972: </tr>
13973: <tr>
1.365 gutterid 13974: <td>SH</td>
1.352 wiz 13975: <td>SHLIB</td>
1.360 leot 13976: </tr>
13977: <tr>
1.367 ! gdt 13978: <td>SHORTNAME</td>
1.365 gutterid 13979: <td>SIGN_PACKAGES</td>
1.367 ! gdt 13980: </tr>
! 13981: <tr>
1.360 leot 13982: <td>SILC_CLIENT_WITH_PERL</td>
1.367 ! gdt 13983: <td>SITE_SPECIFIC_PKGS</td>
1.348 wiz 13984: </tr>
13985: <tr>
1.360 leot 13986: <td>SKIP_DEPENDS</td>
1.367 ! gdt 13987: <td>SMF_INSTANCES</td>
1.269 leot 13988: </tr>
13989: <tr>
1.360 leot 13990: <td>SMF_MANIFEST</td>
1.367 ! gdt 13991: <td>SMF_METHODS</td>
1.342 wiz 13992: </tr>
13993: <tr>
1.360 leot 13994: <td>SMF_METHOD_SHELL</td>
1.367 ! gdt 13995: <td>SMF_METHOD_SRC</td>
1.269 leot 13996: </tr>
13997: <tr>
1.360 leot 13998: <td>SMF_NAME</td>
1.367 ! gdt 13999: <td>SMF_PREFIX</td>
1.269 leot 14000: </tr>
14001: <tr>
1.360 leot 14002: <td>SMF_SRCDIR</td>
1.367 ! gdt 14003: <td>SNIPROXY_GROUP</td>
1.292 leot 14004: </tr>
14005: <tr>
1.360 leot 14006: <td>SNIPROXY_USER</td>
1.367 ! gdt 14007: <td>SOURCE_BUFFSIZE</td>
1.269 leot 14008: </tr>
14009: <tr>
1.360 leot 14010: <td>SPECIAL_PERMS</td>
1.367 ! gdt 14011: <td>SPECIFIC_PKGS</td>
1.332 rillig 14012: </tr>
14013: <tr>
1.360 leot 14014: <td>SSH_SUID</td>
1.367 ! gdt 14015: <td>SSP_SUPPORTED</td>
1.269 leot 14016: </tr>
14017: <tr>
1.360 leot 14018: <td>SSYNC_PAWD</td>
1.367 ! gdt 14019: <td>STEP_MSG</td>
1.274 rillig 14020: </tr>
14021: <tr>
1.360 leot 14022: <td>STRIP</td>
1.367 ! gdt 14023: <td>STRIP_DBG</td>
1.269 leot 14024: </tr>
14025: <tr>
1.360 leot 14026: <td>STRIP_DEBUG</td>
1.367 ! gdt 14027: <td>STRIP_DEBUG_SUPPORTED</td>
1.269 leot 14028: </tr>
14029: <tr>
1.360 leot 14030: <td>STRIP_FILES_SKIP</td>
1.367 ! gdt 14031: <td>SU</td>
1.269 leot 14032: </tr>
14033: <tr>
1.360 leot 14034: <td>SUBDIR</td>
1.367 ! gdt 14035: <td>SUBST</td>
1.269 leot 14036: </tr>
14037: <tr>
1.360 leot 14038: <td>SUBST_CLASSES</td>
1.367 ! gdt 14039: <td>SUBST_FILES</td>
1.269 leot 14040: </tr>
14041: <tr>
1.360 leot 14042: <td>SUBST_FILTER_CMD</td>
1.367 ! gdt 14043: <td>SUBST_MESSAGE</td>
1.269 leot 14044: </tr>
14045: <tr>
1.360 leot 14046: <td>SUBST_NOOP_OK</td>
1.367 ! gdt 14047: <td>SUBST_SED</td>
1.269 leot 14048: </tr>
14049: <tr>
1.360 leot 14050: <td>SUBST_SHOW_DIFF</td>
1.367 ! gdt 14051: <td>SUBST_SKIP_TEXT_CHECK</td>
1.269 leot 14052: </tr>
14053: <tr>
1.360 leot 14054: <td>SUBST_STAGE</td>
1.367 ! gdt 14055: <td>SUBST_VARS</td>
1.269 leot 14056: </tr>
14057: <tr>
1.360 leot 14058: <td>SUNWSPROBASE</td>
1.367 ! gdt 14059: <td>SUSE_PREFER</td>
1.269 leot 14060: </tr>
14061: <tr>
1.360 leot 14062: <td>SU_CMD</td>
1.367 ! gdt 14063: <td>SVN_EXTRACTDIR</td>
1.360 leot 14064: </tr>
14065: <tr>
1.367 ! gdt 14066: <td>SVN_REPO</td>
! 14067: <td>SVN_REPOSITORIES</td>
! 14068: </tr>
! 14069: <tr>
! 14070: <td>SVN_REVISION</td>
1.365 gutterid 14071: <td>SYSCONFBASE</td>
1.367 ! gdt 14072: </tr>
! 14073: <tr>
1.360 leot 14074: <td>TARGET_ARCH</td>
1.367 ! gdt 14075: <td>TBL</td>
1.352 wiz 14076: </tr>
14077: <tr>
1.360 leot 14078: <td>TERMCAP_TYPE</td>
1.367 ! gdt 14079: <td>TERMINFO_DEFAULT</td>
1.269 leot 14080: </tr>
14081: <tr>
1.360 leot 14082: <td>TERMINFO_TYPE</td>
1.367 ! gdt 14083: <td>TEST</td>
1.342 wiz 14084: </tr>
14085: <tr>
1.360 leot 14086: <td>TEST_DEPENDS</td>
1.367 ! gdt 14087: <td>TEST_DIRS</td>
1.269 leot 14088: </tr>
14089: <tr>
1.360 leot 14090: <td>TEST_ENV</td>
1.367 ! gdt 14091: <td>TEST_ENV_SHELL</td>
1.332 rillig 14092: </tr>
14093: <tr>
1.360 leot 14094: <td>TEST_MAKE_CMD</td>
1.367 ! gdt 14095: <td>TEST_MAKE_FLAGS</td>
1.327 wiz 14096: </tr>
14097: <tr>
1.360 leot 14098: <td>TEST_TARGET</td>
1.367 ! gdt 14099: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.332 rillig 14100: </tr>
14101: <tr>
1.360 leot 14102: <td>TEXLIVE_REV</td>
1.367 ! gdt 14103: <td>TEXLIVE_UNVERSIONED</td>
1.320 wiz 14104: </tr>
14105: <tr>
1.360 leot 14106: <td>TEXMFSITE</td>
1.367 ! gdt 14107: <td>TEX_FORMATS</td>
1.303 bacon 14108: </tr>
14109: <tr>
1.360 leot 14110: <td>TEX_HYPHEN_DAT</td>
1.367 ! gdt 14111: <td>TEX_HYPHEN_DEF</td>
1.274 rillig 14112: </tr>
14113: <tr>
1.360 leot 14114: <td>TEX_TEXMF_DIRS</td>
1.367 ! gdt 14115: <td>THTTPD_LOG_FACILITY</td>
1.269 leot 14116: </tr>
14117: <tr>
1.360 leot 14118: <td>TINYDYN_USER</td>
1.367 ! gdt 14119: <td>TLSWRAPPER_CHROOT</td>
1.269 leot 14120: </tr>
14121: <tr>
1.360 leot 14122: <td>TO</td>
1.367 ! gdt 14123: <td>TOOLS_ALIASES</td>
1.269 leot 14124: </tr>
14125: <tr>
1.360 leot 14126: <td>TOOLS_ALWAYS_WRAP</td>
1.367 ! gdt 14127: <td>TOOLS_ARGS</td>
1.269 leot 14128: </tr>
14129: <tr>
1.360 leot 14130: <td>TOOLS_BROKEN</td>
1.367 ! gdt 14131: <td>TOOLS_CMD</td>
1.269 leot 14132: </tr>
14133: <tr>
1.360 leot 14134: <td>TOOLS_CMDLINE_SED</td>
1.367 ! gdt 14135: <td>TOOLS_CREATE</td>
1.269 leot 14136: </tr>
14137: <tr>
1.360 leot 14138: <td>TOOLS_CROSS_DESTDIR</td>
1.367 ! gdt 14139: <td>TOOLS_DIR</td>
1.269 leot 14140: </tr>
14141: <tr>
1.360 leot 14142: <td>TOOLS_FAIL</td>
1.367 ! gdt 14143: <td>TOOLS_GNU_MISSING</td>
1.269 leot 14144: </tr>
14145: <tr>
1.360 leot 14146: <td>TOOLS_LDCONFIG</td>
1.367 ! gdt 14147: <td>TOOLS_NOOP</td>
1.269 leot 14148: </tr>
14149: <tr>
1.360 leot 14150: <td>TOOLS_PATH</td>
1.367 ! gdt 14151: <td>TOOLS_SCRIPT</td>
1.269 leot 14152: </tr>
14153: <tr>
1.360 leot 14154: <td>TOOLS_USE_CROSS_COMPILE</td>
1.367 ! gdt 14155: <td>TOOL_DEPENDS</td>
1.269 leot 14156: </tr>
14157: <tr>
1.367 ! gdt 14158: <td>TTF_FONTDIR</td>
1.356 gutterid 14159: <td>TTF_FONTS_DIR</td>
1.355 rillig 14160: </tr>
14161: <tr>
1.365 gutterid 14162: <td>TYPE</td>
1.356 gutterid 14163: <td>UAC_REQD_EXECS</td>
1.352 wiz 14164: </tr>
14165: <tr>
1.365 gutterid 14166: <td>UCSPI_SSL_GROUP</td>
1.356 gutterid 14167: <td>UCSPI_SSL_USER</td>
1.269 leot 14168: </tr>
14169: <tr>
1.365 gutterid 14170: <td>UNLIMIT_RESOURCES</td>
1.356 gutterid 14171: <td>UNPRIVILEGED</td>
1.338 nia 14172: </tr>
14173: <tr>
1.365 gutterid 14174: <td>UNPRIVILEGED_GROUP</td>
1.356 gutterid 14175: <td>UNPRIVILEGED_GROUPS</td>
1.269 leot 14176: </tr>
14177: <tr>
1.365 gutterid 14178: <td>UNPRIVILEGED_USER</td>
1.356 gutterid 14179: <td>UNWRAP_FILES</td>
1.327 wiz 14180: </tr>
14181: <tr>
1.365 gutterid 14182: <td>UNWRAP_PATTERNS</td>
1.356 gutterid 14183: <td>UPDATE_GEMSPEC</td>
1.269 leot 14184: </tr>
14185: <tr>
1.365 gutterid 14186: <td>UPDATE_TARGET</td>
1.356 gutterid 14187: <td>URI</td>
1.269 leot 14188: </tr>
14189: <tr>
1.365 gutterid 14190: <td>USERGROUP_PHASE</td>
1.356 gutterid 14191: <td>USERPPP_GROUP</td>
1.269 leot 14192: </tr>
14193: <tr>
1.365 gutterid 14194: <td>USER_SPECIFIC_PKGS</td>
1.356 gutterid 14195: <td>USE_ABI_DEPENDS</td>
1.269 leot 14196: </tr>
14197: <tr>
1.365 gutterid 14198: <td>USE_APR</td>
1.356 gutterid 14199: <td>USE_BSD_MAKEFILE</td>
1.269 leot 14200: </tr>
14201: <tr>
1.365 gutterid 14202: <td>USE_BUILTIN</td>
1.357 gutterid 14203: <td>USE_CC_FEATURES</td>
14204: </tr>
14205: <tr>
1.365 gutterid 14206: <td>USE_CROSS_COMPILE</td>
1.357 gutterid 14207: <td>USE_CURSES</td>
1.269 leot 14208: </tr>
14209: <tr>
1.365 gutterid 14210: <td>USE_CWRAPPERS</td>
1.357 gutterid 14211: <td>USE_CXX_FEATURES</td>
1.269 leot 14212: </tr>
14213: <tr>
1.365 gutterid 14214: <td>USE_DB185</td>
1.356 gutterid 14215: <td>USE_FEATURES</td>
1.269 leot 14216: </tr>
14217: <tr>
1.365 gutterid 14218: <td>USE_GAMESGROUP</td>
1.356 gutterid 14219: <td>USE_GCC_RUNTIME</td>
1.269 leot 14220: </tr>
14221: <tr>
1.365 gutterid 14222: <td>USE_IMAKE</td>
1.356 gutterid 14223: <td>USE_JAVA</td>
1.320 wiz 14224: </tr>
14225: <tr>
1.365 gutterid 14226: <td>USE_JAVA2</td>
1.356 gutterid 14227: <td>USE_LANGUAGES</td>
1.269 leot 14228: </tr>
14229: <tr>
1.365 gutterid 14230: <td>USE_LIBTOOL</td>
1.356 gutterid 14231: <td>USE_NATIVE_GCC</td>
1.269 leot 14232: </tr>
14233: <tr>
1.365 gutterid 14234: <td>USE_NETBSD_REPO</td>
1.356 gutterid 14235: <td>USE_PKGSRC_GCC</td>
1.269 leot 14236: </tr>
14237: <tr>
1.365 gutterid 14238: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.356 gutterid 14239: <td>USE_PKGTASKS</td>
1.269 leot 14240: </tr>
14241: <tr>
1.365 gutterid 14242: <td>USE_PKG_ADMIN_DIGEST</td>
1.356 gutterid 14243: <td>USE_RUBY_EXTCONF</td>
1.269 leot 14244: </tr>
14245: <tr>
1.365 gutterid 14246: <td>USE_RUBY_INSTALL</td>
1.356 gutterid 14247: <td>USE_RUBY_SETUP</td>
1.269 leot 14248: </tr>
14249: <tr>
1.365 gutterid 14250: <td>USE_RUBY_SETUP_PKG</td>
1.356 gutterid 14251: <td>USE_TOOLS</td>
1.269 leot 14252: </tr>
14253: <tr>
1.365 gutterid 14254: <td>UUCP_GROUP</td>
1.356 gutterid 14255: <td>UUCP_USER</td>
1.269 leot 14256: </tr>
14257: <tr>
1.365 gutterid 14258: <td>VARBASE</td>
1.356 gutterid 14259: <td>VARNAME</td>
1.269 leot 14260: </tr>
14261: <tr>
1.365 gutterid 14262: <td>VIM_EXTRA_OPTS</td>
1.356 gutterid 14263: <td>WARNING_MSG</td>
1.269 leot 14264: </tr>
14265: <tr>
1.365 gutterid 14266: <td>WCALC_CGIDIR</td>
1.356 gutterid 14267: <td>WCALC_CGIPATH</td>
1.269 leot 14268: </tr>
14269: <tr>
1.365 gutterid 14270: <td>WCALC_HTMLDIR</td>
1.356 gutterid 14271: <td>WCALC_HTMLPATH</td>
1.269 leot 14272: </tr>
14273: <tr>
1.365 gutterid 14274: <td>WDM_MANAGERS</td>
1.356 gutterid 14275: <td>WRAPPER_CC</td>
1.269 leot 14276: </tr>
14277: <tr>
1.365 gutterid 14278: <td>WRAPPER_REORDER_CMDS</td>
1.356 gutterid 14279: <td>WRKDIR</td>
1.269 leot 14280: </tr>
14281: <tr>
1.365 gutterid 14282: <td>WRKDIR_BASENAME</td>
1.356 gutterid 14283: <td>WRKDIR_LOCKTYPE</td>
1.269 leot 14284: </tr>
14285: <tr>
1.365 gutterid 14286: <td>WRKLOG</td>
1.356 gutterid 14287: <td>WRKOBJDIR</td>
1.269 leot 14288: </tr>
14289: <tr>
1.365 gutterid 14290: <td>WRKSRC</td>
1.356 gutterid 14291: <td>X10_PORT</td>
1.269 leot 14292: </tr>
14293: <tr>
1.365 gutterid 14294: <td>X11</td>
1.356 gutterid 14295: <td>X11BASE</td>
1.269 leot 14296: </tr>
14297: <tr>
1.365 gutterid 14298: <td>X11_PKGSRCDIR</td>
1.356 gutterid 14299: <td>X11_TYPE</td>
1.269 leot 14300: </tr>
14301: <tr>
1.365 gutterid 14302: <td>X509_CERTIFICATE</td>
1.356 gutterid 14303: <td>X509_KEY</td>
1.303 bacon 14304: </tr>
14305: <tr>
1.365 gutterid 14306: <td>XAW_TYPE</td>
1.356 gutterid 14307: <td>XLOCK_DEFAULT_MODE</td>
1.269 leot 14308: </tr>
14309: <tr>
1.365 gutterid 14310: <td>XMKMF</td>
1.356 gutterid 14311: <td>XMKMF_FLAGS</td>
1.269 leot 14312: </tr>
14313: <tr>
1.365 gutterid 14314: <td>XXX</td>
1.367 ! gdt 14315: <td>XXXX</td>
! 14316: </tr>
! 14317: <tr>
1.353 dholland 14318: <td>YES</td>
1.367 ! gdt 14319: <td>ZSH_STATIC</td>
1.360 leot 14320: </tr>
14321: <tr>
14322: <td>__stdc__</td>
1.367 ! gdt 14323: <td>_vargroups</td>
1.348 wiz 14324: </tr>
14325: <tr>
1.360 leot 14326: <td>accept</td>
1.367 ! gdt 14327: <td>acquire-localbase-lock</td>
1.269 leot 14328: </tr>
14329: <tr>
1.360 leot 14330: <td>acquire-lock</td>
1.367 ! gdt 14331: <td>add</td>
1.342 wiz 14332: </tr>
14333: <tr>
1.360 leot 14334: <td>added</td>
1.367 ! gdt 14335: <td>administrator</td>
1.269 leot 14336: </tr>
14337: <tr>
1.360 leot 14338: <td>alloca</td>
1.367 ! gdt 14339: <td>alternatives</td>
1.274 rillig 14340: </tr>
14341: <tr>
1.360 leot 14342: <td>aslr</td>
1.367 ! gdt 14343: <td>asprintf</td>
1.332 rillig 14344: </tr>
14345: <tr>
1.360 leot 14346: <td>atlas</td>
1.367 ! gdt 14347: <td>autoconf</td>
1.269 leot 14348: </tr>
14349: <tr>
1.360 leot 14350: <td>automake</td>
1.367 ! gdt 14351: <td>autoreconf</td>
1.316 cirnatda 14352: </tr>
14353: <tr>
1.360 leot 14354: <td>awk</td>
1.367 ! gdt 14355: <td>bash</td>
1.289 leot 14356: </tr>
14357: <tr>
1.360 leot 14358: <td>big-endian</td>
1.367 ! gdt 14359: <td>bin-install</td>
1.269 leot 14360: </tr>
14361: <tr>
1.360 leot 14362: <td>bind</td>
1.367 ! gdt 14363: <td>binpkg-list</td>
1.269 leot 14364: </tr>
14365: <tr>
1.360 leot 14366: <td>blas</td>
1.367 ! gdt 14367: <td>bootstrap-depends</td>
1.289 leot 14368: </tr>
14369: <tr>
1.360 leot 14370: <td>broken</td>
1.367 ! gdt 14371: <td>broken_on_platform</td>
1.269 leot 14372: </tr>
14373: <tr>
1.360 leot 14374: <td>bsd</td>
1.367 ! gdt 14375: <td>bsd.prog.mk</td>
1.269 leot 14376: </tr>
14377: <tr>
1.360 leot 14378: <td>build</td>
1.367 ! gdt 14379: <td>build-env</td>
1.269 leot 14380: </tr>
14381: <tr>
1.360 leot 14382: <td>buildlink-directories</td>
1.367 ! gdt 14383: <td>buildlink-oss-soundcard-h</td>
1.271 brook 14384: </tr>
14385: <tr>
1.360 leot 14386: <td>built-in</td>
1.367 ! gdt 14387: <td>builtin</td>
1.269 leot 14388: </tr>
14389: <tr>
1.360 leot 14390: <td>c</td>
1.367 ! gdt 14391: <td>c++</td>
1.356 gutterid 14392: </tr>
14393: <tr>
1.360 leot 14394: <td>ccache</td>
1.367 ! gdt 14395: <td>cce</td>
1.292 leot 14396: </tr>
14397: <tr>
1.360 leot 14398: <td>cdefs</td>
1.367 ! gdt 14399: <td>ceil</td>
1.274 rillig 14400: </tr>
14401: <tr>
1.360 leot 14402: <td>changes</td>
1.367 ! gdt 14403: <td>changes-entry</td>
1.269 leot 14404: </tr>
14405: <tr>
1.360 leot 14406: <td>changes-entry-noupdate</td>
1.367 ! gdt 14407: <td>check</td>
1.289 leot 14408: </tr>
14409: <tr>
1.360 leot 14410: <td>check-clean</td>
1.367 ! gdt 14411: <td>check-files</td>
1.269 leot 14412: </tr>
14413: <tr>
1.360 leot 14414: <td>check-files-clean</td>
1.367 ! gdt 14415: <td>check-vulnerable</td>
1.269 leot 14416: </tr>
14417: <tr>
1.360 leot 14418: <td>checksum</td>
1.367 ! gdt 14419: <td>checksum-phase</td>
1.269 leot 14420: </tr>
14421: <tr>
1.360 leot 14422: <td>clean</td>
1.367 ! gdt 14423: <td>clean-depends</td>
1.269 leot 14424: </tr>
14425: <tr>
1.360 leot 14426: <td>cleandir</td>
1.367 ! gdt 14427: <td>commit</td>
1.289 leot 14428: </tr>
14429: <tr>
1.360 leot 14430: <td>commit-changes-entry</td>
1.367 ! gdt 14431: <td>compact</td>
1.269 leot 14432: </tr>
14433: <tr>
1.360 leot 14434: <td>compiler</td>
1.367 ! gdt 14435: <td>conf</td>
1.269 leot 14436: </tr>
14437: <tr>
1.360 leot 14438: <td>config.guess</td>
1.367 ! gdt 14439: <td>config.sub</td>
1.269 leot 14440: </tr>
14441: <tr>
1.360 leot 14442: <td>configuration</td>
1.367 ! gdt 14443: <td>configure</td>
1.269 leot 14444: </tr>
14445: <tr>
1.360 leot 14446: <td>configure-env</td>
1.367 ! gdt 14447: <td>configure-help</td>
1.269 leot 14448: </tr>
14449: <tr>
1.360 leot 14450: <td>configure_args</td>
1.367 ! gdt 14451: <td>connect</td>
1.269 leot 14452: </tr>
14453: <tr>
1.360 leot 14454: <td>cos</td>
1.367 ! gdt 14455: <td>cpe</td>
1.269 leot 14456: </tr>
14457: <tr>
1.360 leot 14458: <td>cputime</td>
1.367 ! gdt 14459: <td>create-usergroup</td>
1.269 leot 14460: </tr>
14461: <tr>
1.360 leot 14462: <td>csh</td>
1.367 ! gdt 14463: <td>ctf</td>
1.269 leot 14464: </tr>
14465: <tr>
1.367 ! gdt 14466: <td>cvs</td>
1.356 gutterid 14467: <td>debug</td>
1.355 rillig 14468: </tr>
14469: <tr>
1.365 gutterid 14470: <td>declaration</td>
1.356 gutterid 14471: <td>declare</td>
1.352 wiz 14472: </tr>
14473: <tr>
1.365 gutterid 14474: <td>defined</td>
1.356 gutterid 14475: <td>depend</td>
1.338 nia 14476: </tr>
14477: <tr>
1.365 gutterid 14478: <td>dependencies</td>
1.356 gutterid 14479: <td>depends</td>
1.289 leot 14480: </tr>
14481: <tr>
1.365 gutterid 14482: <td>depends-checksum</td>
1.356 gutterid 14483: <td>depends-fetch</td>
1.329 leot 14484: </tr>
14485: <tr>
1.365 gutterid 14486: <td>deps</td>
1.356 gutterid 14487: <td>describe</td>
1.320 wiz 14488: </tr>
14489: <tr>
1.365 gutterid 14490: <td>destdir</td>
1.356 gutterid 14491: <td>disable</td>
1.269 leot 14492: </tr>
14493: <tr>
1.365 gutterid 14494: <td>distclean</td>
1.356 gutterid 14495: <td>distinfo</td>
1.311 leot 14496: </tr>
14497: <tr>
1.365 gutterid 14498: <td>dl</td>
1.356 gutterid 14499: <td>dlopen</td>
1.269 leot 14500: </tr>
14501: <tr>
1.365 gutterid 14502: <td>do-buildlink</td>
1.356 gutterid 14503: <td>do-clean</td>
1.269 leot 14504: </tr>
14505: <tr>
1.365 gutterid 14506: <td>do-configure</td>
1.356 gutterid 14507: <td>do-configure-post-hook</td>
1.269 leot 14508: </tr>
14509: <tr>
1.365 gutterid 14510: <td>do-extract</td>
1.356 gutterid 14511: <td>do-fetch</td>
1.269 leot 14512: </tr>
14513: <tr>
1.365 gutterid 14514: <td>do-install</td>
1.356 gutterid 14515: <td>emul</td>
1.269 leot 14516: </tr>
14517: <tr>
1.365 gutterid 14518: <td>emul-distinfo</td>
1.356 gutterid 14519: <td>emul-fetch</td>
1.277 rillig 14520: </tr>
14521: <tr>
1.365 gutterid 14522: <td>emulation</td>
1.356 gutterid 14523: <td>emulator</td>
1.269 leot 14524: </tr>
14525: <tr>
1.365 gutterid 14526: <td>enable</td>
1.352 wiz 14527: <td>endian</td>
1.360 leot 14528: </tr>
14529: <tr>
1.367 ! gdt 14530: <td>endif</td>
1.365 gutterid 14531: <td>enomem</td>
1.367 ! gdt 14532: </tr>
! 14533: <tr>
1.360 leot 14534: <td>ensurepip</td>
1.367 ! gdt 14535: <td>err</td>
1.348 wiz 14536: </tr>
14537: <tr>
1.360 leot 14538: <td>errx</td>
1.367 ! gdt 14539: <td>etc</td>
1.269 leot 14540: </tr>
14541: <tr>
1.360 leot 14542: <td>exp</td>
1.367 ! gdt 14543: <td>extract-rpm</td>
1.342 wiz 14544: </tr>
14545: <tr>
1.360 leot 14546: <td>fabs</td>
1.367 ! gdt 14547: <td>feature</td>
1.329 leot 14548: </tr>
14549: <tr>
1.360 leot 14550: <td>features</td>
1.367 ! gdt 14551: <td>fetch</td>
1.269 leot 14552: </tr>
14553: <tr>
1.360 leot 14554: <td>fetch-list</td>
1.367 ! gdt 14555: <td>follows</td>
1.320 wiz 14556: </tr>
14557: <tr>
1.360 leot 14558: <td>forbids</td>
1.367 ! gdt 14559: <td>form</td>
1.311 leot 14560: </tr>
14561: <tr>
1.360 leot 14562: <td>format</td>
1.367 ! gdt 14563: <td>fortify</td>
1.269 leot 14564: </tr>
14565: <tr>
1.360 leot 14566: <td>fortify_source</td>
1.367 ! gdt 14567: <td>fossil</td>
1.352 wiz 14568: </tr>
14569: <tr>
1.365 gutterid 14570: <td>friend</td>
1.356 gutterid 14571: <td>fts</td>
1.355 rillig 14572: </tr>
14573: <tr>
1.365 gutterid 14574: <td>fts_close</td>
1.356 gutterid 14575: <td>fts_open</td>
1.332 rillig 14576: </tr>
14577: <tr>
1.365 gutterid 14578: <td>fts_read</td>
1.356 gutterid 14579: <td>fts_set</td>
1.338 nia 14580: </tr>
14581: <tr>
1.365 gutterid 14582: <td>gcc</td>
1.356 gutterid 14583: <td>gethostbyaddr</td>
1.269 leot 14584: </tr>
14585: <tr>
1.365 gutterid 14586: <td>gethostbyname</td>
1.356 gutterid 14587: <td>gethostbyname2</td>
1.269 leot 14588: </tr>
14589: <tr>
1.365 gutterid 14590: <td>getopt_long</td>
1.356 gutterid 14591: <td>getprogname</td>
1.269 leot 14592: </tr>
14593: <tr>
1.365 gutterid 14594: <td>getservbyname</td>
1.356 gutterid 14595: <td>getservbyport</td>
1.269 leot 14596: </tr>
14597: <tr>
1.365 gutterid 14598: <td>getservent</td>
1.352 wiz 14599: <td>gettext</td>
1.360 leot 14600: </tr>
14601: <tr>
1.367 ! gdt 14602: <td>git</td>
1.365 gutterid 14603: <td>github</td>
1.367 ! gdt 14604: </tr>
! 14605: <tr>
1.360 leot 14606: <td>gitlab</td>
1.367 ! gdt 14607: <td>glob</td>
1.348 wiz 14608: </tr>
14609: <tr>
1.360 leot 14610: <td>gnu</td>
1.367 ! gdt 14611: <td>gnu_configure_strict</td>
1.289 leot 14612: </tr>
14613: <tr>
1.360 leot 14614: <td>go</td>
1.367 ! gdt 14615: <td>go-deps</td>
1.342 wiz 14616: </tr>
14617: <tr>
1.360 leot 14618: <td>golang</td>
1.367 ! gdt 14619: <td>guess-license</td>
1.338 nia 14620: </tr>
14621: <tr>
1.360 leot 14622: <td>hashbang</td>
1.367 ! gdt 14623: <td>heimdal</td>
1.332 rillig 14624: </tr>
14625: <tr>
1.360 leot 14626: <td>help</td>
1.367 ! gdt 14627: <td>hg</td>
1.352 wiz 14628: </tr>
14629: <tr>
1.365 gutterid 14630: <td>imake</td>
1.356 gutterid 14631: <td>in-tree</td>
1.355 rillig 14632: </tr>
14633: <tr>
1.365 gutterid 14634: <td>increment</td>
1.355 rillig 14635: <td>indirect</td>
1.269 leot 14636: </tr>
14637: <tr>
1.365 gutterid 14638: <td>inet_aton</td>
1.355 rillig 14639: <td>interp</td>
1.329 leot 14640: </tr>
14641: <tr>
1.365 gutterid 14642: <td>interpreter</td>
1.355 rillig 14643: <td>intl</td>
1.269 leot 14644: </tr>
14645: <tr>
1.365 gutterid 14646: <td>ip4</td>
1.355 rillig 14647: <td>ip6</td>
1.320 wiz 14648: </tr>
14649: <tr>
1.365 gutterid 14650: <td>ipv4</td>
1.355 rillig 14651: <td>ipv6</td>
1.311 leot 14652: </tr>
14653: <tr>
1.365 gutterid 14654: <td>iso</td>
1.355 rillig 14655: <td>kerberos</td>
1.269 leot 14656: </tr>
14657: <tr>
1.365 gutterid 14658: <td>krb</td>
1.355 rillig 14659: <td>krb5</td>
1.269 leot 14660: </tr>
14661: <tr>
1.365 gutterid 14662: <td>ksh</td>
1.355 rillig 14663: <td>lapack</td>
1.269 leot 14664: </tr>
14665: <tr>
1.365 gutterid 14666: <td>latex</td>
1.355 rillig 14667: <td>libintl_bindtextdomain</td>
1.269 leot 14668: </tr>
14669: <tr>
1.365 gutterid 14670: <td>libintl_gettext</td>
1.355 rillig 14671: <td>libintl_textdomain</td>
1.303 bacon 14672: </tr>
14673: <tr>
1.365 gutterid 14674: <td>libnbcompat</td>
1.355 rillig 14675: <td>libs</td>
1.303 bacon 14676: </tr>
14677: <tr>
1.365 gutterid 14678: <td>libtool</td>
1.355 rillig 14679: <td>licence</td>
1.269 leot 14680: </tr>
14681: <tr>
1.365 gutterid 14682: <td>license</td>
1.355 rillig 14683: <td>lintl</td>
1.292 leot 14684: </tr>
14685: <tr>
1.365 gutterid 14686: <td>little-endian</td>
1.355 rillig 14687: <td>lock</td>
1.269 leot 14688: </tr>
14689: <tr>
1.365 gutterid 14690: <td>locking</td>
1.355 rillig 14691: <td>lua</td>
1.289 leot 14692: </tr>
14693: <tr>
1.365 gutterid 14694: <td>lvalue</td>
1.355 rillig 14695: <td>make</td>
1.274 rillig 14696: </tr>
14697: <tr>
1.365 gutterid 14698: <td>makesum</td>
1.355 rillig 14699: <td>memory</td>
1.360 leot 14700: </tr>
14701: <tr>
1.367 ! gdt 14702: <td>mercurial</td>
1.365 gutterid 14703: <td>meta</td>
1.367 ! gdt 14704: </tr>
! 14705: <tr>
1.360 leot 14706: <td>meta-package</td>
1.367 ! gdt 14707: <td>meta_package</td>
1.271 brook 14708: </tr>
14709: <tr>
1.360 leot 14710: <td>mit-krb5</td>
1.367 ! gdt 14711: <td>mk.conf</td>
1.348 wiz 14712: </tr>
14713: <tr>
1.360 leot 14714: <td>mkl</td>
1.367 ! gdt 14715: <td>mount</td>
1.342 wiz 14716: </tr>
14717: <tr>
1.360 leot 14718: <td>move</td>
1.367 ! gdt 14719: <td>moved</td>
1.269 leot 14720: </tr>
14721: <tr>
1.360 leot 14722: <td>mprotect</td>
1.367 ! gdt 14723: <td>mremap</td>
1.269 leot 14724: </tr>
14725: <tr>
1.360 leot 14726: <td>native</td>
1.367 ! gdt 14727: <td>nb</td>
1.292 leot 14728: </tr>
14729: <tr>
1.360 leot 14730: <td>nbcompat</td>
1.367 ! gdt 14731: <td>netlib</td>
1.274 rillig 14732: </tr>
14733: <tr>
1.360 leot 14734: <td>node</td>
1.367 ! gdt 14735: <td>node.js</td>
1.341 gutterid 14736: </tr>
14737: <tr>
1.360 leot 14738: <td>nodejs</td>
1.367 ! gdt 14739: <td>obstack</td>
1.269 leot 14740: </tr>
14741: <tr>
1.360 leot 14742: <td>obstack_ptr_grow</td>
1.367 ! gdt 14743: <td>occurs</td>
1.269 leot 14744: </tr>
14745: <tr>
1.360 leot 14746: <td>only</td>
1.367 ! gdt 14747: <td>openblas</td>
1.333 nia 14748: </tr>
14749: <tr>
1.360 leot 14750: <td>options</td>
1.367 ! gdt 14751: <td>options.mk</td>
1.333 nia 14752: </tr>
14753: <tr>
1.360 leot 14754: <td>order</td>
1.367 ! gdt 14755: <td>override</td>
1.320 wiz 14756: </tr>
14757: <tr>
1.360 leot 14758: <td>override-intltool</td>
1.367 ! gdt 14759: <td>override-message-intltool</td>
1.269 leot 14760: </tr>
14761: <tr>
1.360 leot 14762: <td>package</td>
1.367 ! gdt 14763: <td>parallel</td>
1.269 leot 14764: </tr>
14765: <tr>
1.360 leot 14766: <td>path</td>
1.367 ! gdt 14767: <td>pax</td>
1.269 leot 14768: </tr>
14769: <tr>
1.360 leot 14770: <td>paxctl</td>
1.367 ! gdt 14771: <td>pbulk-index</td>
1.271 brook 14772: </tr>
14773: <tr>
1.360 leot 14774: <td>pc</td>
1.367 ! gdt 14775: <td>perl</td>
1.269 leot 14776: </tr>
14777: <tr>
1.360 leot 14778: <td>perl5</td>
1.367 ! gdt 14779: <td>perms</td>
1.269 leot 14780: </tr>
14781: <tr>
1.360 leot 14782: <td>php</td>
1.367 ! gdt 14783: <td>pkg-build-options</td>
1.269 leot 14784: </tr>
14785: <tr>
1.360 leot 14786: <td>pkg-config</td>
1.367 ! gdt 14787: <td>pkg_build_options</td>
1.269 leot 14788: </tr>
14789: <tr>
1.360 leot 14790: <td>pkgsrc</td>
1.367 ! gdt 14791: <td>platform</td>
1.269 leot 14792: </tr>
14793: <tr>
1.360 leot 14794: <td>plist</td>
1.367 ! gdt 14795: <td>post-extract</td>
1.269 leot 14796: </tr>
14797: <tr>
1.360 leot 14798: <td>post-fetch</td>
1.367 ! gdt 14799: <td>post-wrapper</td>
1.269 leot 14800: </tr>
14801: <tr>
1.360 leot 14802: <td>pre-build-checks-hook</td>
1.367 ! gdt 14803: <td>pre-configure-checks-hook</td>
1.269 leot 14804: </tr>
14805: <tr>
1.360 leot 14806: <td>pre-extract</td>
1.367 ! gdt 14807: <td>pre-fetch</td>
1.269 leot 14808: </tr>
14809: <tr>
1.360 leot 14810: <td>print-go-deps</td>
1.367 ! gdt 14811: <td>print-plist</td>
1.269 leot 14812: </tr>
14813: <tr>
1.360 leot 14814: <td>print-summary-data</td>
1.367 ! gdt 14815: <td>privileged-install-hook</td>
1.269 leot 14816: </tr>
14817: <tr>
1.360 leot 14818: <td>pypi</td>
1.367 ! gdt 14819: <td>python</td>
1.289 leot 14820: </tr>
14821: <tr>
1.360 leot 14822: <td>r</td>
1.367 ! gdt 14823: <td>readme-all</td>
1.269 leot 14824: </tr>
14825: <tr>
1.360 leot 14826: <td>recursive</td>
1.367 ! gdt 14827: <td>recv</td>
1.269 leot 14828: </tr>
14829: <tr>
1.360 leot 14830: <td>recvfrom</td>
1.367 ! gdt 14831: <td>regcomp</td>
1.269 leot 14832: </tr>
14833: <tr>
1.360 leot 14834: <td>release-localbase-lock</td>
1.367 ! gdt 14835: <td>release-lock</td>
1.269 leot 14836: </tr>
14837: <tr>
1.360 leot 14838: <td>relro</td>
1.367 ! gdt 14839: <td>remove</td>
1.269 leot 14840: </tr>
14841: <tr>
1.360 leot 14842: <td>removed</td>
1.367 ! gdt 14843: <td>rename</td>
1.289 leot 14844: </tr>
14845: <tr>
1.360 leot 14846: <td>renamed</td>
1.367 ! gdt 14847: <td>reorder</td>
1.289 leot 14848: </tr>
14849: <tr>
1.360 leot 14850: <td>replace</td>
1.367 ! gdt 14851: <td>replace_interpreter</td>
1.269 leot 14852: </tr>
14853: <tr>
1.360 leot 14854: <td>reproducible</td>
1.367 ! gdt 14855: <td>resolv</td>
1.341 gutterid 14856: </tr>
14857: <tr>
1.360 leot 14858: <td>root</td>
1.367 ! gdt 14859: <td>ruby</td>
1.341 gutterid 14860: </tr>
14861: <tr>
1.360 leot 14862: <td>send</td>
1.367 ! gdt 14863: <td>sendfile</td>
1.269 leot 14864: </tr>
14865: <tr>
1.360 leot 14866: <td>sendto</td>
1.367 ! gdt 14867: <td>setenv</td>
1.269 leot 14868: </tr>
14869: <tr>
1.360 leot 14870: <td>setgid</td>
1.367 ! gdt 14871: <td>setprogname</td>
1.269 leot 14872: </tr>
14873: <tr>
1.360 leot 14874: <td>setuid</td>
1.367 ! gdt 14875: <td>sh</td>
1.289 leot 14876: </tr>
14877: <tr>
1.360 leot 14878: <td>shebang</td>
1.367 ! gdt 14879: <td>show</td>
1.269 leot 14880: </tr>
14881: <tr>
1.360 leot 14882: <td>show-all</td>
1.367 ! gdt 14883: <td>show-build-defs</td>
1.269 leot 14884: </tr>
14885: <tr>
1.360 leot 14886: <td>show-depends</td>
1.367 ! gdt 14887: <td>show-depends-dirs</td>
1.269 leot 14888: </tr>
14889: <tr>
1.360 leot 14890: <td>show-depends-pkgpaths</td>
1.367 ! gdt 14891: <td>show-depends-recursive</td>
1.269 leot 14892: </tr>
14893: <tr>
1.360 leot 14894: <td>show-deps</td>
1.367 ! gdt 14895: <td>show-distfiles</td>
1.296 rillig 14896: </tr>
14897: <tr>
1.360 leot 14898: <td>show-downlevel</td>
1.367 ! gdt 14899: <td>show-subdir-var</td>
1.269 leot 14900: </tr>
14901: <tr>
1.360 leot 14902: <td>show-tools</td>
1.367 ! gdt 14903: <td>show-var</td>
1.337 gutterid 14904: </tr>
14905: <tr>
1.360 leot 14906: <td>show-vars</td>
1.367 ! gdt 14907: <td>snprintf</td>
1.338 nia 14908: </tr>
14909: <tr>
1.360 leot 14910: <td>socket</td>
1.367 ! gdt 14911: <td>ssp</td>
1.269 leot 14912: </tr>
14913: <tr>
1.360 leot 14914: <td>st_mode</td>
1.367 ! gdt 14915: <td>stage-install</td>
1.269 leot 14916: </tr>
14917: <tr>
1.360 leot 14918: <td>strcasestr</td>
1.367 ! gdt 14919: <td>strict</td>
1.269 leot 14920: </tr>
14921: <tr>
1.360 leot 14922: <td>strip</td>
1.367 ! gdt 14923: <td>strndup</td>
1.269 leot 14924: </tr>
14925: <tr>
1.360 leot 14926: <td>strnlen</td>
1.367 ! gdt 14927: <td>strsep</td>
1.289 leot 14928: </tr>
14929: <tr>
1.360 leot 14930: <td>subst</td>
1.367 ! gdt 14931: <td>substitutions</td>
1.352 wiz 14932: </tr>
14933: <tr>
1.367 ! gdt 14934: <td>subversion</td>
1.341 gutterid 14935: <td>sun</td>
1.355 rillig 14936: </tr>
14937: <tr>
1.365 gutterid 14938: <td>sunpro</td>
1.355 rillig 14939: <td>sunwspro</td>
1.329 leot 14940: </tr>
14941: <tr>
1.367 ! gdt 14942: <td>svn</td>
1.365 gutterid 14943: <td>symlink</td>
1.367 ! gdt 14944: </tr>
! 14945: <tr>
1.356 gutterid 14946: <td>test</td>
1.367 ! gdt 14947: <td>test-env</td>
1.327 wiz 14948: </tr>
14949: <tr>
1.356 gutterid 14950: <td>tex</td>
1.367 ! gdt 14951: <td>texlive</td>
1.342 wiz 14952: </tr>
14953: <tr>
1.356 gutterid 14954: <td>tmp</td>
1.367 ! gdt 14955: <td>todo</td>
1.338 nia 14956: </tr>
14957: <tr>
1.356 gutterid 14958: <td>tool</td>
1.367 ! gdt 14959: <td>tools</td>
1.269 leot 14960: </tr>
14961: <tr>
1.356 gutterid 14962: <td>tools-libtool-m4-override</td>
1.367 ! gdt 14963: <td>transitive</td>
1.269 leot 14964: </tr>
14965: <tr>
1.356 gutterid 14966: <td>type</td>
1.367 ! gdt 14967: <td>ulimit</td>
1.269 leot 14968: </tr>
14969: <tr>
1.356 gutterid 14970: <td>undefined</td>
1.367 ! gdt 14971: <td>undo-replace</td>
1.269 leot 14972: </tr>
14973: <tr>
1.356 gutterid 14974: <td>unlimit</td>
1.367 ! gdt 14975: <td>unprivileged</td>
1.269 leot 14976: </tr>
14977: <tr>
1.356 gutterid 14978: <td>unprivileged-install-hook</td>
1.367 ! gdt 14979: <td>unstripped</td>
1.269 leot 14980: </tr>
14981: <tr>
1.356 gutterid 14982: <td>update</td>
1.367 ! gdt 14983: <td>updated</td>
1.269 leot 14984: </tr>
14985: <tr>
1.356 gutterid 14986: <td>upload</td>
1.367 ! gdt 14987: <td>upload-distfiles</td>
1.269 leot 14988: </tr>
14989: <tr>
1.356 gutterid 14990: <td>use_tools</td>
1.367 ! gdt 14991: <td>user</td>
1.269 leot 14992: </tr>
14993: <tr>
1.356 gutterid 14994: <td>utimes</td>
1.367 ! gdt 14995: <td>vasprintf</td>
1.269 leot 14996: </tr>
14997: <tr>
1.356 gutterid 14998: <td>verbose</td>
1.367 ! gdt 14999: <td>vsnprintf</td>
1.269 leot 15000: </tr>
15001: <tr>
1.356 gutterid 15002: <td>warn</td>
1.367 ! gdt 15003: <td>warning</td>
1.269 leot 15004: </tr>
15005: <tr>
1.356 gutterid 15006: <td>warnings</td>
1.367 ! gdt 15007: <td>warnx</td>
1.269 leot 15008: </tr>
15009: <tr>
1.356 gutterid 15010: <td>wattr_off</td>
1.367 ! gdt 15011: <td>wattr_on</td>
1.269 leot 15012: </tr>
15013: <tr>
1.356 gutterid 15014: <td>work</td>
1.367 ! gdt 15015: <td>wrapper</td>
1.269 leot 15016: </tr>
15017: <tr>
1.289 leot 15018: <td>wrkdir</td>
1.367 ! gdt 15019: <td> </td>
1.269 leot 15020: </tr>
15021: </table>
1.267 rillig 15022: </div>
15023: <div class="appendix">
15024: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 15025: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 15026: <div class="toc">
15027: <p><b>Table of Contents</b></p>
1.210 leot 15028: <dl class="toc">
1.322 leot 15029: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
15030: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75 rillig 15031: </dl>
15032: </div>
1.79 rillig 15033: <p>This section contains information on editing the pkgsrc
15034: guide itself.</p>
1.148 asau 15035: <div class="sect1">
1.75 rillig 15036: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 15037: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.79 rillig 15038: <p>The pkgsrc guide's source code is stored in
15039: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
15040: are created from it:</p>
1.148 asau 15041: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 15042: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
15043: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289 leot 15044: <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>
15045: <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.79 rillig 15046: The PDF version of the pkgsrc guide.</p></li>
1.289 leot 15047: <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.79 rillig 15048: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 15049: </ul></div>
15050: </div>
1.148 asau 15051: <div class="sect1">
1.75 rillig 15052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 15053: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.79 rillig 15054: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 15055: <div class="procedure"><ol class="procedure" type="1">
1.304 bacon 15056: <li class="step"><p>Make sure you have checked out the htdocs repository
15057: into a sibling directory of your pkgsrc directory. You will need
15058: the ability to commit from both pkgsrc and htdocs.</p></li>
1.148 asau 15059: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 15060: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 15061: documentation) installed. These are automatically installed when
1.322 leot 15062: 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.148 asau 15063: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 15064: right directory. All further steps will take place
15065: here.</p></li>
1.148 asau 15066: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 15067: <code class="filename">files/</code>.</p></li>
1.148 asau 15068: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 15069: guide for valid XML and to build the final output files. If you
15070: get any errors at this stage, you can just edit the files, as
15071: there are only symbolic links in the working directory, pointing
15072: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 15073: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 15074: commit)</strong></span></p></li>
1.148 asau 15075: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 15076: regenerate the output files with the proper RCS
15077: Ids.</p></li>
1.148 asau 15078: <li class="step">
1.110 hubertf 15079: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 15080: commit the files in both <code class="filename">pkgsrc/doc</code> and
15081: <code class="filename">htdocs</code>.</p>
1.148 asau 15082: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 15083: <h3 class="title">Note</h3>
15084: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 15085: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
15086: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 15087: directory.</p>
15088: </div>
15089: </li>
1.79 rillig 15090: </ol></div>
1.75 rillig 15091: </div>
15092: </div>
15093: </div></body>
1.1 grant 15094: </html>
CVSweb <webmaster@jp.NetBSD.org>