Annotation of pkgsrc/doc/pkgsrc.html, revision 1.378
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.377 jnemeth 33: <div><p class="copyright">Copyright © 1994-2025 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.44 2025/01/01 01:39:11 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.369 wiz 364: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
365: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
366: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
367: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
368: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
369: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
370: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
371: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
372: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
373: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.87 wiz 374: emulation</a></span></dt>
1.369 wiz 375: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
376: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.77 rillig 377: </dl></dd>
1.267 rillig 378: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 379: </dl></dd>
1.299 rillig 380: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
381: <dd><dl>
382: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
383: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
384: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
385: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
386: </dl></dd>
1.267 rillig 387: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 388: <dd><dl>
1.267 rillig 389: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
390: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
391: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
392: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
393: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
394: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
395: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
396: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
397: </dl></dd>
398: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75 rillig 399: </dl></dd>
400: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
401: <dd><dl>
1.299 rillig 402: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 403: <dd><dl>
1.299 rillig 404: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
405: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
406: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81 rillig 407: <dd><dl>
1.299 rillig 408: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
409: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81 rillig 410: </dl></dd>
1.299 rillig 411: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
412: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 413: <dd><dl>
1.299 rillig 414: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
415: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 416: </dl></dd>
1.299 rillig 417: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 418: <dd><dl>
1.299 rillig 419: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
420: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 421: </dl></dd>
422: </dl></dd>
1.299 rillig 423: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 424: <dd><dl>
1.299 rillig 425: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
426: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 427: <dd><dl>
1.299 rillig 428: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
429: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 430: </dl></dd>
431: </dl></dd>
1.299 rillig 432: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
433: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75 rillig 434: </dl></dd>
435: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
436: <dd><dl>
437: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
438: <dd><dl>
439: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
440: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
441: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287 rillig 442: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 443: </dl></dd>
444: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
445: </dl></dd>
1.322 leot 446: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.75 rillig 447: <dd><dl>
1.322 leot 448: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
449: <dd><dl>
450: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
451: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
452: </dl></dd>
453: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
454: <dd><dl>
455: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
456: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
457: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
458: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
459: </dl></dd>
460: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
461: <dd><dl>
462: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
463: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
464: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
465: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
466: </dl></dd>
467: </dl></dd>
468: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
469: <dd><dl>
470: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
471: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.75 rillig 472: </dl></dd>
1.322 leot 473: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.76 rillig 474: <dd><dl>
1.322 leot 475: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
476: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
477: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
478: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
479: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.261 leot 480: <code class="filename">stable</code>,
1.128 wiz 481: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 482: source packages</a></span></dt>
483: </dl></dd>
1.322 leot 484: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
485: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75 rillig 486: <dd><dl>
1.322 leot 487: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
488: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75 rillig 489: </dl></dd>
490: </dl>
491: </div>
1.82 rillig 492: <div class="list-of-tables">
493: <p><b>List of Tables</b></p>
494: <dl>
495: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
496: </dt>
1.299 rillig 497: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 498: </dt>
1.299 rillig 499: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 500: </dt>
1.82 rillig 501: </dl>
502: </div>
1.148 asau 503: <div class="chapter">
504: <div class="titlepage"><div><div><h1 class="title">
505: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 506: <div class="toc">
507: <p><b>Table of Contents</b></p>
1.210 leot 508: <dl class="toc">
1.75 rillig 509: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 510: <dd><dl>
511: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
512: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
513: </dl></dd>
1.75 rillig 514: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
515: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 516: <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 517: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
518: </dl>
519: </div>
1.148 asau 520: <div class="sect1">
1.75 rillig 521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
522: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 523: <p>There is a lot of software freely available for Unix-based
524: systems, which is usually available in form of the source code. Before
525: such software can be used, it needs to be configured to the local
526: system, compiled and installed, and this is exactly what The NetBSD
527: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
528: to handle binary packages, so that not every user has to build the
529: packages for himself, which is a time-costly task.</p>
1.75 rillig 530: <p>pkgsrc currently contains several thousand packages,
531: including:</p>
1.148 asau 532: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 533: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.75 rillig 534: web server</p></li>
1.322 leot 535: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75 rillig 536: web browser</p></li>
1.322 leot 537: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75 rillig 538: Desktop Environment</p></li>
1.322 leot 539: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.75 rillig 540: Desktop Environment</p></li>
541: </ul></div>
1.219 rillig 542: <p>… just to name a few.</p>
1.75 rillig 543: <p>pkgsrc has built-in support for handling varying dependencies,
544: such as pthreads and X11, and extended features such as IPv6 support on
545: a range of platforms.</p>
1.148 asau 546: <div class="sect2">
1.82 rillig 547: <div class="titlepage"><div><div><h3 class="title">
548: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
549: <p>
550: pkgsrc provides the following key features:
551: </p>
1.148 asau 552: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 553: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 554: and installation of binary packages. The source and latest
555: patches are retrieved from a master or mirror download site, checksum
556: verified, then built on your system. Support for binary-only
557: distributions is available for both native platforms and NetBSD
558: emulated platforms.</p></li>
1.128 wiz 559: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 560: including binaries, libraries, man pages and other
561: documentation.</p></li>
1.214 sevan 562: <li class="listitem"><p>Tracking of package dependencies automatically, including when
563: performing updates, to ensure required packages are installed. The
564: configuration files of various packages are handled automatically during
565: updates, so local changes are preserved.</p></li>
1.128 wiz 566: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 567: consists of highly portable code. This allows the greatest speed of
1.132 spz 568: development when porting to a new platform. This portability also
1.82 rillig 569: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
570: platforms</em></span>.</p></li>
1.128 wiz 571: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 572: international encryption requirements and build-time options for a
573: large number of packages are all set in a simple, central
574: configuration file.</p></li>
1.128 wiz 575: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 576: freely available under a BSD license, so you may extend and adapt
577: pkgsrc to your needs. Support for local packages and patches is
578: available right out of the box, so you can configure it specifically
579: for your environment.</p></li>
580: </ul></div>
1.91 rillig 581: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 582: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 583: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 584: — That means, if a package contains bugs, it's better to find
1.91 rillig 585: them and to complain about them rather than to just install the package
586: and hope that it works. There are numerous checks in pkgsrc that try to
1.322 leot 587: find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91 rillig 588: of shell scripts), and post-installation checks (installed files,
589: references to shared libraries, script interpreters).</p></li>
1.128 wiz 590: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 591: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 592: pkgsrc has been ported to many operating systems. Care is taken that
593: packages behave the same on all platforms.</p></li>
594: </ul></div>
1.82 rillig 595: </div>
1.148 asau 596: <div class="sect2">
1.82 rillig 597: <div class="titlepage"><div><div><h3 class="title">
598: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
599: <p>pkgsrc consists of both a source distribution and a binary
600: distribution for these operating systems. After retrieving the required
601: source or binaries, you can be up and running with pkgsrc in just
602: minutes!</p>
1.75 rillig 603: <p>pkgsrc was derived from FreeBSD's ports system, and
604: initially developed for NetBSD only. Since then, pkgsrc has
605: grown a lot, and now supports the following platforms:</p>
1.82 rillig 606: <div class="table">
607: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216 tnn 608: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 609: <colgroup>
610: <col>
611: <col>
1.202 sevan 612: <col>
1.82 rillig 613: </colgroup>
614: <thead><tr>
615: <th>Platform</th>
616: <th>Date Support Added</th>
1.202 sevan 617: <th>Notes</th>
1.82 rillig 618: </tr></thead>
619: <tbody>
620: <tr>
1.289 leot 621: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 622: <td align="center">Aug 1997</td>
1.202 sevan 623: <td class="auto-generated"> </td>
1.82 rillig 624: </tr>
625: <tr>
1.110 hubertf 626: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 627: <td align="center">Mar 1999</td>
1.264 sevan 628: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.82 rillig 629: </tr>
630: <tr>
1.289 leot 631: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 632: <td align="center">Jun 1999</td>
1.264 sevan 633: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.82 rillig 634: </tr>
635: <tr>
636: <td>
1.230 sevan 637: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82 rillig 638: </td>
639: <td align="center">Oct 2001</td>
1.305 bacon 640: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.82 rillig 641: </tr>
642: <tr>
1.289 leot 643: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 644: <td align="center">Nov 2002</td>
1.264 sevan 645: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.82 rillig 646: </tr>
647: <tr>
1.289 leot 648: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 649: <td align="center">Nov 2002</td>
1.264 sevan 650: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.82 rillig 651: </tr>
652: <tr>
1.289 leot 653: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 654: <td align="center">Dec 2002</td>
1.202 sevan 655: <td>
1.264 sevan 656: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.202 sevan 657: </td>
1.82 rillig 658: </tr>
659: <tr>
660: <td>BSD/OS</td>
661: <td align="center">Dec 2003</td>
1.202 sevan 662: <td class="auto-generated"> </td>
1.82 rillig 663: </tr>
664: <tr>
1.289 leot 665: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 666: <td align="center">Dec 2003</td>
1.264 sevan 667: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.82 rillig 668: </tr>
669: <tr>
670: <td>
1.289 leot 671: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 672: (Microsoft Windows Services for Unix)
673: </td>
674: <td align="center">Mar 2004</td>
1.264 sevan 675: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.82 rillig 676: </tr>
677: <tr>
1.289 leot 678: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 679: <td align="center">Oct 2004</td>
1.202 sevan 680: <td class="auto-generated"> </td>
1.82 rillig 681: </tr>
682: <tr>
1.110 hubertf 683: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 684: <td align="center">Nov 2004</td>
1.264 sevan 685: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.82 rillig 686: </tr>
1.98 wiz 687: <tr>
1.289 leot 688: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 689: <td align="center">Apr 2007</td>
1.264 sevan 690: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.98 wiz 691: </tr>
1.128 wiz 692: <tr>
1.289 leot 693: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128 wiz 694: <td align="center">Sep 2010</td>
1.264 sevan 695: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.128 wiz 696: </tr>
1.151 obache 697: <tr>
1.289 leot 698: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 699: <td align="center">Jan 2011</td>
1.202 sevan 700: <td class="auto-generated"> </td>
1.151 obache 701: </tr>
702: <tr>
1.289 leot 703: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151 obache 704: <td align="center">Nov 2011</td>
1.264 sevan 705: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.151 obache 706: </tr>
707: <tr>
1.289 leot 708: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151 obache 709: <td align="center">Mar 2013</td>
1.264 sevan 710: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.151 obache 711: </tr>
1.166 jnemeth 712: <tr>
1.289 leot 713: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166 jnemeth 714: <td align="center">Jul 2013</td>
1.264 sevan 715: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.166 jnemeth 716: </tr>
1.214 sevan 717: <tr>
1.289 leot 718: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214 sevan 719: <td align="center">Jun 2014</td>
1.344 gutterid 720: <td>Removed from pkgsrc Sep 2022</td>
1.214 sevan 721: </tr>
1.82 rillig 722: </tbody>
1.91 rillig 723: </table></div>
1.82 rillig 724: </div>
1.91 rillig 725: <br class="table-break">
1.82 rillig 726: </div>
1.75 rillig 727: </div>
1.148 asau 728: <div class="sect1">
1.75 rillig 729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
730: <a name="overview"></a>1.2. Overview</h2></div></div></div>
731: <p>This document is divided into three parts. The first,
1.110 hubertf 732: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 733: describes how one can use one of the packages in the Package
734: Collection, either by installing a precompiled binary package,
1.93 rillig 735: or by building one's own copy using the NetBSD package system.
1.110 hubertf 736: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75 rillig 737: package so it can be easily built by other NetBSD users without
738: knowing about the package's building details. The third part,
1.110 hubertf 739: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 740: is intended for those who want to understand how pkgsrc is
741: implemented.</p>
742: <p>This document is available in various formats:
1.110 hubertf 743: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75 rillig 744: </div>
1.148 asau 745: <div class="sect1">
1.75 rillig 746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
747: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 748: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
749: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 750: terminology used within this document.</p>
1.148 asau 751: <div class="variablelist"><dl class="variablelist">
1.75 rillig 752: <dt><span class="term">Package</span></dt>
753: <dd><p>A set of files and building instructions
754: that describe what's necessary
755: to build a certain piece of software using
756: pkgsrc. Packages are traditionally stored under
1.236 wiz 757: <code class="filename">/usr/pkgsrc</code>,
758: but may be stored in any location,
759: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75 rillig 760: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 761: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 762: is part of the NetBSD operating system and can be bootstrapped
763: to run on non-NetBSD operating systems as well. It handles
764: building (compiling), installing, and removing of
765: packages.</p></dd>
1.75 rillig 766: <dt><span class="term">Distfile</span></dt>
767: <dd><p>This term describes the file or files that are
768: provided by the author of the piece of software to
769: distribute his work. All the changes necessary to build on
770: NetBSD are reflected in the corresponding package. Usually
771: the distfile is in the form of a compressed tar-archive,
772: but other types are possible, too. Distfiles are usually
773: stored below
1.76 rillig 774: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 775: <dt><span class="term">Port</span></dt>
776: <dd><p>This is the term used by FreeBSD and OpenBSD people
777: for what we call a package.
1.128 wiz 778: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 779: architecture.</p></dd>
780: <dt><span class="term">Precompiled/binary package</span></dt>
781: <dd>
782: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 783: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 784: file so it can be installed on machines of the same
785: machine architecture without the need to
786: recompile. Packages are usually generated in
1.76 rillig 787: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 788: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 789: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 790: especially in the context of precompiled packages.</p>
791: </dd>
792: <dt><span class="term">Program</span></dt>
1.88 wiz 793: <dd><p>The piece of software to be installed which will be
794: constructed from all the files in the distfile by the
795: actions defined in the corresponding package.</p></dd>
1.75 rillig 796: </dl></div>
1.148 asau 797: <div class="sect2">
1.75 rillig 798: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 799: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 800: <div class="variablelist"><dl class="variablelist">
1.75 rillig 801: <dt><span class="term">pkgsrc users</span></dt>
802: <dd>
803: <p>The
804: pkgsrc users are people who use the packages provided by pkgsrc.
805: Typically they are system administrators. The people using the
1.128 wiz 806: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
807: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 808: <p>There are two kinds of pkgsrc users: Some only want to
809: install pre-built binary packages. Others build the pkgsrc
810: packages from source, either for installing them directly or for
1.110 hubertf 811: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.75 rillig 812: documentation.</p>
813: </dd>
814: <dt><span class="term">package maintainers</span></dt>
815: <dd><p>A
1.110 hubertf 816: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.75 rillig 817: <dt><span class="term">infrastructure developers</span></dt>
818: <dd><p>These people are involved in all those files
1.76 rillig 819: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 820: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.75 rillig 821: too.</p></dd>
822: </dl></div>
823: </div>
824: </div>
1.148 asau 825: <div class="sect1">
1.75 rillig 826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
827: <a name="typography"></a>1.4. Typography</h2></div></div></div>
828: <p>When giving examples for commands, shell prompts are used to
829: show if the command should/can be issued as root, or if
1.128 wiz 830: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.226 sevan 831: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
832: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.344 gutterid 833: Bourne shell and derivatives.</p>
1.75 rillig 834: </div>
835: </div>
1.148 asau 836: <div class="part">
1.75 rillig 837: <div class="titlepage"><div><div><h1 class="title">
838: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
839: <div class="toc">
840: <p><b>Table of Contents</b></p>
1.210 leot 841: <dl class="toc">
1.267 rillig 842: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
843: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75 rillig 844: <dd><dl>
1.267 rillig 845: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 846: <dd><dl>
1.267 rillig 847: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
848: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 849: </dl></dd>
1.267 rillig 850: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 851: <dd><dl>
1.267 rillig 852: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
853: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 854: </dl></dd>
855: </dl></dd>
1.267 rillig 856: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75 rillig 857: <dd><dl>
1.267 rillig 858: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
859: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 860: </dl></dd>
1.267 rillig 861: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75 rillig 862: <dd><dl>
1.267 rillig 863: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 864: <dd><dl>
1.267 rillig 865: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
866: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317 nia 867: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
868: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
869: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
870: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
871: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
872: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75 rillig 873: </dl></dd>
1.267 rillig 874: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75 rillig 875: <dd><dl>
1.267 rillig 876: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
877: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
878: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75 rillig 879: </dl></dd>
880: </dl></dd>
1.267 rillig 881: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75 rillig 882: <dd><dl>
1.267 rillig 883: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
884: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.355 rillig 885: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
886: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
887: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
888: <dd><dl>
889: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
890: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
891: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 892: </dl></dd>
1.355 rillig 893: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
894: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.75 rillig 895: </dl></dd>
1.267 rillig 896: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75 rillig 897: <dd><dl>
1.267 rillig 898: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
899: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 900: </dl></dd>
1.267 rillig 901: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 902: builds)</a></span></dt>
1.75 rillig 903: <dd><dl>
1.267 rillig 904: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 905: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 906: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
907: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 908: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
909: <dd><dl>
1.294 rillig 910: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
911: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296 rillig 912: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
913: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
914: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
915: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
916: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
917: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
918: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
919: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 920: </dl></dd>
921: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
922: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267 rillig 923: </dl></dd>
924: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
925: <dd><dl>
926: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
927: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
928: </dl></dd>
929: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
930: <dd><dl>
931: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
932: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
933: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
934: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
935: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
936: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
937: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
938: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
939: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
940: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 941: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 942: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.336 nia 943: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267 rillig 944: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
945: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
946: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
947: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
948: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 949: </dl></dd>
950: </dl>
951: </div>
1.148 asau 952: <div class="chapter">
1.75 rillig 953: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 954: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
955: <p>
956: To get help when using pkgsrc, the definitive source is this
957: document, the pkgsrc guide. If you don't find anything here,
958: there are alternatives:
959: </p>
960: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
961: <li class="listitem">
962: <p>
963: The built-in pkgsrc help, which is available after bootstrapping
964: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
965: help for any topic, such as a variable name like
966: <code class="varname">BUILD_DEFS</code>, a make target like
967: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
968: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322 leot 969: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.267 rillig 970: </li>
971: <li class="listitem"><p>
1.278 rillig 972: To see the value of a single variable, run <span class="command"><strong>bmake
973: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
974: </p></li>
975: <li class="listitem"><p>
976: To see the values of the most common variables, run
977: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
978: topic. To see the variables for a single topic, run
979: <span class="command"><strong>bmake
980: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
981: <span class="command"><strong>bmake show-all-fetch</strong></span>.
982: </p></li>
983: <li class="listitem"><p>
1.267 rillig 984: The pkgsrc-users mailing list, to which
985: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
986: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
987: questions</a>.</p></li>
988: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
989: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
990: or by using a specialized chat program such as
991: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
992: Pick any user name and join the channel #pkgsrc.</p></li>
993: </ul></div>
994: </div>
995: <div class="chapter">
996: <div class="titlepage"><div><div><h2 class="title">
997: <a name="getting"></a>Chapter 3. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
1.75 rillig 998: <div class="toc">
999: <p><b>Table of Contents</b></p>
1.210 leot 1000: <dl class="toc">
1.267 rillig 1001: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 1002: <dd><dl>
1.267 rillig 1003: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
1004: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 1005: </dl></dd>
1.267 rillig 1006: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 1007: <dd><dl>
1.267 rillig 1008: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
1009: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 1010: </dl></dd>
1011: </dl>
1012: </div>
1.91 rillig 1013: <p>Before you download and extract the files, you need to decide
1014: where you want to extract them. When using pkgsrc as root user, pkgsrc
1015: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
1016: free to install the sources and binary packages wherever you want in
1017: your filesystem, provided that the pathname does not contain white-space
1018: or other characters that are interpreted specially by the shell and some
1019: other programs. A safe bet is to use only letters, digits, underscores
1020: and dashes.</p>
1.148 asau 1021: <div class="sect1">
1.75 rillig 1022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1023: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75 rillig 1024: <p>Before you download any pkgsrc files, you should decide
1025: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1026: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1027: quarterly basis from the current branch and only gets modified
1028: for security updates. The names of the stable branches are built
1029: from the year and the quarter, for example
1.378 ! leot 1030: <code class="literal">2024Q4</code>.</p>
1.75 rillig 1031: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 1032: want to download pkgsrc. You can get it as a tar file or via CVS.
1033: Both ways are described here.</p>
1.157 asau 1034: <p>Note that tar archive contains CVS working copy.
1035: Thus you can switch to using CVS at any later time.</p>
1.148 asau 1036: <div class="sect2">
1.75 rillig 1037: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1038: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75 rillig 1039: <p>The primary download location for all pkgsrc files is
1.264 sevan 1040: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157 asau 1041: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1042: (it points to the same location).
1043: There are a number of subdirectories for different purposes,
1.322 leot 1044: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix D. Directory layout of the pkgsrc FTP server">Appendix D, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.157 asau 1045: <p>The tar archive for the current branch is in the directory
1.264 sevan 1046: <code class="filename">current</code> and is called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.230 sevan 1047: It is autogenerated weekly.</p>
1.157 asau 1048: <p>To save download time we provide bzip2- and
1049: xz-compressed archives which are published at
1.264 sevan 1050: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
1.157 asau 1051: and
1.264 sevan 1052: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
1.157 asau 1053: respectively.
1054: </p>
1055: <p>You can fetch the same files using FTP.</p>
1.378 ! leot 1056: <p>The tar file for the stable branch 2024Q4 is in the
! 1057: directory <code class="filename">pkgsrc-2024Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2024Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249 leot 1058: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112 weinem 1059: <pre class="screen">
1.378 ! leot 1060: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2024Q4/pkgsrc.tar.gz</code></strong></pre>
1.188 snj 1061: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 1062: or your web browser.</p>
1.112 weinem 1063: <p>Then, extract it with:</p>
1.188 snj 1064: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 weinem 1065: <p>This will create the directory <code class="filename">pkgsrc/</code>
1066: in <code class="filename">/usr/</code> and all the package source will be
1067: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1068: <p>To download pkgsrc-current, run:</p>
1069: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75 rillig 1070: </div>
1.148 asau 1071: <div class="sect2">
1.75 rillig 1072: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1073: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128 wiz 1074: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.378 ! leot 1075: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2024Q4 -P pkgsrc</code></strong>
1.128 wiz 1076: </pre>
1077: <p>This will create the directory <code class="filename">pkgsrc/</code>
1078: in your <code class="filename">/usr/</code> directory and all the package source
1079: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1080: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 1081: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 grant 1082: </pre>
1.289 leot 1083: <p>Refer to the <a class="ulink" href="https://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128 wiz 1084: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.146 wiz 1085: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.128 wiz 1086: </pre>
1087: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1088: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1089: or better globally in <code class="filename">/etc/profile</code>:</p>
1090: <pre class="programlisting">
1091: # set CVS remote shell command
1092: CVS_RSH=ssh
1093: export CVS_RSH
1094: </pre>
1095: <p>By default, CVS doesn't do things like most people would expect it to do.
1096: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1097: in your home directory and saving the following lines to it.
1098: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1099: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1100: <pre class="programlisting">
1101: # recommended CVS configuration file from the pkgsrc guide
1.268 sevan 1102: cvs -q
1.101 rillig 1103: checkout -P
1.103 wiz 1104: update -dP
1105: diff -upN
1.101 rillig 1106: rdiff -u
1.128 wiz 1107: release -d
1.101 rillig 1108: </pre>
1.75 rillig 1109: </div>
1110: </div>
1.148 asau 1111: <div class="sect1">
1.75 rillig 1112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1113: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75 rillig 1114: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1115: (which also works if you have first installed it via a tar
1116: file). It saves bandwidth and hard disk activity, compared to
1117: downloading the tar file again.</p>
1.148 asau 1118: <div class="sect2">
1.75 rillig 1119: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1120: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148 asau 1121: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1122: <h3 class="title">Warning</h3>
1.77 rillig 1123: <p>When updating from a tar file, you first need to
1124: completely remove the old pkgsrc directory. Otherwise those
1125: files that have been removed from pkgsrc in the mean time will
1126: not be removed on your local disk, resulting in inconsistencies.
1127: When removing the old files, any changes that you have done to
1128: the pkgsrc files will be lost after updating. Therefore updating
1129: via CVS is strongly recommended.</p>
1.75 rillig 1130: </div>
1.82 rillig 1131: <p>Note that by default the distfiles and the binary packages
1132: are saved in the pkgsrc tree, so don't forget to rescue them
1.188 snj 1133: before updating. You can also configure pkgsrc to store distfiles
1134: and packages in directories outside the pkgsrc tree by setting the
1.82 rillig 1135: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267 rillig 1136: variables. See <a class="xref" href="#configuring" title="Chapter 6. Configuring pkgsrc">Chapter 6, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 1137: <p>To update pkgsrc from a tar file, download the tar file as
1138: explained above. Then, make sure that you have not made any
1139: changes to the files in the pkgsrc directory. Remove the pkgsrc
1140: directory and extract the new tar file. Done.</p>
1141: </div>
1.148 asau 1142: <div class="sect2">
1.75 rillig 1143: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1144: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132 spz 1145: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1146: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1147: </pre>
1148: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
1149: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1150: </pre>
1.148 asau 1151: <div class="sect3">
1.75 rillig 1152: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1153: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75 rillig 1154: <p>When updating pkgsrc, the CVS program keeps track of the
1155: branch you selected. But if you, for whatever reason, want to
1156: switch from the stable branch to the current one, you can do it
1.128 wiz 1157: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1158: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1159: back to the stable branch, add the
1.378 ! leot 1160: <span class="quote">“<span class="quote">-rpkgsrc-2024Q4</span>”</span> option.</p>
1.75 rillig 1161: </div>
1.148 asau 1162: <div class="sect3">
1.75 rillig 1163: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1164: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75 rillig 1165: <p>When you update pkgsrc, the CVS program will only touch
1166: those files that are registered in the CVS repository. That
1167: means that any packages that you created on your own will stay
1168: unmodified. If you change files that are managed by CVS, later
1169: updates will try to merge your changes with those that have been
1170: done by others. See the CVS manual, chapter
1.128 wiz 1171: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1172: </div>
1173: </div>
1174: </div>
1175: </div>
1.148 asau 1176: <div class="chapter">
1.75 rillig 1177: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1178: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75 rillig 1179: <div class="toc">
1180: <p><b>Table of Contents</b></p>
1.210 leot 1181: <dl class="toc">
1.267 rillig 1182: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1183: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 1184: </dl>
1185: </div>
1.148 asau 1186: <div class="sect1">
1.75 rillig 1187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1188: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1189: <p>See <a class="xref" href="#using-pkg" title="5.1. Using binary packages">Section 5.1, “Using binary packages”</a>.</p>
1.82 rillig 1190: </div>
1.148 asau 1191: <div class="sect1">
1.82 rillig 1192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1193: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1194: <p>pkgsrc can be bootstrapped for use in two different modes:
1195: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1196: to privileged one all programs are installed under one particular user
1.149 asau 1197: and cannot utilise privileged operations (packages don't create
1198: special users and all special file permissions like setuid are ignored).
1199: </p>
1.82 rillig 1200: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1201: <pre class="screen">
1.167 asau 1202: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.75 rillig 1203: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1204: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1205: </pre>
1.149 asau 1206: <p>To bootstrap in unprivileged mode pass <span class="quote">“<span class="quote">--unprivileged</span>”</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
1207: <p>By default, in privileged mode pkgsrc uses
1208: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1209: where programs will be installed in,
1.230 sevan 1210: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149 asau 1211: directory where pkgsrc will do its internal bookkeeping,
1212: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1213: where packages install their persistent data.
1214: In unprivileged mode pkgsrc uses
1215: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230 sevan 1216: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149 asau 1217: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1218: </p>
1219: <p>You can change default layout using command-line arguments.
1220: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1221: </p>
1.148 asau 1222: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1223: <h3 class="title">Note</h3>
1.110 hubertf 1224: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1225: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1226: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1227: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1228: </div>
1.149 asau 1229: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1230: <h3 class="title">Note</h3>
1231: <p>It is possible to bootstrap multiple instances of pkgsrc
1232: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1233: corresponding to the installation you're working with to build
1234: and install packages.
1235: </p>
1236: </div>
1.75 rillig 1237: </div>
1238: </div>
1.148 asau 1239: <div class="chapter">
1.75 rillig 1240: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1241: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75 rillig 1242: <div class="toc">
1243: <p><b>Table of Contents</b></p>
1.210 leot 1244: <dl class="toc">
1.267 rillig 1245: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 1246: <dd><dl>
1.267 rillig 1247: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1248: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317 nia 1249: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1250: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1251: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1252: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1253: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
1254: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.267 rillig 1255: </dl></dd>
1256: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1257: <dd><dl>
1258: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1259: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1260: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75 rillig 1261: </dl></dd>
1262: </dl>
1263: </div>
1264: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1265: is to only install the package tools and to use binary packages
1.128 wiz 1266: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1267: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1268: of pkgsrc, too. Then you are able to build your own packages,
1269: and you can still use binary packages from someone else.</p>
1.148 asau 1270: <div class="sect1">
1.75 rillig 1271: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1272: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.317 nia 1273: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264 sevan 1274: site and mirrors, there are collections of binary packages,
1.109 rillig 1275: ready to be installed. These binary packages have been built using the
1276: default settings for the directories, that is:</p>
1.148 asau 1277: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1278: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1279: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1280: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.109 rillig 1281: </ul></div>
1282: <p>If you cannot use these directories for whatever reasons (maybe
1283: because you're not root), you cannot use these binary packages, but
1.267 rillig 1284: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="4.2. Bootstrapping pkgsrc">Section 4.2, “Bootstrapping pkgsrc”</a>.</p>
1.148 asau 1285: <div class="sect2">
1.75 rillig 1286: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1287: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1288: <p>To install binary packages, you first need to know from where
1289: to get them. The first place where you should look is on the main
1.317 nia 1290: pkgsrc CDN in the directory <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105 weinem 1291: <p>This directory contains binary packages for multiple
1.341 gutterid 1292: platforms. First, select your operating system. Then, select your
1293: hardware architecture, and in the third step, the OS version and
1294: the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1295: <p>In this directory, you may find a file called
1.109 rillig 1296: <code class="filename">bootstrap.tar.gz</code> which contains the package
1297: management tools. If the file is missing, it is likely that your
1298: operating system already provides those tools. Download the file and
1299: extract it in the <code class="filename">/</code> directory. It will create
1300: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230 sevan 1301: for managing binary packages and the database of installed packages).</p>
1.75 rillig 1302: </div>
1.148 asau 1303: <div class="sect2">
1.75 rillig 1304: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1305: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1306: <p>In the directory from the last section, there is a
1.196 wiz 1307: subdirectory called <code class="filename">All/</code>, which contains all the
1.109 rillig 1308: binary packages that are available for the platform, excluding those
1.317 nia 1309: that may not be distributed via HTTP or FTP.</p>
1.109 rillig 1310: <p>To install packages directly from an FTP or HTTP server, run
1311: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1312: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1313: <pre class="screen">
1.317 nia 1314: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1315: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284 rillig 1316: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="$PKG_PATH/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.109 rillig 1317: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.317 nia 1318: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.109 rillig 1319: </pre>
1320: <p>Instead of URLs, you can also use local paths, for example if
1321: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1322: repository. If you want to install packages from multiple sources,
1323: you can separate them by a semicolon in
1324: <code class="varname">PKG_PATH</code>.</p>
1325: <p>After these preparations, installing a package is very
1326: easy:</p>
1327: <pre class="screen">
1.317 nia 1328: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1329: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1330: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1331: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1332: </pre>
1333: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1334: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1335: <p>Any prerequisite packages needed to run the
1.88 wiz 1336: package in question will be installed, too, assuming they are
1.317 nia 1337: present in the repository.</p>
1.75 rillig 1338: <p>After you've installed packages, be sure to have
1.88 wiz 1339: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1340: <code class="varname">PATH</code> so you can actually start the just
1341: installed program.</p>
1.75 rillig 1342: </div>
1.148 asau 1343: <div class="sect2">
1.75 rillig 1344: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1345: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1346: <p>To update binary packages, it is recommended that you use
1347: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1348: package repository to your locally installed packages and safely
1349: replace any older packages.</p>
1350: <p>Note that pkgsrc is released as quarterly branches.
1351: If you are updating to a newer quarterly branch of pkgsrc, you may
1352: need to adjust the repository in
1353: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1354: </div>
1355: <div class="sect2">
1356: <div class="titlepage"><div><div><h3 class="title">
1357: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.82 rillig 1358: <p>To deinstall a package, it does not matter whether it was
1.317 nia 1359: installed from source code or from a binary package. Neither the
1360: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1361: command need to know.</p>
1362: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.88 wiz 1363: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.317 nia 1364: name can be given with or without version number.</p>
1.82 rillig 1365: </div>
1.148 asau 1366: <div class="sect2">
1.82 rillig 1367: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1368: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1369: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.317 nia 1370: installed packages or binary package files.
1371: As with other management tools, it works with packages installed
1372: from source or binaries.</p>
1.82 rillig 1373: </div>
1.148 asau 1374: <div class="sect2">
1.82 rillig 1375: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1376: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82 rillig 1377: <p>
1.279 leot 1378: The pkgsrc Security Team and Packages Groups maintain a list of
1.317 nia 1379: known vulnerabilities to packages which are (or have been)
1.88 wiz 1380: included in pkgsrc. The list is available from the NetBSD
1.317 nia 1381: CDN at <a class="ulink" href="https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
1382: </p>
1383: <p>
1384: Please note that not every "vulnerability" with a CVE assignment is
1385: exploitable in every configuration.
1386: Some bugs are marked as active simply because an fix was not
1387: marked as such.
1388: Operating system specific hardening and mitigation features may also
1389: reduce the impact of bugs.
1.88 wiz 1390: </p>
1.82 rillig 1391: <p>
1.125 wiz 1392: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1393: this list can be downloaded
1394: automatically, and a security audit of all packages installed on a system
1395: can take place.
1396: </p>
1.82 rillig 1397: <p>
1.125 wiz 1398: There are two components to auditing. The first
1399: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1400: is for downloading
1.88 wiz 1401: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1402: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1403: installed packages are vulnerable. If a package is vulnerable, you
1404: will see output similar to the following:
1405: </p>
1.82 rillig 1406: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289 leot 1407: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1408: <p>
1.125 wiz 1409: You may wish to have the
1.317 nia 1410: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1411: file downloaded daily so that
1412: it remains current. This may be done by adding an appropriate entry
1.378 ! leot 1413: to the root users <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.125 wiz 1414: </p>
1415: <pre class="screen">
1.233 sevan 1416: # Download vulnerabilities file
1.230 sevan 1417: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.233 sevan 1418: # Audit the installed packages and email results to root
1419: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1420: root >/dev/null 2>&1
1.125 wiz 1421: </pre>
1422: <p>
1.230 sevan 1423: will update the vulnerability list every day at 3AM, followed by an audit
1424: at 3:09AM. The result of the audit are then emailed to root.
1.125 wiz 1425:
1.230 sevan 1426: On NetBSD this may be accomplished instead by adding the following
1427: line to <code class="filename">/etc/daily.conf</code>:
1428: </p>
1429: <pre class="screen">
1430: fetch_pkg_vulnerabilities=YES
1431: </pre>
1432: <p>
1433: to fetch the vulnerability list from the daily security script. The system
1434: is set to audit the packages by default but can be set explicitly, if
1.235 yyamano 1435: desired (not required), by adding the following line to
1.230 sevan 1436: <code class="filename">/etc/security.conf</code>:
1.125 wiz 1437: </p>
1438: <pre class="screen">
1.230 sevan 1439: check_pkg_vulnerabilities=YES
1.125 wiz 1440: </pre>
1441: <p>
1.378 ! leot 1442: see <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88 wiz 1443: </p>
1.82 rillig 1444: </div>
1.148 asau 1445: <div class="sect2">
1.82 rillig 1446: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1447: <a name="pkg_versions"></a>5.1.7. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.82 rillig 1448: <p>
1.322 leot 1449: Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128 wiz 1450: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.317 nia 1451: argument to check if any packages are stale, e.g.
1.88 wiz 1452: </p>
1453: <pre class="screen">
1454: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1455: ...
1.88 wiz 1456: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1457: </pre>
1.82 rillig 1458: </div>
1.148 asau 1459: <div class="sect2">
1.82 rillig 1460: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1461: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.110 hubertf 1462: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1463: administrative functions on the package system.</p>
1.82 rillig 1464: </div>
1.75 rillig 1465: </div>
1.148 asau 1466: <div class="sect1">
1.75 rillig 1467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1468: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88 wiz 1469: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1470: directory now contains a set of packages, organized into
1471: categories. You can browse the online index of packages, or run
1.110 hubertf 1472: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1473: directory to build local <code class="filename">README.html</code> files for
1.322 leot 1474: all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/index.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88 wiz 1475: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1476: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1477: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1478: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1479: different <code class="varname">LOCALBASE</code> definitions on the same
1480: system (inside a chroot is an exception). </p>
1481: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1482: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.88 wiz 1483: instructions how to create your own packages.</p>
1.148 asau 1484: <div class="sect2">
1.75 rillig 1485: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1486: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82 rillig 1487: <p>To build packages from source, you need a working C
1.88 wiz 1488: compiler. On NetBSD, you need to install the
1.128 wiz 1489: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1490: sets. If you want to build X11-related packages, the
1.128 wiz 1491: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1492: sets are required, too.</p>
1.75 rillig 1493: </div>
1.148 asau 1494: <div class="sect2">
1.75 rillig 1495: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1496: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75 rillig 1497: <p>The first step for building a package is downloading the
1.88 wiz 1498: distfiles (i.e. the unmodified source). If they have not yet been
1499: downloaded, pkgsrc will fetch them automatically.</p>
1500: <p>If you have all files that you need in the
1501: <code class="filename">distfiles</code> directory,
1502: you don't need to connect. If the distfiles are on CD-ROM, you can
1503: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1504: </p>
1.82 rillig 1505: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1506: <p>
1.110 hubertf 1507: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1508: <p>By default a list of distribution sites will be randomly
1509: intermixed to prevent huge load on servers which holding popular
1510: packages (for example, SourceForge.net mirrors). Thus, every
1511: time when you need to fetch yet another distfile all the mirrors
1512: will be tried in new (random) order. You can turn this feature
1513: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1514: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1515: <p>You can overwrite some of the major distribution sites to
1516: fit to sites that are close to your own. By setting one or two
1517: variables you can modify the order in which the master sites are
1518: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1519: delimited list of domain suffixes.
1520: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1521: contains a whitespace delimited list of regular expressions. It
1522: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1523: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1524: some examples. This may save some of your bandwidth and
1525: time.</p>
1.75 rillig 1526: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1527: if you want to keep the settings, by editing the
1.110 hubertf 1528: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1529: and adding the definitions there.</p>
1.82 rillig 1530: <p>
1.88 wiz 1531: If a package depends on many other packages (such as
1.322 leot 1532: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.88 wiz 1533: alternate between periods of
1534: downloading source, and compiling. To ensure you have all the source
1535: downloaded initially you can run the command:
1536: </p>
1.82 rillig 1537: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1538: <p>
1.88 wiz 1539: which will output and run a set of shell commands to fetch the
1540: necessary files into the <code class="filename">distfiles</code> directory. You can
1541: also choose to download the files manually.
1542: </p>
1.75 rillig 1543: </div>
1.148 asau 1544: <div class="sect2">
1.75 rillig 1545: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1546: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1547: <p>
1.88 wiz 1548: Once the software has downloaded, any patches will be applied, then it
1549: will be compiled for you. This may take some time depending on your
1550: computer, and how many other packages the software depends on and their
1551: compile time.
1552: </p>
1.148 asau 1553: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1554: <h3 class="title">Note</h3>
1555: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1556: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1557: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1558: </div>
1.87 wiz 1559: <p>For example, type</p>
1.88 wiz 1560: <pre class="screen">
1561: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1562: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1563: </pre>
1.75 rillig 1564: <p>at the shell prompt to build the various components of the
1.88 wiz 1565: package.</p>
1.82 rillig 1566: <p>The next stage is to actually install the newly compiled
1.88 wiz 1567: program onto your system. Do this by entering:
1.82 rillig 1568:
1.88 wiz 1569: </p>
1.82 rillig 1570: <pre class="screen">
1.88 wiz 1571: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1572: </pre>
1.82 rillig 1573: <p>
1574:
1.88 wiz 1575: while you are still in the directory for whatever package you
1576: are installing.</p>
1.82 rillig 1577: <p>Installing the package on your system may require you to
1.88 wiz 1578: be root. However, pkgsrc has a
1579: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1580: to only become root for the actual installation step.</p>
1.82 rillig 1581: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1582: You can now enter:
1.82 rillig 1583:
1.88 wiz 1584: </p>
1.82 rillig 1585: <pre class="screen">
1.88 wiz 1586: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1587: </pre>
1.82 rillig 1588: <p>
1589:
1.88 wiz 1590: to remove the compiled files in the work directory, as you shouldn't need
1591: them any more. If other packages were also added to your system
1592: (dependencies) to allow your program to compile, you can tidy these up
1593: also with the command:</p>
1.82 rillig 1594: <pre class="screen">
1.88 wiz 1595: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1596: </pre>
1.75 rillig 1597: <p>Taking the figlet utility as an example, we can install it on our
1.322 leot 1598: system by building as shown in <a class="xref" href="#logs" title="Appendix C. Build logs">Appendix C, <i>Build logs</i></a>.</p>
1.88 wiz 1599: <p>The program is installed under the default root of the
1600: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1601: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1602: variable in your environment, and it will use that value as the
1603: root of your packages tree. So, to use
1604: <code class="filename">/usr/local</code>, set
1605: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1606: Please note that you should use a directory which is dedicated to
1607: packages and not shared with other programs (i.e., do not try and
1608: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1609: to add any of your own files or directories (such as
1610: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1611: <code class="filename">pkgsrc/</code>) below the
1612: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1613: conflicts between programs and other files installed by the
1614: package system and whatever else may have been installed
1615: there.</p>
1.110 hubertf 1616: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1617: alter some configuration options at build time. Have a look at
1618: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1619: of what will be set there by default. Environment variables such
1620: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1621: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1622: set them each time you want to use pkgsrc.</p>
1.128 wiz 1623: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1624: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 1625: or being installed. This may be for debugging purposes, or out of
1626: simple curiosity. A number of utility values have been added to
1627: help with this.</p>
1.128 wiz 1628: <div class="orderedlist"><ol class="orderedlist" type="1">
1629: <li class="listitem">
1.378 ! leot 1630: <p>If you invoke the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88 wiz 1631: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1632: information will be displayed. For example,</p>
1.75 rillig 1633: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1634: <p>will show all the commands that are invoked, up to and
1.128 wiz 1635: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1636: </li>
1.128 wiz 1637: <li class="listitem">
1.378 ! leot 1638: <p>If you want to know the value of a certain <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1639: definition, then the <code class="varname">VARNAME</code> definition
1640: should be used, in conjunction with the show-var
1.378 ! leot 1641: target. e.g. to show the expansion of the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1642: variable <code class="varname">LOCALBASE</code>:</p>
1643: <pre class="screen">
1644: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 1645: /usr/pkg
1646: <code class="prompt">%</code>
1.88 wiz 1647: </pre>
1.75 rillig 1648: </li>
1649: </ol></div>
1650: <p>If you want to install a binary package that you've either
1.88 wiz 1651: created yourself (see next section), that you put into
1652: pkgsrc/packages manually or that is located on a remote FTP
1653: server, you can use the "bin-install" target. This target will
1.378 ! leot 1654: install a binary package - if available - via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110 hubertf 1655: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1656: sites searched is kept in the variable
1657: <code class="varname">BINPKG_SITES</code>, which defaults to
1.378 ! leot 1658: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88 wiz 1659: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1660: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1661: details.</p>
1662: <p>A final word of warning: If you set up a system that has a
1663: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1664: set that before any packages are installed, as you cannot use
1665: several directories for the same purpose. Doing so will result in
1666: pkgsrc not being able to properly detect your installed packages,
1667: and fail miserably. Note also that precompiled binary packages are
1668: usually built with the default <code class="varname">LOCALBASE</code> of
1669: <code class="filename">/usr/pkg</code>, and that you should
1670: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1671: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 1672: </div>
1673: </div>
1674: </div>
1.148 asau 1675: <div class="chapter">
1.75 rillig 1676: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1677: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75 rillig 1678: <div class="toc">
1679: <p><b>Table of Contents</b></p>
1.210 leot 1680: <dl class="toc">
1.267 rillig 1681: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1682: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.355 rillig 1683: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
1684: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
1685: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
1686: <dd><dl>
1687: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
1688: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1689: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 1690: </dl></dd>
1.355 rillig 1691: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
1692: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.75 rillig 1693: </dl>
1694: </div>
1.104 rillig 1695: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 1696: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1697: that file depends on the installation. On NetBSD, when you use
1.378 ! leot 1698: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 1699: <code class="filename">/etc/</code>. In all other cases the default location is
1700: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1701: bootstrap program to install the binary packages.</p>
1702: <p>The format of the configuration file is that of the usual
1703: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1704: is done by setting variables in this file. Note that you can define all
1705: kinds of variables, and no special error checking (for example for
1.223 rillig 1706: spelling mistakes) takes place.</p>
1.148 asau 1707: <div class="sect1">
1.75 rillig 1708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1709: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223 rillig 1710: <p>The following variables apply to all
1.89 rillig 1711: pkgsrc packages. A complete list of the variables that can be
1712: configured by the user is available in
1713: <code class="filename">mk/defaults/mk.conf</code>, together with some
1714: comments that describe each variable's intent.</p>
1.148 asau 1715: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1716: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 1717: packages will be installed. The default is
1.76 rillig 1718: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 1719: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 1720: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1721: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 1722: installed. The default is
1.76 rillig 1723: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 1724: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 1725: X11 is installed on the system. The default is
1.194 bsiegert 1726: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 1727: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 1728: downloaded copies of the original source distributions used
1729: for building pkgsrc packages. The default is
1.76 rillig 1730: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 1731: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 1732: database about installed packages is stored. The default is
1.230 sevan 1733: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128 wiz 1734: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 1735: If set, override the packages'
1736: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 1737: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 1738: Backup location(s) for distribution files and patch files
1739: if not found locally or in
1.76 rillig 1740: <code class="filename">${MASTER_SITES}</code> or
1741: <code class="filename">${PATCH_SITES}</code> respectively.
1.230 sevan 1742: The defaults is
1743: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 1744: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 1745: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1746: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 1747: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1748: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1749: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 1750: List of acceptable licenses. License names are case-sensitive.
1751: Whenever you try to build a package whose license is not in this
1752: list, you will get an error message. If the license condition is
1753: simple enough, the error message will include specific
1754: instructions on how to change this variable.</p></li>
1.75 rillig 1755: </ul></div>
1756: </div>
1.148 asau 1757: <div class="sect1">
1.75 rillig 1758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1759: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219 rillig 1760: <p>
1.75 rillig 1761: </p>
1.148 asau 1762: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1763: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 1764: directory for the binary packages. The default is
1.76 rillig 1765: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 1766: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 1767: The top level directory where, if defined, the separate
1768: working directories will get created, and symbolically
1.76 rillig 1769: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 1770: This is useful for building packages on several
1.76 rillig 1771: architectures, then <code class="filename">${PKGSRCDIR}</code>
1772: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 1773: is local to every architecture. (It should be noted that
1774: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 1775: — it is an internal definition which refers to the
1.75 rillig 1776: root of the pkgsrc tree. It is possible to have many
1777: pkgsrc tree instances.)</p></li>
1.128 wiz 1778: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 1779: Directory for local patches that aren't part of pkgsrc.
1.299 rillig 1780: See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> for more
1.93 rillig 1781: information.</p></li>
1.128 wiz 1782: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 1783: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 1784: BSD-style Makefile. If this is not set,
1785: <code class="varname">MAKECONF</code> is set to
1.76 rillig 1786: <code class="filename">/dev/null</code> to avoid picking up
1787: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75 rillig 1788: </ul></div>
1789: </div>
1.148 asau 1790: <div class="sect1">
1.75 rillig 1791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.355 rillig 1792: <a name="native-or-pkgsrc-preference"></a>6.3. Preferences for native or pkgsrc software</h2></div></div></div>
1793: <p>Whenever a package depends on a package that has a
1794: <code class="filename">builtin.mk</code> file, the dependent package can
1795: either use the built-in (native) version from the base system or the
1796: pkgsrc-provided version. This only affects dependencies, so it is
1797: still possible to build the pkgsrc package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pcre++/index.html" target="_top"><code class="filename">devel/pcre++</code></a> even when other packages depend
1798: on the native pcre++ version instead.</p>
1799: <p>To force using the pkgsrc-provided version for a particular
1800: package, define <span class="quote">“<span class="quote"><code class="varname">PREFER_PKGSRC</code> =
1801: <em class="replaceable"><code>package-ID</code></em></span>”</span> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. To force
1802: using the native package, define
1803: <span class="quote">“<span class="quote"><code class="varname">PREFER_NATIVE</code> =
1804: <em class="replaceable"><code>package-ID</code></em></span>”</span>. In both cases, the
1805: <em class="replaceable"><code>package-ID</code></em> is the one from the
1806: <code class="filename">buildlink3.mk</code> of the package. In most cases,
1807: this ID is the same as the directory name of the package, but for
1808: example, <code class="filename">devel/pcre++</code> has the
1809: package ID <span class="quote">“<span class="quote">pcrexx</span>”</span>.</p>
1810: <p>For the packages that are not listed by their package ID,
1811: pkgsrc uses the pkgsrc-provided version if
1812: <code class="varname">PREFER_PKGSRC</code> contains the word
1813: <span class="quote">“<span class="quote">yes</span>”</span>. Otherwise, if <code class="varname">PREFER_NATIVE</code>
1814: contains the word <span class="quote">“<span class="quote">yes</span>”</span>, pkgsrc uses the native
1815: version. For example, to require using the pkgsrc-provided versions
1816: for all but the most basic bits on a NetBSD system, you can
1817: set:</p>
1818: <pre class="programlisting">
1819: PREFER_PKGSRC= yes
1820: PREFER_NATIVE= getopt skey tcp_wrappers
1821: </pre>
1822: <p>A package <span class="emphasis"><em>must</em></span> have a
1823: <code class="filename">builtin.mk</code> file to be listed in
1824: <code class="varname">PREFER_NATIVE</code>, otherwise it is simply ignored in
1825: that list.</p>
1826: <p><code class="varname">PREFER_PKGSRC</code> and
1827: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap to
1828: ensure that the bootstrap process does not use inapropriate native
1829: tools as dependencies for core packages.</p>
1830: <pre class="screen">
1831: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
1832: </pre>
1833: <p>Switching between settings globally at a later date can
1834: introduce complications with dependency resolution. This is caused
1835: by packages built with the opposite preference being installed
1836: alongside each other. Hence, when changing any of these variables
1837: after bootstrap, you need to rebuild all packages depending on those
1838: whose preference has been changed. This is not trivial and should
1839: be avoided.</p>
1840: <p>When using pkgsrc on Linux systems, there is high risk of
1841: <span class="quote">“<span class="quote">leakage</span>”</span>, where programs installed by pkgsrc may
1842: inadvertently use a command or library not installed by pkgsrc, e.g.
1843: those installed by yum or apt. Such foreign dependencies may be
1844: installed, removed, or upgraded to a version incompatible with the
1845: pkgsrc package at any time, causing pkgsrc packages to subsequently
1846: malfunction. Pkgsrc cannot prevent this, as it has no control over
1847: other package managers. Another potential problem is that under
1848: Redhat Enterprise and related Linux systems, yum packages are only
1849: patched and never upgraded, so eventually they may become too
1850: outdated for use by pkgsrc. Even intentionally using foreign
1851: dependencies, not considered leakage, can lead to these problems, so
1852: it is generally discouraged. In order to minimize such problems,
1853: PREFER_PKGSRC defaults to <span class="quote">“<span class="quote">yes</span>”</span> on Linux systems. This ensures that
1854: pkgsrc is aware of any changes to dependency packages and can
1855: rebuild or upgrade the entire dependency tree as needed. This
1856: default can be overridden by setting --prefer-pkgsrc to a
1857: list of packages and --prefer-native to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1858: </div>
1859: <div class="sect1">
1860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1861: <a name="variables-affecting-installation"></a>6.4. Variables affecting the installation process</h2></div></div></div>
1.312 gdt 1862: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
1.256 maya 1863: By default, binary packages of built packages are
1.263 leot 1864: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256 maya 1865: this variable to "no" prevents this.</p></li></ul></div>
1.217 jnemeth 1866: <p>Packages have to support installation into a
1.103 wiz 1867: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1868: to be built, before the actual filesystem is touched. DESTDIR
1869: support exists in two variations:</p>
1.148 asau 1870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1871: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 1872: installation and packaging is still run as root.</p></li>
1873: <li class="listitem"><p>Full DESTDIR support can run the complete
1874: build, installation and packaging as normal user. Root
1875: privileges are only needed to add packages.</p></li>
1876: </ul></div>
1.103 wiz 1877: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1878: clean</code></strong> needs to be run as root.</p>
1.118 imil 1879: <p>Considering the <code class="filename">foo/bar</code> package,
1880: DESTDIR full support can be tested using the following commands
1881:
1882: </p>
1883: <pre class="programlisting">
1884: <code class="prompt">$</code> id
1885: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1886: <code class="prompt">$</code> mkdir $HOME/packages
1887: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1888: </pre>
1889: <p>
1890:
1891: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1892: should be needed
1893:
1894: </p>
1895: <pre class="programlisting">
1.174 asau 1896: <code class="prompt">$</code> make stage-install
1.118 imil 1897: </pre>
1898: <p>
1899:
1900: Create a package without root privileges
1901:
1902: </p>
1903: <pre class="programlisting">
1.174 asau 1904: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 1905: </pre>
1906: <p>
1907:
1908: For the following command, you must be able to gain root
1.378 ! leot 1909: privileges using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118 imil 1910:
1911: </p>
1912: <pre class="programlisting">
1.174 asau 1913: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 1914: </pre>
1915: <p>
1916:
1917: Then, as a simple user
1918:
1919: </p>
1920: <pre class="programlisting">
1921: <code class="prompt">$</code> make clean
1922: </pre>
1923: <p>
1924:
1925: </p>
1.103 wiz 1926: </div>
1.148 asau 1927: <div class="sect1">
1.103 wiz 1928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.355 rillig 1929: <a name="conf.compiler"></a>6.5. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 1930: <div class="sect2">
1.78 rillig 1931: <div class="titlepage"><div><div><h3 class="title">
1.355 rillig 1932: <a name="selecting-the-compiler"></a>6.5.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 1933: <p>By default, pkgsrc will use GCC to build packages. This may be
1934: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 1935: <div class="variablelist"><dl class="variablelist">
1.89 rillig 1936: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1937: <dd>
1938: <p>This is a list of values specifying the chain of
1939: compilers to invoke when building packages. Valid values
1940: are:</p>
1.148 asau 1941: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 1942: <li class="listitem"><p><code class="varname">ccc</code>:
1943: Compaq C Compilers (Tru64)</p></li>
1944: <li class="listitem"><p><code class="varname">ccache</code>:
1945: compiler cache (chainable)</p></li>
1946: <li class="listitem"><p><code class="varname">clang</code>:
1947: Clang C and Objective-C compiler</p></li>
1.128 wiz 1948: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 1949: distributed C/C++ (chainable)</p></li>
1.174 asau 1950: <li class="listitem"><p><code class="varname">f2c</code>:
1951: Fortran 77 to C compiler (chainable)</p></li>
1952: <li class="listitem"><p><code class="varname">icc</code>:
1953: Intel C++ Compiler (Linux)</p></li>
1954: <li class="listitem"><p><code class="varname">ido</code>:
1955: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 1956: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 1957: GNU C/C++ Compiler</p></li>
1.174 asau 1958: <li class="listitem"><p><code class="varname">hp</code>:
1959: HP-UX C/aC++ compilers</p></li>
1.128 wiz 1960: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 1961: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 1962: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 1963: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 1964: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 1965: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 1966: <li class="listitem"><p><code class="varname">xlc</code>:
1.230 sevan 1967: IBM's XL C/C++ compiler suite</p></li>
1.89 rillig 1968: </ul></div>
1969: <p>The default is
1.128 wiz 1970: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 1971: <code class="varname">ccache</code> and/or
1972: <code class="varname">distcc</code> with an appropriate
1973: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 1974: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 1975: variable should always be terminated with a value for
1976: a real compiler. Note that only one real compiler
1.128 wiz 1977: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 1978: is not allowed).</p>
1.89 rillig 1979: </dd>
1980: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1981: <dd><p>This specifies the minimum version of GCC to use
1982: when building packages. If the system GCC doesn't
1983: satisfy this requirement, then pkgsrc will build and
1984: install one of the GCC packages to use instead.</p></dd>
1.266 leot 1985: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225 maya 1986: <dd><p>Specifies which version of python to use when several
1987: options are available.</p></dd>
1988: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291 gutterid 1989: <dd><p>Specifies the Fortran compiler to use.
1990: The default is <code class="varname">gfortran</code>.</p></dd>
1.225 maya 1991: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1992: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1993: <code class="varname">gfortran</code> is used, this option specifies which
1994: version to use.</p></dd>
1.89 rillig 1995: </dl></div>
1996: </div>
1.148 asau 1997: <div class="sect2">
1.89 rillig 1998: <div class="titlepage"><div><div><h3 class="title">
1.355 rillig 1999: <a name="conf.cflags"></a>6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78 rillig 2000: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2001: please make sure to use the <code class="literal">+=</code> operator
2002: instead of the <code class="literal">=</code> operator:</p>
2003: <pre class="programlisting">
1.100 rillig 2004: CFLAGS+= -your -flags
1.78 rillig 2005: </pre>
2006: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 2007: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 2008: need to add their own flags. You may want to take a look
1.322 leot 2009: at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128 wiz 2010: package if you're interested in optimization specifically
2011: for the current CPU. </p>
1.78 rillig 2012: </div>
1.148 asau 2013: <div class="sect2">
1.88 wiz 2014: <div class="titlepage"><div><div><h3 class="title">
1.355 rillig 2015: <a name="conf.ldflags"></a>6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88 wiz 2016: <p>If you want to pass flags to the linker, both in the configure
2017: step and the build step, you can do this in two ways. Either set
2018: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2019: between the two is that <code class="varname">LIBS</code> will be appended to
2020: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2021: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2022: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2023: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2024: <code class="varname">CFLAGS</code>, if you do not wish to override these
2025: settings, use the <code class="literal">+=</code> operator:</p>
2026: <pre class="programlisting">
1.100 rillig 2027: LDFLAGS+= -your -linkerflags
1.88 wiz 2028: </pre>
2029: </div>
1.78 rillig 2030: </div>
1.148 asau 2031: <div class="sect1">
1.78 rillig 2032: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.355 rillig 2033: <a name="developer-advanced-settings"></a>6.6. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 2034: <p>
1.75 rillig 2035: </p>
1.148 asau 2036: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2037: <li class="listitem">
1.75 rillig 2038: <p><code class="varname">PKG_DEVELOPER</code>:
1.347 gutterid 2039: Run some sanity checks that package developers want:
2040: </p>
1.148 asau 2041: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2042: <li class="listitem"><p>make sure patches apply with zero
1.347 gutterid 2043: fuzz</p></li>
1.128 wiz 2044: <li class="listitem"><p>run check-shlibs to see that all
1.347 gutterid 2045: binaries will find their shared libs.</p></li>
1.75 rillig 2046: </ul></div>
2047: </li>
1.347 gutterid 2048: <li class="listitem"><p><code class="varname">CHECK_FILES_STRICT</code>:
2049: Also check <code class="varname">VARBASE</code> and <code class="varname">PKG_SYSCONFDIR
2050: </code> values in PLIST entries.
2051: </p></li>
1.128 wiz 2052: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.347 gutterid 2053: of debugging output which is displayed whilst making and
2054: installing the package. The default value for this is 0,
2055: which will not display the commands as they are executed
2056: (normal, default, quiet operation); the value 1 will display
2057: all shell commands before their invocation, and the value 2
2058: will display both the shell commands before their invocation,
2059: as well as their actual execution progress with <span class="command"><strong>set
2060: -x</strong></span>.</p></li>
1.75 rillig 2061: </ul></div>
2062: <p>
2063: </p>
2064: </div>
1.148 asau 2065: <div class="sect1">
1.75 rillig 2066: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.355 rillig 2067: <a name="selecting-build-options"></a>6.7. Selecting Build Options</h2></div></div></div>
1.88 wiz 2068: <p>Some packages have build time options, usually to select
2069: between different dependencies, enable optional support for big
2070: dependencies or enable experimental features.</p>
1.75 rillig 2071: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2072: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2073: show-options</strong></span>, for example:</p>
1.75 rillig 2074: <pre class="programlisting">
2075: The following options are supported by this package:
2076: ssl Enable SSL support.
2077: Exactly one of the following gecko options is required:
2078: firefox Use firefox as gecko rendering engine.
2079: mozilla Use mozilla as gecko rendering engine.
2080: At most one of the following database options may be selected:
2081: mysql Enable support for MySQL database.
2082: pgsql Enable support for PostgreSQL database.
1.1 grant 2083:
1.75 rillig 2084: These options are enabled by default: firefox
2085: These options are currently enabled: mozilla ssl
1.1 grant 2086: </pre>
1.75 rillig 2087: <p>The following variables can be defined in
1.110 hubertf 2088: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2089: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2090: which can be used to select or disable options for all packages
2091: that support them, and
2092: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2093: which can be used to select or disable options specifically for
2094: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2095: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2096: are disabled. A few examples:</p>
1.75 rillig 2097: <pre class="screen">
1.110 hubertf 2098: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75 rillig 2099: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2100: PKG_OPTIONS.kdebase= debug -sasl
2101: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2102: <p>It is important to note that options that were specifically
1.120 snj 2103: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2104: you do not wish to include the option. If you are unsure you can view
2105: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2106: <p>The following settings are consulted in the order given, and
2107: the last setting that selects or disables an option is
2108: used:</p>
1.128 wiz 2109: <div class="orderedlist"><ol class="orderedlist" type="1">
2110: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2111: maintainer</p></li>
1.128 wiz 2112: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2113: variables (see below)</p></li>
1.128 wiz 2114: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2115: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2116: </ol></div>
2117: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2118: selected is used, all others are automatically disabled. If an
2119: option of the group is explicitly disabled, the previously
2120: selected option, if any, is used. It is an error if no option
2121: from a required group of options is selected, and building the
2122: package will fail.</p>
2123: <p>Before the options framework was introduced, build options
2124: were selected by setting a variable (often named
2125: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2126: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2127: transition to the options framework for the user, these legacy
2128: variables are converted to the appropriate options setting
2129: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2130: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2131: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2132: directly. Support for the legacy variables will be removed
2133: eventually.</p>
1.75 rillig 2134: </div>
2135: </div>
1.148 asau 2136: <div class="chapter">
1.75 rillig 2137: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2138: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75 rillig 2139: <div class="toc">
2140: <p><b>Table of Contents</b></p>
1.210 leot 2141: <dl class="toc">
1.267 rillig 2142: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2143: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.75 rillig 2144: </dl>
2145: </div>
1.148 asau 2146: <div class="sect1">
1.75 rillig 2147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2148: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2149: <p>Once you have built and installed a package, you can create
2150: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.378 ! leot 2151: another system with <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87 wiz 2152: the same package on a group of hosts and wasting CPU time. It also
2153: provides a simple means for others to install your package, should
2154: you distribute it.</p>
2155: <p>To create a binary package, change into the appropriate
1.110 hubertf 2156: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2157: package</strong></span>:</p>
2158: <pre class="screen">
1.223 rillig 2159: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2160: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2161: </pre>
1.356 gutterid 2162: <p>This will build your package (if not already done) and package
2163: it into a binary package. You can then use the
2164: <span class="command"><strong>pkg_*</strong></span> tools to manipulate it. Binary packages are
2165: created in <code class="varname">PACKAGES</code>, which defaults to
2166: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a compressed
2167: tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a continuation of
2168: the above <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/index.html" target="_top"><code class="filename">misc/figlet</code></a>
2169: example.</p>
1.267 rillig 2170: <p>See <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a> for information on how to submit
1.87 wiz 2171: such a binary package.</p>
1.75 rillig 2172: </div>
1.148 asau 2173: <div class="sect1">
1.75 rillig 2174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2175: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.299 rillig 2176: <p>See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a>.</p>
1.106 rillig 2177: </div>
2178: </div>
1.148 asau 2179: <div class="chapter">
1.106 rillig 2180: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2181: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 2182: builds)</h2></div></div></div>
2183: <div class="toc">
2184: <p><b>Table of Contents</b></p>
1.210 leot 2185: <dl class="toc">
1.267 rillig 2186: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 2187: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 2188: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2189: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 2190: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2191: <dd><dl>
1.294 rillig 2192: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2193: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296 rillig 2194: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
2195: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
2196: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
2197: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
2198: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
2199: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
2200: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
2201: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 2202: </dl></dd>
2203: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2204: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2205: </dl>
2206: </div>
1.290 gutterid 2207: <p>For a number of reasons, you may want to build binary packages
2208: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180 wiz 2209: For instance, when you have multiple machines that should run the same software,
2210: it is wasted time if they all build their packages themselves from source.
2211: Or you may want to build a list of packages you want and check them before
1.290 gutterid 2212: deploying onto production systems.
1.180 wiz 2213: There is a way of getting a set of binary packages:
1.290 gutterid 2214: the bulk build system, or pbulk ("p" stands for "parallel").
1.223 rillig 2215: This chapter describes how to set it up.</p>
1.148 asau 2216: <div class="sect1">
1.106 rillig 2217: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2218: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180 wiz 2219: <p>First of all, you have to decide whether you build all packages
2220: or a limited set of them. Full bulk builds usually consume a lot more resources,
2221: both space and time, than builds for some practical sets of packages.
1.290 gutterid 2222: A number of particularly heavy packages exist that are not actually
2223: interesting to a wide audience. (The approximate resource consumption for a
2224: full bulk build is given in section <a class="xref" href="#bulk.req" title="8.3. Requirements of a full bulk build">Section 8.3, “Requirements of a full bulk build”</a>.)
2225: For limited bulk builds you need to make a list of packages you want to build.
1.223 rillig 2226: Note that all their dependencies will be built, so you don't need to track them manually.
1.180 wiz 2227: </p>
2228: <p>During bulk builds various packages are installed and deinstalled
2229: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2230: so make sure that you don't need any package during the builds.
1.223 rillig 2231: Essentially, you should provide a fresh system, either a chroot environment
1.180 wiz 2232: or something even more restrictive, depending on what the operating system provides,
2233: or dedicate the whole physical machine.
2234: As a useful side effect this makes sure that bulk builds cannot
2235: break anything in your system. There have been numerous cases where
1.106 rillig 2236: certain packages tried to install files outside the
2237: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2238: <code class="filename">/etc</code>.
2239: </p>
1.106 rillig 2240: </div>
1.148 asau 2241: <div class="sect1">
1.106 rillig 2242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.295 rillig 2243: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
2244: <p>Running a bulk build works roughly as follows:</p>
1.148 asau 2245: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2246: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2247: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2248: </ul></div>
1.148 asau 2249: <div class="sect2">
1.116 rillig 2250: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 2251: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223 rillig 2252: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178 asau 2253: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2254: Configure network access to fetch distribution files.
1.223 rillig 2255: Create a user with name "pbulk".</p>
1.178 asau 2256: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2257: <pre class="screen">
1.264 sevan 2258: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && ftp -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
2259: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
1.181 wiz 2260: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.178 asau 2261: </pre>
2262: <p>Or any other way that fits (e.g., curl, wget).</p>
2263: <p>Deploy and configure pbulk tools, e.g.:</p>
2264: <pre class="screen">
1.230 sevan 2265: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.178 asau 2266: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment</code></strong>
2267: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2268: </pre>
2269: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2270: <h3 class="title">Note</h3>
2271: <p><code class="filename">mk.conf.frag</code> is a fragment of
2272: <code class="filename">mk.conf</code> that contains settings you want to
2273: apply to packages you build. For instance,</p>
2274: <pre class="programlisting">
1.223 rillig 2275: PKG_DEVELOPER= yes # perform more checks
2276: X11_TYPE= modular # use pkgsrc X11
2277: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2278: # when building all packages)
1.178 asau 2279: </pre>
2280: </div>
2281: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223 rillig 2282: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178 asau 2283: <pre class="programlisting">
2284: www/firefox
2285: mail/thunderbird
2286: misc/libreoffice4
2287: </pre>
1.179 asau 2288: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2289: and make final amendments, if wanted.</p>
1.178 asau 2290: <p>Start it:</p>
2291: <pre class="screen">
2292: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2293: </pre>
2294: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2295: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2296: </p>
2297: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2298: <h3 class="title">Note</h3>
2299: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2300: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2301: The script is kept small enough for better understanding.</p>
2302: </div>
2303: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2304: <h3 class="title">Note</h3>
2305: <p>The <code class="filename">pbulk.sh</code> script supports running
1.320 wiz 2306: unprivileged bulk build and helps configuring distributed bulk builds.
2307: Distributed bulk builds support either building in worker chroots
2308: (each node is a path to a different chroot)
2309: that replicate the target system, including the pbulk prefix,
2310: or remote machines (each node is
2311: an IP address that must be accessible over SSH without a password).</p>
1.178 asau 2312: </div>
1.106 rillig 2313: </div>
2314: </div>
1.148 asau 2315: <div class="sect1">
1.106 rillig 2316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2317: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180 wiz 2318: <p>A complete bulk build requires lots of disk space. Some of the
2319: disk space can be read-only, some other must be writable. Some can be on
2320: remote filesystems (such as NFS) and some should be local. Some can be
2321: temporary filesystems, others must survive a sudden reboot.</p>
2322: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.320 wiz 2323: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2324: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.180 wiz 2325: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2326: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2327: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2328: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2329: </ul></div>
2330: </div>
2331: <div class="sect1">
2332: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.293 rillig 2333: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2334: <p>To ensure that pkgsrc packages work in different configurations, it
2335: makes sense to run non-default bulk builds from time to time. This
2336: section lists some ideas for bulk builds that intentionally let packages
2337: fail if they don't follow the pkgsrc style.</p>
2338: <div class="sect2">
2339: <div class="titlepage"><div><div><h3 class="title">
1.294 rillig 2340: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.293 rillig 2341: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2342: <pre class="programlisting">
2343: GNU_CONFIGURE_STRICT= yes
2344: </pre>
2345: <p>When a package fails this additional check, the most common cause
2346: is that the configure option was valid for an older version of the
2347: package but does not apply anymore. In that case, just remove it.</p>
2348: </div>
2349: <div class="sect2">
2350: <div class="titlepage"><div><div><h3 class="title">
1.294 rillig 2351: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293 rillig 2352: <p>The job of a compiler is not restricted to producing executable
1.294 rillig 2353: code, most compilers also detect typical programming mistakes. The pkgsrc
2354: compiler wrappers make it easy to force compiler options when the package
2355: is built. This can be used to find typical bugs across all packages that
2356: are in pkgsrc. By reporting these bugs upstream, the packages will be
2357: more reliable with the next updates.</p>
2358: <p>Add some of the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.293 rillig 2359: <pre class="programlisting">
2360: CFLAGS+= -Werror=char-subscripts
1.294 rillig 2361: CFLAGS+= -Werror=implicit-function-declaration
1.293 rillig 2362: </pre>
1.294 rillig 2363: <p>When a package fails to build using these stricter compiler
2364: options, document the circumstances in which the compiler produced the
2365: error message. This includes:</p>
1.293 rillig 2366: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2367: <li class="listitem"><p>The platform
2368: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2369: <li class="listitem"><p>The source file</p></li>
2370: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2371: part of the diagnostic.</p></li>
1.294 rillig 2372: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293 rillig 2373: </ul></div>
2374: <p>If a package produces these error messages, but the package is
1.294 rillig 2375: fine, record this in your local <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, like this, to skip this check
2376: in the next builds:</p>
1.293 rillig 2377: <pre class="programlisting">
1.294 rillig 2378: .if ${PKGPATH} == category/package
1.293 rillig 2379: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2380: # error message
2381: # code
1.294 rillig 2382: # Reason why the code does not need to be fixed.
1.293 rillig 2383: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.294 rillig 2384: .endif
1.293 rillig 2385: </pre>
2386: <p>If the error messages from the compiler are valid and the code
1.294 rillig 2387: needs to be fixed, prepare a local patch (see
2388: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2389: authors of the package, providing them with the information you collected
2390: above.</p>
2391: <p>Patches that are not essential for the package to work should only
2392: be reported upstream but not committed to pkgsrc, to make future updates
2393: easier.</p>
1.293 rillig 2394: </div>
2395: <div class="sect2">
2396: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2397: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
2398: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2399: these apply to all phases of the package build process. Especially in the
2400: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2401: decisions. The GNU configure scripts feed many small test programs to the
2402: C compiler to see whether certain headers are available, functions are
2403: defined in a library and programs can be run. In many cases these
2404: programs would not survive a strict compiler run with <code class="literal">-Wall
2405: -Wextra -Werror</code>.</p>
2406: <p>The pkgsrc infrastructure is flexible enough to support compiler
2407: options being added between the <code class="literal">configure</code> and
2408: <code class="literal">build</code> phases. It's a little more complicated than the
2409: other examples in this section but still easy enough.</p>
2410: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2411: desired compiler options. The compiler wrapper's original task is to hide
2412: unwanted directories of include files and to normalize compiler options.
2413: It does this by wrapping the compiler command and rewriting the command
2414: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2415: package directory and examine the
2416: <code class="filename">work/.cwrappers/config</code> directory. It contains
2417: individual configurations for the C compiler and the related tools. The
2418: plan is to find a hook between the configure and build phases, and to
2419: modify these configuration files at that point.</p>
2420: <p>To find this hook, have a look at
2421: <code class="filename">mk/build/build.mk</code>, which contains among others the
2422: <code class="literal">pre-build-checks-hook</code>. The word
2423: <code class="literal">checks</code> doesn't quite fit, but the
2424: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2425: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2426: <pre class="programlisting">
2427: # Just a few example options.
2428: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2429:
2430: .if ${BUILD_ONLY_CFLAGS:U:M*}
2431: pre-build-checks-hook: add-build-only-cflags
2432:
2433: add-build-only-cflags: .PHONY
2434: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2435: ${TEST} ! -f ${.TARGET} || exit 0; \
2436: for flag in ${BUILD_ONLY_CFLAGS}; do \
2437: ${ECHO} "append=$$flag" >> cc; \
2438: done; \
2439: > ${.TARGET}
2440: .endif
2441: </pre>
2442: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2443: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2444: not with spaces.)</p>
2445: <p>The condition in the <code class="literal">.if</code> statement contains the
2446: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2447: should be undefined, possibly because it is only defined for a subset of
2448: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2449: at least one compiler option, to prevent a syntax error in the shell
2450: parser.</p>
2451: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2452: that the additional compiler options are only appended once, even if
2453: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2454: creates a marker file.</p>
2455: <p>To verify that this setup works, run <span class="command"><strong>bmake
2456: configure</strong></span> in a package directory. Up to now, everything works
2457: as usual. Examine the directory
2458: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2459: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2460: the file <code class="filename">cc</code>. Examine the tail of the
2461: <code class="filename">work/.work.log</code> file to see that the normal compiler
2462: options are used.</p>
2463: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2464: options to the file <code class="filename">cc</code> and will create the marker
2465: file in the same directory. After that, the build starts as usual, but
2466: with the added compiler options. Examine the tail of the file
2467: <code class="filename">work/.work.log</code> to see that the lines starting with
2468: <code class="literal">[*]</code> don't contain the compiler options, but the
2469: corresponding lines starting with <code class="literal"><.></code> do end
2470: with these options.</p>
2471: <p>Building packages using this setup variant and fixing the resulting
2472: bugs is the same as in <a class="xref" href="#bulk.var.comperr" title="8.4.2. Detect classes of bugs by forcing compiler warnings">Section 8.4.2, “Detect classes of bugs by forcing compiler warnings”</a>.</p>
2473: </div>
2474: <div class="sect2">
2475: <div class="titlepage"><div><div><h3 class="title">
2476: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.293 rillig 2477: <p>Some directories like <code class="varname">PREFIX</code>,
2478: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2479: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2480: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2481: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2482: <pre class="programlisting">
2483: PREFIX= /a-random-uuid
2484: PKG_SYSCONFDIR= /a-random-uuid
2485: VARBASE= /a-random-uuid
2486: PKGMANDIR= a-random-uuid
2487: PKG_INFODIR= a-random-uuid
2488: </pre>
2489: </div>
2490: <div class="sect2">
2491: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2492: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.293 rillig 2493: <p>When building a package, warnings are typically ignored since they
2494: just flow by and do not cause the build to fail immediately. To find
2495: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2496: <pre class="programlisting">
2497: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2498: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2499: </pre>
2500: <p>(There are many more classes of warnings in pkgsrc, and most of
2501: them can be redefined with a simple definition like above.</p>
1.294 rillig 2502: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293 rillig 2503: the package Makefile, research whether the package actually needs Perl.
2504: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2505: Makefile, and if it doesn't, add
2506: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2507: </div>
2508: <div class="sect2">
2509: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2510: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293 rillig 2511: <p>Using pkglint as part of the regular build process is mostly a
2512: waste of time. If you want to fix some of the warnings, just run pkglint
2513: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2514: 10), which is much faster than a complete bulk build.</p>
2515: </div>
2516: <div class="sect2">
2517: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2518: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293 rillig 2519: <p>To ensure that the binary packages don't contain references to the
2520: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2521: that variable includes the item <code class="literal">extra</code>, it is
2522: possible to define additional patterns that must not appear in any
2523: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2524: <pre class="programlisting">
2525: CHECK_WRKREF= extra
2526: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2527: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2528: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2529: </pre>
2530: <p>The above patterns will probably generate many false positives,
2531: therefore the results need to be taken with a grain of salt.</p>
2532: </div>
2533: <div class="sect2">
2534: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2535: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.293 rillig 2536: <p>To run the test suites that come with each package, add this line
2537: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2538: <pre class="programlisting">
2539: PKGSRC_RUN_TEST= yes
2540: </pre>
2541: <p>Be prepared that even the most basic packages fail this test. When
2542: doing a bulk build with this, it will often abort in the early phase
2543: where the packages are scanned for their dependencies since there are
2544: cyclic dependencies. There is still a lot to do in this area.</p>
2545: </div>
2546: <div class="sect2">
2547: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2548: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293 rillig 2549: <p>To catch typos in the shell snippets from the Makefile fragments,
2550: add the <code class="literal">-u</code> flag to most of the commands by adding this
2551: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2552: <pre class="programlisting">
2553: RUN= @set -eu;
2554: </pre>
1.296 rillig 2555: <p>After that, ensure that none of the bulk build log files (even
2556: those for successfully built packages) contains the string
2557: <code class="literal">parameter not set</code> or whatever error message the
2558: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293 rillig 2559: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2560: definition.</p>
2561: </div>
2562: <div class="sect2">
2563: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2564: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.293 rillig 2565: <p>The build logs of a package are often quite long. This allows error
2566: messages or other interesting details to hide between the noise. To make
2567: the actual error message stand out more, add these lines to
2568: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2569: <pre class="programlisting">
2570: GNU_CONFIGURE_QUIET= yes
2571: MAKE_FLAGS+= -s
2572: </pre>
2573: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2574: Make. On exotic platforms with their own make, it may be a little
2575: different.</p>
2576: </div>
2577: </div>
2578: <div class="sect1">
2579: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2580: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2581: <p>After your pkgsrc bulk-build has completed, you may wish to
2582: create a CD-ROM set of the resulting binary packages to assist
2583: in installing packages on other machines. The
1.322 leot 2584: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/index.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87 wiz 2585: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2586: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2587: way that keeps all the dependencies for a given package on the same
2588: CD as that package.</p>
1.148 asau 2589: <div class="sect2">
1.75 rillig 2590: <div class="titlepage"><div><div><h3 class="title">
1.293 rillig 2591: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2592: <p>Complete documentation for cdpack is found in the cdpack(1)
2593: man page. The following short example assumes that the binary
2594: packages are left in
2595: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2596: sufficient disk space exists in <code class="filename">/u2</code> to
2597: hold the ISO 9660 images.</p>
2598: <pre class="screen">
2599: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2600: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2601: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2602: </pre>
2603: <p>If you wish to include a common set of files
2604: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2605: etc.) on each CD in the collection, then you need to create a
1.290 gutterid 2606: directory which contains these files, e.g.:</p>
1.87 wiz 2607: <pre class="screen">
2608: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2609: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2610: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2611: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2612: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2613: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2614: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2615: </pre>
1.75 rillig 2616: <p>Now create the images:</p>
2617: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76 rillig 2618: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2619: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2620: in their root directories.</p>
1.75 rillig 2621: </div>
2622: </div>
2623: </div>
1.148 asau 2624: <div class="chapter">
1.75 rillig 2625: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2626: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2627: <div class="toc">
2628: <p><b>Table of Contents</b></p>
1.210 leot 2629: <dl class="toc">
1.267 rillig 2630: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2631: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90 rillig 2632: </dl>
2633: </div>
2634: <p>The files that are installed by pkgsrc are organized in a way that
2635: is similar to what you find in the <code class="filename">/usr</code> directory
2636: of the base system. But some details are different. This is because
2637: pkgsrc initially came from FreeBSD and had adopted its file system
2638: hierarchy. Later it was largely influenced by NetBSD. But no matter
2639: which operating system you are using pkgsrc with, you can expect the
2640: same layout for pkgsrc.</p>
1.91 rillig 2641: <p>There are mainly four root directories for pkgsrc, which are all
2642: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2643: When pkgsrc has been installed as root, the default locations
2644: are:</p>
2645: <pre class="programlisting">
1.100 rillig 2646: LOCALBASE= /usr/pkg
2647: PKG_SYSCONFBASE= /usr/pkg/etc
2648: VARBASE= /var
1.231 sevan 2649: PKG_DBDIR= /usr/pkg/pkgdb
1.91 rillig 2650: </pre>
2651: <p>In unprivileged mode (when pkgsrc has been installed as any other
2652: user), the default locations are:</p>
2653: <pre class="programlisting">
1.100 rillig 2654: LOCALBASE= ${HOME}/pkg
2655: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2656: VARBASE= ${HOME}/pkg/var
1.231 sevan 2657: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.91 rillig 2658: </pre>
2659: <p>What these four directories are for, and what they look like is
2660: explained below.</p>
1.148 asau 2661: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2662: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2663: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2664: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2665: the well-known subdirectories like <code class="filename">bin</code>,
2666: <code class="filename">include</code>, <code class="filename">lib</code>,
2667: <code class="filename">share</code> and
2668: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2669: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2670: <code class="filename">/var</code> in the base system. Some programs (especially
2671: games, network daemons) need write access to it during normal
2672: operation.</p></li>
1.128 wiz 2673: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2674: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2675: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90 rillig 2676: itself.</p></li>
2677: </ul></div>
1.148 asau 2678: <div class="sect1">
1.90 rillig 2679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2680: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2681: </h2></div></div></div>
1.90 rillig 2682: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2683: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2684: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2685: <dt><span class="term"><code class="filename">bin</code></span></dt>
2686: <dd><p>Contains executable programs that are intended to be
2687: directly used by the end user.</p></dd>
2688: <dt><span class="term"><code class="filename">emul</code></span></dt>
2689: <dd><p>Contains files for the emulation layers of various other
2690: operating systems, especially for
2691: NetBSD.</p></dd>
2692: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2693: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2694: <dd><p>Contains
2695: the configuration files.</p></dd>
2696: <dt><span class="term"><code class="filename">include</code></span></dt>
2697: <dd><p>Contains headers for the C and C++ programming
2698: languages.</p></dd>
2699: <dt><span class="term"><code class="filename">info</code></span></dt>
2700: <dd><p>Contains GNU info files of various
2701: packages.</p></dd>
2702: <dt><span class="term"><code class="filename">lib</code></span></dt>
2703: <dd><p>Contains shared and static
2704: libraries.</p></dd>
2705: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2706: <dd><p>Contains data files that don't change after
2707: installation. Other data files belong into
2708: <code class="filename">${VARBASE}</code>.</p></dd>
2709: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2710: <dd><p>Contains programs that are not intended to be used by
2711: end users, such as helper programs or network
2712: daemons.</p></dd>
2713: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2714: <dd><p>Contains programs that are intended to be executed as
2715: CGI scripts by a web server.</p></dd>
2716: <dt><span class="term"><code class="filename">man</code> (the usual value of
2717: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2718: <dd><p>Contains brief
2719: documentation in form of manual pages.</p></dd>
2720: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2721: <dd><p>Contains programs that are intended to be used only by
2722: the super-user.</p></dd>
2723: <dt><span class="term"><code class="filename">share</code></span></dt>
2724: <dd><p>Contains platform-independent data files that don't
2725: change after installation.</p></dd>
2726: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2727: <dd><p>Contains documentation files provided by the
2728: packages.</p></dd>
2729: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2730: <dd><p>Contains example files provided by the packages. Among
2731: others, the original configuration files are saved here and copied to
2732: <code class="filename">${PKG_SYSCONFDIR}</code> during
2733: installation.</p></dd>
2734: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2735: <dd><p>Contains the original files for rc.d
2736: scripts.</p></dd>
2737: <dt><span class="term"><code class="filename">var</code> (the usual location of
2738: <code class="filename">${VARBASE}</code>)</span></dt>
2739: <dd><p>Contains files
2740: that may be modified after
2741: installation.</p></dd>
2742: </dl></div>
2743: </div>
1.148 asau 2744: <div class="sect1">
1.90 rillig 2745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2746: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2747: </h2></div></div></div>
1.148 asau 2748: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2749: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2750: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2751: <dd><p>Contains
2752: information about the currently installed
2753: packages.</p></dd>
2754: <dt><span class="term"><code class="filename">games</code></span></dt>
2755: <dd><p>Contains highscore
2756: files.</p></dd>
2757: <dt><span class="term"><code class="filename">log</code></span></dt>
2758: <dd><p>Contains log files.</p></dd>
2759: <dt><span class="term"><code class="filename">run</code></span></dt>
2760: <dd><p>Contains informational files about daemons that are
2761: currently running.</p></dd>
2762: </dl></div>
2763: </div>
2764: </div>
1.148 asau 2765: <div class="chapter">
1.90 rillig 2766: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2767: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2768: <div class="toc">
2769: <p><b>Table of Contents</b></p>
1.210 leot 2770: <dl class="toc">
1.267 rillig 2771: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2772: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2773: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2774: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2775: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
2776: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2777: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2778: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
2779: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2780: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 2781: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 2782: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.336 nia 2783: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267 rillig 2784: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2785: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2786: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2787: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2788: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 2789: </dl>
2790: </div>
2791: <p>This section contains hints, tips & tricks on special things in
2792: pkgsrc that we didn't find a better place for in the previous chapters, and
2793: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2794: <div class="sect1">
1.75 rillig 2795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2796: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2797: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2798: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2799: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 2800: This is a general purpose list for most issues regarding
2801: pkgsrc, regardless of platform, e.g. soliciting user help
2802: for pkgsrc configuration, unexpected build failures, using
2803: particular packages, upgrading pkgsrc installations,
2804: questions regarding the pkgsrc release branches, etc. General announcements or
2805: proposals for changes that impact the pkgsrc user community,
2806: e.g. major infrastructure changes, new features, package
2807: removals, etc., may also be posted.</p></li>
1.289 leot 2808: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 2809: A list where the results of pkgsrc bulk builds are sent and
2810: discussed.</p></li>
1.289 leot 2811: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 2812: This list is for those who are interested in getting a
2813: commit message for every change committed to pkgsrc. It is
2814: also available in digest form, meaning one daily message
2815: containing all commit messages for changes to the package
2816: source tree in that 24 hour period.</p></li>
2817: </ul></div>
2818: <p>To subscribe, do:</p>
2819: <pre class="programlisting">
1.100 rillig 2820: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2821: </pre>
2822: <p>Archives for all these mailing lists are available from
1.289 leot 2823: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2824: </div>
1.148 asau 2825: <div class="sect1">
1.75 rillig 2826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2827: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2828: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2829: a number of useful utilities for both users and developers of pkgsrc. This
1.233 sevan 2830: section attempts only to make the reader aware of some of the utilities and when
1.75 rillig 2831: they might be useful, and not to duplicate the documentation that comes
2832: with each package.</p>
2833: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.322 leot 2834: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/index.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75 rillig 2835: Symlinks for use by buildlink.</p></li></ul></div>
2836: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2837: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2838: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/index.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233 sevan 2839: Calculates various kinds of checksums (including SHA3).</p></li>
1.322 leot 2840: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/index.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75 rillig 2841: Compatibility library for pkgsrc tools.</p></li>
1.322 leot 2842: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/index.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87 wiz 2843: non-BSD systems due to lack of native mtree.</p></li>
1.322 leot 2844: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75 rillig 2845: Up-to-date replacement for
1.76 rillig 2846: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2847: systems where pkg_install is not present.</p></li>
2848: </ul></div>
2849: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2850: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2851: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75 rillig 2852: Create a binary package from an
1.110 hubertf 2853: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2854: save the old package.</p></li>
1.322 leot 2855: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/index.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75 rillig 2856: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2857: from multiple locations. It currently supports the following
2858: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.322 leot 2859: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117 jnemeth 2860: the best compiler flags to optimise code for your current
1.128 wiz 2861: CPU and compiler. </p></li>
1.75 rillig 2862: </ul></div>
2863: <p>Utilities for keeping track of installed packages, being up to date,
2864: etc:</p>
1.148 asau 2865: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2866: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/index.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173 wiz 2867: update tool similar to apt(1). Download, install, and upgrade
2868: binary packages easily.</p></li>
1.322 leot 2869: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75 rillig 2870: packages whose installed versions do not match the latest pkgsrc
2871: entries.</p></li>
1.322 leot 2872: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75 rillig 2873: dependency graphs of packages, to aid in choosing a strategy for
2874: updating.</p></li>
1.322 leot 2875: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/index.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
2876: graphs from the output of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
2877: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112 weinem 2878: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.322 leot 2879: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75 rillig 2880: does various checks on the complete pkgsrc system.</p></li>
1.322 leot 2881: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/index.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75 rillig 2882: packages you have installed.</p></li>
2883: </ul></div>
2884: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2885: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2886: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75 rillig 2887: making and maintaining patches for a package (includes pkgdiff,
2888: pkgvi, mkpatches, etc.).</p></li>
1.322 leot 2889: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/index.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75 rillig 2890: converting to pkgsrc.</p></li>
2891: </ul></div>
2892: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2893: utilities)</p>
1.148 asau 2894: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2895: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/index.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75 rillig 2896: packages in a chrooted area.</p></li>
1.322 leot 2897: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/index.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75 rillig 2898: kernel version for chrooted cross builds.</p></li>
2899: </ul></div>
2900: </div>
1.148 asau 2901: <div class="sect1">
1.75 rillig 2902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2903: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219 rillig 2904: <p>To install packages from source as a non-root user, download
1.267 rillig 2905: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 3. Where to get pkgsrc and how to keep it up-to-date">Chapter 3, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
1.219 rillig 2906: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2907: --unprivileged</strong></span>.</p>
2908: <p>This will install the binary part of pkgsrc to
2909: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2910: into <code class="filename">~/pkg/etc</code>.</p>
2911: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75 rillig 2912: </div>
1.148 asau 2913: <div class="sect1">
1.75 rillig 2914: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2915: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 2916: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2917: enable this feature by adding the option
2918: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 2919: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 2920: distfile is found, pkgsrc will try to resume it.</p>
2921: <p>You can also
1.168 wiz 2922: use a different program than the platform default program by changing the
1.117 jnemeth 2923: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2924: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2925: by using the value manual. A value of custom disables the system defaults
2926: and dependency tracking for the fetch program. In that case you have to
2927: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2928: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2929: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 2930: <p>For example, if you want to use
1.117 jnemeth 2931: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 2932: like:</p>
2933: <pre class="programlisting">
1.223 rillig 2934: FETCH_USING= wget
1.1 grant 2935: </pre>
1.75 rillig 2936: </div>
1.148 asau 2937: <div class="sect1">
1.75 rillig 2938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2939: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103 wiz 2940: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 2941: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 2942: you will have to add the following line into
1.110 hubertf 2943: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 2944: <pre class="programlisting">
1.103 wiz 2945: X11_TYPE=modular
1.1 grant 2946: </pre>
1.75 rillig 2947: </div>
1.148 asau 2948: <div class="sect1">
1.75 rillig 2949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2950: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 2951: <p>If you are sitting behind a firewall which does not allow direct
2952: connections to Internet hosts (i.e. non-NAT), you may specify the
2953: relevant proxy hosts. This is done using an environment variable in the
2954: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 2955: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 2956: port 80 as the proxy port number. So the proxy environment variables
2957: are:</p>
2958: <pre class="programlisting">
1.100 rillig 2959: ftp_proxy=ftp://orpheus.amdahl.com:80/
2960: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 2961: </pre>
1.75 rillig 2962: </div>
1.148 asau 2963: <div class="sect1">
1.75 rillig 2964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2965: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 wiz 2966: <p>Some fetch tools are not prepared to support HTTPS by default
2967: (for example, the one in NetBSD 6.0), or the one installed by the
2968: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2969: dependency graph).</p>
2970: <p>Usually you won't notice, because distribution files are
2971: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2972: be often enough if you are following pkgsrc-current. In that case, set
2973: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2974: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2975: with HTTPS support by default. Of course, these tools need to be
2976: installed before you can use them this way.</p>
2977: </div>
2978: <div class="sect1">
2979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2980: <a name="passive-ftp"></a>10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75 rillig 2981: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 2982: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 2983: the first available command from the following list:</p>
1.148 asau 2984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2985: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2986: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 2987: </ul></div>
2988: <p>On a default NetBSD installation, this will be
1.76 rillig 2989: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 2990: connections first, and falls back to active connections if the server
2991: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 2992: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 2993: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2994: <p>Having that option present will prevent
1.76 rillig 2995: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 2996: transfers.</p>
2997: </div>
1.148 asau 2998: <div class="sect1">
1.75 rillig 2999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3000: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3001: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3002: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 3003: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75 rillig 3004: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3005: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3006: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3007: resulting list to your machine at work/school and use it there. If you
1.378 ! leot 3008: don't have a NetBSD-compatible <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75 rillig 3009: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3010: URL:</p>
3011: <p>At home:</p>
3012: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3013: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3014: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3015: <p>At work:</p>
3016: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3017: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3018: home.</p>
3019: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3020: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3021: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3022: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3023: directly by running:</p>
1.75 rillig 3024: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3025: <p>If you even decide to ignore
3026: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3027: by running:</p>
3028: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3029: </div>
1.148 asau 3030: <div class="sect1">
1.75 rillig 3031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3032: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 3033: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.322 leot 3034: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75 rillig 3035: package, you get the error from make that it doesn't know how to make
1.76 rillig 3036: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 3037: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 3038: the NetBSD base distribution on your machine. It is recommended to do
3039: that to format man pages.</p>
1.322 leot 3040: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75 rillig 3041: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3042: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3043: </div>
1.148 asau 3044: <div class="sect1">
1.75 rillig 3045: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3046: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.87 wiz 3047: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3048: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3049: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3050: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3051: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3052: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3053: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3054: -r</strong></span>).</p>
3055: </div>
1.148 asau 3056: <div class="sect1">
1.75 rillig 3057: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.336 nia 3058: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.75 rillig 3059: <p>When installing packages as non-root user and using the just-in-time
1.378 ! leot 3060: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 3061: password for each required package installed. To avoid this, the sudo
3062: package can be used, which does password caching over a limited time. To
1.336 nia 3063: use it, install <span class="command"><strong>sudo</strong></span> or
3064: <span class="command"><strong>priv</strong></span> (either as binary package, from
3065: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/priv/index.html" target="_top"><code class="filename">security/priv</code></a>, or
1.322 leot 3066: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/index.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110 hubertf 3067: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3068: <span class="emphasis"><em>after</em></span> the definition of the
3069: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3070: <pre class="programlisting">
1.100 rillig 3071: .if exists(${LOCALBASE}/bin/sudo)
3072: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3073: .endif
1.1 grant 3074: </pre>
1.75 rillig 3075: </div>
1.148 asau 3076: <div class="sect1">
1.75 rillig 3077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3078: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3079: <p>As the system administrator, you can choose where configuration files
3080: are installed. The default settings make all these files go into
1.76 rillig 3081: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3082: be suboptimal depending on your expectations (e.g., a read-only,
3083: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3084: configuration of the provided packages).</p>
3085: <p>In order to change the defaults, you can modify the
3086: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3087: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3088: directory; some common examples include <code class="filename">/etc</code> or
3089: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3090: <p>Furthermore, you can change this value on a per-package basis by
3091: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3092: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3093: package you would like to modify, that is, the contents of
3094: <code class="varname">PKGBASE</code>.</p>
3095: <p>Note that after changing these settings, you must rebuild and
3096: reinstall any affected packages.</p>
3097: </div>
1.148 asau 3098: <div class="sect1">
1.75 rillig 3099: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3100: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75 rillig 3101: <p>Please be aware that there can often be bugs in third-party software,
3102: and some of these bugs can leave a machine vulnerable to exploitation by
3103: attackers. In an effort to lessen the exposure, the NetBSD packages team
3104: maintains a database of known-exploits to packages which have at one time
3105: been included in pkgsrc. The database can be downloaded automatically, and
3106: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3107: do this, refer to the following two tools (installed as part of the
1.322 leot 3108: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128 wiz 3109: <div class="orderedlist"><ol class="orderedlist" type="1">
3110: <li class="listitem">
1.122 reed 3111: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3112: download a list of the security vulnerabilities information. This list
1.132 spz 3113: is kept up to date by the pkgsrc security team, and is distributed
3114: from the NetBSD ftp server:</p>
1.292 leot 3115: <p><a class="ulink" href="https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a></p>
1.75 rillig 3116: </li>
1.128 wiz 3117: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3118: current machine, checking each known vulnerability. If a
1.75 rillig 3119: vulnerable package is installed, it will be shown by output to stdout,
3120: including a description of the type of vulnerability, and a URL
3121: containing more information.</p></li>
3122: </ol></div>
1.233 sevan 3123: <p>Use of these tools is strongly recommended!
1.317 nia 3124: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, “Checking for security vulnerabilities in installed packages”</a> for instructions on how to automate checking and
1.233 sevan 3125: reporting.</p>
3126: <p>If this database is installed, pkgsrc builds will use it to
3127: perform a security check before building any package.</p>
1.75 rillig 3128: </div>
1.148 asau 3129: <div class="sect1">
1.75 rillig 3130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3131: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 3132: <p>When you add your own preferences to the
3133: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3134: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3135: environment variables to the <code class="filename">./configure</code>
1.378 ! leot 3136: scripts and to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75 rillig 3137: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3138: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3139: package.</p>
3140: <p>Currently there is no solution to this problem. If you
3141: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3142: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3143: directory and then inspect any <code class="filename">Makefile</code> and
3144: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3145: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3146: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3147: programmers write so bad code that it only works for the
3148: specific combination of <code class="varname">CFLAGS</code> they have
3149: chosen.</p>
1.287 rillig 3150: <p>To find out where the CFLAGS are ignored, add the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
3151: <pre class="programlisting">
3152: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3153: CFLAGS+= -Dpkgsrc___CFLAGS
3154: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3155: </pre>
3156: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3157: to see whether the above flags are passed to the actual build
3158: commands in general.</p>
3159: <p>To find out whether the flags are passed to individual compiler
3160: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3161: most cases, the flags from the original command lines (the lines starting
3162: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3163: (the lines starting with <code class="literal"><.></code>). If the flag is
3164: missing from the actual compiler command, it must have been removed by
1.299 rillig 3165: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75 rillig 3166: </div>
1.148 asau 3167: <div class="sect1">
1.80 rillig 3168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3169: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3170: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3171: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3172: case that occurs often is that people only update pkgsrc in
3173: parts, because of performance reasons. Since pkgsrc is one large
3174: system, not a collection of many small systems, there are
3175: sometimes changes that only work when the whole pkgsrc tree is
3176: updated.</p></li>
1.148 asau 3177: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3178: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3179: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3180: files.</p></li>
1.148 asau 3181: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3182: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3183: verify this.</p></li>
1.218 rillig 3184: <li class="step"><p>If you are a package developer who wants to invest
1.267 rillig 3185: some work, have a look at <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.148 asau 3186: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3187: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3188: </ol></div>
3189: </div>
1.148 asau 3190: <div class="sect1">
1.88 wiz 3191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3192: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.89 rillig 3193: <p>You have modified a file from pkgsrc, and someone else has
3194: modified that same file afterwards in the CVS repository. Both changes
3195: are in the same region of the file, so when you updated pkgsrc, the
3196: <code class="literal">cvs</code> command marked the conflicting changes in the
3197: file. Because of these markers, the file is no longer a valid
3198: <code class="filename">Makefile</code>.</p>
3199: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3200: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3201: -dP</strong></span> in that directory to download the current version.</p>
3202: </div>
1.75 rillig 3203: </div>
3204: </div>
1.148 asau 3205: <div class="part">
1.75 rillig 3206: <div class="titlepage"><div><div><h1 class="title">
3207: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3208: <div class="partintro">
1.77 rillig 3209: <div></div>
3210: <p>This part of the book deals with creating and
1.128 wiz 3211: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3212: guide on creating a new package. The remaining chapters are more
3213: like a reference manual for pkgsrc.</p>
1.75 rillig 3214: <div class="toc">
3215: <p><b>Table of Contents</b></p>
1.210 leot 3216: <dl class="toc">
1.267 rillig 3217: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299 rillig 3218: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91 rillig 3219: <dd><dl>
1.299 rillig 3220: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3221: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3222: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91 rillig 3223: <dd><dl>
1.299 rillig 3224: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3225: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3226: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3227: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3228: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91 rillig 3229: </dl></dd>
1.299 rillig 3230: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3231: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3232: <dd><dl>
3233: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3234: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3235: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3236: </dl></dd>
3237: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3238: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3239: </dl></dd>
1.299 rillig 3240: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106 rillig 3241: <dd><dl>
1.299 rillig 3242: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3243: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3244: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3245: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3246: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 3247: <dd><dl>
1.299 rillig 3248: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3249: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106 rillig 3250: </dl></dd>
1.299 rillig 3251: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3252: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3253: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3254: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3255: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3256: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3257: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3258: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3259: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3260: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3261: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3262: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3263: </dl></dd>
3264: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3265: <dd><dl>
3266: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106 rillig 3267: <dd><dl>
1.334 nia 3268: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
3269: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
3270: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106 rillig 3271: </dl></dd>
1.299 rillig 3272: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3273: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106 rillig 3274: </dl></dd>
1.299 rillig 3275: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3276: <dd><dl>
1.299 rillig 3277: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3278: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3279: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3280: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106 rillig 3281: <dd><dl>
1.299 rillig 3282: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3283: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3284: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
3285: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344 gutterid 3286: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.106 rillig 3287: </dl></dd>
3288: </dl></dd>
1.299 rillig 3289: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106 rillig 3290: <dd><dl>
1.299 rillig 3291: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3292: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
3293: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3294: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3295: </dl></dd>
1.299 rillig 3296: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106 rillig 3297: <dd><dl>
1.299 rillig 3298: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3299: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3300: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3301: </dl></dd>
3302: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3303: <dd><dl>
3304: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3305: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3306: <dd><dl>
1.299 rillig 3307: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3308: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133 wiz 3309: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3310: and
3311: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3312: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3313: </dl></dd>
1.299 rillig 3314: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.355 rillig 3315: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.299 rillig 3316: </dl></dd>
3317: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106 rillig 3318: <dd><dl>
1.299 rillig 3319: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3320: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3321: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
3322: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3323: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3324: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3325: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3326: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3327: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106 rillig 3328: </dl></dd>
1.299 rillig 3329: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3330: <dd><dl>
3331: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3332: <dd><dl>
3333: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3334: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106 rillig 3335: </dl></dd>
1.299 rillig 3336: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106 rillig 3337: <dd><dl>
1.299 rillig 3338: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3339: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.353 dholland 3340: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
3341: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
3342: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299 rillig 3343: </dl></dd>
3344: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3345: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
3346: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3347: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3348: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3349: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3350: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.267 rillig 3351: </dl></dd>
3352: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3353: <dd><dl>
3354: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3355: <dd><dl>
3356: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
3357: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3358: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3359: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3360: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3361: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3362: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3363: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3364: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3365: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3366: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3367: </dl></dd>
3368: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3369: <dd><dl>
3370: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3371: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
3372: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3373: </dl></dd>
3374: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3375: <dd><dl>
3376: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3377: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3378: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338 nia 3379: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.267 rillig 3380: </dl></dd>
3381: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3382: <dd><dl>
3383: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3384: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 3385: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338 nia 3386: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
3387: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
3388: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
3389: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267 rillig 3390: </dl></dd>
3391: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3392: <dd><dl>
3393: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3394: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 3395: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3396: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
3397: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 3398: </dl></dd>
3399: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3400: <dd><dl>
3401: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3402: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3403: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3404: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3405: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 3406: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.369 wiz 3407: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
3408: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
3409: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
3410: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
3411: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
3412: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
3413: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
3414: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
3415: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
3416: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.87 wiz 3417: emulation</a></span></dt>
1.369 wiz 3418: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
3419: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.77 rillig 3420: </dl></dd>
1.267 rillig 3421: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3422: </dl></dd>
1.299 rillig 3423: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3424: <dd><dl>
3425: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3426: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3427: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3428: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3429: </dl></dd>
1.267 rillig 3430: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 3431: <dd><dl>
1.267 rillig 3432: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3433: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3434: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3435: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3436: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3437: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3438: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3439: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3440: </dl></dd>
3441: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75 rillig 3442: </dl>
3443: </div>
1.77 rillig 3444: </div>
1.148 asau 3445: <div class="chapter">
1.77 rillig 3446: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 3447: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3448: <p>
3449: To get help when developing pkgsrc, the definitive source is this
3450: document, the pkgsrc guide. If you don't find anything here,
3451: there are alternatives:
3452: </p>
3453: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3454: <li class="listitem">
3455: <p>
3456: The built-in pkgsrc help, which is available after bootstrapping
3457: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3458: help for any topic, such as a variable name like
3459: <code class="varname">BUILD_DEFS</code>, a make target like
3460: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3461: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322 leot 3462: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.267 rillig 3463: </li>
3464: <li class="listitem"><p>
1.278 rillig 3465: To see the value of a single variable, run <span class="command"><strong>bmake
3466: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3467: </p></li>
3468: <li class="listitem"><p>
3469: To see the values of the most common variables, run
3470: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3471: topic. To see the variables for a single topic, run
3472: <span class="command"><strong>bmake
3473: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3474: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3475: </p></li>
3476: <li class="listitem"><p>
1.267 rillig 3477: The tech-pkg mailing list, to which
3478: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3479: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3480: questions</a>.</p></li>
3481: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3482: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3483: or by using a specialized chat program such as
3484: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3485: Pick any user name and join the channel #pkgsrc.</p></li>
3486: </ul></div>
3487: </div>
3488: <div class="chapter">
3489: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 3490: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91 rillig 3491: <div class="toc">
3492: <p><b>Table of Contents</b></p>
1.210 leot 3493: <dl class="toc">
1.299 rillig 3494: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3495: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3496: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3497: <dd><dl>
3498: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3499: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3500: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3501: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3502: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3503: </dl></dd>
3504: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3505: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3506: <dd><dl>
3507: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3508: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3509: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91 rillig 3510: </dl></dd>
1.299 rillig 3511: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3512: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91 rillig 3513: </dl>
3514: </div>
1.299 rillig 3515: <p>Whenever you're preparing a package, there are a number of
3516: files involved which are described in the following
3517: sections.</p>
3518: <div class="sect1">
3519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3520: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3521: </h2></div></div></div>
3522: <p>Building, installation and creation of a binary package are all
3523: controlled by the package's <code class="filename">Makefile</code>.
3524: The <code class="filename">Makefile</code> describes various things about
3525: a package, for example from where to get it, how to configure,
3526: build, and install it.</p>
3527: <p>A package <code class="filename">Makefile</code> contains several
3528: sections that describe the package.</p>
3529: <p>In the first section there are the following variables, which
3530: should appear exactly in the order given here. The order and
3531: grouping of the variables is mostly historical and has no further
3532: meaning.</p>
3533: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3534: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3535: distribution file to be downloaded from the package's
3536: website.</p></li>
3537: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3538: package, as used by pkgsrc. You need to provide it if
3539: <code class="varname">DISTNAME</code> (which is the default) is not a good
3540: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3541: provided (no distribution file is required). Usually it is the pkgsrc
3542: directory name together with the version number. It must match the
3543: regular expression
3544: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3545: starts with a letter or digit, and contains only letters, digits,
1.319 nia 3546: dashes, underscores, dots and plus signs.
3547: New packages should have entirely lower-case names, with the exception
3548: of some that must follow pre-existing conventions
3549: (e.g. R packages begin with <code class="varname">R-</code>).
3550: You can use the <code class="code">:tl</code> variable modifier to lower-case
3551: the package name.</p></li>
1.299 rillig 3552: <li class="listitem">
3553: <p><code class="varname">CATEGORIES</code> is a list of categories
3554: which the package fits in. You can choose any of the top-level
3555: directories of pkgsrc for it.</p>
3556: <p>Currently the following values are available for
3557: <code class="varname">CATEGORIES</code>. If more than
3558: one is used, they need to be separated by spaces:</p>
1.77 rillig 3559: <pre class="programlisting">
1.299 rillig 3560: archivers cross geography meta-pkgs security
3561: audio databases graphics misc shells
3562: benchmarks devel ham multimedia sysutils
3563: biology editors inputmethod net textproc
3564: cad emulators lang news time
3565: chat finance mail parallel wm
3566: comms fonts math pkgtools www
3567: converters games mbone print x11
1.77 rillig 3568: </pre>
3569: </li>
1.299 rillig 3570: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3571: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3572: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3573: and <code class="varname">DISTFILES</code> are discussed in detail in
3574: <a class="xref" href="#build.fetch" title="13.5. The fetch phase">Section 13.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
3575: </ul></div>
3576: <p>The second section contains information about separately
3577: downloaded patches, if any.
3578: </p>
3579: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3580: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3581: Name(s) of additional files that contain distribution patches.
3582: There is no default. pkgsrc will look for them at
3583: <code class="varname">PATCH_SITES</code>.
3584: They will automatically be uncompressed before patching if
3585: the names end with <code class="filename">.gz</code> or
3586: <code class="filename">.Z</code>.</p></li>
3587: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3588: Primary location(s) for distribution patch files (see
3589: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3590: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.378 ! leot 3591: an argument to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.299 rillig 3592: help find the correct files to patch. It defaults to
3593: <span class="command"><strong>-p0</strong></span>.</p></li>
3594: </ul></div>
3595: <p>The third section contains the following variables.
3596: </p>
3597: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.367 gdt 3598: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email address
3599: of the person who is currently responsible for this package. In
3600: theory, the maintainer will be aware of upstream release, keep it
3601: updated, and generally resolve problems. Others contemplating
3602: significant changes should ask the maintainer for advice or review
3603: of a proposed change. This is not necessary for micro updates,
3604: bug fixes, pkgsrc-wide changes affecting many packages, and other
3605: things expected to be uncontroversial. It goes with this "should
3606: ask" that the maintainer should respond to inquiries reasonably
3607: promptly (most of the time), and either approve changes or provide
3608: reasons why not. Typically, when packaging a new program, set
3609: <code class="varname">MAINTAINER</code> to yourself. If you don't intend to
3610: maintain the package (especially if you feel you have no special
3611: insight), set it to <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>. This
3612: special value is a code point indicating that there is no
3613: maintainer, but the variable is mandatory, absent
3614: <code class="varname">OWNER</code>.</p></li>
3615: <li class="listitem">
3616: <p><code class="varname">OWNER</code> can be used instead of
3617: <code class="varname">MAINTAINER</code> in relatively rare circumstances
3618: when the package is such that modifying it is riskier than normal.
3619: This is a stronger form of being the maintainer, with an
3620: expectation that others will ask for almost all changes, except
3621: revbumps and accommodating structural changes. Someone who becomes
3622: <code class="varname">OWNER</code> has a strong obligation to keep the
3623: package very well maintained, to answer queries promptly and to be
3624: a steward of the package on behalf of users. In this case,
3625: <code class="varname">MAINTAINER</code> should be omitted.</p>
3626: <p>Because of the friction that <code class="varname">OWNER</code> adds,
3627: PMC may downgrade it to <code class="varname">MAINTAINER</code> at any
3628: time.</p>
3629: </li>
1.299 rillig 3630: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3631: find more information about the package.</p></li>
3632: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3633: description of the package (should not include the package
3634: name).</p></li>
3635: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3636: applicable for the package. See <a class="xref" href="#handling-licenses" title="21.1.3. Handling licenses">Section 21.1.3, “Handling licenses”</a> for further details.</p></li>
3637: </ul></div>
3638: <p>Other variables that affect the build:
3639: </p>
3640: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3641: <p><code class="varname">WRKSRC</code>: The directory where the
3642: interesting distribution files of the package are found. The
3643: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3644: works for most packages.</p>
3645: <p>If a package doesn't create a subdirectory for itself
3646: (most GNU software does, for instance), but extracts itself in
3647: the current directory, you should set
3648: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3649: <p>If a package doesn't create a subdirectory with the
3650: name of <code class="varname">DISTNAME</code> but some different name,
3651: set <code class="varname">WRKSRC</code> to point to the proper name in
3652: <code class="filename">${WRKDIR}</code>, for example
3653: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.322 leot 3654: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/index.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/index.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.299 rillig 3655: <p>The name of the working directory created by pkgsrc is
3656: taken from the <code class="varname">WRKDIR_BASENAME</code>
3657: variable. By default, its value is
3658: <code class="filename">work</code>. If you want to use the same
3659: pkgsrc tree for building different kinds of binary packages,
3660: you can change the variable according to your needs. Two
3661: other variables handle common cases of setting
3662: <code class="varname">WRKDIR_BASENAME</code> individually. If
3663: <code class="varname">OBJHOSTNAME</code> is defined in
3664: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3665: the host's name is attached to the directory name. If
3666: <code class="varname">OBJMACHINE</code> is defined, the platform name
3667: is attached, which might look like
3668: <code class="filename">work.i386</code> or
3669: <code class="filename">work.sparc</code>.</p>
3670: </li></ul></div>
3671: <p>Please pay attention to the following gotchas:</p>
3672: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3673: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3674: installed in compressed form by the package. For packages using
3675: BSD-style makefiles which honor MANZ, there is
3676: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3677: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3678: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3679: below).</p></li>
1.369 wiz 3680: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.8. Packages installing info files">Section 21.6.8, “Packages installing info files”</a>.</p></li>
1.299 rillig 3681: </ul></div>
3682: </div>
1.148 asau 3683: <div class="sect1">
1.91 rillig 3684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 3685: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3686: </h2></div></div></div>
3687: <p>The <code class="filename">distinfo</code> file contains the message
3688: digest, or checksum, of each distfile needed for the package. This
3689: ensures that the distfiles retrieved from the Internet have not been
3690: corrupted during transfer or altered by a malign force to introduce
3691: a security hole. To provide maximum security, all distfiles are
1.357 gutterid 3692: protected using two different message digest algorithms (BLAKE2s
3693: and SHA512), as well as the file size.</p>
1.299 rillig 3694: <p>The <code class="filename">distinfo</code> file also contains the
3695: checksums for all the patches found in the
3696: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a>). These checksums ensure that patches
3697: are only applied intentionally and that they don't accidentally change,
3698: e.g. when merging different changes together. They also make sure that
3699: new patches are actually added to CVS and old ones are removed.
3700: Too see whether the patches and the <code class="filename">distinfo</code> file
3701: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3702: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3703: <span class="command"><strong>make distinfo</strong></span> command.</p>
3704: <p>Some packages have different sets of distfiles depending on
1.322 leot 3705: the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk8/index.html" target="_top"><code class="filename">lang/openjdk8</code></a>. These are kept in the same
1.299 rillig 3706: <code class="filename">distinfo</code> file and care should be taken when
3707: upgrading such a package to ensure distfile information is not
3708: lost.</p>
3709: </div>
3710: <div class="sect1">
3711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3712: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3713: </h2></div></div></div>
3714: <p>Some packages don't work out-of-the box on the various
3715: platforms that are supported by pkgsrc. These packages need
3716: to be patched to make them work. The patch files can be
3717: found in the <code class="filename">patches/</code> directory.</p>
3718: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3719: applied to the files in <code class="varname">WRKSRC</code> directory after
3720: extracting them, in alphabetic order.</p>
1.148 asau 3721: <div class="sect2">
1.91 rillig 3722: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3723: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3724: <p>The <code class="filename">patch-*</code> files should be in
3725: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3726: problems. (To force patches to apply with fuzz you can set
3727: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3728: should contain only changes for a single file, and no file should be
3729: patched by more than one patch file. This helps to keep future
3730: modifications simple.</p>
3731: <p>Each patch file is structured as follows: In the first line,
3732: there is the RCS Id of the patch itself. The second line should be
3733: empty for aesthetic reasons. After that, there should be a comment for
3734: each change that the patch does. There are a number of standard
3735: cases:</p>
3736: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3737: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3738: mention the vulnerability ID (CAN, CVE).</p></li>
3739: <li class="listitem"><p>Patches that change source code should mention the
3740: platform and other environment (for example, the compiler) that the
3741: patch is needed for.</p></li>
3742: </ul></div>
3743: <p>The patch should be commented so that any
3744: developer who knows the code of the application can make some use of
3745: the patch. Special care should be taken for the upstream developers,
3746: since we generally want that they accept our patches, so we have less
3747: work in the future.</p>
1.91 rillig 3748: </div>
1.148 asau 3749: <div class="sect2">
1.91 rillig 3750: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3751: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3752: <p>One important thing to mention is to pay attention that no RCS
3753: IDs get stored in the patch files, as these will cause problems when
3754: later checked into the NetBSD CVS tree. Use the
1.322 leot 3755: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.299 rillig 3756: problems.</p>
3757: <p>For even more automation, we recommend using
3758: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.337 gutterid 3759: whole set of patches. You just have to back up files before you
3760: edit them to <code class="filename">filename.orig</code>, e.g., with
1.299 rillig 3761: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3762: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3763: you upgrade a package this way, you can easily compare the new
3764: set of patches with the previously existing one with
3765: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3766: are replaced by new files, so carefully check if you want to take all
3767: the changes.</p>
3768: <p>When you have finished a package, remember to generate
3769: the checksums for the patch files by using the <span class="command"><strong>make
3770: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="12.2. distinfo">Section 12.2, “<code class="filename">distinfo</code>”</a>.</p>
3771: <p>When adding a patch that corrects a problem in the
3772: distfile (rather than e.g. enforcing pkgsrc's view of where
3773: man pages should go), send the patch as a bug report to the
3774: maintainer. This benefits non-pkgsrc users of the package,
3775: and usually makes it possible to remove the patch in future
3776: version.</p>
3777: <p>The file names of the patch files are usually of the form
3778: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3779: Many packages still use the previous convention
3780: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3781: but new patches should be of the form containing the filename.
1.322 leot 3782: <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.299 rillig 3783: automatically.</p>
1.337 gutterid 3784: <p>When updating pre-existing patch files, if a file uses the old
3785: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
3786: convention, it's best not to change it to the new form, as that will
3787: just cause churn that makes it harder to track changes to patching
3788: over time. Similarly, if a patch now applies at different line offsets,
3789: but still applies cleanly as-is, there's no need to update it, as that
3790: also unnecessarily complicates the patch history.</p>
1.118 imil 3791: </div>
1.275 brook 3792: <div class="sect2">
3793: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3794: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3795: <p>If you want to share patches between multiple packages
3796: in pkgsrc, e.g. because they use the same distfiles, set
3797: <code class="varname">PATCHDIR</code> to the path where the patch files
3798: can be found, e.g.:</p>
3799: <pre class="programlisting">
3800: PATCHDIR= ../../editors/xemacs/patches
3801: </pre>
3802: <p>Patch files that are distributed by the author or other
3803: maintainers can be listed in
3804: <code class="varname">PATCHFILES</code>.</p>
3805: <p>If it is desired to store any patches that should not be
3806: committed into pkgsrc, they can be kept outside the pkgsrc
3807: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3808: directory tree there is expected to have the same
3809: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3810: patches are expected to be stored inside these dirs (also
3811: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3812: example, if you want to keep a private patch for
3813: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3814: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3815: files in the named directory are expected to be patch files,
3816: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3817: applied</em></span>.</p>
1.275 brook 3818: </div>
3819: <div class="sect2">
3820: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3821: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3822: <p>When fixing a portability issue in the code do not use
3823: preprocessor magic to check for the current operating system nor
3824: platform. Doing so hurts portability to other platforms because
3825: the OS-specific details are not abstracted appropriately.</p>
3826: <p>The general rule to follow is: instead of checking for the
3827: operating system the application is being built on, check for the
3828: specific <span class="emphasis"><em>features</em></span> you need. For example,
3829: instead of assuming that kqueue is available under NetBSD and
3830: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3831: kqueue support, add a check that detects kqueue itself —
3832: yes, this generally involves patching the
3833: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3834: that prevents some OSes from adopting interfaces from other OSes
3835: (e.g. Linux implementing kqueue), something that the above checks
3836: cannot take into account.</p>
3837: <p>Of course, checking for features generally involves more
3838: work on the developer's side, but the resulting changes are
3839: cleaner and there are chances they will work on many other
3840: platforms. Not to mention that there are higher chances of being
3841: later integrated into the mainstream sources. Remember:
3842: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3843: <p>Some typical examples:</p>
3844: <div class="table">
3845: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3846: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3847: <colgroup>
3848: <col>
3849: <col>
3850: <col>
3851: </colgroup>
3852: <thead><tr>
3853: <th>Where</th>
3854: <th>Incorrect</th>
3855: <th>Correct</th>
3856: </tr></thead>
3857: <tbody>
3858: <tr>
3859: <td>configure script</td>
3860: <td>
1.275 brook 3861: <pre class="programlisting">
1.299 rillig 3862: case ${target_os} in
3863: netbsd*) have_kvm=yes ;;
3864: *) have_kvm=no ;;
3865: esac
1.275 brook 3866: </pre>
1.299 rillig 3867: </td>
3868: <td>
1.275 brook 3869: <pre class="programlisting">
1.299 rillig 3870: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275 brook 3871: </pre>
1.299 rillig 3872: </td>
3873: </tr>
3874: <tr>
3875: <td>C source file</td>
3876: <td>
1.91 rillig 3877: <pre class="programlisting">
1.299 rillig 3878: #if defined(__NetBSD__)
3879: # include <sys/event.h>
3880: #endif
1.91 rillig 3881: </pre>
1.299 rillig 3882: </td>
3883: <td>
1.91 rillig 3884: <pre class="programlisting">
1.299 rillig 3885: #if defined(HAVE_SYS_EVENT_H)
3886: # include <sys/event.h>
3887: #endif
1.91 rillig 3888: </pre>
1.299 rillig 3889: </td>
3890: </tr>
3891: <tr>
3892: <td>C source file</td>
3893: <td>
1.91 rillig 3894: <pre class="programlisting">
1.299 rillig 3895: int
3896: monitor_file(...)
3897: {
3898: #if defined(__NetBSD__)
3899: int fd = kqueue();
3900: ...
3901: #else
3902: ...
3903: #endif
3904: }
1.91 rillig 3905: </pre>
1.299 rillig 3906: </td>
3907: <td>
1.91 rillig 3908: <pre class="programlisting">
1.299 rillig 3909: int
3910: monitor_file(...)
3911: {
3912: #if defined(HAVE_KQUEUE)
3913: int fd = kqueue();
3914: ...
3915: #else
3916: ...
3917: #endif
3918: }
1.91 rillig 3919: </pre>
1.299 rillig 3920: </td>
3921: </tr>
3922: </tbody>
3923: </table></div>
3924: </div>
3925: <br class="table-break">
3926: </div>
3927: <div class="sect2">
3928: <div class="titlepage"><div><div><h3 class="title">
3929: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3930: <p>Always, always, <span class="strong"><strong>always</strong></span>
3931: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3932: improvements you do to a package to the mainstream developers.
3933: This is the only way to get their attention on portability issues
3934: and to ensure that future versions can be built out-of-the box on
3935: NetBSD. Furthermore, any user that gets newer distfiles will get
3936: the fixes straight from the packaged code.</p>
3937: <p>This generally involves cleaning up the patches
3938: (because sometimes the patches that are
3939: added to pkgsrc are quick hacks), filing bug reports in the
3940: appropriate trackers for the projects and working with the
3941: mainstream authors to accept your changes. It is
3942: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3943: the packages in pkgsrc are kept simple and thus further changes
3944: can be done without much hassle.</p>
3945: <p>When you have done this, please add a URL to the upstream
3946: bug report to the patch comment.</p>
3947: <p>Support the idea of free software!</p>
3948: </div>
1.91 rillig 3949: </div>
1.299 rillig 3950: <div class="sect1">
3951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3952: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3953: <div class="variablelist"><dl class="variablelist">
3954: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3955: <dd><p>A multi-line description of the piece of software. This should include
3956: any credits where they are due. Please bear in mind that others do not
3957: share your sense of humour (or spelling idiosyncrasies), and that others
3958: will read everything that you write here.</p></dd>
3959: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3960: <dd><p>This file governs the files that are installed on your
3961: system: all the binaries, manual pages, etc. There are other
3962: directives which may be entered in this file, to control the
3963: creation and deletion of directories, and the location of
3964: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3965: information.</p></dd>
3966: </dl></div>
3967: </div>
3968: <div class="sect1">
3969: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3970: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3971: <div class="sect2">
3972: <div class="titlepage"><div><div><h3 class="title">
3973: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3974: <div class="variablelist"><dl class="variablelist">
3975: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3976: <dd>
1.378 ! leot 3977: <p>This shell script is invoked twice by <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.299 rillig 3978: First time after package extraction and before files are
3979: moved in place, the second time after the files to install
3980: are moved in place. This can be used to do any custom
3981: procedures not possible with @exec commands in
1.378 ! leot 3982: <code class="filename">PLIST</code>. See <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
! 3983: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 3984: Please note that you can modify variables in it easily by using
3985: <code class="varname">FILES_SUBST</code> in the package's
3986: <code class="filename">Makefile</code>:</p>
1.91 rillig 3987: <pre class="programlisting">
1.299 rillig 3988: FILES_SUBST+= SOMEVAR="somevalue"
1.91 rillig 3989: </pre>
1.299 rillig 3990: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3991: <code class="filename">INSTALL</code>. By default, substitution is
3992: performed for <code class="varname">PREFIX</code>,
3993: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3994: <code class="varname">VARBASE</code>, and a few others, type
3995: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3996: complete list.</p>
3997: </dd>
3998: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3999: <dd><p>This script is executed before and after any files are removed. It is
4000: this script's responsibility to clean up any additional messy details
4001: around the package's installation, since all pkg_delete knows is how to
4002: delete the files created in the original distribution.
1.378 ! leot 4003: See <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
! 4004: and <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.299 rillig 4005: The same methods to replace variables can be used as for
4006: the <code class="filename">INSTALL</code> file.</p></dd>
4007: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4008: <dd>
4009: <p>This file is displayed after installation of the package.
1.312 gdt 4010: While this was used often in the past, it has two
4011: problems: the display will be missed if many packages are
1.375 jkoshy 4012: installed at once, and the person installing the package
1.312 gdt 4013: and the one using or configuring it may be different. It
4014: should therefore be used only in exceptional circumstances
4015: where lasting negative consequences would result from
4016: someone not reading it.</p>
4017: <p>MESSAGE should not be used for:</p>
4018: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4019: <li class="listitem"><p>exhortations to read the documentation</p></li>
4020: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
4021: <li class="listitem"><p>anything that should be explained in the
4022: installation/configuration documentation that should
4023: come with the package</p></li>
4024: </ul></div>
4025: <p>If the documentation provided by upstream needs
1.313 leot 4026: enhancing, create e.g. files/README.pkgsrc and install it
4027: in the package's documentation directory.
1.312 gdt 4028: </p>
4029: <p>Note that MESSAGE is shown for all operating
4030: systems and all init systems. If a MESSAGE is necessary,
1.313 leot 4031: it should be narrowed to only those operating systems and
1.312 gdt 4032: init systems to which it applies.</p>
4033: <p>Note that you can modify variables in it easily by using
1.299 rillig 4034: <code class="varname">MESSAGE_SUBST</code> in the package's
4035: <code class="filename">Makefile</code>:</p>
1.91 rillig 4036: <pre class="programlisting">
1.299 rillig 4037: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.91 rillig 4038: </pre>
1.299 rillig 4039: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
4040: <code class="filename">MESSAGE</code>. By default, substitution is
4041: performed for <code class="varname">PKGNAME</code>,
4042: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4043: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4044: <code class="varname">PKG_SYSCONFDIR</code>,
4045: <code class="varname">ROOT_GROUP</code>, and
4046: <code class="varname">ROOT_USER</code>.</p>
4047: <p>You can display a different or additional files by
4048: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4049: default is <code class="filename">MESSAGE</code>, if the file
4050: exists.</p>
4051: </dd>
4052: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4053: <dd>
4054: <p>This file is used by the alternatives framework.
4055: It creates, configures, and destroys generic wrappers used to
4056: run programs with similar interfaces.
4057: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4058: for more information.</p>
4059: <p>Each line of the file contains two filenames, first
4060: the wrapper and then the alternative provided by the package.
4061: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4062: </dd>
4063: </dl></div>
4064: </div>
4065: <div class="sect2">
4066: <div class="titlepage"><div><div><h3 class="title">
4067: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
4068: <div class="variablelist"><dl class="variablelist">
4069: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4070: <dd><p>This file contains arbitrary things that could
4071: also go into a <code class="filename">Makefile</code>, but its purpose is
4072: to be used by more than one package. This file should only be
4073: used when the packages that will use the file are known in
4074: advance. For other purposes it is often better to write a
4075: <code class="filename">*.mk</code> file and give it a good name that
4076: describes what it does.</p></dd>
4077: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4078: <dd><p>This file contains the dependency information
4079: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
4080: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4081: <dd><p>This file contains workarounds for compiler bugs
4082: and similar things. It is included automatically by the pkgsrc
4083: infrastructure, so you don't need an extra
4084: <code class="literal">.include</code> line for
4085: it.</p></dd>
4086: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4087: <dd><p>This file contains the code for the
4088: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
4089: selected by the user. If a package has only one or two options,
4090: it is equally acceptable to put the code directly into the
4091: <code class="filename">Makefile</code>.</p></dd>
4092: </dl></div>
4093: </div>
4094: <div class="sect2">
4095: <div class="titlepage"><div><div><h3 class="title">
4096: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
4097: <div class="variablelist"><dl class="variablelist">
4098: <dt><span class="term"><code class="filename">README*</code></span></dt>
4099: <dd><p>These files do not take place in the creation of
4100: a package and thus are purely informative to the package
4101: developer.</p></dd>
4102: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4103: <dd><p>This file contains things that need to be done
4104: to make the package even
4105: better.</p></dd>
4106: </dl></div>
4107: </div>
4108: </div>
4109: <div class="sect1">
4110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4111: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
4112: </h2></div></div></div>
4113: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4114: unpacked into the directory denoted by
4115: <code class="varname">WRKDIR</code>. It can be removed by running
4116: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4117: directory is also used to keep various timestamp files.
4118: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4119: The default is <code class="filename">${.CURDIR}/work</code>
4120: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4121: if <code class="varname">OBJMACHINE</code> is set.</p>
1.91 rillig 4122: </div>
1.299 rillig 4123: <div class="sect1">
4124: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4125: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
4126: </h2></div></div></div>
4127: <p>If you have any files that you wish to be placed in the package
4128: prior to configuration or building, you can place these files here
4129: and use a <span class="command"><strong>${CP}</strong></span> command in the
4130: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4131: <p>If you want to share files in this way with other
4132: packages, set the <code class="varname">FILESDIR</code> variable to point
4133: to the other package's <code class="filename">files</code> directory,
4134: e.g.:</p>
1.91 rillig 4135: <pre class="programlisting">
1.299 rillig 4136: FILESDIR= ../../editors/xemacs/files
1.91 rillig 4137: </pre>
4138: </div>
4139: </div>
1.148 asau 4140: <div class="chapter">
1.75 rillig 4141: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 4142: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75 rillig 4143: <div class="toc">
4144: <p><b>Table of Contents</b></p>
1.210 leot 4145: <dl class="toc">
1.299 rillig 4146: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4147: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4148: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4149: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4150: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4151: <dd><dl>
4152: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4153: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4154: </dl></dd>
4155: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4156: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4157: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4158: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4159: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4160: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4161: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4162: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4163: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4164: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4165: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4166: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75 rillig 4167: </dl>
4168: </div>
1.148 asau 4169: <div class="sect1">
1.75 rillig 4170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4171: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4172: <p>This chapter gives a detailed description on how a package is
4173: built. Building a package is separated into different
4174: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4175: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4176: described in the following sections. Each phase is split into
4177: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4178: containing phase, prefixed by one of <code class="varname">pre-</code>,
4179: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4180: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4181: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4182: <p>Never override the regular targets (like
4183: <code class="varname">fetch</code>), if you have to, override the
4184: <code class="varname">do-*</code> ones instead.</p>
4185: <p>The basic steps for building a program are always the same. First
4186: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4187: the local system and then extracted. After any pkgsrc-specific patches
4188: to compile properly are applied, the software can be configured, then
4189: built (usually by compiling), and finally the generated binaries, etc.
4190: can be put into place on the system.</p>
4191: <p>To get more details about what is happening at each step,
4192: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4193: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4194: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4195: </div>
4196: <div class="sect1">
4197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4198: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4199: <p>Before outlining the process performed by the NetBSD package system in
4200: the next section, here's a brief discussion on where programs are
4201: installed, and which variables influence this.</p>
4202: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4203: where all files of the final program shall be installed. It is
4204: usually set to <code class="varname">LOCALBASE</code>
4205: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4206: for pkgs in the <code class="filename">cross</code> category. The value of
4207: <code class="varname">PREFIX</code> needs to be put
4208: into the various places in the program's source where paths to
4209: these files are encoded. See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> and <a class="xref" href="#fixes.libtool" title="21.3.1. Shared libraries - libtool">Section 21.3.1, “Shared libraries - libtool”</a> for more details.</p>
4210: <p>When choosing which of these variables to use,
4211: follow the following rules:</p>
1.148 asau 4212: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 4213: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4214: where the current pkg will be installed. When referring to a
4215: pkg's own installation path, use
4216: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
1.338 nia 4217: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.299 rillig 4218: are installed. If you need to construct a -I or -L argument
4219: to the compiler to find includes and libraries installed by
1.338 nia 4220: another pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.299 rillig 4221: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4222: installed all packages in <code class="filename">/usr/local</code>. As
4223: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4224: administrator, this variable is a misnomer.</p></li>
4225: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4226: distribution (from xsrc, etc.) is installed. When looking for
4227: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4228: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4229: <li class="listitem"><p>X11-based packages using imake must set
4230: <code class="varname">USE_IMAKE</code> to be installed correctly under
4231: <code class="varname">LOCALBASE</code>.</p></li>
4232: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.378 ! leot 4233: install files according to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.299 rillig 4234: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4235: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4236: </ul></div>
4237: </div>
4238: <div class="sect1">
4239: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4240: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4241: <p>When building a package, various directories are used to store
4242: source files, temporary files, pkgsrc-internal files, and so on. These
4243: directories are explained here.</p>
4244: <p>Some of the directory variables contain relative pathnames. There
4245: are two common base directories for these relative directories:
4246: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4247: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4248: inside the package itself.</p>
4249: <div class="variablelist"><dl class="variablelist">
4250: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4251: <dd><p>This is an absolute pathname that points to the pkgsrc
4252: root directory. Generally, you don't need
4253: it.</p></dd>
4254: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4255: <dd><p>This is an absolute pathname that points to the
4256: current package.</p></dd>
4257: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.343 gutterid 4258: <dd>
4259: <p>This is a pathname relative to
4260: <code class="varname">PKGSRCDIR</code> that points to the current package.
4261: It is defined after including <code class="filename">bsd.prefs.mk</code>
4262: and can be used in makefile fragments that are used by several
4263: packages to distinguish between these packages. Other variables
4264: that would serve the same purpose are <code class="varname">PKGBASE</code>
4265: and <code class="varname">PKGNAME</code>, but these are only defined after
4266: including <code class="filename">bsd.pkg.mk</code>, which is too
4267: late.</p>
4268: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
4269: <code class="varname">PKGPATH</code> to tweak variables like
4270: <code class="varname">MAKE_JOBS</code> and
4271: <code class="varname">CFLAGS</code>.</p>
4272: </dd>
1.299 rillig 4273: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4274: <dd><p>This is an absolute pathname pointing to the directory
4275: where all work takes place. The distfiles are extracted to this
4276: directory. It also contains temporary directories and log files used by
4277: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4278: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4279: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4280: <dd><p>This is an absolute pathname pointing to the directory
4281: where the distfiles are extracted. It is usually a direct subdirectory
4282: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4283: that isn't hidden. This variable may be changed by a package
4284: <code class="filename">Makefile</code>.</p></dd>
4285: </dl></div>
4286: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4287: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4288: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4289: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4290: If users would like to have their pkgsrc trees behave in a
4291: read-only manner, then the value of
4292: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4293: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 4294: </div>
1.148 asau 4295: <div class="sect1">
1.75 rillig 4296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4297: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4298: <p>You can run a particular phase by typing <span class="command"><strong>make
1.343 gutterid 4299: <em class="replaceable"><code>phase</code></em></strong></span>, where
4300: <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
4301: automatically run all phases that are required for this phase. The
4302: default phase is <code class="varname">build</code>, that is, when you run
4303: <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.299 rillig 4304: the package will be built, but not installed.</p>
1.75 rillig 4305: </div>
1.148 asau 4306: <div class="sect1">
1.75 rillig 4307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4308: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4309: <p>The first step in building a package is to fetch the
4310: distribution files (distfiles) from the sites that are providing
4311: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4312: phase.</p>
1.148 asau 4313: <div class="sect2">
1.93 rillig 4314: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 4315: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4316: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4317: defines all URLs from where the distfile, whose name is
4318: derived from the <code class="varname">DISTNAME</code> variable, is
4319: fetched. The more complicated cases are described
4320: below.</p>
4321: <p>The variable <code class="varname">DISTFILES</code> specifies
4322: the list of distfiles that have to be fetched. Its value
4323: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4324: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4325: so that most packages don't need to define it at all.
4326: <code class="varname">EXTRACT_SUFX</code> is
4327: <code class="literal">.tar.gz</code> by default, but can be changed
4328: freely. Note that if your package requires additional
4329: distfiles to the default one, you cannot just append the
4330: additional filenames using the <code class="literal">+=</code>
4331: operator, but you have write for example:</p>
4332: <pre class="programlisting">
4333: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4334: </pre>
4335: <p>Each distfile is fetched from a list of sites, usually
4336: <code class="varname">MASTER_SITES</code>. If the package has multiple
4337: <code class="varname">DISTFILES</code> or multiple
4338: <code class="varname">PATCHFILES</code> from different sites, you can
4339: set
4340: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4341: to the list of URLs where the file
4342: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4343: (including the suffix) can be found.</p>
4344: <pre class="programlisting">
4345: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4346: DISTFILES+= foo-file.tar.gz
4347: SITES.foo-file.tar.gz= \
4348: https://www.somewhere.com/somehow/ \
4349: https://www.somewhereelse.com/mirror/somehow/
4350: </pre>
4351: <p>When actually fetching the distfiles, each item from
4352: <code class="varname">MASTER_SITES</code> or
4353: <code class="varname">SITES.*</code> gets the name of each distfile
4354: appended to it, without an intermediate slash. Therefore,
4355: all site values have to end with a slash or other separator
4356: character. This allows for example to set
4357: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4358: that gets the name of the distfile as a parameter. In this
4359: case, the definition would look like:</p>
4360: <pre class="programlisting">
4361: MASTER_SITES= https://www.example.com/download.cgi?file=
4362: </pre>
4363: <p> The exception to this rule are URLs starting with a dash.
4364: In that case the URL is taken as is, fetched and the result
4365: stored under the name of the distfile. You can use this style
4366: for the case when the download URL style does not match the
4367: above common case. For example, if permanent download URL is a
4368: redirector to the real download URL, or the download file name
4369: is offered by an HTTP Content-Disposition header. In the
4370: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4371: created instead of the default
4372: <code class="filename">v1.0.0.tar.gz</code>.</p>
4373: <pre class="programlisting">
4374: DISTNAME= foo-1.0.0
4375: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4376: </pre>
4377: <p>There are some predefined values for
4378: <code class="varname">MASTER_SITES</code>, which can be used in
4379: packages. The names of the variables should speak for
4380: themselves.</p>
4381: <table border="0" summary="Simple list" class="simplelist">
4382: <tr>
4383: <td>MASTER_SITE_APACHE</td>
4384: <td>MASTER_SITE_BACKUP</td>
4385: </tr>
4386: <tr>
4387: <td>MASTER_SITE_CRATESIO</td>
4388: <td>MASTER_SITE_CYGWIN</td>
4389: </tr>
4390: <tr>
4391: <td>MASTER_SITE_DEBIAN</td>
4392: <td>MASTER_SITE_FREEBSD</td>
4393: </tr>
4394: <tr>
4395: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4396: <td>MASTER_SITE_GENTOO</td>
4397: </tr>
4398: <tr>
4399: <td>MASTER_SITE_GITHUB</td>
1.340 gutterid 4400: <td>MASTER_SITE_GITLAB</td>
4401: </tr>
4402: <tr>
1.299 rillig 4403: <td>MASTER_SITE_GNOME</td>
1.340 gutterid 4404: <td>MASTER_SITE_GNU</td>
1.299 rillig 4405: </tr>
4406: <tr>
4407: <td>MASTER_SITE_GNUSTEP</td>
1.340 gutterid 4408: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.299 rillig 4409: </tr>
4410: <tr>
4411: <td>MASTER_SITE_IFARCHIVE</td>
1.340 gutterid 4412: <td>MASTER_SITE_KDE</td>
1.299 rillig 4413: </tr>
4414: <tr>
4415: <td>MASTER_SITE_MOZILLA</td>
1.340 gutterid 4416: <td>MASTER_SITE_MOZILLA_ALL</td>
1.299 rillig 4417: </tr>
4418: <tr>
4419: <td>MASTER_SITE_MYSQL</td>
1.340 gutterid 4420: <td>MASTER_SITE_NETLIB</td>
1.299 rillig 4421: </tr>
4422: <tr>
4423: <td>MASTER_SITE_OPENBSD</td>
1.340 gutterid 4424: <td>MASTER_SITE_OPENOFFICE</td>
1.299 rillig 4425: </tr>
4426: <tr>
4427: <td>MASTER_SITE_OSDN</td>
1.340 gutterid 4428: <td>MASTER_SITE_PERL_CPAN</td>
1.299 rillig 4429: </tr>
4430: <tr>
4431: <td>MASTER_SITE_PGSQL</td>
1.340 gutterid 4432: <td>MASTER_SITE_PYPI</td>
1.299 rillig 4433: </tr>
4434: <tr>
4435: <td>MASTER_SITE_RUBYGEMS</td>
1.340 gutterid 4436: <td>MASTER_SITE_R_CRAN</td>
1.299 rillig 4437: </tr>
4438: <tr>
4439: <td>MASTER_SITE_SOURCEFORGE</td>
1.340 gutterid 4440: <td>MASTER_SITE_SUNSITE</td>
1.299 rillig 4441: </tr>
1.85 jmmv 4442: <tr>
1.299 rillig 4443: <td>MASTER_SITE_SUSE</td>
1.340 gutterid 4444: <td>MASTER_SITE_TEX_CTAN</td>
1.85 jmmv 4445: </tr>
4446: <tr>
1.299 rillig 4447: <td>MASTER_SITE_XCONTRIB</td>
1.340 gutterid 4448: <td>MASTER_SITE_XEMACS</td>
1.85 jmmv 4449: </tr>
4450: <tr>
1.299 rillig 4451: <td>MASTER_SITE_XORG</td>
1.340 gutterid 4452: <td> </td>
1.299 rillig 4453: </tr>
4454: </table>
4455: <p>Some explanations for the less self-explaining ones:
4456: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.369 wiz 4457: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.299 rillig 4458: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
4459: <p>If you choose one of these predefined sites, you may
4460: want to specify a subdirectory of that site. Since these
4461: macros may expand to more than one actual site, you
4462: <span class="emphasis"><em>must</em></span> use the following construct to
4463: specify a subdirectory:</p>
1.100 rillig 4464: <pre class="programlisting">
1.299 rillig 4465: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4466: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100 rillig 4467: </pre>
1.299 rillig 4468: <p>Note the trailing slash after the subdirectory
4469: name.</p>
4470: </div>
4471: <div class="sect2">
4472: <div class="titlepage"><div><div><h3 class="title">
4473: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4474: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4475: all the distfiles exist in a local directory
4476: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4477: user). If the files do not exist, they are fetched using
4478: commands of the form</p>
1.100 rillig 4479: <pre class="programlisting">
1.299 rillig 4480: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4481: </pre>
4482: <p>where <code class="literal">${site}</code> varies through
4483: several possibilities in turn: first,
4484: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4485: sites specified in either <code class="varname">SITES.file</code> if
4486: defined, else <code class="varname">MASTER_SITES</code> or
4487: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4488: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4489: all except the first and the last can be optionally sorted
4490: by the user, via setting either
4491: <code class="varname">MASTER_SORT_RANDOM</code>, and
4492: <code class="varname">MASTER_SORT_AWK</code> or
4493: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4494: <p> The specific command and arguments used depend on the
4495: <code class="varname">FETCH_USING</code> parameter. The example above is
4496: for <code class="literal">FETCH_USING=custom</code>.</p>
4497: <p>The distfiles mirror run by the NetBSD Foundation uses the
4498: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4499: distfiles, if they are freely distributable. Packages setting
4500: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4501: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4502: mirrored.</p>
1.85 jmmv 4503: </div>
4504: </div>
1.299 rillig 4505: <div class="sect1">
4506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4507: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4508: <p>After the distfile(s) are fetched, their checksum is
4509: generated and compared with the checksums stored in the
4510: distinfo file. If the checksums don't match, the build is
4511: aborted. This is to ensure the same distfile is used for
4512: building, and that the distfile wasn't changed, e.g. by some
4513: malign force, deliberately changed distfiles on the master
4514: distribution site or network lossage.</p>
1.75 rillig 4515: </div>
1.148 asau 4516: <div class="sect1">
1.75 rillig 4517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4518: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4519: <p>When the distfiles are present on the local system, they
4520: need to be extracted, as they usually come in the form of some
4521: compressed archive format.</p>
4522: <p>By default, all <code class="varname">DISTFILES</code> are
4523: extracted. If you only need some of them, you can set the
4524: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4525: files.</p>
4526: <p>Extracting the files is usually done by a little
4527: program, <code class="filename">mk/extract/extract</code>, which
4528: already knows how to extract various archive formats, so most
4529: likely you will not need to change anything here. But if you
4530: need, the following variables may help you:</p>
1.148 asau 4531: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4532: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4533: <dd><p>Use these variables to override the default
4534: options for an extract command, which are defined in
4535: <code class="filename">mk/extract/extract</code>.</p></dd>
4536: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4537: <dd><p>This variable can be set to
4538: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4539: (which is the default value), <code class="literal">pax</code>, or an
4540: absolute pathname pointing to the command with which tar
4541: archives should be extracted. It is preferred to choose bsdtar over gtar
4542: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 4543: </dl></div>
1.299 rillig 4544: <p>If the <code class="filename">extract</code> program doesn't
4545: serve your needs, you can also override the
4546: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4547: command used for extracting the files. This command is
4548: executed in the <code class="filename">${WRKSRC}</code>
4549: directory. During execution of this command, the shell
4550: variable <code class="varname">extract_file</code> holds the absolute
4551: pathname of the file that is going to be extracted.</p>
4552: <p>And if that still does not suffice, you can override the
4553: <code class="varname">do-extract</code> target in the package
4554: Makefile.</p>
1.75 rillig 4555: </div>
1.148 asau 4556: <div class="sect1">
1.75 rillig 4557: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4558: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4559: <p>After extraction, all the patches named by the
4560: <code class="varname">PATCHFILES</code>, those present in the patches
4561: subdirectory of the package as well as in
4562: $LOCALPATCHES/$PKGPATH (e.g.
4563: <code class="filename">/usr/local/patches/graphics/png</code>) are
4564: applied. Patchfiles ending in <code class="filename">.Z</code> or
4565: <code class="filename">.gz</code> are uncompressed before they are
4566: applied, files ending in <code class="filename">.orig</code> or
4567: <code class="filename">.rej</code> are ignored. Any special options to
1.378 ! leot 4568: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.299 rillig 4569: <code class="varname">PATCH_DIST_ARGS</code>. See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> for more details.</p>
1.378 ! leot 4570: <p>By default <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.299 rillig 4571: fail if the expected text from the patch context is not found in the
4572: patched file. If that happens, fix the patch file by comparing it
4573: with the actual text in the file to be patched.</p>
1.78 rillig 4574: </div>
1.148 asau 4575: <div class="sect1">
1.75 rillig 4576: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4577: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4578: <p>This is covered in <a class="xref" href="#tools" title="Chapter 17. Tools needed for building or running">Chapter 17, <i>Tools needed for building or running</i></a>.
4579: </p>
1.75 rillig 4580: </div>
1.148 asau 4581: <div class="sect1">
1.75 rillig 4582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4583: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4584: <p>This phase creates wrapper programs for the compilers and
4585: linkers. The following variables can be used to tweak the
4586: wrappers.</p>
4587: <div class="variablelist"><dl class="variablelist">
4588: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4589: <dd><p>The command used to print progress
4590: messages. Does nothing by default. Set to
4591: <code class="literal">${ECHO}</code> to see the progress
4592: messages.</p></dd>
4593: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4594: <dd><p>This variable can be set to
4595: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4596: depending on whether you want additional information in the
4597: wrapper log file.</p></dd>
4598: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4599: <dd><p>This variable can be set to
4600: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4601: on whether the wrapper should use its cache, which will
4602: improve the speed. The default value is
4603: <code class="literal">yes</code>, but is forced to
4604: <code class="literal">no</code> if the platform does not support
4605: it.</p></dd>
4606: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4607: <dd><p>A list of reordering commands. A reordering
4608: command has the form
4609: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4610: It ensures that that
4611: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4612: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4613: </p></dd>
4614: </dl></div>
4615: </div>
4616: <div class="sect1">
4617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4618: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4619: <p>Most pieces of software need information on the header
4620: files, system calls, and library routines which are available
4621: on the platform they run on. The process of determining this
4622: information is known as configuration, and is usually
4623: automated. In most cases, a script is supplied with the
4624: distfiles, and its invocation results in generation of header
4625: files, Makefiles, etc.</p>
4626: <p>If the package contains a configure script, this can be
4627: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4628: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4629: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.301 rillig 4630: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4631: <p>In the <code class="literal">do-configure</code> stage, a rough
4632: equivalent of the following command is run. See
4633: <code class="filename">mk/configure/configure.mk</code>, target
4634: <code class="literal">do-configure-script</code> for the exact
4635: definition.</p>
4636: <pre class="programlisting">
4637: .for dir in ${CONFIGURE_DIRS}
4638: cd ${WRKSRC} && cd ${dir} \
4639: && env ${CONFIGURE_ENV} \
4640: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299 rillig 4641: .endfor
1.100 rillig 4642: </pre>
1.299 rillig 4643: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4644: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4645: <code class="varname">WRKSRC</code>. In each of these directories, the
4646: configure script is run with the environment
4647: <code class="varname">CONFIGURE_ENV</code> and arguments
4648: <code class="varname">CONFIGURE_ARGS</code>. The variables
4649: <code class="varname">CONFIGURE_ENV</code>,
4650: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4651: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4652: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4653: package.</p>
4654: <p>If the program uses the Perl way of configuration (mainly Perl
4655: modules, but not only), i.e. a file called
4656: <code class="filename">Makefile.PL</code>, it should include
4657: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4658: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4659: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4660: <p>If the program uses an <code class="filename">Imakefile</code>
4661: for configuration, the appropriate steps can be invoked by
4662: setting <code class="varname">USE_IMAKE</code> to
4663: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4664: You can add variables to xmkmf's environment by adding them to the
4665: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4666: <p>If the program uses <code class="filename">cmake</code>
4667: for configuration, the appropriate steps can be invoked by
1.348 wiz 4668: including <code class="filename">../../devel/cmake/build.mk</code>.
1.299 rillig 4669: You can add variables to cmake's environment by adding them to the
4670: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
1.373 wiz 4671: by adding them to the <code class="varname">CMAKE_CONFIGURE_ARGS</code> variable.
1.348 wiz 4672: If you want to add arguments only for particular stages, you can use the
4673: <code class="varname">CMAKE_CONFIGURE_ARGS</code>,
4674: <code class="varname">CMAKE_BUILD_ARGS</code>, and
4675: <code class="varname">CMAKE_INSTALL_ARGS</code> variables.
4676: You can set the <code class="varname">CONFIGURE_DIRS</code> variable to the
4677: directories in which CMake should be run, relative to
4678: <code class="varname">WRKSRC</code>. This defaults to to <span class="quote">“<span class="quote">.</span>”</span>.
4679: </p>
1.374 wiz 4680: <p>Any package using the now-deprecated
4681: <code class="varname">USE_CMAKE=yes</code> should be converted.
4682: Essentially, replace with an include of
4683: <code class="filename">../../devel/cmake/build.mk</code>, prune creation of a build
4684: directory and settings to use it, and check/fix settings that
4685: intend to perform the build in a subdirectory.
4686: </p>
1.299 rillig 4687: <p>If there is no configure step at all, set
4688: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 4689: </div>
1.148 asau 4690: <div class="sect1">
1.75 rillig 4691: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4692: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301 rillig 4693: <p>For building a package, a rough equivalent of the following
4694: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4695: <code class="literal">do-build</code> for the exact definition.</p>
1.97 rillig 4696: <pre class="programlisting">
1.301 rillig 4697: .for dir in ${BUILD_DIRS}
4698: cd ${WRKSRC} && cd ${dir} \
1.299 rillig 4699: && env ${MAKE_ENV} \
1.301 rillig 4700: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299 rillig 4701: -f ${MAKE_FILE} \
4702: ${BUILD_TARGET}
4703: .endfor
1.97 rillig 4704: </pre>
1.299 rillig 4705: <p><code class="varname">BUILD_DIRS</code> (default:
4706: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4707: <code class="varname">WRKSRC</code>. In each of these directories,
4708: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4709: <code class="varname">MAKE_ENV</code> and arguments
4710: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4711: <code class="varname">MAKE_ENV</code>,
4712: <code class="varname">BUILD_MAKE_FLAGS</code>,
4713: <code class="varname">MAKE_FILE</code> and
4714: <code class="varname">BUILD_TARGET</code> may all be changed by the
4715: package.</p>
4716: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4717: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4718: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4719: default value of <code class="varname">MAKE_FILE</code> is
4720: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4721: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4722: <p>If there is no build step at all, set
4723: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.97 rillig 4724: </div>
1.148 asau 4725: <div class="sect1">
1.97 rillig 4726: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4727: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4728: <p>[TODO]</p>
1.75 rillig 4729: </div>
1.148 asau 4730: <div class="sect1">
1.75 rillig 4731: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4732: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4733: <p>Once the build stage has completed, the final step is to
4734: install the software in public directories, so users can
4735: access the programs and files.</p>
1.301 rillig 4736: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4737: of the following code is executed; see
4738: <code class="filename">mk/install/install.mk</code>, target
4739: <code class="literal">do-install</code> for the exact definition. Additionally,
4740: before and after this code, several consistency checks are run
4741: against the files-to-be-installed, see
4742: <code class="filename">mk/check/*.mk</code> for details.</p>
4743: <pre class="programlisting">
4744: .for dir in ${INSTALL_DIRS}
4745: cd ${WRKSRC} && cd ${dir} \
4746: && env ${INSTALL_ENV} ${MAKE_ENV} \
4747: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4748: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299 rillig 4749: .endfor
1.220 wiz 4750: </pre>
1.299 rillig 4751: <p>The variable's meanings are analogous to the ones in the
4752: <span class="emphasis"><em>build</em></span> phase.
4753: <code class="varname">INSTALL_DIRS</code> defaults to
4754: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4755: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4756: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4757: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4758: defined.</p>
4759: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4760: variables are useful. They are all variations of the
1.378 ! leot 4761: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.299 rillig 4762: permissions preset. <code class="varname">INSTALL</code> is the plain
4763: install command. The specialized variants, together with their
4764: intended use, are:</p>
4765: <div class="variablelist"><dl class="variablelist">
4766: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4767: <dd><p>directories that contain
4768: binaries</p></dd>
4769: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4770: <dd><p>directories that contain
4771: scripts</p></dd>
4772: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4773: <dd><p>directories that contain shared and static
4774: libraries</p></dd>
4775: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4776: <dd><p>directories that contain data
4777: files</p></dd>
4778: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4779: <dd><p>directories that contain man
4780: pages</p></dd>
4781: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4782: <dd><p>directories that contain data files for games
4783: </p></dd>
4784: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4785: <dd><p>binaries that can be stripped from debugging
4786: symbols</p></dd>
4787: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4788: <dd><p>binaries that cannot be
4789: stripped</p></dd>
4790: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4791: <dd><p>game
4792: binaries</p></dd>
4793: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4794: <dd><p>shared and static
4795: libraries</p></dd>
4796: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4797: <dd><p>data files</p></dd>
4798: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4799: <dd><p>data files for
4800: games</p></dd>
4801: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4802: <dd><p>man pages</p></dd>
4803: </dl></div>
4804: <p>Some other variables are:</p>
4805: <div class="variablelist"><dl class="variablelist">
4806: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.378 ! leot 4807: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.299 rillig 4808: when installing binaries. Any debugging sections and symbols present in
4809: binaries will be preserved.
4810: </p></dd>
4811: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4812: <dd><p>A list of directories relative to
4813: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4814: beginning of the <span class="emphasis"><em>install</em></span> phase.
4815: The package is supposed to create all needed directories itself
4816: before installing files to it and list all other directories here.
4817: </p></dd>
4818: </dl></div>
4819: <p>In the rare cases that a package shouldn't install anything,
4820: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4821: mostly relevant for packages in the <code class="filename">regress</code>
4822: category.</p>
1.75 rillig 4823: </div>
1.148 asau 4824: <div class="sect1">
1.75 rillig 4825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4826: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4827: <p>Once the install stage has completed, a binary package of
4828: the installed files can be built. These binary packages can be
4829: used for quick installation without previous compilation, e.g. by
4830: the <span class="command"><strong>make bin-install</strong></span> or by using
4831: <span class="command"><strong>pkg_add</strong></span>.</p>
4832: <p>By default, the binary packages are created in
4833: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4834: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4835: one for each category in the <code class="varname">CATEGORIES</code>
4836: variable. <code class="varname">PACKAGES</code> defaults to
4837: <code class="filename">pkgsrc/packages</code>.</p>
1.75 rillig 4838: </div>
1.148 asau 4839: <div class="sect1">
1.75 rillig 4840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4841: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4842: <p>Once you're finished with a package, you can clean the work
4843: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4844: to clean the work directories of all dependencies too, use
4845: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 4846: </div>
1.148 asau 4847: <div class="sect1">
1.75 rillig 4848: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4849: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148 asau 4850: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4851: <dt><span class="term">pre/post-*</span></dt>
4852: <dd>
4853: <p>For any of the main targets described in the previous
4854: section (configure, build, install, etc.), two auxiliary
4855: targets exist with
4856: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4857: prefix for the main target's name. These targets are
4858: invoked before and after the main target is called,
4859: allowing extra configuration or installation steps be
4860: performed from a package's Makefile, for example, which
4861: a program's configure script or install target
4862: omitted.</p>
4863: <p>About 5% of the pkgsrc packages define their custom
4864: post-extract target, another 5% define pre-configure, and 10%
4865: define post-install. The other pre/post-* targets are defined
4866: even less often.</p>
4867: </dd>
4868: <dt><span class="term">do-*</span></dt>
1.75 rillig 4869: <dd>
1.299 rillig 4870: <p>Should one of the main targets do the wrong thing,
4871: and should there be no variable to fix this, you can
4872: redefine it with the do-* target. (Note that redefining
4873: the target itself instead of the do-* target is a bad
4874: idea, as the pre-* and post-* targets won't be called
4875: anymore, etc.)</p>
4876: <p>About 15% of the pkgsrc packages override the default
4877: do-install, the other do-* targets are overridden even less
4878: often.</p>
1.75 rillig 4879: </dd>
1.299 rillig 4880: <dt><span class="term">reinstall</span></dt>
1.75 rillig 4881: <dd>
1.299 rillig 4882: <p>If you did a <span class="command"><strong>make install</strong></span> and
4883: you noticed some file was not installed properly, you
4884: can repeat the installation with this target, which will
4885: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4886: <p>This is the default value of
4887: <code class="varname">DEPENDS_TARGET</code> except in the case of
4888: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4889: package</strong></span>, where the defaults are
4890: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4891: respectively.</p>
1.75 rillig 4892: </dd>
1.299 rillig 4893: <dt><span class="term">deinstall</span></dt>
4894: <dd>
1.378 ! leot 4895: <p>This target does a <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.299 rillig 4896: current directory, effectively de-installing the
4897: package. The following variables can be used to tune the
4898: behaviour:</p>
4899: <div class="variablelist"><dl class="variablelist">
4900: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.378 ! leot 4901: <dd><p>Add a "-v" to the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.299 rillig 4902: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4903: <dd><p>Remove all packages that require (depend on)
4904: the given package. This can be used to remove any
4905: packages that may have been pulled in by a given
4906: package, e.g. if <span class="command"><strong>make deinstall
4907: DEINSTALLDEPENDS=1</strong></span> is done in
4908: <code class="filename">pkgsrc/x11/kde</code>, this is
4909: likely to remove whole KDE. Works by adding
1.378 ! leot 4910: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.299 rillig 4911: command line.</p></dd>
4912: </dl></div>
4913: </dd>
4914: <dt><span class="term">bin-install</span></dt>
4915: <dd><p>Install a binary package from local disk and via FTP
4916: from a list of sites (see the
4917: <code class="varname">BINPKG_SITES</code> variable), and do a
4918: <span class="command"><strong>make package</strong></span> if no binary package is
4919: available anywhere. The arguments given to
4920: <span class="command"><strong>pkg_add</strong></span> can be set via
4921: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4922: operation, etc.</p></dd>
4923: <dt><span class="term">install-clean</span></dt>
4924: <dd><p>This target removes the state files for the "install" and later
4925: phases so that the "install" target may be re-invoked. This can be
4926: used after editing the PLIST to install the package without
4927: rebuilding it.</p></dd>
4928: <dt><span class="term">build-clean</span></dt>
4929: <dd><p>This target removes the state files for the "build" and later
4930: phases so that the "build" target may be re-invoked.</p></dd>
4931: <dt><span class="term">update</span></dt>
4932: <dd>
4933: <p>This target causes the current package to be
4934: updated to the latest version. The package and all
4935: depending packages first get de-installed, then current
4936: versions of the corresponding packages get compiled and
4937: installed. This is similar to manually noting which
4938: packages are currently installed, then performing a
4939: series of <span class="command"><strong>make deinstall</strong></span> and
4940: <span class="command"><strong>make install</strong></span> (or whatever
4941: <code class="varname">UPDATE_TARGET</code> is set to) for these
4942: packages.</p>
4943: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4944: resume package updating in case a previous <span class="command"><strong>make
4945: update</strong></span> was interrupted for some reason.
4946: However, in this case, make sure you don't call
4947: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4948: list of dependent packages in <code class="varname">WRKDIR</code>.
4949: Otherwise, you lose the ability to automatically update
4950: the current package along with the dependent packages
4951: you have installed.</p>
4952: <p>Resuming an interrupted <span class="command"><strong>make
4953: update</strong></span> will only work as long as the package
4954: tree remains unchanged. If the source code for one of
4955: the packages to be updated has been changed, resuming
4956: <span class="command"><strong>make update</strong></span> will most certainly
4957: fail!</p>
4958: <p>The following variables can be used either on the
4959: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4960: alter the behaviour of <span class="command"><strong>make
4961: update</strong></span>:</p>
4962: <div class="variablelist"><dl class="variablelist">
4963: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4964: <dd><p>Install target to recursively use for the
4965: updated package and the dependent packages.
4966: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4967: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4968: <span class="command"><strong>make update</strong></span>. Other good
4969: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4970: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4971: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4972: endless loop!</p></dd>
4973: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4974: <dd><p>Don't clean up after updating. Useful if
4975: you want to leave the work sources of the updated
4976: packages around for inspection or other purposes.
4977: Be sure you eventually clean up the source tree
4978: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4979: or you may run into troubles with old source code
4980: still lying around on your next
4981: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4982: update</strong></span>.</p></dd>
4983: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4984: <dd><p>Deinstall each package before installing
4985: (making <code class="varname">DEPENDS_TARGET</code>). This
4986: may be necessary if the
4987: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4988: called after interrupting a running <span class="command"><strong>make
4989: update</strong></span>.</p></dd>
4990: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4991: <dd><p>Allows you to disable recursion and hardcode
4992: the target for packages. The default is
4993: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4994: facilitating a recursive update of prerequisite
4995: packages. Only set
4996: <code class="varname">DEPENDS_TARGET</code> if you want to
4997: disable recursive updates. Use
4998: <code class="varname">UPDATE_TARGET</code> instead to just
4999: set a specific target for each package to be
5000: installed during <span class="command"><strong>make update</strong></span>
5001: (see above).</p></dd>
5002: </dl></div>
5003: </dd>
5004: <dt><span class="term">clean-update</span></dt>
5005: <dd>
5006: <p>Clean the source tree for all packages that would
5007: get updated if <span class="command"><strong>make update</strong></span> was called
5008: from the current directory. This target should not be
5009: used if the current package (or any of its depending
5010: packages) have already been de-installed (e.g., after
5011: calling <span class="command"><strong>make update</strong></span>) or you may lose
5012: some packages you intended to update. As a rule of
5013: thumb: only use this target <span class="emphasis"><em>before</em></span>
5014: the first time you run <span class="command"><strong>make update</strong></span>
5015: and only if you have a dirty package tree (e.g., if you
5016: used <code class="varname">NOCLEAN</code>).</p>
5017: <p>If you are unsure about whether your tree is
5018: clean, you can either perform a <span class="command"><strong>make
5019: clean</strong></span> at the top of the tree, or use the
5020: following sequence of commands from the directory of the
5021: package you want to update (<span class="emphasis"><em>before</em></span>
5022: running <span class="command"><strong>make update</strong></span> for the first
5023: time, otherwise you lose all the packages you wanted to
5024: update!):</p>
5025: <pre class="screen">
5026: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
5027: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
5028: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
5029: </pre>
5030: <p>The following variables can be used either on the
5031: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
5032: <span class="command"><strong>make clean-update</strong></span>:</p>
5033: <div class="variablelist"><dl class="variablelist">
5034: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
5035: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
5036: reconstruct the list of directories to update for
5037: this package. Only use this if <span class="command"><strong>make
5038: update</strong></span> successfully installed all
5039: packages you wanted to update. Normally, this is
5040: done automatically on <span class="command"><strong>make
5041: update</strong></span>, but may have been suppressed by
5042: the <code class="varname">NOCLEAN</code> variable (see
5043: above).</p></dd>
5044: </dl></div>
5045: </dd>
5046: <dt><span class="term">replace</span></dt>
5047: <dd>
5048: <p>Update the installation of the current package. This
5049: differs from update in that it does not replace dependent
1.322 leot 5050: 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 5051: target to work.</p>
5052: <p><span class="emphasis"><em>Be careful when using this
5053: target!</em></span> There are no guarantees that dependent
5054: packages will still work, in particular they will most
5055: certainly break if you <span class="command"><strong>make replace</strong></span> a
5056: library package whose shared library major version changed
5057: between your installed version and the new one. For this
5058: reason, this target is not officially supported and only
5059: recommended for advanced users.</p>
5060: </dd>
5061: <dt><span class="term">info</span></dt>
1.378 ! leot 5062: <dd><p>This target invokes <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.299 rillig 5063: package. You can use this to check which version of a
5064: package is installed.</p></dd>
5065: <dt><span class="term">index</span></dt>
5066: <dd>
5067: <p>This is a top-level command, i.e. it should be used in
5068: the <code class="filename">pkgsrc</code> directory. It creates a
5069: database of all packages in the local pkgsrc tree, including
5070: dependencies, comment, maintainer, and some other useful
5071: information. Individual entries are created by running
5072: <span class="command"><strong>make describe</strong></span> in the packages'
5073: directories. This index file is saved as
5074: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
5075: verbose format by running <span class="command"><strong>make
5076: print-index</strong></span>. You can search in it with
5077: <span class="command"><strong>make search
5078: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
5079: extract a list of all packages that depend on a particular
5080: one by running <span class="command"><strong>make show-deps
5081: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
5082: <p>Running this command takes a very long time, some
5083: hours even on fast machines!</p>
5084: </dd>
5085: <dt><span class="term">readme</span></dt>
5086: <dd>
5087: <p>This target generates a
1.314 nia 5088: <code class="filename">index.html</code> file, which can be
1.322 leot 5089: 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 5090: contain references to any packages which are in the
5091: <code class="varname">PACKAGES</code> directory on the local
5092: host. The generated files can be made to refer to URLs
5093: based on <code class="varname">FTP_PKG_URL_HOST</code> and
5094: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314 nia 5095: wanted to generate <code class="filename">index.html</code>
1.299 rillig 5096: files which pointed to binary packages on the local
5097: machine, in the directory
5098: <code class="filename">/usr/packages</code>, set
5099: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
5100: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
5101: <code class="varname">${PACKAGES}</code> directory and its
5102: subdirectories will be searched for all the binary
5103: packages.</p>
5104: <p>The target can be run at the toplevel or in category
5105: directories, in which case it descends recursively.</p>
5106: </dd>
5107: <dt><span class="term">readme-all</span></dt>
5108: <dd><p>This is a top-level command, run it in
5109: <code class="filename">pkgsrc</code>. Use this target to create a
5110: file <code class="filename">README-all.html</code> which contains a
5111: list of all packages currently available in the NetBSD
5112: Packages Collection, together with the category they belong
5113: to and a short description. This file is compiled from the
1.314 nia 5114: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299 rillig 5115: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
5116: readme</strong></span>.</p></dd>
5117: <dt><span class="term">cdrom-readme</span></dt>
5118: <dd><p>This is very much the same as the
5119: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
5120: used when generating a pkgsrc tree to be written to a
5121: CD-ROM. This target also produces
1.314 nia 5122: <code class="filename">index.html</code> files, and can be made
1.299 rillig 5123: to refer to URLs based on
5124: <code class="varname">CDROM_PKG_URL_HOST</code> and
5125: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
5126: <dt><span class="term">show-distfiles</span></dt>
5127: <dd><p>This target shows which distfiles and patchfiles
5128: are needed to build the package
5129: (<code class="varname">ALLFILES</code>, which contains all
5130: <code class="varname">DISTFILES</code> and
5131: <code class="varname">PATCHFILES</code>, but not
5132: <code class="filename">patches/*</code>).</p></dd>
5133: <dt><span class="term">show-downlevel</span></dt>
5134: <dd><p>This target shows nothing if the package is not
5135: installed. If a version of this package is installed,
5136: but is not the version provided in this version of
5137: pkgsrc, then a warning message is displayed. This target
5138: can be used to show which of your installed packages are
5139: downlevel, and so the old versions can be deleted, and
5140: the current ones added.</p></dd>
5141: <dt><span class="term">show-pkgsrc-dir</span></dt>
5142: <dd><p>This target shows the directory in the pkgsrc
5143: hierarchy from which the package can be built and
5144: installed. This may not be the same directory as the one
5145: from which the package was installed. This target is
5146: intended to be used by people who may wish to upgrade
5147: many packages on a single host, and can be invoked from
5148: the top-level pkgsrc Makefile by using the
5149: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
5150: <dt><span class="term">show-installed-depends</span></dt>
5151: <dd><p>This target shows which installed packages match
5152: the current package's <code class="varname">DEPENDS</code>. Useful
5153: if out of date dependencies are causing build
5154: problems.</p></dd>
5155: <dt><span class="term">print-build-depends-list</span></dt>
5156: <dd><p>This target shows the list of packages that the current package
5157: depends on for building.</p></dd>
5158: <dt><span class="term">print-run-depends-list</span></dt>
5159: <dd><p>This target shows the list of packages that the current package
5160: depends on for running.</p></dd>
5161: <dt><span class="term">check-shlibs</span></dt>
5162: <dd><p>After a package is installed, check all its
5163: binaries and (on ELF platforms) shared libraries to see
5164: if they find the shared libs they need. Run by default
5165: 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>
5166: <dt><span class="term">print-PLIST</span></dt>
5167: <dd>
5168: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5169: upgraded pkg, this prints out an attempt to generate a
5170: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5171: -newer work/.extract_done</strong></span>. An attempt is made
5172: to care for shared libs etc., but it is
5173: <span class="emphasis"><em>strongly</em></span> recommended to review the
5174: result before putting it into
5175: <code class="filename">PLIST</code>. On upgrades, it's useful to
5176: diff the output of this command against an already
5177: existing <code class="filename">PLIST</code> file.</p>
1.378 ! leot 5178: <p>If the package installs files via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.299 rillig 5179: other methods that don't update file access times, be
5180: sure to add these files manually to your
5181: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5182: -newer</span>”</span> command used by this target won't catch
5183: them!</p>
5184: <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
5185: information on this target.</p>
5186: </dd>
1.371 cheusov 5187: <dt><span class="term">rebuild</span></dt>
5188: <dd><p>If you did a <span class="command"><strong>make build</strong></span> and you
5189: noticed some further modifications of sources are needed,
5190: you can repeat the build with this target, which will ignore
5191: the <span class="quote">“<span class="quote">already built</span>”</span> flag. This target is
5192: helpful while working with patches.</p></dd>
5193: <dt><span class="term">repackage</span></dt>
5194: <dd><p>If you did a <span class="command"><strong>make package</strong></span> and you
5195: noticed some further modifications of sources are needed,
5196: you can repeat the package with this target, which will ignore
5197: the <span class="quote">“<span class="quote">already packaged</span>”</span> flag. This target is
5198: helpful while working with patches, PLIST* files etc.</p></dd>
5199: <dt><span class="term">retest</span></dt>
5200: <dd><p>If you did a <span class="command"><strong>make test</strong></span> and you
5201: noticed some further modifications of sources are needed,
5202: you can repeat the test with this target, which will ignore
5203: the <span class="quote">“<span class="quote">already tested</span>”</span> flag. This target is
5204: helpful while working with patches.</p></dd>
1.299 rillig 5205: </dl></div>
5206: </div>
5207: </div>
5208: <div class="chapter">
5209: <div class="titlepage"><div><div><h2 class="title">
5210: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5211: <div class="toc">
5212: <p><b>Table of Contents</b></p>
5213: <dl class="toc">
5214: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5215: <dd><dl>
1.334 nia 5216: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
5217: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
5218: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.299 rillig 5219: </dl></dd>
5220: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5221: <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>
5222: </dl>
5223: </div>
5224: <p>When you find a package that is not yet in pkgsrc, you
5225: most likely have a URL from where you can download the source
5226: code. Starting with this URL, creating a package involves only a
5227: few steps.</p>
5228: <div class="procedure"><ol class="procedure" type="1">
5229: <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
5230: enable the basic quality checks.</p></li>
5231: <li class="step">
1.322 leot 5232: <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 5233: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5234: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5235: <span class="command"><strong>mkpatches</strong></span>:</p>
5236: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5237: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5238: </li>
5239: <li class="step">
5240: <p>Choose one of the top-level directories as the category in
5241: which you want to place your package. You can also create a directory of
1.334 nia 5242: your own (maybe called <code class="filename">local</code>). Change into that
5243: category directory:</p>
5244: <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 5245: </li>
5246: <li class="step">
1.334 nia 5247: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
5248: argument the URL of the distribution file (in most cases a
5249: <code class="filename">.tar.gz</code> file). This will download the distribution
5250: file and create the necessary files of the package, based on what's in
5251: the distribution file:</p>
1.299 rillig 5252: <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>
5253: </li>
5254: <li class="step">
5255: <p>Examine the extracted files to determine the dependencies of
5256: your package. Ideally, this is mentioned in some
5257: <code class="filename">README</code> file, but things may differ. For each of
5258: these dependencies, look where it exists in pkgsrc, and if there is a
5259: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5260: line to your package <code class="filename">Makefile</code> which includes that
5261: file just before the last line. If the
5262: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5263: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5264: that the package's include files and libraries are provided.</p>
1.334 nia 5265: <p>If you just need binaries from a dependent package, add a
1.299 rillig 5266: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5267: version of the dependency and where it can be found in pkgsrc. This line
5268: should be placed in the third paragraph. If the dependency is only
5269: needed for building the package, but not when using it, use
5270: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5271: instead of <code class="varname">DEPENDS</code>.
5272: The difference between <code class="varname">TOOL_DEPENDS</code> and
5273: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5274: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.334 nia 5275: packages, i.e. packages for the platform where the package is built;
1.299 rillig 5276: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.334 nia 5277: packages, i.e. packages for the platform for which the package
5278: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
5279: specifies a dependency used only for testing the resulting package
5280: built, using the upstream project's included test suite, on the native
5281: platform.
1.299 rillig 5282: Your package may then look like this:</p>
5283: <pre class="programlisting">
5284: [...]
5285:
5286: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5287: DEPENDS+= screen-[0-9]*:../../misc/screen
5288: DEPENDS+= screen>=4.0:../../misc/screen
5289:
5290: [...]
5291:
5292: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5293: .include "../../devel/glib2/buildlink3.mk"
5294: .include "../../mk/bsd.pkg.mk"
5295: </pre>
5296: </li>
5297: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5298: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5299: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5300: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5301: additional explanations.</p></li>
5302: <li class="step"><p>In many cases the package is not yet ready to build. You can
5303: 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
5304: over there, you can hopefully continue here.</p></li>
5305: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5306: directory from the extracted files. Besides these files, a lot of cache
1.334 nia 5307: files and other system information have been saved in the working
5308: directory, which may have become outdated after you edited the
1.299 rillig 5309: <code class="filename">Makefile</code>.</p></li>
5310: <li class="step">
5311: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5312: 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 5313: <p>If the extracted files from the package need to be fixed, run
5314: multiple rounds of these commands:</p>
5315: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.299 rillig 5316: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5317: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.334 nia 5318: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
5319: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.299 rillig 5320: </li>
5321: <li class="step"><p>When the package builds fine, the next step is to install
5322: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5323: everything works.</p></li>
5324: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5325: contains a list of the files that are installed by the package, is
5326: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5327: >PLIST</strong></span> to generate a probably correct list. Check
5328: the file using your preferred text editor to see if the list of
5329: files looks plausible.</p></li>
5330: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5331: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5332: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5333: had been registered in the database of installed files, but with an
5334: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5335: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5336: registered with the list of files from
5337: <code class="filename">PLIST</code>.</p></li>
5338: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5339: from above again in a single step, making sure that the PLIST is correct
5340: and the whole package is created as intended.</p></li>
1.334 nia 5341: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
5342: left to do.</p></li>
1.299 rillig 5343: <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>
5344: </ol></div>
5345: <div class="sect1">
5346: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5347: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5348: <div class="sect2">
5349: <div class="titlepage"><div><div><h3 class="title">
1.334 nia 5350: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.299 rillig 5351: <p>Python modules and programs packages are easily created using a
5352: set of predefined variables.</p>
5353: <p>
5354: If some Python versions are not supported by the software, set the
5355: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5356: that are not supported, e.g.
5357: </p>
5358: <pre class="programlisting">
5359: PYTHON_VERSIONS_INCOMPATIBLE= 27
5360: </pre>
5361: <p>
1.363 gutterid 5362: If the packaged software is a Python module, include
1.372 wiz 5363: <code class="filename">../../lang/python/wheel.mk</code>. Note per PEP-518,
1.376 wiz 5364: the minimum and default requirement to create .whl files is <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/py-setuptools/index.html" target="_top"><code class="filename">devel/py-setuptools</code></a>; however, there are various
5365: other possible tools that projects can use. Thus inclusion of
1.372 wiz 5366: <code class="filename">wheel.mk</code> does not imply these defaults are
5367: defined as <code class="varname">TOOL_DEPENDS</code>. Whatever the project
5368: specifically requires as packaging tools must be defined in the
5369: package Makefile.
1.330 wiz 5370: </p>
1.362 wiz 5371: <p>The package directory should be called
1.299 rillig 5372: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5373: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5374: </p>
5375: <pre class="programlisting">
5376: DISTNAME= foopymodule-1.2.10
5377: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5378: </pre>
1.341 gutterid 5379: <p>
5380: For software in PyPi, the name should match what PyPi specifies for
5381: "pip install software".
5382: </p>
1.299 rillig 5383: <p>If it is an application, include
5384: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5385: In order to correctly set the path to the Python interpreter, use the
5386: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5387: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5388: For example:
5389: </p>
5390: <pre class="programlisting">
5391: REPLACE_PYTHON= *.py
5392: </pre>
5393: </div>
5394: <div class="sect2">
5395: <div class="titlepage"><div><div><h3 class="title">
1.334 nia 5396: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.299 rillig 5397: <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>
5398: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.322 leot 5399: 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 5400: Individual packages (and optionally their dependencies) may be created
5401: and updated. R packages generally follow the same form, and most of
5402: the relevant information needed is contained in a
5403: <code class="filename">DESCRIPTION</code> file as part of each R package on
5404: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5405: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5406: creates or updates a package in the canonical form. The resulting
5407: package should be reviewed for correctness.</p>
5408: </div>
5409: <div class="sect2">
5410: <div class="titlepage"><div><div><h3 class="title">
1.334 nia 5411: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.299 rillig 5412: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.322 leot 5413: <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 5414: <p>If the TeXlive package name is not known, it may be useful to
5415: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5416: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5417: 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
5418: archive</a>.</p>
5419: <p>If the TeXlive package name is known, download the files from
5420: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5421: archive</a>. For package <code class="filename">foo</code>, you will need
5422: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5423: also have associated documentation packages, so download
5424: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5425: should be placed in the appropriate category directory, which is often
5426: but not always <code class="filename">print</code>. Then run the following
5427: command in the category directory.</p>
5428: <pre class="programlisting">
5429: texlive2pkg foo.tar.xz foo.doc.tar.xz
5430: </pre>
5431: <p>This will create two packages, <code class="filename">tex-foo</code> and
5432: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5433: are correct.</p>
5434: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5435: currently does not include version information in package filenames
5436: and changes their contents periodically when updates occur.
5437: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5438: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5439: main one and the corresponding documentation, upload the distfiles
5440: with the following command in each package directory.</p>
5441: <pre class="programlisting">
5442: make upload-distfiles
5443: </pre>
5444: </div>
5445: </div>
5446: <div class="sect1">
5447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5448: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5449: <div class="sect2">
5450: <div class="titlepage"><div><div><h3 class="title">
5451: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5452: <div class="sect3">
5453: <div class="titlepage"><div><div><h4 class="title">
5454: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5455: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5456: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5457: pkgsrc. As the description says it has to do with the web, the obvious
5458: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5459: <pre class="programlisting">
5460: <code class="prompt">$</code> mkdir www/nvu
5461: <code class="prompt">$</code> cd www/nvu
5462: </pre>
5463: <p>The web site says that the sources are available as a tar file, so
5464: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5465: <pre class="programlisting">
5466: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5467: </pre>
5468: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5469: below the <code class="varname">DISTNAME</code> line, as the package name should
5470: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5471: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5472: <code class="varname">COMMENT</code> fields. Then the package
5473: <code class="filename">Makefile</code> looked like that:</p>
5474: <pre class="programlisting">
5475: # $NetBSD $
5476: #
5477:
5478: DISTNAME= nvu-1.0-sources
5479: PKGNAME= nvu-1.0
5480: CATEGORIES= www
5481: MASTER_SITES= http://cvs.nvu.com/download/
5482: EXTRACT_SUFX= .tar.bz2
5483:
5484: MAINTAINER= rillig@NetBSD.org
5485: HOMEPAGE= http://cvs.nvu.com/
5486: COMMENT= Web Authoring System
5487:
5488: # url2pkg-marker (please do not remove this line.)
5489: .include "../../mk/bsd.pkg.mk"
5490: </pre>
5491: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5492: this is a workaround to prevent CVS expanding to the filename of the
5493: guide.</p>
5494: <p>Then, I quit the editor and watched pkgsrc downloading a large
5495: source archive:</p>
5496: <pre class="programlisting">
5497: url2pkg> Running "make makesum" ...
5498: => Required installed package digest>=20010302: digest-20060826 found
5499: => Fetching nvu-1.0-sources.tar.bz2
5500: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5501: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5502: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5503: url2pkg> Running "make extract" ...
5504: => Required installed package digest>=20010302: digest-20060826 found
5505: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5506: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5507: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5508: ===> Installing dependencies for nvu-1.0
5509: ===> Overriding tools for nvu-1.0
5510: ===> Extracting for nvu-1.0
5511: url2pkg> Adjusting the Makefile.
5512:
5513: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5514:
5515: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5516: </pre>
5517: </div>
5518: <div class="sect3">
5519: <div class="titlepage"><div><div><h4 class="title">
5520: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5521: <p>Now that the package has been extracted, let's see what's inside
5522: it. The package has a <code class="filename">README.txt</code>, but that only
5523: says something about mozilla, so it's probably useless for seeing what
5524: dependencies this package has. But since there is a GNU configure script
5525: in the package, let's hope that it will complain about everything it
5526: needs.</p>
5527: <pre class="programlisting">
5528: <code class="prompt">$</code> bmake
5529: => Required installed package digest>=20010302: digest-20060826 found
5530: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5531: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5532: ===> Patching for nvu-1.0
5533: ===> Creating toolchain wrappers for nvu-1.0
5534: ===> Configuring for nvu-1.0
5535: [...]
5536: configure: error: Perl 5.004 or higher is required.
5537: [...]
5538: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5539: [...]
5540: </pre>
5541: <p>That worked quite well. So I opened the package Makefile in my
5542: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5543: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5544: package have changed now, and since a perl wrapper is automatically
5545: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5546: from scratch.</p>
5547: <pre class="programlisting">
5548: <code class="prompt">$</code> bmake clean
5549: ===> Cleaning for nvu-1.0
5550: <code class="prompt">$</code> bmake
5551: [...]
5552: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5553: GNU Make. You will not be able to build Mozilla without GNU Make.
5554: [...]
5555: </pre>
5556: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5557: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5558: <pre class="programlisting">
5559: [...]
5560: checking for GTK - version >= 1.2.0... no
5561: *** Could not run GTK test program, checking why...
5562: [...]
5563: </pre>
5564: <p>Now to the other dependencies. The first question is: Where is the
5565: GTK package hidden in pkgsrc?</p>
5566: <pre class="programlisting">
5567: <code class="prompt">$</code> echo ../../*/gtk*
5568: [many packages ...]
5569: <code class="prompt">$</code> echo ../../*/gtk
5570: ../../x11/gtk
5571: <code class="prompt">$</code> echo ../../*/gtk2
5572: ../../x11/gtk2
5573: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5574: ../../x11/gtk2/buildlink3.mk
5575: </pre>
5576: <p>The first try was definitely too broad. The second one had exactly
5577: one result, which is very good. But there is one pitfall with GNOME
5578: packages. Before GNOME 2 had been released, there were already many
5579: GNOME 1 packages in pkgsrc. To be able to continue to use these
5580: packages, the GNOME 2 packages were imported as separate packages, and
5581: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5582: whether this was the case here, and indeed it was.</p>
5583: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5584: file, adding the dependency is very easy. I just inserted an
5585: <code class="literal">.include</code> line before the last line of the package
5586: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5587: <pre class="programlisting">
5588: [...]
5589: .include "../../x11/gtk2/buildlink3.mk"
5590: .include "../../mk/bsd.pkg.mk
5591: </pre>
5592: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5593: was:</p>
1.75 rillig 5594: <pre class="programlisting">
1.299 rillig 5595: [...]
5596: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5597: checking for GTK - version >= 1.2.0... no
5598: *** Could not run GTK test program, checking why...
5599: *** The test program failed to compile or link. See the file config.log for the
5600: *** exact error that occured. This usually means GTK was incorrectly installed
5601: *** or that you have moved GTK since it was installed. In the latter case, you
5602: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5603: configure: error: Test for GTK failed.
5604: [...]
1.222 sevan 5605: </pre>
1.299 rillig 5606: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5607: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5608: told me that this package really wanted to have the GNOME 1 version of
5609: GTK. If the package had looked for GTK2, it would have looked for
5610: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5611: So I changed the <code class="literal">x11/gtk2</code> to
5612: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5613: and tried again.</p>
1.119 mishka 5614: <pre class="programlisting">
1.299 rillig 5615: [...]
5616: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5617: In file included from xpidl.c:42:
5618: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5619: In file included from xpidl.c:42:
5620: xpidl.h:132: error: parse error before "IDL_ns"
5621: [...]
1.222 sevan 5622: </pre>
1.299 rillig 5623: <p>The package still does not find all of its dependencies. Now the
5624: question is: Which package provides the
5625: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119 mishka 5626: <pre class="programlisting">
1.299 rillig 5627: <code class="prompt">$</code> echo ../../*/*idl*
5628: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5629: <code class="prompt">$</code> echo ../../*/*IDL*
5630: ../../net/libIDL
1.222 sevan 5631: </pre>
1.299 rillig 5632: <p>Let's take the one from the second try. So I included the
5633: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5634: again. But the error didn't change. After digging through some of the
5635: code, I concluded that the build process of the package was broken and
5636: couldn't have ever worked, but since the Mozilla source tree is quite
5637: large, I didn't want to fix it. So I added the following to the package
5638: <code class="filename">Makefile</code> and tried again:</p>
1.197 wiz 5639: <pre class="programlisting">
1.299 rillig 5640: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5641: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.222 sevan 5642: </pre>
1.299 rillig 5643: <p>The latter line is needed because the package expects the library
5644: <code class="filename">libIDL.so</code>, but only
5645: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5646: wrapper to rewrite that on the fly.</p>
5647: <p>The next problem was related to a recent change of the FreeType
1.322 leot 5648: 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 5649: which patch files were relevant for this issue and copied them to the
5650: <code class="filename">patches</code> directory. Then I retried, fixed the
5651: patches so that they applied cleanly and retried again. This time,
5652: everything worked.</p>
1.197 wiz 5653: </div>
1.299 rillig 5654: <div class="sect3">
5655: <div class="titlepage"><div><div><h4 class="title">
5656: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87 wiz 5657: <pre class="programlisting">
1.299 rillig 5658: <code class="prompt">$</code> bmake CHECK_FILES=no install
5659: [...]
5660: <code class="prompt">$</code> bmake print-PLIST >PLIST
5661: <code class="prompt">$</code> bmake deinstall
5662: <code class="prompt">$</code> bmake install
1.222 sevan 5663: </pre>
1.299 rillig 5664: </div>
5665: </div>
1.75 rillig 5666: </div>
5667: </div>
1.148 asau 5668: <div class="chapter">
1.75 rillig 5669: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 5670: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 5671: <div class="toc">
5672: <p><b>Table of Contents</b></p>
1.210 leot 5673: <dl class="toc">
1.299 rillig 5674: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5675: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5676: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5677: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5678: <dd><dl>
5679: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5680: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5681: <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>
5682: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344 gutterid 5683: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.75 rillig 5684: </dl></dd>
5685: </dl>
5686: </div>
1.299 rillig 5687: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5688: each of which forms a well-defined part of the pkgsrc system. Using
1.378 ! leot 5689: the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 5690: like pkgsrc requires some discipline to keep the code correct and
5691: understandable.</p>
5692: <p>The basic ingredients for <code class="filename">Makefile</code>
5693: programming are variables and shell
5694: commands. Among these shell commands may even be more complex ones
1.378 ! leot 5695: like <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 5696: as intended it is necessary to quote all variables correctly when they
5697: are used.</p>
5698: <p>This chapter describes some patterns that appear quite often in
5699: <code class="filename">Makefile</code>s, including the pitfalls that come along
5700: with them.</p>
1.148 asau 5701: <div class="sect1">
1.75 rillig 5702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5703: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5704: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5705: <p>When you are creating a file as a
5706: target of a rule, always write the data to a temporary file first
5707: and finally rename that file. Otherwise there might occur an error
5708: in the middle of generating the file, and when the user runs
1.378 ! leot 5709: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 5710: regenerated properly. Example:</p>
1.75 rillig 5711: <pre class="programlisting">
1.299 rillig 5712: wrong:
5713: @echo "line 1" > ${.TARGET}
5714: @echo "line 2" >> ${.TARGET}
5715: @false
5716:
5717: correct:
5718: @echo "line 1" > ${.TARGET}.tmp
5719: @echo "line 2" >> ${.TARGET}.tmp
5720: @false
5721: @mv ${.TARGET}.tmp ${.TARGET}
1.100 rillig 5722: </pre>
1.299 rillig 5723: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5724: <code class="filename">wrong</code> will exist, although there was an error
5725: message in the first run. On the other hand, running <span class="command"><strong>make
5726: correct</strong></span> gives an error message twice, as expected.</p>
1.378 ! leot 5727: <p>You might remember that <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.299 rillig 5728: <code class="literal">${.TARGET}</code> in case of error, but this only
5729: happens when it is interrupted, for example by pressing
5730: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.378 ! leot 5731: when one of the commands fails (like <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.299 rillig 5732: </li></ul></div>
5733: </div>
5734: <div class="sect1">
5735: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5736: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5737: <p><code class="filename">Makefile</code> variables contain strings that
5738: can be processed using the five operators <code class="code">=</code>,
5739: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.378 ! leot 5740: <code class="code">!=</code>, which are described in the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.299 rillig 5741: page.</p>
5742: <p>When a variable's value is parsed from a
5743: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5744: the backslash character <code class="code">\</code> are handled specially. If a
5745: backslash is the last character in a line, that backslash is removed
5746: from the line and the line continues with the next line of the file.</p>
5747: <p>The <code class="code">#</code> character starts a comment that reaches
5748: until the end of the line. To get an actual <code class="code">#</code> character,
5749: such as in a URL, write <code class="code">\#</code> instead.</p>
5750: <p>The evaluation of variables either happens immediately or lazy.
5751: It happens immediately when the variable occurs on the right-hand
5752: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5753: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5754: In the other cases, it is evaluated lazily.</p>
5755: <p>Some of the modifiers split the string into words and then
5756: operate on the words, others operate on the string as a whole. When a
5757: string is split into words, double quotes and single quotes are
1.378 ! leot 5758: interpreted as delimiters, just like in <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.299 rillig 5759: <div class="sect2">
5760: <div class="titlepage"><div><div><h3 class="title">
5761: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5762: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5763: <li class="listitem"><p>All variable names starting with an underscore
5764: are reserved for use by the pkgsrc infrastructure. They shall
5765: not be used by packages.</p></li>
5766: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5767: lowercase variable names for the iteration
5768: variables.</p></li>
5769: <li class="listitem"><p>All list variables should have a plural name,
5770: such as <code class="varname">PKG_OPTIONS</code> or
5771: <code class="varname">DISTFILES</code>.</p></li>
5772: </ul></div>
5773: </div>
5774: </div>
5775: <div class="sect1">
5776: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5777: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5778: <div class="sect2">
5779: <div class="titlepage"><div><div><h3 class="title">
5780: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5781: <p>When adding a string that possibly contains whitespace or quotes to
5782: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5783: modifier.</p>
5784: <p>When adding another list to a list (example 2), it must not be
5785: quoted, since its elements are already quoted.</p>
1.75 rillig 5786: <pre class="programlisting">
1.299 rillig 5787: STRING= foo * bar `date`
5788: LIST= # empty
5789: ANOTHER_LIST= a=b c=d
5790:
5791: LIST+= ${STRING:Q} # 1
5792: LIST+= ${ANOTHER_LIST} # 2
1.100 rillig 5793: </pre>
1.299 rillig 5794: </div>
5795: <div class="sect2">
5796: <div class="titlepage"><div><div><h3 class="title">
5797: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5798: <p>Echoing a string containing special characters needs special
5799: work.</p>
1.75 rillig 5800: <pre class="programlisting">
1.299 rillig 5801: STRING= foo bar < > * `date` $$HOME ' "
5802: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5803:
5804: all:
5805: echo ${STRING} # 1
5806: echo ${STRING:Q} # 2
5807: printf '%s\n' ${STRING:Q}'' # 3
5808: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.100 rillig 5809: </pre>
1.299 rillig 5810: <p>Example 1 leads to a syntax error in the shell, as the characters
5811: are just copied.</p>
5812: <p>Example 2 quotes the string so that the shell interprets it
5813: correctly. But the echo command may additionally interpret strings with a
5814: leading dash or those containing backslashes.</p>
1.378 ! leot 5815: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.299 rillig 5816: interprets the format string, but not the next argument. The trailing
5817: single quotes handle the case when the string is empty. In that case, the
5818: :Q modifier would result in an empty string too, which would then be
1.378 ! leot 5819: skipped by the shell. For <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.299 rillig 5820: but other programs may care.</p>
5821: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5822: need to be quoted because the quoting has already been done
5823: when adding elements to the list.</p>
1.75 rillig 5824: </div>
1.148 asau 5825: <div class="sect2">
1.75 rillig 5826: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 5827: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5828: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5829: GNU-style configure script (especially those that call other configure
5830: scripts), it must not have leading or trailing whitespace, since
5831: otherwise the configure script gets confused. To trim leading and
5832: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5833: following example:</p>
1.75 rillig 5834: <pre class="programlisting">
1.299 rillig 5835: CPPFLAGS= # empty
5836: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5837: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 grant 5838:
1.299 rillig 5839: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 grant 5840:
1.299 rillig 5841: all:
5842: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5843: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5844: </pre>
5845: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5846: trailing whitespace because the <code class="code">+=</code> operator always adds a
5847: space.</p>
5848: </div>
5849: <div class="sect2">
5850: <div class="titlepage"><div><div><h3 class="title">
5851: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5852: <p>When a possibly empty variable is used in a shell program, it may
5853: lead to a syntax error.</p>
5854: <pre class="programlisting">
5855: EGFILES= # empty
1.87 wiz 5856:
1.299 rillig 5857: install-examples: # produces a syntax error in the shell
5858: for egfile in ${EGFILES}; do \
5859: echo "Installing $$egfile"; \
5860: done
5861: </pre>
5862: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.378 ! leot 5863: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.299 rillig 5864: To fix this syntax error, use one of the snippets below.</p>
5865: <pre class="programlisting">
1.344 gutterid 5866: EGFILES= # empty
1.87 wiz 5867:
1.299 rillig 5868: install-examples:
5869: for egfile in ${EGFILES} ""; do \
5870: [ -n "$$egfile" ] || continue; \
5871: echo "Installing $$egfile"; \
5872: done
5873: </pre>
5874: <p>In this case, an empty string is appended to the iteration list (to
5875: prevent the syntax error) and filtered out later.</p>
5876: <pre class="programlisting">
5877: EGFILES= # empty
1.87 wiz 5878:
1.299 rillig 5879: install-examples:
5880: .for egfile in ${EGFILES}
5881: echo "Installing ${egfile}"
5882: .endfor
1.100 rillig 5883: </pre>
1.299 rillig 5884: <p>If one of the filenames contains special characters, it should be
5885: enclosed in single or double quotes.</p>
5886: <p>To have a shell command test whether a make variable is empty, use
5887: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5888: </div>
1.344 gutterid 5889: <div class="sect2">
5890: <div class="titlepage"><div><div><h3 class="title">
5891: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
5892: <p>When a variable can have the values <code class="literal">yes</code> or
5893: <code class="literal">no</code>, use the following pattern to test the variable:</p>
5894: <pre class="programlisting">
5895: .if ${VAR:U:tl} == "yes"
5896: # do something
5897: .endif
5898: </pre>
5899: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
5900: can be undefined. If the variable is guaranteed to be defined, the
5901: <code class="literal">:U</code> can be omitted.</p>
5902: <p>The <code class="literal">:tl</code> modifier converts the variable value to
5903: lowercase, allowing for the values <code class="literal">yes</code>,
5904: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
5905: </div>
1.299 rillig 5906: </div>
5907: </div>
5908: <div class="chapter">
5909: <div class="titlepage"><div><div><h2 class="title">
5910: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5911: <div class="toc">
5912: <p><b>Table of Contents</b></p>
5913: <dl class="toc">
5914: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5915: <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>
5916: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5917: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5918: </dl>
1.75 rillig 5919: </div>
1.299 rillig 5920: <p>Many packages have the ability to be built to support different
5921: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5922: in pkgsrc that provides generic handling of those options that
5923: determine different ways in which the packages can be built. It's
5924: possible for the user to specify exactly which sets of options will be
5925: built into a package or to allow a set of global default options
5926: apply.</p>
5927: <p>There are two broad classes of behaviors that one might want to
5928: control via options. One is whether some particular feature is
5929: enabled in a program that will be built anyway, often by including or
5930: not including a dependency on some other package. The other is
5931: whether or not an additional program will be built as part of the
5932: package. Generally, it is better to make a split package for such
5933: additional programs instead of using options, because it enables
5934: binary packages to be built which can then be added separately. For
5935: example, the foo package might have minimal dependencies (those
5936: packages without which foo doesn't make sense), and then the foo-gfoo
5937: package might include the GTK frontend program gfoo. This is better
5938: than including a gtk option to foo that adds gfoo, because either that
5939: option is default, in which case binary users can't get foo without
5940: gfoo, or not default, in which case they can't get gfoo. With split
5941: packages, they can install foo without having GTK, and later decide to
5942: install gfoo (pulling in GTK at that time). This is an advantage to
5943: source users too, avoiding the need for rebuilds.</p>
5944: <p>Plugins with widely varying dependencies should usually be split
5945: instead of options.</p>
5946: <p>It is often more work to maintain split packages, especially if
5947: the upstream package does not support this. The decision of split
5948: vs. option should be made based on the likelihood that users will want
5949: or object to the various pieces, the size of the dependencies that are
5950: included, and the amount of work.</p>
5951: <p>A further consideration is licensing. Non-free parts, or parts
5952: that depend on non-free dependencies (especially plugins) should
5953: almost always be split if feasible.</p>
5954: <div class="sect1">
5955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5956: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5957: <p>Global default options are listed in
5958: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5959: that should be built into every package if that option is supported.
5960: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 5961: </div>
1.148 asau 5962: <div class="sect1">
1.75 rillig 5963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5964: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5965: </h2></div></div></div>
5966: <p>The following example shows how
5967: <code class="filename">bsd.options.mk</code> should be used
5968: by the hypothetical ``wibble'' package, either in the package
5969: <code class="filename">Makefile</code>, or in a file,
5970: e.g. <code class="filename">options.mk</code>, that is included by the
5971: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 5972: <pre class="programlisting">
1.299 rillig 5973: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5974: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5975: PKG_OPTIONS_OPTIONAL_GROUPS= database
5976: PKG_OPTIONS_GROUP.database= mysql pgsql
5977: PKG_SUGGESTED_OPTIONS= wibble-foo
5978: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5979: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5980:
5981: .include "../../mk/bsd.prefs.mk"
5982:
5983: # this package was previously named wibble2
5984: .if defined(PKG_OPTIONS.wibble2)
5985: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5986: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5987: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5988: .endif
5989:
5990: .include "../../mk/bsd.options.mk"
5991:
5992: # Package-specific option-handling
1.100 rillig 5993:
1.299 rillig 5994: ###
5995: ### FOO support
5996: ###
5997: .if !empty(PKG_OPTIONS:Mwibble-foo)
5998: CONFIGURE_ARGS+= --enable-foo
5999: .endif
1.100 rillig 6000:
1.299 rillig 6001: ###
6002: ### LDAP support
6003: ###
6004: .if !empty(PKG_OPTIONS:Mldap)
6005: . include "../../databases/openldap-client/buildlink3.mk"
6006: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6007: .endif
1.100 rillig 6008:
1.299 rillig 6009: ###
6010: ### database support
6011: ###
6012: .if !empty(PKG_OPTIONS:Mmysql)
6013: . include "../../mk/mysql.buildlink3.mk"
6014: .endif
6015: .if !empty(PKG_OPTIONS:Mpgsql)
6016: . include "../../mk/pgsql.buildlink3.mk"
6017: .endif
6018: </pre>
6019: <p>The first section contains the information about which build
6020: options are supported by the package, and any default options settings
6021: if needed.</p>
6022: <div class="orderedlist"><ol class="orderedlist" type="1">
6023: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.378 ! leot 6024: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 6025: options. It should be set to
6026: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6027: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6028: at the point where the options are processed.</p></li>
6029: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6030: build options supported by the package.</p></li>
6031: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6032: list of names of groups of mutually exclusive options. The options in
6033: each group are listed in
6034: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6035: The most specific setting of any option from the group takes
6036: precedence over all other options in the group. Options from the
6037: groups will be automatically added to
6038: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6039: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6040: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6041: packages will fail if no option from the group is
6042: selected.</p></li>
6043: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6044: of names of sets of options. At least one option from each set must
6045: be selected. The options in each set are listed in
6046: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6047: Options from the sets will be automatically added to
6048: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6049: fail if no option from the set is selected.</p></li>
6050: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6051: build options which are enabled by default.</p></li>
6052: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6053: of
6054: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
6055: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
6056: their option counterparts. Pairs should be added with
6057: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
6058: warning will be issued if the user uses a legacy
6059: variable.</p></li>
6060: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6061: of
6062: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
6063: pairs that map options that have been renamed to their new
6064: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
6065: the listing of global legacy options. A warning will be issued if
6066: the user uses a legacy option.</p></li>
6067: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6068: options implied by deprecated variables used. This can be used for
6069: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6070: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6071: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6072: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6073: a list of warnings about deprecated variables or options used, and
6074: what to use instead.</p></li>
6075: </ol></div>
6076: <p>A package should never modify
6077: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6078: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6079: To suggest a default set of options, use
6080: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6081: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6082: including <code class="filename">bsd.options.mk</code>. If none of
6083: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6084: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6085: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6086: happen with platform-specific options if none of them is supported on
6087: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6088: empty list and the package is otherwise treated as not using the
6089: options framework.</p>
6090: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6091: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6092: build options, properly filtered to remove unsupported and duplicate
6093: options.</p>
6094: <p>The remaining sections contain the logic that is specific to
6095: each option. The correct way to check for an option is to check
6096: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6097: <pre class="programlisting">
6098: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100 rillig 6099: </pre>
1.75 rillig 6100: </div>
1.299 rillig 6101: <div class="sect1">
6102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6103: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
6104: <p>Options that enable similar features in different packages (like
6105: optional support for a library) should use a common name in all
6106: packages that support it (like the name of the library). If another
6107: package already has an option with the same meaning, use the same
6108: name.</p>
6109: <p>Options that enable features specific to one package, where it's
6110: unlikely that another (unrelated) package has the same (or a similar)
6111: optional feature, should use a name prefixed with
6112: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6113: <p>If a group of related packages share an optional feature
6114: specific to that group, prefix it with the name of the
6115: <span class="quote">“<span class="quote">main</span>”</span> package
6116: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6117: <p>For new options, add a line to
6118: <code class="filename">mk/defaults/options.description</code>. Lines have two
6119: fields, separated by tab. The first field is the option name, the
6120: second its description. The description should be a whole sentence
6121: (starting with an uppercase letter and ending with a period) that
6122: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6123: support.</span>”</span> The file is sorted by option names.</p>
6124: </div>
6125: <div class="sect1">
6126: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6127: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
6128: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6129: different dependencies based on the options with which the package was
6130: built. For querying these options, the file
6131: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6132: typical example looks like this:</p>
1.87 wiz 6133: <pre class="programlisting">
1.299 rillig 6134: pkgbase := libpurple
6135: .include "../../mk/pkg-build-options.mk"
6136:
6137: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6138: ...
6139: .endif
1.229 sevan 6140: </pre>
1.299 rillig 6141: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6142: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6143: options of the libpurple package, which can then be queried like
6144: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6145: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6146: details.</p>
1.75 rillig 6147: </div>
6148: </div>
1.148 asau 6149: <div class="chapter">
1.75 rillig 6150: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 6151: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 6152: <div class="toc">
6153: <p><b>Table of Contents</b></p>
1.210 leot 6154: <dl class="toc">
1.299 rillig 6155: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
6156: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
6157: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75 rillig 6158: </dl>
6159: </div>
1.299 rillig 6160: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6161: by pkgsrc and also for individual packages to define what commands
6162: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6163: or for later run-time of an installed packaged (such as
6164: <code class="varname">DEPENDS</code>).
6165: If the native system provides an adequate tool, then in many cases, a pkgsrc
6166: package will not be used.</p>
6167: <p>When building a package, the replacement tools are
6168: made available in a directory (as symlinks or wrapper scripts)
6169: that is early in the executable search path. Just like the buildlink
6170: system, this helps with consistent builds.</p>
6171: <p>A tool may be needed to help build a specific package. For example,
6172: perl, GNU make (gmake) or yacc may be needed.</p>
6173: <p>Also a tool may be needed, for example, because the native system's supplied
6174: tool may be inefficient for building a package with pkgsrc.
6175: For example, a package may need GNU awk, bison (instead of
6176: yacc) or a better sed.</p>
6177: <p>The tools used by a package can be listed by running
6178: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 6179: <div class="sect1">
1.75 rillig 6180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6181: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6182: <p>The default set of tools used by pkgsrc is defined in
6183: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6184: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6185: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6186: These can be seen by running:
6187: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6188: <p>If a package needs a specific program to build
6189: then the <code class="varname">USE_TOOLS</code> variable can be used
6190: to define the tools needed.</p>
1.75 rillig 6191: </div>
1.299 rillig 6192: <div class="sect1">
6193: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6194: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6195: <p>In the following examples, the :run means that it is needed at
6196: run-time (and becomes a DEPENDS).
6197: The default is a build dependency which can be set with
6198: :build. (So in this example, it is the same as gmake:build
6199: and pkg-config:build.)</p>
1.75 rillig 6200: <pre class="programlisting">
1.299 rillig 6201: USE_TOOLS+= gmake perl:run pkg-config
1.1 grant 6202: </pre>
1.299 rillig 6203: <p>When using the tools framework, a
6204: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6205: which contains the full path to the appropriate tool. For example,
6206: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6207: on Linux systems.</p>
6208: <p>If you always need a pkgsrc version of the
6209: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6210: </p>
1.75 rillig 6211: </div>
1.299 rillig 6212: <div class="sect1">
6213: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6214: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6215: <p>When improving or porting pkgsrc to a new platform, have a look
6216: at (or create) the corresponding platform specific make file fragment under
6217: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6218: the name of the common tools. For example:</p>
1.75 rillig 6219: <pre class="programlisting">
1.299 rillig 6220: .if exists(/usr/bin/bzcat)
6221: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6222: .elif exists(/usr/bin/bzip2)
6223: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6224: .endif
6225:
6226: TOOLS_PLATFORM.true?= true # shell builtin
1.1 grant 6227: </pre>
1.75 rillig 6228: </div>
6229: </div>
1.299 rillig 6230: <div class="chapter">
6231: <div class="titlepage"><div><div><h2 class="title">
6232: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6233: <div class="toc">
6234: <p><b>Table of Contents</b></p>
6235: <dl class="toc">
6236: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6237: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6238: <dd><dl>
6239: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6240: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6241: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6242: and
6243: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6244: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6245: </dl></dd>
6246: <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 6247: <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 6248: </dl>
1.75 rillig 6249: </div>
1.299 rillig 6250: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6251: are seen by a package's configure and build processes. This is implemented
6252: in a two step process:</p>
6253: <div class="orderedlist"><ol class="orderedlist" type="1">
6254: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6255: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6256: of <code class="varname">WRKDIR</code>.</p></li>
6257: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6258: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6259: <code class="option">-L${LOCALBASE}/lib</code> into references to
6260: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6261: native compiler on some operating systems look like GCC, so that
6262: packages that expect GCC won't require modifications to build with
6263: those native compilers.</p></li>
6264: </ol></div>
6265: <p>This normalizes the environment in which a package is built so that the
6266: package may be built consistently despite what other software may be
6267: installed. Please note that the normal system header and library paths,
6268: e.g. <code class="filename">/usr/include</code>,
6269: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6270: designed to insulate the package build from non-system-supplied
6271: software.</p>
1.148 asau 6272: <div class="sect1">
1.75 rillig 6273: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6274: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6275: <p>The process of converting packages to use the buildlink3
6276: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6277: The things to keep in mind are:</p>
1.128 wiz 6278: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299 rillig 6279: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6280: instead of the actual toolchain. Some packages are tricky,
6281: and the only way to know for sure is the check
6282: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6283: wrappers are being invoked.</p></li>
6284: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6285: the package Makefile, e.g. Java VMs, standalone shells,
6286: etc., because the code to symlink files into
6287: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6288: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6289: </p></li>
6290: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6291: <code class="filename">buildlink3.mk</code> files that you list in a
6292: package's Makefile are added as dependencies for that package.
6293: </p></li>
6294: </ol></div>
6295: <p>If a dependency on a particular package is required for its libraries and
6296: headers, then we replace:</p>
6297: <pre class="programlisting">
6298: DEPENDS+= foo>=1.1.0:../../category/foo
6299: </pre>
6300: <p>with</p>
6301: <pre class="programlisting">
6302: .include "../../category/foo/buildlink3.mk"
6303: </pre>
6304: <p>The buildlink3.mk files usually define the required dependencies.
6305: If you need a newer version of the dependency when using buildlink3.mk
6306: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 6307: <pre class="programlisting">
1.299 rillig 6308: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6309: .include "../../category/foo/buildlink3.mk"
1.1 grant 6310: </pre>
1.299 rillig 6311: <p>There are several <code class="filename">buildlink3.mk</code>
6312: files in <code class="filename">pkgsrc/mk</code>
6313: that handle special package issues:</p>
6314: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6315: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6316: the native or a pkgsrc Berkeley DB implementation based on
6317: the values of <code class="varname">BDB_ACCEPTED</code> and
6318: <code class="varname">BDB_DEFAULT</code>.</p></li>
6319: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6320: comes with neither Curses nor NCurses, this will take care
1.322 leot 6321: 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 6322: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6323: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6324: adding a dependency on Heimdal or MIT-krb5 for packages that
6325: require a Kerberos 5 implementation.</p></li>
6326: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6327: system-provided Motif installation or adds a dependency on
1.322 leot 6328: <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 6329: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6330: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6331: to choose which Motif version will be used.</p></li>
6332: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6333: system-provided GNU readline or editline (libedit) installation,
1.322 leot 6334: 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>,
6335: <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 6336: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6337: If your package really needs GNU readline library, its Makefile
6338: should include <code class="filename">devel/readline/buildlink3.mk</code>
6339: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6340: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6341: variables that may be used by packages that use the
6342: Open Sound System (OSS) API.</p></li>
6343: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6344: any of the Postgres versions in the variable
6345: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6346: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6347: the file for more information.</p></li>
6348: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6349: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.322 leot 6350: 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 6351: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6352: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6353: library.</p></li>
6354: </ul></div>
6355: <p>The comments in those <code class="filename">buildlink3.mk</code>
6356: files provide a more complete
6357: description of how to use them properly.</p>
1.75 rillig 6358: </div>
1.148 asau 6359: <div class="sect1">
1.75 rillig 6360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6361: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6362: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6363: included by Makefiles to indicate the need to compile and link
6364: against header files and libraries provided by the package. A
6365: <code class="filename">buildlink3.mk</code> file should always provide
6366: enough information to add the correct type of dependency
6367: relationship and include any other
6368: <code class="filename">buildlink3.mk</code> files that it needs to find
6369: headers and libraries that it needs in turn.</p>
6370: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.322 leot 6371: 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 6372: package is highly recommended. For most packages, the following
6373: command will generate a good starting point for
6374: <code class="filename">buildlink3.mk</code> files:</p>
6375: <pre class="screen">
6376: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6377: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6378: </pre>
1.148 asau 6379: <div class="sect2">
1.75 rillig 6380: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6381: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6382: <p>The following real-life example
6383: <code class="filename">buildlink3.mk</code> is taken
6384: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 6385: <pre class="programlisting">
1.299 rillig 6386: BUILDLINK_TREE+= tiff
6387:
6388: .if !defined(TIFF_BUILDLINK3_MK)
6389: TIFF_BUILDLINK3_MK:=
6390:
6391: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6392: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6393: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6394:
6395: .include "../../devel/zlib/buildlink3.mk"
6396: .include "../../graphics/jpeg/buildlink3.mk"
6397: .endif # TIFF_BUILDLINK3_MK
6398:
6399: BUILDLINK_TREE+= -tiff
1.1 grant 6400: </pre>
1.299 rillig 6401: <p>The header and footer manipulate
6402: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6403: <code class="filename">buildlink3.mk</code> files and is used to track
6404: the dependency tree.</p>
6405: <p>The main section is protected from multiple inclusion
6406: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6407: added. Several important variables are set in the section:</p>
6408: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6409: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6410: is the dependency version recorded in the installed
1.299 rillig 6411: package; this should always be set using
6412: <span class="command"><strong>+=</strong></span> to ensure that
6413: we're appending to any pre-existing list of values. This
1.300 wiz 6414: variable should be set to the last version of the
1.299 rillig 6415: package that had an backwards-incompatible API change.
6416: </p></li>
6417: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6418: is the location of the <em class="replaceable"><code>pkg</code></em>
6419: pkgsrc directory.</p></li>
6420: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6421: (not shown above) controls whether we use
1.350 gutterid 6422: <code class="varname">BUILD_DEPENDS</code> or
1.299 rillig 6423: <code class="varname">DEPENDS</code> to add the dependency on
6424: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6425: selected by setting
6426: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.350 gutterid 6427: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.299 rillig 6428: used.</p></li>
6429: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6430: and
6431: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6432: (not shown above) are lists of subdirectories of
6433: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6434: to add to the header and library search paths. These
6435: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6436: respectively.</p></li>
6437: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6438: (not shown above) is the list of preprocessor flags to add
6439: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6440: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6441: should be avoided and instead be handled using
6442: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6443: above.</p></li>
6444: </ul></div>
6445: <p>The following variables are all optionally defined within
6446: this second section (protected against multiple inclusion) and
6447: control which package files are symlinked into
6448: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6449: transformed during the symlinking:</p>
6450: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6451: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6452: (not shown above) is a shell glob pattern relative to
6453: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6454: to be symlinked into
6455: <code class="filename">${BUILDLINK_DIR}</code>,
6456: e.g. <code class="filename">include/*.h</code>.</p></li>
6457: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6458: (not shown above) is a shell pipeline that
6459: outputs to stdout a list of files relative to
6460: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6461: The resulting files are to be symlinked
6462: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6463: this takes the <code class="filename">+CONTENTS</code> of a
6464: <em class="replaceable"><code>pkg</code></em> and filters it through
6465: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6466: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6467: (not shown above) is a filter command that filters
6468: <code class="filename">+CONTENTS</code> input into a list of files
6469: relative to
6470: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6471: on stdout. By default,
6472: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6473: outputs the contents of the <code class="filename">include</code>
6474: and <code class="filename">lib</code> directories in the package
6475: <code class="filename">+CONTENTS</code>.</p></li>
6476: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6477: (not shown above) is a list of sed arguments used to
6478: transform the name of the source filename into a
6479: destination filename, e.g. <span class="command"><strong>-e
6480: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6481: </ul></div>
6482: <p>This section can additionally include any
6483: <code class="filename">buildlink3.mk</code> needed for
6484: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6485: Including these <code class="filename">buildlink3.mk</code> files
6486: means that the headers and libraries for these
6487: dependencies are also symlinked into
6488: <code class="filename">${BUILDLINK_DIR}</code>
6489: whenever the <em class="replaceable"><code>pkg</code></em>
6490: <code class="filename">buildlink3.mk</code>
6491: file is included. Dependencies are only added for directly
6492: include <code class="filename">buildlink3.mk</code> files.</p>
6493: <p>When providing a <code class="filename">buildlink3.mk</code> and
6494: including other <code class="filename">buildlink3.mk</code> files in it,
6495: please only add necessary ones, i.e., those whose libraries or
6496: header files are automatically exposed when the package is
6497: use.</p>
6498: <p>In particular, if only an executable
6499: (<code class="filename">bin/foo</code>) is linked against a library, that
6500: library does not need to be propagated in the
6501: <code class="filename">buildlink3.mk</code> file.</p>
6502: <p>The following steps should help you decide if a
6503: <code class="filename">buildlink3.mk</code> file needs to be included:
6504: </p>
6505: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6506: <li class="listitem"><p>Look at the installed header files: What
6507: headers do they include? The packages providing these files
6508: must be buildlinked.</p></li>
6509: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6510: libraries and look against what other libraries they link.
6511: Some of the packages providing these probably need to be
6512: buildlinked; however, it's not automatic, since e.g. GTK on
6513: some systems pulls in the X libraries, so they will show up in
6514: the <code class="filename">ldd</code> output, while on others (like OS
6515: X) it won't. <code class="filename">ldd</code> output can thus only be
6516: used as a hint.</p></li>
6517: </ul></div>
6518: <p>
6519: </p>
6520: </div>
1.148 asau 6521: <div class="sect2">
1.75 rillig 6522: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6523: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6524: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6525: and
6526: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6527: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300 wiz 6528: <p>Both variables set lower bounds for a version of this package.
6529: The two variables differ in that one describes source
1.299 rillig 6530: compatibility (API) and the other binary compatibility (ABI).
6531: The difference is that a change in the API breaks compilation of
6532: programs while changes in the ABI stop compiled programs from
6533: running.</p>
1.300 wiz 6534: <p>The
6535: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6536: variable in a <code class="filename">buildlink3.mk</code> should be
6537: changed very rarely. (One possible scenario: If all packages
6538: using this package need a higher version than defined in the
6539: <code class="filename">buildlink3.mk</code>,
1.299 rillig 6540: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6541: could be updated to that higher version.)</p>
6542: <p>On the other hand, changes to
1.299 rillig 6543: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6544: are more common. The variable will need to be updated every
6545: time the major version of one of its shared libraries is changed,
6546: or any other change where a binary built against the previous
6547: version of the package will not run against the new version any
6548: longer.</p>
6549: <p>In such a case, the package's
1.299 rillig 6550: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6551: must be increased to require the new package version. Then the
6552: <code class="varname">PKGREVISION</code> of all packages
6553: <em class="replaceable"><code>foo</code></em> that depend on this package need
6554: to be increased, and if they have
6555: <code class="filename">buildlink3.mk</code> files,
6556: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6557: in their <code class="filename">buildlink3.mk</code> files must be
6558: increased to the new version as well. This is required so that a
6559: package will pull in the versions of the packages that use the
6560: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6561: uniquely identify the packages built against the new ABI. The
1.322 leot 6562: <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 6563: help with these updates.</p>
6564: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6565: about dependencies on other packages, including the
6566: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299 rillig 6567: <p>Please take careful consideration before adjusting
6568: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6569: or
6570: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6571: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6572: cause unneeded package deletions and rebuilds. In many cases,
6573: new versions of packages work just fine with older
6574: dependencies.</p>
1.326 gutterid 6575: <p>Also, it is not needed to set
1.299 rillig 6576: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6577: when it is identical to
1.326 gutterid 6578: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
6579: <p>Note there is also the distinction that users are able to disable
6580: enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
6581: variable, but there is no equivalent option for API dependencies.</p>
1.75 rillig 6582: </div>
6583: </div>
1.148 asau 6584: <div class="sect1">
1.75 rillig 6585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6586: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6587: <p>Some packages in pkgsrc install headers and libraries that
6588: coincide with headers and libraries present in the base system.
6589: Aside from a <code class="filename">buildlink3.mk</code> file, these
6590: packages should also include a <code class="filename">builtin.mk</code>
6591: file that includes the necessary checks to decide whether using
6592: the built-in software or the pkgsrc software is
6593: appropriate.</p>
6594: <p>The only requirements of a builtin.mk file for
6595: <em class="replaceable"><code>pkg</code></em> are:</p>
6596: <div class="orderedlist"><ol class="orderedlist" type="1">
6597: <li class="listitem"><p>It should set
6598: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6599: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6600: after it is included.</p></li>
6601: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6602: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6603: which is already set before the
6604: <code class="filename">builtin.mk</code> file is included.</p></li>
6605: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6606: is <span class="emphasis"><em>very</em></span> important and takes careful
6607: attention to <code class="filename">Makefile</code> coding.</p></li>
6608: </ol></div>
6609: <div class="sect2">
6610: <div class="titlepage"><div><div><h3 class="title">
6611: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6612: <p>The following is the recommended template for builtin.mk
6613: files:</p>
1.75 rillig 6614: <pre class="programlisting">
1.299 rillig 6615: .if !defined(IS_BUILTIN.foo)
6616: #
6617: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6618: # genuinely exists in the system or not.
6619: #
6620: IS_BUILTIN.foo?= no
1.100 rillig 6621:
1.299 rillig 6622: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6623: # version can be determined.
6624: #
6625: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6626: BUILTIN_PKG.foo?= foo-1.0
6627: . endif
6628: .endif # IS_BUILTIN.foo
1.100 rillig 6629:
1.299 rillig 6630: .if !defined(USE_BUILTIN.foo)
6631: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6632: . if defined(BUILTIN_PKG.foo)
6633: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6634: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6635: USE_BUILTIN.foo!= \
6636: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6637: && ${ECHO} "yes" || ${ECHO} "no"
6638: . endif
6639: . endfor
6640: . endif
6641: .endif # USE_BUILTIN.foo
1.100 rillig 6642:
1.299 rillig 6643: CHECK_BUILTIN.foo?= no
6644: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6645: #
6646: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6647: # "yes" or "no".
6648: #
6649: .endif # CHECK_BUILTIN.foo
1.75 rillig 6650: </pre>
1.299 rillig 6651: <p>The first section sets
6652: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6653: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6654: in the base system. This should not be a base system software
6655: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6656: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6657: included as part of the base system. This variable is only
6658: used internally within the <code class="filename">builtin.mk</code>
6659: file.</p>
6660: <p>The second section sets
6661: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6662: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6663: system if it exists (if
6664: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6665: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6666: within the <code class="filename">builtin.mk</code> file.</p>
6667: <p>The third section sets
6668: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6669: and is <span class="emphasis"><em>required</em></span> in all
6670: <code class="filename">builtin.mk</code> files. The code in this
6671: section must make the determination whether the built-in
6672: software is adequate to satisfy the dependencies listed in
6673: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6674: This is typically done by comparing
6675: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6676: against each of the dependencies in
6677: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6678: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6679: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6680: end of the <code class="filename">builtin.mk</code> file. Note that
6681: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6682: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6683: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6684: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6685: that the built-in version of the software is similar enough to
6686: be used as a replacement.</p>
6687: <p>The last section is guarded by
6688: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6689: and includes code that uses the value of
6690: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6691: set in the previous section. This typically includes, e.g.,
6692: adding additional dependency restrictions and listing additional
6693: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6694: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6695: </div>
1.107 rillig 6696: </div>
1.75 rillig 6697: </div>
1.148 asau 6698: <div class="chapter">
1.75 rillig 6699: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 6700: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75 rillig 6701: <div class="toc">
6702: <p><b>Table of Contents</b></p>
1.210 leot 6703: <dl class="toc">
1.299 rillig 6704: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6705: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6706: <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>
6707: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6708: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6709: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6710: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6711: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6712: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75 rillig 6713: </dl>
6714: </div>
1.299 rillig 6715: <p>The <code class="filename">PLIST</code> file contains a package's
6716: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6717: the package (relative to the <code class="filename">${PREFIX}</code>
6718: directory it's been installed in) plus some additional statements
1.378 ! leot 6719: - see the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.299 rillig 6720: This chapter addresses some issues that need attention when
6721: dealing with the <code class="filename">PLIST</code> file (or files, see
6722: below!).</p>
1.148 asau 6723: <div class="sect1">
1.75 rillig 6724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6725: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6726: <p>Be sure to add a RCS ID line as the first thing in any
6727: <code class="filename">PLIST</code> file you write:</p>
6728: <pre class="programlisting">
6729: @comment $NetBSD $
6730: </pre>
6731: <p>An artificial space has been added between NetBSD and $, this is a
6732: workaround here to prevent CVS expanding to the filename of the guide. When
6733: adding the RCS ID the space should be omitted.</p>
1.75 rillig 6734: </div>
1.148 asau 6735: <div class="sect1">
1.75 rillig 6736: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6737: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6738: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6739: to output a PLIST that matches any new files since the package
6740: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6741: more information on this target.</p>
1.75 rillig 6742: </div>
1.148 asau 6743: <div class="sect1">
1.75 rillig 6744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6745: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6746: </h2></div></div></div>
6747: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6748: of AWK patterns and actions that are used to filter the output of
6749: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6750: scripting you like to it, but be careful with quoting.</p>
6751: <p>For example, to get all files inside the
6752: <code class="filename">libdata/foo</code> directory removed from the
6753: resulting PLIST:</p>
1.88 wiz 6754: <pre class="programlisting">
1.299 rillig 6755: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.100 rillig 6756: </pre>
1.300 wiz 6757: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6758: evaluated after the file list and directory list are sorted.
6759: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6760: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6761: list and directory list are sorted.</p>
1.299 rillig 6762: </div>
6763: <div class="sect1">
6764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6765: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6766: <p>A number of variables are substituted automatically in
6767: PLISTs when a package is installed on a system. This includes the
6768: following variables:</p>
6769: <div class="variablelist"><dl class="variablelist">
6770: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6771: <dd>
6772: <p>Some packages like emacs and perl embed information
6773: about which architecture they were built on into the
6774: pathnames where they install their files. To handle this
6775: case, PLIST will be preprocessed before actually used, and
6776: the symbol
6777: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6778: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6779: same is done if the string
6780: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6781: PLIST somewhere - use this on packages that have GNU
6782: autoconf-created configure scripts.</p>
6783: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6784: <h3 class="title">Legacy note</h3>
6785: <p>There used to be a symbol
6786: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6787: was replaced by the output of <span class="command"><strong>uname
6788: -m</strong></span>, but that's no longer supported and has
6789: been removed.</p>
6790: </div>
6791: </dd>
6792: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6793: <dd>
6794: <p>Some packages want to embed the OS name and version
6795: into some paths. To do this, use these variables in the
6796: <code class="filename">PLIST</code>:
6797: </p>
6798: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6799: <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>
6800: <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>
6801: <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>
6802: </ul></div>
6803: </dd>
6804: </dl></div>
6805: <p>For a list of values which are replaced by
6806: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6807: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6808: <code class="varname">PLIST_SUBST</code> should help.</p>
6809: <p>If you want to change other variables not listed above, you
6810: can add variables and their expansions to this variable in the
6811: 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 6812: <pre class="programlisting">
1.299 rillig 6813: PLIST_SUBST+= SOMEVAR="somevalue"
1.100 rillig 6814: </pre>
1.299 rillig 6815: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6816: in the <code class="filename">PLIST</code> with
6817: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6818: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6819: the common case of conditionally including some
6820: <code class="filename">PLIST</code> entries. It can be done by adding
6821: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6822: setting the corresponding <code class="varname">PLIST.foo</code> variable
6823: to <code class="literal">yes</code> if the entry should be included.
6824: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6825: in the <code class="filename">PLIST</code> with either
6826: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6827: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6828: For example, in <code class="filename">Makefile</code>:</p>
1.174 asau 6829: <pre class="programlisting">
1.299 rillig 6830: PLIST_VARS+= foo
6831: .if <em class="replaceable"><code>condition</code></em>
6832: PLIST.foo= yes
6833: .else
1.174 asau 6834: </pre>
1.299 rillig 6835: <p>And then in <code class="filename">PLIST</code>:</p>
1.81 rillig 6836: <pre class="programlisting">
1.299 rillig 6837: @comment $NetBSD $
6838: bin/bar
6839: man/man1/bar.1
6840: ${PLIST.foo}bin/foo
6841: ${PLIST.foo}man/man1/foo.1
6842: ${PLIST.foo}share/bar/foo.data
1.100 rillig 6843: </pre>
1.299 rillig 6844: <p>An artificial space has been added between NetBSD and $, this is a
6845: workaround here to prevent CVS expanding to the filename of the guide. When
1.309 gutterid 6846: adding the RCS ID the space should be omitted.</p>
1.81 rillig 6847: </div>
1.299 rillig 6848: <div class="sect1">
6849: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6850: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6851: <p>Man pages should be installed in compressed form if
6852: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6853: and uncompressed otherwise. To handle this in the
6854: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6855: appended/removed automatically for man pages according to
6856: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6857: or not, see above for details. This modification of the
6858: <code class="filename">PLIST</code> file is done on a copy of it, not
6859: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 6860: </div>
1.148 asau 6861: <div class="sect1">
1.75 rillig 6862: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6863: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6864: </h2></div></div></div>
6865: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6866: in generating the binary package, set the variable
6867: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.378 ! leot 6868: The files are later concatenated using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.299 rillig 6869: important. The default for <code class="varname">PLIST_SRC</code> is
6870: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 6871: </div>
1.148 asau 6872: <div class="sect1">
1.75 rillig 6873: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6874: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6875: <p>Some packages decide to install a different set of files based on
6876: the operating system being used. These differences can be
6877: automatically handled by using the following files:</p>
6878: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6879: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6880: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6881: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6882: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6883: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6884: </ul></div>
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="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6889: <p>Some packages decide to generate hard-to-guess file names
6890: during installation that are hard to wire down.</p>
6891: <p>In such cases, you can set the
6892: <code class="varname">GENERATE_PLIST</code> variable to shell code
6893: terminated (with a semicolon) that will output PLIST entries which
6894: will be appended to the PLIST</p>
6895: <p>You can find one example in editors/xemacs:</p>
6896: <pre class="programlisting">
6897: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6898: </pre>
6899: <p>which will append something like
6900: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6901: <code class="filename">PLIST</code>.
6902: </p>
1.75 rillig 6903: </div>
1.148 asau 6904: <div class="sect1">
1.75 rillig 6905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6906: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6907: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6908: multiple (and unrelated) packages install files. These
6909: directories were problematic because you had to add special
6910: tricks in the PLIST to conditionally remove them, or have some
6911: centralized package handle them.</p>
6912: <p>In pkgsrc, it is now easy: Each package should create
6913: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6914: will remove any directories left empty after uninstalling a
6915: package.</p>
6916: <p>If a package needs an empty directory to work, create
6917: the directory during installation as usual, and also add an
6918: entry to the PLIST:
6919:
6920: </p>
6921: <pre class="programlisting">
6922: @pkgdir path/to/empty/directory
6923: </pre>
6924: <p>
6925:
6926: or take a look at <code class="varname">MAKE_DIRS</code> and
6927: <code class="varname">OWN_DIRS</code>.
1.88 wiz 6928: </p>
1.75 rillig 6929: </div>
1.299 rillig 6930: </div>
6931: <div class="chapter">
6932: <div class="titlepage"><div><div><h2 class="title">
6933: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6934: <div class="toc">
6935: <p><b>Table of Contents</b></p>
6936: <dl class="toc">
6937: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6938: <dd><dl>
6939: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6940: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6941: </dl></dd>
6942: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6943: <dd><dl>
6944: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6945: <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 6946: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
6947: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
6948: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.299 rillig 6949: </dl></dd>
6950: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6951: <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>
6952: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6953: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6954: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6955: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6956: <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>
6957: </dl>
6958: </div>
6959: <p>This chapter describes the framework known as
6960: <code class="literal">pkginstall</code>, whose key features are:</p>
6961: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6962: <li class="listitem"><p>Generic installation and manipulation of directories and files
6963: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6964: <li class="listitem"><p>Automatic handling of configuration files during installation,
6965: provided that packages are correctly designed.</p></li>
6966: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6967: <li class="listitem"><p>Registration of system users and groups.</p></li>
6968: <li class="listitem"><p>Registration of system shells.</p></li>
6969: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6970: </ul></div>
6971: <p>The following sections inspect each of the above points in detail.</p>
6972: <p>You may be thinking that many of the things described here could be
6973: easily done with simple code in the package's post-installation target
6974: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6975: as the code in them is only executed when building from source. Machines
6976: using binary packages could not benefit from it at all (as the code itself
6977: could be unavailable). Therefore, the only way to achieve any of the items
6978: described above is by means of the installation scripts, which are
6979: automatically generated by pkginstall.</p>
1.148 asau 6980: <div class="sect1">
1.75 rillig 6981: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6982: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6983: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6984: of files and directories that belong to a package. The names used in it
6985: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6986: which means that it cannot register files outside this directory (absolute
6987: path names are not allowed). Despite this restriction, some packages need
6988: to install files outside this location; e.g., under
6989: <code class="filename">${VARBASE}</code> or
6990: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6991: is to create such files during installation time by using
6992: installation scripts.</p>
6993: <p>The generic installation scripts are shell scripts that can
6994: contain arbitrary code. The list of scripts to execute is taken from
6995: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6996: <code class="filename">INSTALL</code>. A similar variable exists for package
6997: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6998: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6999: commands, so they have the potential to create and manage files
7000: anywhere in the file system.</p>
7001: <p>Using these general installation files is not recommended, but
7002: may be needed in some special cases. One reason for avoiding them is
7003: that the user has to trust the packager that there is no unwanted or
7004: simply erroneous code included in the installation script. Also,
7005: previously there were many similar scripts for the same functionality,
7006: and fixing a common error involved finding and changing all of
7007: them.</p>
7008: <p>The pkginstall framework offers another, standardized way. It
7009: provides generic scripts to abstract the manipulation of such files
7010: and directories based on variables set in the package's
7011: <code class="filename">Makefile</code>. The rest of this section describes
7012: these variables.</p>
7013: <div class="sect2">
7014: <div class="titlepage"><div><div><h3 class="title">
7015: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
7016: <p>The following variables can be set to request the creation of
7017: directories anywhere in the file system:</p>
7018: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7019: <li class="listitem">
7020: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
7021: contain a list of directories that should be created and should attempt
7022: to be destroyed by the installation scripts. The difference between
7023: the two is that the latter prompts the administrator to remove any
7024: directories that may be left after deinstallation (because they were
7025: not empty), while the former does not. Example:</p>
7026: <pre class="programlisting">
7027: MAKE_DIRS+= ${VARBASE}/foo/private
7028: </pre>
7029: </li>
7030: <li class="listitem">
7031: <p><code class="varname">MAKE_DIRS_PERMS</code> and
7032: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
7033: which directories should be created and should attempt to be destroyed
7034: by the installation scripts. Each tuple holds the following values,
7035: separated by spaces: the directory name, its owner, its group and its
7036: numerical mode. For example:</p>
7037: <pre class="programlisting">
7038: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
7039: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
7040: </pre>
7041: <p>The difference between the two is exactly the same as their
7042: non-<code class="varname">PERMS</code> counterparts.</p>
7043: </li>
7044: </ul></div>
1.75 rillig 7045: </div>
1.299 rillig 7046: <div class="sect2">
7047: <div class="titlepage"><div><div><h3 class="title">
7048: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
7049: <p>Creating non-empty files outside the installation prefix is tricky
7050: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.353 dholland 7051: To overcome this problem, the only solution is to extract the file in a
1.299 rillig 7052: known place (i.e., inside the installation prefix) and copy it to the
7053: appropriate location during installation (done by the installation scripts
1.353 dholland 7054: generated by pkginstall). We will call the former the <span class="emphasis"><em>reference
1.299 rillig 7055: file</em></span> in the following paragraphs, which describe the variables
7056: that can be used to automatically and consistently handle files outside the
7057: installation prefix:</p>
7058: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.353 dholland 7059: <li class="listitem"><p><code class="varname">REQD_FILES</code> is a list of pairs of reference
7060: and target files. At installation time, the reference file is copied
7061: to the target if and only if the latter does not exist. Upon
7062: deinstallation, the reference file is removed provided that it was
7063: not modified by the installation.</p></li>
1.299 rillig 7064: <li class="listitem">
1.353 dholland 7065: <p><code class="varname">REQD_FILES_PERMS</code> contains tuples describing
7066: reference files and targets, including owner, group, and numeric
7067: permissions that should be set. For example:</p>
1.88 wiz 7068: <pre class="programlisting">
1.299 rillig 7069: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
7070: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100 rillig 7071: </pre>
1.299 rillig 7072: </li>
1.353 dholland 7073: <li class="listitem"><p><code class="varname">CONF_FILES</code> and
7074: <code class="varname">CONF_FILES_PERMS</code> have the same syntax as
7075: <code class="varname">REQD_FILES</code> and
7076: <code class="varname">REQD_FILES_PERMS</code> respectively. The difference
7077: is that these variables are specifically intended for handling
7078: configuration files, for which additional conventions and
7079: constraints apply. See <a class="xref" href="#conf-files" title="20.2. Configuration files">Section 20.2, “Configuration files”</a> for further
7080: discussion. Note in particular that while handling of
7081: 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
7082: <code class="varname">REQD_FILES</code> and
7083: <code class="varname">REQD_FILES_PERMS</code>.</p></li>
1.299 rillig 7084: </ul></div>
1.353 dholland 7085: <p>To install an empty file, one can use these macros and
7086: <code class="filename">/dev/null</code> as the reference file.</p>
1.299 rillig 7087: </div>
1.75 rillig 7088: </div>
1.148 asau 7089: <div class="sect1">
1.75 rillig 7090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7091: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
1.353 dholland 7092: <p>There are two principles that govern the handling of
7093: configuration files in pkgsrc: first, the user's configuration must
7094: not be lost or overwritten by upgrades or reinstallations; and second,
7095: the default configuration should always be available for reference.
7096: To that end, pkgsrc has a framework specifically for handling
7097: configuration files. In general, configuration files are installed
7098: into <code class="filename">${PREFIX}/share/examples</code>, and copied from
7099: there to the pertinent <code class="filename">etc</code> directory as a
7100: separate step and only as needed.</p>
7101: <p>To make this work, there are three things that need to happen,
7102: any of which may require patching. First, the package must be told to
7103: read its configuration from the correct place at runtime; this place
7104: is <code class="filename">${PKG_SYSCONFDIR}</code> (or possibly a subdirectory
7105: of it) which is often but not always
7106: <code class="filename">${PREFIX}/etc</code>. Second, the package must be
7107: taught to install its default configuration files in
7108: <code class="filename">${PREFIX}/share/examples/${PKGBASE}</code>; this is the
7109: point at which patching often becomes required because it is not the
7110: same place as the runtime location. Third, the configuration files
7111: need to be declared in the package makefile; this is the easy part.
7112: </p>
7113: <p>With those elements in place, the right things will happen: the
7114: package install phase and resulting binary package will not touch
7115: <code class="filename">${PKG_SYSCONFDIR}</code>, and the default configuration
7116: will be copied into place by the pkgsrc framework only if not already
7117: present. Similarly, upon deinstall the configuration will not be
7118: removed if it has been modified. (This means that in the case of
7119: reinstallation and upgrades, unmodified configuration files are
7120: updated but modifications are never discarded.)</p>
7121: <p>The following sections describe how to make these things happen
7122: and document other relevant knobs available in the pkgsrc
7123: infrastructure.</p>
1.299 rillig 7124: <div class="sect2">
7125: <div class="titlepage"><div><div><h3 class="title">
7126: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7127: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7128: specifies where configuration files shall be installed. Its contents are
7129: set based upon the following variables:</p>
7130: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7131: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7132: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.353 dholland 7133: be overridden by the user to point to their preferred location (e.g.,
1.299 rillig 7134: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7135: Packages must not use it directly.</p></li>
7136: <li class="listitem">
7137: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7138: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7139: for the package being built shall be installed. The definition of this
7140: variable only makes sense in the package's
7141: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7142: <p>As an example, consider the Apache package,
1.322 leot 7143: <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 7144: configuration files under the
7145: <code class="filename">httpd/</code> subdirectory of
7146: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7147: Makefile.</p>
7148: </li>
7149: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7150: variable that holds this package's configuration directory (if
7151: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7152: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7153: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7154: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7155: directory where the configuration files for the package identified by
7156: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7157: </ul></div>
7158: <p>Based on the above variables, pkginstall determines the value of
7159: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
1.353 dholland 7160: variable that may be used within a package to refer to its configuration
1.299 rillig 7161: directory. The algorithm used to set its value is basically the
7162: following:</p>
7163: <div class="orderedlist"><ol class="orderedlist" type="1">
7164: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7165: its value is used.</p></li>
7166: <li class="listitem"><p>If the previous variable is not defined but
7167: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7168: <code class="filename">Makefile</code>, the resulting value is
7169: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7170: <li class="listitem"><p>Otherwise, it is set to
7171: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7172: </ol></div>
7173: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.353 dholland 7174: automatically added to <code class="filename">OWN_DIRS</code>. This causes it
7175: 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
7176: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>; they must be manually
7177: created with <code class="varname">OWN_DIRS</code> or
7178: <code class="varname">MAKE_DIRS</code>.</p>
1.299 rillig 7179: </div>
7180: <div class="sect2">
7181: <div class="titlepage"><div><div><h3 class="title">
7182: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7183: <p>Given that pkgsrc (and users!) expect configuration files to be in a
1.353 dholland 7184: known place, you need to teach each package where to install its files. In
7185: some cases you will have to patch the package Makefiles to achieve it. If
7186: you are lucky, though, it may be as easy as passing an extra flag to the
7187: configuration script. This is the case for packages using GNU
7188: autoconf:</p>
1.75 rillig 7189: <pre class="programlisting">
1.299 rillig 7190: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100 rillig 7191: </pre>
1.299 rillig 7192: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
1.353 dholland 7193: for</em></span> its configuration files, not where they will be installed.
7194: Fortunately, there is a different way to specify the latter, as seen
1.354 gutterid 7195: in the next section, although the combination is rather confusing at
1.353 dholland 7196: first glance.</p>
1.75 rillig 7197: </div>
1.299 rillig 7198: <div class="sect2">
7199: <div class="titlepage"><div><div><h3 class="title">
1.353 dholland 7200: <a name="conf-files-patching"></a>20.2.3. Patching installation</h3></div></div></div>
7201: <p>As discussed above, <span class="strong"><strong>packages themselves must not
1.299 rillig 7202: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7203: directly</strong></span>. Bad news is that many software installation scripts
7204: will, out of the box, mess with the contents of that directory. So what is
7205: the correct procedure to fix this issue?</p>
7206: <p>You must teach the package (usually by manually patching it) to
7207: install any configuration files under the examples hierarchy,
7208: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7209: <code class="filename">PLIST</code> registers them and the administrator always
7210: has the original copies available.</p>
1.353 dholland 7211: <p>It turns out that for packages using GNU autoconf it is possible
7212: to create the desired effect by setting <code class="varname">sysconfdir</code>
7213: on the make command line at install time. Consider this example taken
7214: 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>
7215: <pre class="programlisting">
7216: EGDIR= ${PREFIX}/share/examples/mutt
7217: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
7218: </pre>
7219: <p>Note that the <code class="varname">EGDIR</code> variable, though commonly
7220: used for this purpose, is local to that package and has no meaning
7221: outside it.</p>
7222: </div>
7223: <div class="sect2">
7224: <div class="titlepage"><div><div><h3 class="title">
7225: <a name="conf-files-declare"></a>20.2.4. Declaring configuration files</h3></div></div></div>
1.299 rillig 7226: <p>Once the required configuration files are in place (i.e., under the
1.353 dholland 7227: examples hierarchy), the pkginstall framework can use them as reference copies
1.299 rillig 7228: during the package installation to update what is in
7229: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7230: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.353 dholland 7231: 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
7232: information about their syntax and their purpose. Here is an example,
7233: 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>
7234: <pre class="programlisting">
7235: EGDIR= ${PREFIX}/share/examples/mutt
7236: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7237: </pre>
7238: <p>Note that (as in the previous section's example) the
7239: <code class="varname">EGDIR</code> variable is specific to the package and has
7240: no meaning outside it.</p>
7241: <p>For reference, the complete example from Mutt is as follows:</p>
1.88 wiz 7242: <pre class="programlisting">
1.353 dholland 7243: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
7244: EGDIR= ${PREFIX}/share/examples/mutt
7245: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7246: INSTALLATION_DIRS+= ${EGDIR}
7247: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.100 rillig 7248: </pre>
1.75 rillig 7249: </div>
1.299 rillig 7250: <div class="sect2">
7251: <div class="titlepage"><div><div><h3 class="title">
1.353 dholland 7252: <a name="conf-files-disable"></a>20.2.5. Disabling handling of configuration files</h3></div></div></div>
1.299 rillig 7253: <p>The automatic copying of config files can be toggled by setting the
7254: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7255: installation.</p>
1.88 wiz 7256: </div>
1.75 rillig 7257: </div>
1.148 asau 7258: <div class="sect1">
1.75 rillig 7259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7260: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7261: <p>System startup scripts are special files because they must be
7262: installed in a place known by the underlying OS, usually outside the
7263: 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
7264: can be used. However, pkginstall provides a special mechanism to handle
7265: these files.</p>
7266: <p>In order to provide system startup scripts, the package has
7267: to:</p>
7268: <div class="orderedlist"><ol class="orderedlist" type="1">
7269: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7270: the <code class="literal">.sh</code> suffix appended. Considering the
1.338 nia 7271: <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
7272: has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.299 rillig 7273: <li class="listitem">
7274: <p>Tell pkginstall to handle it, appending the name of the script,
7275: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7276: Continuing the previous example:</p>
7277: <pre class="programlisting">
7278: RCD_SCRIPTS+= cupsd
7279: </pre>
7280: </li>
7281: </ol></div>
7282: <p>Once this is done, pkginstall will do the following steps for each
7283: script in an automated fashion:</p>
7284: <div class="orderedlist"><ol class="orderedlist" type="1">
7285: <li class="listitem"><p>Process the file found in the files directory applying all the
7286: substitutions described in the <code class="filename">FILES_SUBST</code>
7287: variable.</p></li>
7288: <li class="listitem"><p>Copy the script from the files directory to the examples
7289: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.353 dholland 7290: that this reference file must be explicitly registered in the
1.299 rillig 7291: <code class="filename">PLIST</code>.</p></li>
7292: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7293: from the examples hierarchy into the system-wide startup scripts
7294: directory.</p></li>
7295: </ol></div>
7296: <div class="sect2">
7297: <div class="titlepage"><div><div><h3 class="title">
7298: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7299: <p>The automatic copying of config files can be toggled by setting the
7300: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7301: installation. Note that the scripts will be always copied inside the
7302: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7303: matter what the value of this variable is.</p>
1.75 rillig 7304: </div>
7305: </div>
1.299 rillig 7306: <div class="sect1">
7307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7308: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7309: <p>If a package needs to create special users and/or groups during
7310: installation, it can do so by using the pkginstall framework.</p>
7311: <p>Users can be created by adding entries to the
7312: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7313: syntax:</p>
7314: <pre class="programlisting">
7315: user:group
7316: </pre>
7317: <p>Further specification of user details may be done by setting
7318: per-user variables.
7319: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7320: numeric UID for the user.
7321: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7322: user's description or comment.
7323: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7324: user's home directory, and defaults to
7325: <code class="filename">/nonexistent</code> if not specified.
7326: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7327: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7328: not specified.</p>
7329: <p>Similarly, groups can be created by adding entries to the
7330: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7331: <pre class="programlisting">
7332: group
7333: </pre>
7334: <p>The numeric GID of the group may be set by defining
7335: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7336: <p>If a package needs to create the users and groups at an earlier
7337: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7338: <code class="literal">configure</code>,<code class="literal">build</code>, or
7339: <code class="literal">pre-install</code> to indicate the phase before which the
7340: users and groups are created. In this case, the numeric UIDs and GIDs
7341: of the created users and groups are automatically hardcoded into the
7342: final installation scripts.</p>
1.75 rillig 7343: </div>
1.148 asau 7344: <div class="sect1">
1.75 rillig 7345: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7346: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7347: <p>Packages that install system shells should register them in the shell
7348: database, <code class="filename">/etc/shells</code>, to make things easier to the
7349: administrator. This must be done from the installation scripts to keep
7350: binary packages working on any system. pkginstall provides an easy way to
7351: accomplish this task.</p>
7352: <p>When a package provides a shell interpreter, it has to set the
7353: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7354: add some hooks to the installation scripts to handle it. Consider the
1.322 leot 7355: 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 7356: <pre class="programlisting">
7357: PKG_SHELL= ${PREFIX}/bin/zsh
7358: </pre>
7359: <div class="sect2">
7360: <div class="titlepage"><div><div><h3 class="title">
7361: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7362: <p>The automatic registration of shell interpreters can be disabled by
7363: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7364: environment variable to <code class="literal">NO</code>.</p>
7365: </div>
1.75 rillig 7366: </div>
1.148 asau 7367: <div class="sect1">
1.75 rillig 7368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7369: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7370: <p>Packages that install X11 fonts should update the database files
7371: that index the fonts within each fonts directory. This can easily be
7372: accomplished within the pkginstall framework.</p>
7373: <p>When a package installs X11 fonts, it must list the directories in
7374: which fonts are installed in the
7375: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7376: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7377: <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
7378: installation scripts to run the appropriate commands to update the fonts
7379: database files within each of those directories. For convenience, if the
7380: directory path is relative, it is taken to be relative to the package's
1.322 leot 7381: 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 7382: <pre class="programlisting">
1.299 rillig 7383: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75 rillig 7384: </pre>
1.299 rillig 7385: <div class="sect2">
7386: <div class="titlepage"><div><div><h3 class="title">
7387: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7388: <p>The automatic update of fonts databases can be disabled by
7389: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7390: environment variable to <code class="literal">NO</code>.</p>
1.75 rillig 7391: </div>
7392: </div>
7393: </div>
1.148 asau 7394: <div class="chapter">
1.75 rillig 7395: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 7396: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75 rillig 7397: <div class="toc">
7398: <p><b>Table of Contents</b></p>
1.210 leot 7399: <dl class="toc">
1.267 rillig 7400: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75 rillig 7401: <dd><dl>
1.267 rillig 7402: <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>
7403: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7404: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7405: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7406: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7407: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7408: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7409: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7410: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7411: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7412: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7413: </dl></dd>
7414: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7415: <dd><dl>
7416: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7417: <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>
7418: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7419: </dl></dd>
7420: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7421: <dd><dl>
7422: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7423: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7424: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338 nia 7425: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.267 rillig 7426: </dl></dd>
7427: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7428: <dd><dl>
7429: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7430: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 7431: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338 nia 7432: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
7433: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
7434: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
7435: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267 rillig 7436: </dl></dd>
7437: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7438: <dd><dl>
7439: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7440: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 7441: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7442: <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>
7443: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 7444: </dl></dd>
7445: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7446: <dd><dl>
7447: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7448: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7449: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7450: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7451: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 7452: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.369 wiz 7453: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
7454: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
7455: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
7456: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
7457: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
7458: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
7459: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
7460: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
7461: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
7462: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.87 wiz 7463: emulation</a></span></dt>
1.369 wiz 7464: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
7465: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.75 rillig 7466: </dl></dd>
1.267 rillig 7467: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7468: </dl>
7469: </div>
1.148 asau 7470: <div class="sect1">
1.75 rillig 7471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 7472: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78 rillig 7473: <p>One appealing feature of pkgsrc is that it runs on many
1.218 rillig 7474: different platforms. As a result, it is important to ensure,
7475: where possible, that packages in pkgsrc are portable. This
7476: chapter mentions some particular details you should pay
7477: attention to while working on pkgsrc.</p>
1.148 asau 7478: <div class="sect2">
1.78 rillig 7479: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7480: <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 7481: </h3></div></div></div>
1.78 rillig 7482: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7483: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7484: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7485: want to use those variables in the preprocessor directives of
1.378 ! leot 7486: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87 wiz 7487: <code class="literal">.for</code>), you need to include the file
7488: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7489: loads the user preferences.</p>
1.78 rillig 7490: <p>But note that some variables may not be completely defined
1.219 rillig 7491: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7492: included, as they may contain references to variables that are
7493: not yet defined. In shell commands (the lines in
7494: <code class="filename">Makefile</code> that are indented with a tab) this
7495: is no problem, since variables are only expanded when they are
7496: used. But in the preprocessor directives mentioned above and in
7497: dependency lines (of the form <code class="literal">target:
7498: dependencies</code>) the variables are expanded at load
7499: time.</p>
1.148 asau 7500: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7501: <h3 class="title">Note</h3>
1.218 rillig 7502: <p>To check whether a variable can be used at load time,
7503: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78 rillig 7504: </div>
7505: </div>
1.148 asau 7506: <div class="sect2">
1.78 rillig 7507: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7508: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88 wiz 7509: <p>Occasionally, packages require interaction from the user,
7510: and this can be in a number of ways:</p>
1.148 asau 7511: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7512: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7513: interaction such as entering username/password or accepting a
7514: license on a web page.</p></li>
1.128 wiz 7515: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7516: passwords.</p></li>
1.128 wiz 7517: <li class="listitem"><p>help to configure the package before it is built</p></li>
7518: <li class="listitem"><p>help during the build process</p></li>
7519: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7520: </ul></div>
1.218 rillig 7521: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7522: variable to define which stages need interaction. This should be
7523: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7524: <pre class="programlisting">
1.100 rillig 7525: INTERACTIVE_STAGE= configure install
1.222 sevan 7526: </pre>
1.88 wiz 7527: <p>The user can then decide to skip this package by setting the
1.218 rillig 7528: <code class="varname">BATCH</code> variable. Packages that require interaction
7529: are also excluded from bulk builds.</p>
1.75 rillig 7530: </div>
1.148 asau 7531: <div class="sect2">
1.75 rillig 7532: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7533: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222 sevan 7534: <p>Authors of software can choose the licence under which software
7535: can be copied. The Free Software Foundation has declared some
7536: licenses "Free", and the Open Source Initiative has a definition of
7537: "Open Source".</p>
7538: <p>By default, pkgsrc allows packages with Free or Open Source
7539: licenses to be built. To allow packages with other licenses to be
7540: built as well, the pkgsrc user needs to add these licenses to the
7541: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7542: that this variable only affects which packages may be
7543: <span class="emphasis"><em>built</em></span>, while the license terms often also
7544: restrict the actual use of the package and its redistribution.</p>
1.98 wiz 7545: <p>One might want to only install packages with a BSD license,
1.218 rillig 7546: or the GPL, and not the other. The free licenses are added to the
1.222 sevan 7547: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.121 jnemeth 7548: user can override the default by setting the
7549: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222 sevan 7550: of "+=". The licenses accepted by default are defined in the
7551: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7552: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78 rillig 7553: <p>The license tag mechanism is intended to address
1.87 wiz 7554: copyright-related issues surrounding building, installing and
7555: using a package, and not to address redistribution issues (see
7556: <code class="varname">RESTRICTED</code> and
1.222 sevan 7557: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121 jnemeth 7558: Packages with redistribution restrictions should set these
7559: tags.</p>
1.98 wiz 7560: <p>Denoting that a package may be copied according to a
7561: particular license is done by placing the license in
1.87 wiz 7562: <code class="filename">pkgsrc/licenses</code> and setting the
7563: <code class="varname">LICENSE</code> variable to a string identifying the
1.322 leot 7564: 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 7565: <pre class="programlisting">
1.100 rillig 7566: LICENSE= xv-license
1.222 sevan 7567: </pre>
1.87 wiz 7568: <p>When trying to build, the user will get a notice that the
1.98 wiz 7569: package is covered by a license which has not been placed in the
7570: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7571: <pre class="programlisting">
1.100 rillig 7572: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7573: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7574: ===> To view the license, enter "/usr/bin/make show-license".
7575: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7576: ===> ACCEPTABLE_LICENSES+=xv-license
7577: *** Error code 1
1.222 sevan 7578: </pre>
1.110 hubertf 7579: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7580: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7581: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7582: convey to pkgsrc that it should not in the future fail because of
7583: that license:</p>
1.78 rillig 7584: <pre class="programlisting">
1.100 rillig 7585: ACCEPTABLE_LICENSES+=xv-license
1.222 sevan 7586: </pre>
7587: <p>The use of <code class="varname">LICENSE=shareware</code>,
7588: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7589: is deprecated because it does not crisply refer to a particular
7590: license text. Another problem with such usage is that it does not
7591: enable a user to tell pkgsrc to proceed for a single package
7592: without also telling pkgsrc to proceed for all packages with that
7593: tag.</p>
7594: <div class="sect3">
7595: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7596: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154 rodent 7597: <p>When adding a package with a new license, the following steps
7598: are required:</p>
7599: <div class="orderedlist"><ol class="orderedlist" type="1">
7600: <li class="listitem">
1.284 rillig 7601: <p>Check whether the license qualifies as Free or Open Source by
7602: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7603: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222 sevan 7604: Open Source Initiative</a>. If this is the case, the filename in
7605: <code class="filename">pkgsrc/licenses/</code> does not need the
7606: <code class="filename">-license</code> suffix, and the license name should be
7607: added to:</p>
1.154 rodent 7608: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7609: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7610: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7611: <li class="listitem"><p>default_acceptable_licenses in
7612: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154 rodent 7613: </ul></div>
7614: </li>
1.284 rillig 7615: <li class="listitem"><p>The license text should be added to
7616: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7617: licenses can be seen in this directory.</p></li>
1.154 rodent 7618: </ol></div>
1.222 sevan 7619: </div>
7620: <div class="sect3">
7621: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7622: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98 wiz 7623: <p>When the license changes (in a way other than formatting),
1.222 sevan 7624: make sure that the new license has a different name (e.g.,
1.98 wiz 7625: append the version number if it exists, or the date). Just
7626: because a user told pkgsrc to build programs under a previous
7627: version of a license does not mean that pkgsrc should build
1.99 rillig 7628: programs under the new licenses. The higher-level point is that
1.98 wiz 7629: pkgsrc does not evaluate licenses for reasonableness; the only
7630: test is a mechanistic test of whether a particular text has been
1.222 sevan 7631: approved by either of two bodies (FSF or OSI).</p>
7632: </div>
1.75 rillig 7633: </div>
1.148 asau 7634: <div class="sect2">
1.75 rillig 7635: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7636: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75 rillig 7637: <p>Some licenses restrict how software may be re-distributed.
1.222 sevan 7638: By declaring the restrictions, package tools can
1.98 wiz 7639: automatically refrain from e.g. placing binary packages on FTP
7640: sites.</p>
1.222 sevan 7641: <p>There are four possible restrictions, which are
1.98 wiz 7642: the cross product of sources (distfiles) and binaries not being
7643: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7644: language in any license, and because non-Free licenses tend to be
7645: different from each other, pkgsrc adopts a definition of FTP and
1.222 sevan 7646: CD-ROM.
7647:
7648: "FTP" means making the source or binary file available over the
7649: Internet at no charge.
7650:
7651: "CD-ROM" means making the source or binary available on some kind of
7652: media, together with other source and binary packages, which is sold
7653: for a distribution charge.
1.98 wiz 7654: </p>
7655: <p>In order to encode these restrictions, the package system
1.87 wiz 7656: defines five make variables that can be set to note these
7657: restrictions:</p>
1.148 asau 7658: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7659: <li class="listitem">
1.75 rillig 7660: <p><code class="varname">RESTRICTED</code></p>
7661: <p>This variable should be set whenever a restriction
1.87 wiz 7662: exists (regardless of its kind). Set this variable to a
1.98 wiz 7663: string containing the reason for the restriction. It should
7664: be understood that those wanting to understand the restriction
7665: will have to read the license, and perhaps seek advice of
7666: counsel.</p>
1.75 rillig 7667: </li>
1.128 wiz 7668: <li class="listitem">
1.75 rillig 7669: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7670: <p>Binaries may not be placed on CD-ROM containing other
7671: binary packages, for which a distribution charge may be made.
7672: In this case, set this variable to
7673: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7674: </li>
1.128 wiz 7675: <li class="listitem">
1.75 rillig 7676: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7677: <p>Binaries may not made available on the Internet without
7678: charge. In this case, set this variable to
7679: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7680: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7681: </li>
1.128 wiz 7682: <li class="listitem">
1.75 rillig 7683: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7684: <p>Distfiles may not be placed on CD-ROM, together with
7685: other distfiles, for which a fee may be charged. In this
7686: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7687: </p>
1.75 rillig 7688: </li>
1.128 wiz 7689: <li class="listitem">
1.75 rillig 7690: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7691: <p>Distfiles may not made available via FTP at no charge.
7692: In this case, set this variable to
7693: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7694: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7695: </li>
7696: </ul></div>
1.222 sevan 7697: <p>Please note that packages will be removed from pkgsrc when the
7698: distfiles are not distributable and cannot be obtained for a period
7699: of one full quarter branch. Packages with manual/interactive fetch
7700: must have a maintainer and it is his/her responsibility to ensure
7701: this.</p>
1.75 rillig 7702: </div>
1.148 asau 7703: <div class="sect2">
1.75 rillig 7704: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7705: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290 gutterid 7706: <p>Your package may depend on some other package being present,
7707: and there are various ways of expressing this dependency.
7708: pkgsrc supports the <code class="varname">DEPENDS</code>,
7709: <code class="varname">BUILD_DEPENDS</code>,
7710: <code class="varname">TOOL_DEPENDS</code>, and
7711: <code class="varname">TEST_DEPENDS</code> definitions, the
1.88 wiz 7712: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7713: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7714: to handle dependencies, and which uses the variables named above.
1.299 rillig 7715: 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 7716: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7717: definition registers that pre-requisite in the binary package so it
7718: will be pulled in when the binary package is later installed, whilst
7719: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7720: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7721: dependency that is only needed for building or testing the resulting
1.299 rillig 7722: 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 7723: <p>This means that if you only need a package present whilst
1.290 gutterid 7724: you are building or testing, it should be noted as a
7725: <code class="varname">TOOL_DEPENDS</code>,
7726: <code class="varname">BUILD_DEPENDS</code>, or
7727: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.269 leot 7728: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7729: packages, i.e. packages for the architecture where the package
7730: is built;
7731: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290 gutterid 7732: packages, i.e., packages for the architecture for which the package
1.269 leot 7733: is built.</p>
1.290 gutterid 7734: <p>The format for a <code class="varname">DEPENDS</code>,
7735: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7736: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75 rillig 7737: <pre class="programlisting">
1.100 rillig 7738: <pre-req-package-name>:../../<category>/<pre-req-package>
1.222 sevan 7739: </pre>
1.128 wiz 7740: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7741: may include any of the wildcard version numbers recognized by
1.378 ! leot 7742: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128 wiz 7743: <div class="orderedlist"><ol class="orderedlist" type="1">
7744: <li class="listitem">
1.75 rillig 7745: <p>If your package needs another package's binaries or
1.160 wiz 7746: libraries to build and run, and if that package has a
1.87 wiz 7747: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7748: <pre class="programlisting">
1.100 rillig 7749: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7750: </pre>
1.75 rillig 7751: </li>
1.128 wiz 7752: <li class="listitem">
1.160 wiz 7753: <p>If your package needs another package's binaries or
7754: libraries only for building, and if that package has a
7755: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7756: <pre class="programlisting">
7757: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7758: </pre>
1.160 wiz 7759: <p>but set
7760: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7761: to make it a build dependency only. This case is rather
7762: rare.</p>
7763: </li>
7764: <li class="listitem">
1.132 spz 7765: <p>If your package needs binaries from another package to build,
1.269 leot 7766: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75 rillig 7767: <pre class="programlisting">
1.269 leot 7768: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222 sevan 7769: </pre>
1.75 rillig 7770: </li>
1.269 leot 7771: <li class="listitem"><p>If your package needs static libraries to link against, header
7772: files to include, etc. from another package to build,
7773: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132 spz 7774: <li class="listitem"><p>If your package needs a library with which to link and
7775: there is no <code class="filename">buildlink3.mk</code> file
7776: available, create one. Using
7777: <code class="varname">DEPENDS</code> won't be sufficient because the
7778: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7779: <li class="listitem">
1.132 spz 7780: <p>If your package needs some executable to be able to run
7781: correctly and if there's no
7782: <code class="filename">buildlink3.mk</code> file, this is specified
7783: using the <code class="varname">DEPENDS</code> variable. The
1.322 leot 7784: <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 7785: be able to execute the latex binary from the tex-latex-bin package
1.132 spz 7786: when it runs, and that is specified:</p>
1.75 rillig 7787: <pre class="programlisting">
1.242 wiz 7788: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222 sevan 7789: </pre>
1.132 spz 7790: </li>
1.290 gutterid 7791: <li class="listitem"><p>If your package includes a test suite that has extra
7792: dependencies only required for this purpose (frequently this
7793: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7794: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132 spz 7795: <li class="listitem">
7796: <p>You can use wildcards in package dependencies. Note that
7797: such wildcard dependencies are retained when creating binary
7798: packages. The dependency is checked when installing the binary
7799: package and any package which matches the pattern will be
7800: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7801: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7802: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7803: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7804: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7805: <p>Wildcards can also be used to specify that a package
1.87 wiz 7806: will only build against a certain minimum version of a
7807: pre-requisite:</p>
1.75 rillig 7808: <pre class="programlisting">
1.132 spz 7809: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.222 sevan 7810: </pre>
1.132 spz 7811: <p>This means that the package will build using version 6.0
7812: of ImageMagick or newer. Such a dependency may be warranted
7813: if, for example, the command line options of an executable
7814: have changed.</p>
7815: <p>If you need to depend on minimum versions of libraries,
1.298 wiz 7816: set
7817: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7818: to the appropriate pattern before including its
7819: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7820: <pre class="programlisting">
7821: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7822: .include "../../graphics/jpeg/buildlink3.mk"
7823: </pre>
1.75 rillig 7824: <p>For security fixes, please update the package
1.267 rillig 7825: 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 7826: information.</p>
1.75 rillig 7827: </li>
7828: </ol></div>
7829: <p>If your package needs files from another package to build,
1.87 wiz 7830: add the relevant distribution files to
7831: <code class="varname">DISTFILES</code>, so they will be extracted
1.322 leot 7832: 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 7833: (It relies on the jpeg sources being present in source form
7834: during the build.)</p>
1.75 rillig 7835: </div>
1.148 asau 7836: <div class="sect2">
1.75 rillig 7837: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7838: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.341 gutterid 7839: <p>Your package may conflict with other packages users might
7840: already have installed on their system, e.g., if your package
1.88 wiz 7841: installs the same set of files as another package in the pkgsrc
1.342 wiz 7842: tree.</p>
1.322 leot 7843: <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>
7844: 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 7845: install the same shared library, thus you set in
7846: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7847: <pre class="programlisting">
7848: CONFLICTS= Xaw-Xpm-[0-9]*
1.352 wiz 7849: </pre>
1.255 leot 7850: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7851: <pre class="programlisting">
7852: CONFLICTS= libXaw3d-[0-9]*
1.352 wiz 7853: </pre>
1.378 ! leot 7854: <p><a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 7855: that conflict with existing packages and abort. However, in many
7856: situations this is too late in the process. Binary package managers
7857: will not know about the conflict until they attempt to install the
7858: package after already downloading it and all its dependencies.
7859: Users may also waste time building a package and its dependencies
7860: only to find out at the end that it conflicts with another package
7861: they have installed.</p>
7862: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7863: should be added in all cases where it is known that packages conflict
7864: with each other. These <code class="varname">CONFLICTS</code> entries are
1.378 ! leot 7865: exported in <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255 leot 7866: managers to inform users that packages cannot be installed onto
7867: the target system.</p>
1.75 rillig 7868: </div>
1.148 asau 7869: <div class="sect2">
1.75 rillig 7870: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7871: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7872: <p>There are several reasons why a package might be
1.88 wiz 7873: instructed to not build under certain circumstances. If the
1.87 wiz 7874: package builds and runs on most platforms, the exceptions
1.193 dholland 7875: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7876: the package builds and runs on a small handful of platforms,
7877: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7878: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7879: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7880: (OS-version-platform) that can use glob-style
7881: wildcards.</p>
7882: <p>If a package is not appropriate for some platforms (as
1.225 maya 7883: opposed to merely broken), a different set of variables should be
1.193 dholland 7884: used as this affects failure reporting and statistics.
7885: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7886: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 dholland 7887: the package is appropriate for only a small handful of platforms
7888: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7889: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7890: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7891: (OS-version-platform) that can use glob-style
7892: wildcards.</p>
1.88 wiz 7893: <p>Some packages are tightly bound to a specific version of an
1.322 leot 7894: 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 7895: backwards compatible with other versions of the OS, and should be
7896: uploaded to a version specific directory on the FTP server. Mark
7897: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7898: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7899: the package system internals, but may be used in the
7900: future.</p>
1.75 rillig 7901: <p>If the package should be skipped (for example, because it
1.87 wiz 7902: provides functionality already provided by the system), set
1.88 wiz 7903: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7904: the package should fail because some preconditions are not met,
7905: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7906: message.</p>
1.75 rillig 7907: </div>
1.148 asau 7908: <div class="sect2">
1.75 rillig 7909: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7910: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7911: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7912: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7913: be set in the package Makefile. This will be carried into any
7914: binary package that is made from this pkgsrc entry. A
1.128 wiz 7915: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.378 ! leot 7916: not be deleted using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128 wiz 7917: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7918: </div>
1.148 asau 7919: <div class="sect2">
1.75 rillig 7920: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7921: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7922: <p>When a vulnerability is found, this should be noted in
1.361 wiz 7923: <code class="filename">pkgsrc/doc/pkg-vulnerabilities</code>.
1.320 wiz 7924: Entries in that file consist of three parts:</p>
7925: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7926: <li class="listitem"><p>package version pattern</p></li>
7927: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
7928: <li class="listitem"><p>URL providing additional information about the issue</p></li>
7929: </ul></div>
7930: <p>For the package version pattern please always use `<' to
7931: mark an upper bound (not `<='!). This will avoid possible
7932: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
7933: related to security fixes. Lower bounds can be added too, using
7934: '>' or '>='. For example,
1.321 wiz 7935: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.320 wiz 7936: versions 1.0 (included) to 1.2 (excluded) of
7937: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
7938: issue.</p>
7939: <p>Entries should always be added at the bottom of the file.</p>
7940: <p>When fixing packages, please modify the upper bound of the
7941: corresponding entry. To continue the previous example, if a fix
7942: was backported to version 1.1nb2, change the previous pattern to
1.321 wiz 7943: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.320 wiz 7944: <p>To locally test a package version pattern against a
7945: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
7946: pmatch</strong></span> command.</p>
7947: <p>The URL should be as permanent as possible and provide as
7948: much information about the issue as possible. CVE entries are
7949: preferred.</p>
7950: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.138 wiz 7951: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7952: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7953: <code class="varname">PKGREVISION</code> should be increased (this is of
7954: course not necessary if the problem is fixed by using a newer
7955: release of the software), and the pattern in the
7956: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7957: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7958: branch, be sure to submit a pullup request!</p>
1.75 rillig 7959: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7960: semi-automatically by a weekly cron job.</p>
1.320 wiz 7961: <p>In case a security issue is disputed, please contact
7962: pkgsrc-security@NetBSD.org.</p>
1.75 rillig 7963: </div>
1.148 asau 7964: <div class="sect2">
1.75 rillig 7965: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7966: <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 7967: <p>When making fixes to an existing package it can be useful
1.87 wiz 7968: to change the version number in <code class="varname">PKGNAME</code>. To
7969: avoid conflicting with future versions by the original author, a
1.128 wiz 7970: <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 7971: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7972: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7973: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7974: <pre class="programlisting">
1.100 rillig 7975: DISTNAME= foo-17.42
7976: PKGREVISION= 9
1.222 sevan 7977: </pre>
1.75 rillig 7978: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7979: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7980: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7981: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7982: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7983: <p>When a new release of the package is released, the
1.87 wiz 7984: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7985: minor release of the above package, things should be like:</p>
1.75 rillig 7986: <pre class="programlisting">
1.100 rillig 7987: DISTNAME= foo-17.43
1.222 sevan 7988: </pre>
1.87 wiz 7989: <p><code class="varname">PKGREVISION</code> should be incremented for any
7990: non-trivial change in the resulting binary package. Without a
7991: <code class="varname">PKGREVISION</code> bump, someone with the previous
7992: version installed has no way of knowing that their package is out
7993: of date. Thus, changes without increasing
7994: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7995: trivial that no reasonable person would want to upgrade", and this
7996: is the rough test for when increasing
7997: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7998: changes that do not merit increasing
7999: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 8000: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8001: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284 rillig 8002: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
8003: comments in Makefile.</p></li>
8004: <li class="listitem"><p>Changing build variables if the resulting binary
8005: package is the same.</p></li>
8006: <li class="listitem"><p>Changing
8007: <code class="filename">DESCR</code>.</p></li>
8008: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
8009: default options don't change.</p></li>
1.100 rillig 8010: </ul></div>
1.87 wiz 8011: <p>Examples of changes that do merit an increase to
8012: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 8013: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 8014: <li class="listitem"><p>Security fixes</p></li>
8015: <li class="listitem"><p>Changes or additions to a patch
8016: file</p></li>
8017: <li class="listitem"><p>Changes to the
8018: <code class="filename">PLIST</code></p></li>
8019: <li class="listitem"><p>A dependency is changed or
8020: renamed.</p></li>
1.100 rillig 8021: </ul></div>
1.78 rillig 8022: <p>PKGREVISION must also be incremented when dependencies have ABI
8023: changes.</p>
1.75 rillig 8024: </div>
1.148 asau 8025: <div class="sect2">
1.79 rillig 8026: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8027: <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 8028: <p>When you want to replace the same text in multiple files, or
8029: multiple times in the same file, it is cumbersome to maintain a patch
8030: file for this. This is where the SUBST framework steps in. It provides an
8031: easy-to-use interface for replacing text in files. It just needs the
8032: following information:</p>
8033: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8034: <li class="listitem"><p>In which phase of the package build cycle should the
8035: replacement happen?</p></li>
8036: <li class="listitem"><p>In which files should the replacement
1.287 rillig 8037: happen?</p></li>
1.295 rillig 8038: <li class="listitem"><p>Which text should be replaced with
8039: what?</p></li>
1.287 rillig 8040: </ul></div>
8041: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295 rillig 8042: variables. A minimal example is:</p>
8043: <pre class="programlisting">
8044: SUBST_CLASSES+= paths
8045: SUBST_STAGE.paths= pre-configure
8046: SUBST_FILES.paths= src/*.c
8047: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
8048: </pre>
8049: <p>Translated into English, it means: In the pre-configure stage (that
8050: is, after applying the patches from the patches/ directory and before
8051: running the configure script and the portability check), replace the text
8052: <code class="literal">/usr/local</code> with the content of the variable
8053: <code class="varname">PREFIX</code>.</p>
8054: <p>Each SUBST block starts by appending an identifier to
8055: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
8056: identifier can be chosen freely by the package. If there should ever be
8057: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
8058: early, so don't worry about name collisions.</p>
8059: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
8060: SUBST block are parameterized using this identifier. In the remainder of
8061: this section, these parameterized variables are written as
8062: <code class="varname">SUBST_STAGE.*</code>.</p>
8063: <pre class="programlisting">
8064: SUBST_CLASSES+= paths
8065: SUBST_STAGE.paths= pre-configure
8066: SUBST_MESSAGE.paths= Fixing absolute paths.
8067: SUBST_FILES.paths= src/*.c
8068: SUBST_FILES.paths+= scripts/*.sh
8069: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
8070: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8071: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
8072: </pre>
8073: <p>To get a complete picture about the SUBST substitutions, run
8074: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
8075: expected, run pkglint on the package, which detects several typical
8076: mistakes surrounding the SUBST blocks. For any questions that might
8077: remain after this, have a look at
8078: <code class="filename">mk/subst.mk</code>.</p>
8079: <div class="sect3">
8080: <div class="titlepage"><div><div><h4 class="title">
8081: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
8082: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
8083: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
8084: <code class="literal">pre-configure</code> is used most often, by far. The most
8085: popular stages are, in chronological order:</p>
8086: <div class="variablelist"><dl class="variablelist">
8087: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
8088: <dd>
8089: <p>The substitutions are applied immediately after the
8090: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
8091: package will leave no traces of the original files.</p>
8092: <p>When the substitution applies to files for which there is also a
8093: patch in the <code class="filename">patches/</code> directory, this means that the
8094: patches will be computed based on the result of the substitution. When
8095: these patches are sent to the upstream maintainer later, to be fixed in
8096: the upstream package, these patches may no longer match what the upstream
8097: author is used to. Because of this, <code class="literal">pre-configure</code> is
8098: often a better choice.</p>
8099: </dd>
8100: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
8101: <dd>
8102: <p>The substitutions are applied after the patches from the
8103: <code class="filename">patches/</code> directory. This makes it possible to run
8104: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.322 leot 8105: 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 8106: <p>When updating the patches, it is helpful to explicitly separate the
8107: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
8108: configure</strong></span>, and to only edit the patches between these commands.
8109: Otherwise the substitutions from the SUBST block will end up in the patch
8110: file. When this happens in really obvious ways, pkglint will complain
8111: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
8112: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
8113: can only detect these really obvious
8114: cases.</p>
8115: </dd>
8116: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
8117: <dd><p>This stage should only be used if the package defines a
8118: <code class="literal">pre-configure</code> action itself, and the substitution must
8119: happen after that. Typical examples are packages that use the
8120: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
8121: script from
8122: <code class="filename">configure.ac</code>.</p></dd>
8123: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
8124: <dd><p>This stage is used to fix up any mistakes by the
8125: configure stage.</p></dd>
8126: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
8127: <dd><p>This stage should only be used for substitutions that are
8128: clearly related to building the package, not for fixing the
8129: configuration. Substitutions for pathnames (such as replacing
8130: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
8131: user names (such as replacing <code class="literal">@MY_USER@</code> with the
8132: actual username) belong in pre-configure or post-configure
8133: instead.</p></dd>
8134: <dt><span class="term"><code class="literal">post-build</code></span></dt>
8135: <dd>
8136: <p>Just as with pre-build, this stage should only be used
8137: for substitutions that are clearly related to building the package, not
8138: for fixing the configuration. Substitutions for pathnames (such as
8139: replacing <code class="filename">/usr/local</code> with
8140: <code class="literal">${PREFIX}</code>) or user names (such as replacing
8141: <code class="literal">@MY_USER@</code> with the actual username) belong in
8142: pre-configure or post-configure instead.</p>
8143: <p>A typical use is to update pkg-config files to include the rpath
8144: compiler options.</p>
8145: </dd>
8146: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8147: <dd><p>In general, the install phase should be as simple as
8148: possible. As with the pre-build and post-build stages, it should not be
8149: used to fix pathnames or user names, these belong in pre-configure
8150: instead. There are only few legitimate use cases for applying
8151: substitutions in this stage.</p></dd>
8152: </dl></div>
8153: </div>
8154: <div class="sect3">
8155: <div class="titlepage"><div><div><h4 class="title">
1.296 rillig 8156: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295 rillig 8157: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8158: filename patterns. These patterns are relative to
8159: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8160: A typical example is:</p>
8161: <pre class="programlisting">
8162: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8163: </pre>
8164: <p>The above patterns, especially the last, are quite broad. The SUBST
8165: implementation checks that each filename pattern that is mentioned here
8166: has an effect. For example, if none of the
8167: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8168: and substituted, that filename pattern is redundant and should be left
1.296 rillig 8169: out. By default, the SUBST framework will complain with an error message.
8170: If the text to be substituted occurs in some of the files from a single
8171: pattern, but not in all of them, that is totally ok, and the SUBST
1.295 rillig 8172: framework will only print an INFO message for those files.</p>
8173: <p>If there is a good reason for having redundant filename patterns,
1.296 rillig 8174: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295 rillig 8175: <p>Another popular way of choosing the files for the substitutions is
8176: via a shell command, like this:</p>
8177: <pre class="programlisting">
1.296 rillig 8178: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.295 rillig 8179: SUBST_FILES.path= ${C_FILES_CMD:sh}
8180: </pre>
8181: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8182: freely chosen and independent of the SUBST framework.</p>
8183: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8184: lists each file individually. Thereby chances are higher that there are
8185: filename patterns in which no substitution happens. Since the SUBST
8186: framework cannot know whether the filename patterns in
8187: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8188: Makefile (where any redundant filename pattern would be suspicious) or
8189: been generated by a shell command (in which redundant filename patterns
8190: are more likely and to be expected), it will complain about these
8191: redundant filename patterns. Therefore, SUBST blocks that use a shell
8192: command to generate the list of filename patterns often need to set
8193: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8194: </div>
8195: <div class="sect3">
8196: <div class="titlepage"><div><div><h4 class="title">
8197: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8198: <p>In most cases, the substitutions are given using one or more
1.378 ! leot 8199: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.295 rillig 8200: <pre class="programlisting">
8201: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8202: </pre>
8203: <p>Each of the sed commands needs to be preceded by the
8204: <code class="literal">-e</code> option and should be specified on a line of its
8205: own, to avoid hiding short sed commands at the end of a line.</p>
8206: <p>Since the sed commands often contain shell metacharacters as the
8207: separator (the <code class="literal">|</code> in the above example), it is common
8208: to enclose them in single quotes.</p>
8209: <p>A common substitution is to replace placeholders of the form
8210: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8211: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8212: <pre class="programlisting">
8213: SUBST_VARS.path= PREFIX
8214: </pre>
8215: <p>This type of substitutions is typically done by the GNU configure
1.296 rillig 8216: scripts during the do-configure stage, but in some cases these need to be
8217: overridden. The same pattern is also used when a package defines patches
8218: that replace previously hard-coded paths like
8219: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8220: placeholder first, which then gets substituted by the actual
8221: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8222: cases, it works equally well to just use the SUBST framework to directly
8223: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8224: thereby omitting the intermediate patch file.</p>
1.295 rillig 8225: <p>If the above is not flexible enough, it is possible to not use sed
8226: at all for the substitution but to specify an entirely different command,
8227: like this:</p>
1.87 wiz 8228: <pre class="programlisting">
1.295 rillig 8229: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8230: </pre>
8231: <p>This is used for the few remaining packages in which the
8232: distributed files use Windows-style line endings that need to be
8233: converted to UNIX-style line endings.</p>
8234: </div>
8235: <div class="sect3">
8236: <div class="titlepage"><div><div><h4 class="title">
8237: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8238: <p>When a SUBST block is applied during a package build, a message is
8239: logged. The default message is fine for most purposes but can be
8240: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8241: message.</p>
8242: </div>
1.79 rillig 8243: </div>
1.75 rillig 8244: </div>
1.148 asau 8245: <div class="sect1">
1.75 rillig 8246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8247: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 8248: <div class="sect2">
1.75 rillig 8249: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8250: <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 8251: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8252: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8253: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8254: with the name of each file to download as an argument, expecting
8255: it to output the URL of the directory from which to download
1.322 leot 8256: 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 8257: example of this usage.</p>
1.75 rillig 8258: <p>If the download can't be automated, because the user must
1.87 wiz 8259: submit personal information to apply for a password, or must pay
8260: for the source, or whatever, you can set
8261: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8262: displayed to the user before aborting the build. Example:</p>
8263: <pre class="programlisting">
1.100 rillig 8264: FETCH_MESSAGE= "Please download the files"
8265: FETCH_MESSAGE+= " "${DISTFILES:Q}
8266: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222 sevan 8267: </pre>
1.75 rillig 8268: </div>
1.148 asau 8269: <div class="sect2">
1.75 rillig 8270: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8271: <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 8272: <p>Sometimes authors of a software package make some
1.87 wiz 8273: modifications after the software was released, and they put up a
8274: new distfile without changing the package's version number. If a
8275: package is already in pkgsrc at that time, the checksum will
8276: no longer match. The contents of the new distfile should be
8277: compared against the old one before changing anything, to make
8278: sure the distfile was really updated on purpose, and that
8279: no trojan horse or so crept in.
1.97 rillig 8280: Please mention that the distfiles were compared and what was found
1.159 rodent 8281: in your commit message.</p>
1.220 wiz 8282: <p>Then, the correct way to work around this is to set
8283: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8284: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8285: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8286: a variable prefix). All <code class="varname">DISTFILES</code> and
1.93 rillig 8287: <code class="varname">PATCHFILES</code> for this package will be put in that
1.267 rillig 8288: 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 8289: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220 wiz 8290: including the <code class="filename">nbX</code> suffix) or a date stamp can
8291: be appended, like
8292: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284 rillig 8293: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8294: name does not contain a version and the distfile is apt to change. In
8295: cases where the likelihood of this is very small,
8296: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8297: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8298: distfile name changes, even if a package is being moved or
8299: renamed.</p>
1.159 rodent 8300: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8301: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8302: path in the filenames.
1.159 rodent 8303: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8304: Furthermore, a mail to the package's authors seems appropriate
8305: telling them that changing distfiles after releases without
8306: changing the file names is not good practice.</p>
1.75 rillig 8307: </div>
1.199 tnn 8308: <div class="sect2">
8309: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8310: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284 rillig 8311: <p>Helper methods exist for packages hosted on github.com which
8312: will often have distfile names that clash with other packages, for
8313: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8314: from below:</p>
1.199 tnn 8315: <div class="sect3">
8316: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8317: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284 rillig 8318: <p>If your distfile URL looks similar to
1.303 bacon 8319: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284 rillig 8320: then you are packaging a tagged release.</p>
1.199 tnn 8321: <pre class="programlisting">
1.303 bacon 8322: DISTNAME= example-1.0
1.200 tnn 8323: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8324: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8325: GITHUB_TAG= v${PKGVERSION_NOREV}
1.199 tnn 8326: EXTRACT_SUFX= .zip
8327: </pre>
1.345 gutterid 8328: <p>Here, DISTNAME combined with use of GITHUB_TAG leads the
8329: file fetching infrastructure to save the resulting file locally as
8330: <code class="literal">example-1.0.zip</code>.</p>
1.199 tnn 8331: </div>
8332: <div class="sect3">
8333: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8334: <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>
8335: <p>If your distfile looks similar to
8336: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8337: release, then set the package version to 0.0.0.N, where N is the number
8338: of commits to the repository, and set GITHUB_TAG to the commit hash.
8339: This will (almost) ensure that the first tagged release will have a
8340: version greater than this one so that package upgrades will function
8341: properly.</p>
8342: <pre class="programlisting">
8343: DISTNAME= example-0.0.0.347
8344: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8345: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8346: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8347: </pre>
8348: </div>
8349: <div class="sect3">
8350: <div class="titlepage"><div><div><h4 class="title">
8351: <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>
8352: <p>If your distfile looks similar to
8353: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8354: then include the last release version and the commit count since that
8355: release in the package version and set GITHUB_TAG to the commit hash.
8356: The latest release and commit count are shown in the output of
8357: "git describe --tags":
8358: </p>
8359: <pre class="screen">
8360: # git clone https://github.com/username/example
8361: # cd example
8362: # git describe --tags
8363: 1.2.3-5-g988881a
8364: </pre>
1.199 tnn 8365: <pre class="programlisting">
1.303 bacon 8366: DISTNAME= example-1.2.3.5
8367: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8368: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8369: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222 sevan 8370: </pre>
1.199 tnn 8371: </div>
8372: <div class="sect3">
8373: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8374: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284 rillig 8375: <p>If your distfile URL looks similar to
1.303 bacon 8376: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284 rillig 8377: then you are packaging a release.</p>
1.199 tnn 8378: <pre class="programlisting">
8379: DISTNAME= offensive-1.6
1.200 tnn 8380: PKGNAME= ${DISTNAME:S/offensive/proper/}
8381: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8382: GITHUB_PROJECT= example
1.200 tnn 8383: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8384: EXTRACT_SUFX= .zip
1.222 sevan 8385: </pre>
1.199 tnn 8386: </div>
8387: </div>
1.75 rillig 8388: </div>
1.148 asau 8389: <div class="sect1">
1.75 rillig 8390: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8391: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 8392: <div class="sect2">
1.75 rillig 8393: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8394: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8395: <p>pkgsrc supports many different machines, with different
1.87 wiz 8396: object formats like a.out and ELF, and varying abilities to do
8397: shared library and dynamic loading at all. To accompany this,
8398: varying commands and options have to be passed to the
8399: compiler, linker, etc. to get the Right Thing, which can be
8400: pretty annoying especially if you don't have all the machines
8401: at your hand to test things. The
1.322 leot 8402: <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 8403: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8404: both static and dynamic libraries from a set of source files,
8405: thus being platform-independent.</p>
8406: <p>Here's how to use libtool in a package in seven simple
8407: steps:</p>
1.128 wiz 8408: <div class="orderedlist"><ol class="orderedlist" type="1">
8409: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8410: Makefile.</p></li>
1.128 wiz 8411: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8412: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8413: add it to the definition of <code class="varname">CC</code>, if only
8414: libraries are being built in a given Makefile. This one command
8415: will build both PIC and non-PIC library objects, so you need not
8416: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8417: <li class="listitem">
1.75 rillig 8418: <p>For the linking of the library, remove any
1.128 wiz 8419: <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
8420: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8421: <pre class="programlisting">
1.100 rillig 8422: ${LIBTOOL} --mode=link \
8423: ${CC} -o ${.TARGET:.a=.la} \
8424: ${OBJS:.o=.lo} \
8425: -rpath ${PREFIX}/lib \
8426: -version-info major:minor
1.222 sevan 8427: </pre>
1.75 rillig 8428: <p>Note that the library is changed to have a
1.87 wiz 8429: <code class="filename">.la</code> extension, and the objects are
8430: changed to have a <code class="filename">.lo</code>
8431: extension. Change <code class="varname">OBJS</code> as
8432: necessary. This automatically creates all of the
8433: <code class="filename">.a</code>,
8434: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8435: necessary) in the build directory. Be sure to include
1.128 wiz 8436: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8437: minor are zero, as libtool will otherwise strip off the
8438: shared library version.</p>
1.75 rillig 8439: <p>From the libtool manual:</p>
8440: <pre class="programlisting">
1.100 rillig 8441: So, libtool library versions are described by three integers:
1.69 rillig 8442:
1.100 rillig 8443: CURRENT
8444: The most recent interface number that this library implements.
1.69 rillig 8445:
1.100 rillig 8446: REVISION
8447: The implementation number of the CURRENT interface.
1.69 rillig 8448:
1.100 rillig 8449: AGE
8450: The difference between the newest and oldest interfaces that
8451: this library implements. In other words, the library implements
8452: all the interface numbers in the range from number `CURRENT -
8453: AGE' to `CURRENT'.
1.1 grant 8454:
1.100 rillig 8455: If two libraries have identical CURRENT and AGE numbers, then the
8456: dynamic linker chooses the library with the greater REVISION number.
1.222 sevan 8457: </pre>
1.128 wiz 8458: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8459: different results for a.out and ELF (excluding symlinks)
8460: in only one case. An ELF library of the form
1.128 wiz 8461: <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 8462: will have a symlink of
1.128 wiz 8463: <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 8464: on an a.out platform. This is handled
8465: automatically.</p>
1.128 wiz 8466: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8467: directory of the library being built.</p>
1.76 rillig 8468: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8469: <code class="filename">.la</code> file, the other files will be
8470: added automatically.</p>
1.75 rillig 8471: </li>
1.128 wiz 8472: <li class="listitem">
1.76 rillig 8473: <p>When linking shared object (<code class="filename">.so</code>)
1.378 ! leot 8474: files, i.e. files that are loaded via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128 wiz 8475: shared libraries, use <span class="quote">“<span class="quote">-module
8476: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8477: tacked on.</p>
1.76 rillig 8478: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8479: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8480: </li>
1.128 wiz 8481: <li class="listitem">
1.75 rillig 8482: <p>When linking programs that depend on these libraries
1.87 wiz 8483: <span class="emphasis"><em>before</em></span> they are installed, preface
1.378 ! leot 8484: the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 8485: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8486: libraries (static or shared), but please be aware that
8487: libtool will not allow you to specify a relative path in
1.128 wiz 8488: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8489: expects you to change that argument to be the
8490: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8491: <pre class="programlisting">
1.100 rillig 8492: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222 sevan 8493: </pre>
1.75 rillig 8494: <p>should be changed to:</p>
8495: <pre class="programlisting">
1.100 rillig 8496: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222 sevan 8497: </pre>
1.75 rillig 8498: <p>and it will do the right thing with the libraries.</p>
8499: </li>
1.128 wiz 8500: <li class="listitem">
1.378 ! leot 8501: <p>When installing libraries, preface the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
! 8502: or <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 8503: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8504: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8505: <pre class="programlisting">
1.126 jakllsch 8506: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222 sevan 8507: </pre>
1.76 rillig 8508: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8509: shared library, any needed symlinks, and run
1.378 ! leot 8510: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75 rillig 8511: </li>
1.128 wiz 8512: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8513: the <code class="filename">.la</code>
8514: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8515: </ol></div>
8516: </div>
1.148 asau 8517: <div class="sect2">
1.75 rillig 8518: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8519: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8520: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8521: package Makefile. This will override the package's own libtool
8522: in most cases. For older libtool using packages, libtool is
8523: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8524: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8525: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8526: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8527: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8528: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8529: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8530: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8531: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8532: libraries built and installed, then use
8533: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8534: <p>If your package makes use of the platform-independent library
1.87 wiz 8535: for loading dynamic shared objects, that comes with libtool
8536: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8537: <p>Some packages use libtool incorrectly so that the package
8538: may not work or build in some circumstances. Some of the more
8539: common errors are:</p>
1.148 asau 8540: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8541: <li class="listitem">
1.75 rillig 8542: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8543: executable or library. This in itself isn't a problem if one of two things
8544: has been done:</p>
1.128 wiz 8545: <div class="orderedlist"><ol class="orderedlist" type="1">
8546: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8547: <code class="filename">libfoo.la</code>, not
8548: <code class="filename">foo.la</code></p></li>
1.128 wiz 8549: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8550: </ol></div>
8551: </li>
1.128 wiz 8552: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8553: The function lt_dlinit() should be called and the macro
8554: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8555: executables.</p></li>
1.75 rillig 8556: </ul></div>
8557: </div>
1.148 asau 8558: <div class="sect2">
1.75 rillig 8559: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8560: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8561: <p>If a package needs GNU autoconf or automake to be executed
1.338 nia 8562: to regenerate the
8563: <code class="filename">configure</code>
8564: script and <code class="filename">Makefile.in</code> makefile
8565: templates from <code class="filename">configure.ac</code> and
8566: <code class="filename">Makefile.am</code>,
8567: then they should be executed in a pre-configure target:</p>
1.75 rillig 8568: <pre class="programlisting">
1.338 nia 8569: USE_TOOLS+= autoconf automake autoreconf
8570: GNU_CONFIGURE= yes
1.100 rillig 8571: ...
1.1 grant 8572:
1.100 rillig 8573: pre-configure:
1.338 nia 8574: set -e; cd ${WRKSRC} && autoreconf -fi
1.100 rillig 8575: ...
1.222 sevan 8576: </pre>
1.338 nia 8577: <p>Packages which use GNU Automake will sometimes
8578: require GNU Make (<code class="literal">gmake</code> in
8579: <code class="varname">USE_TOOLS</code>),
8580: but not always. Note that autoreconf
8581: only needs to be executed if <code class="filename">configure.ac</code>
8582: or Makefiles are modified, or <code class="filename">configure</code>
8583: is not present.</p>
1.75 rillig 8584: <p>There are times when the configure process makes
1.87 wiz 8585: additional changes to the generated files, which then causes
8586: the build process to try to re-execute the automake sequence.
8587: This is prevented by touching various files in the configure
8588: stage. If this causes problems with your package you can set
8589: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8590: Makefile.</p>
1.75 rillig 8591: </div>
1.338 nia 8592: <div class="sect2">
8593: <div class="titlepage"><div><div><h3 class="title">
8594: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
8595: <p>Packages using Meson to configure need to include:
8596:
8597: </p>
8598: <pre class="programlisting">
8599: .include "../../devel/meson/build.mk"
8600: </pre>
8601: <p>In nearly all cases (any program with dependencies),
8602: pkg-config needs to be added to
8603: <code class="varname">USE_TOOLS</code>. If the package installs
8604: translation files for non-English languages, also
8605: add msgfmt and xgettext:
8606:
8607: </p>
8608: <pre class="programlisting">
8609: USE_TOOLS+= pkg-config msgfmt xgettext
8610: </pre>
8611: <p>If any options need to be passed to Meson, use
8612: <code class="varname">MESON_ARGS</code> instead of
8613: <code class="varname">CONFIGURE_ARGS</code>:
8614:
8615: </p>
8616: <pre class="programlisting">
8617: MESON_ARGS+= -Dx11=false
8618: </pre>
8619: </div>
1.75 rillig 8620: </div>
1.148 asau 8621: <div class="sect1">
1.75 rillig 8622: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8623: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148 asau 8624: <div class="sect2">
1.87 wiz 8625: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8626: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.358 gutterid 8627: <p>Compilers for the C and C++ languages come with
1.87 wiz 8628: the NetBSD base system. By default, pkgsrc assumes that a package
8629: is written in C and will hide all other compilers (via the wrapper
1.299 rillig 8630: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.357 gutterid 8631: <p>To declare which languages should be made available through
8632: pkgsrc's compiler wrappers, use
1.87 wiz 8633: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.327 wiz 8634: currently are:
1.352 wiz 8635: </p>
1.327 wiz 8636: <pre class="programlisting">
1.358 gutterid 8637: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.352 wiz 8638: </pre>
1.327 wiz 8639: <p>
8640: (and any combination). The default is
1.128 wiz 8641: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8642: written in C++, usually need a C compiler for the configure
1.358 gutterid 8643: phase.</p>
1.364 jnemeth 8644: <p>To declare which features a package requires from the
1.357 gutterid 8645: compiler, set either <code class="varname">USE_CC_FEATURES</code>
8646: or <code class="varname">USE_CXX_FEATURES</code>. Allowed values for
8647: <code class="varname">USE_CC_FEATURES</code> are currently:
8648: </p>
8649: <pre class="programlisting">
8650: c11, c99, has_include
8651: </pre>
8652: <p>
8653: Allowed values for <code class="varname">USE_CXX_FEATURES</code> are
8654: currently:
8655: </p>
8656: <pre class="programlisting">
8657: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
8658: charconv, parallelism_ts, unique_ptr, put_time,
8659: is_trivially_copy_constructible
8660: </pre>
8661: <p>
1.365 gutterid 8662: Note at present these variables only affect use of GCC, not other
8663: compilers.
1.357 gutterid 8664: </p>
1.358 gutterid 8665: <p>Language variants like <code class="literal">gnu99</code> and
8666: <code class="literal">c++11</code> can be specified in <code class="varname">FORCE_C_STD</code>
8667: and <code class="varname">FORCE_CXX_STD</code> if the package does not explicitly set
8668: <code class="literal">-std=...</code> when compiling (i.e. the package
8669: assumes the compiler defaults to C++11 or some other standard).
8670: This is a common bug in upstream build systems.</p>
8671: <p>Allowed values for <code class="varname">FORCE_C_STD</code> are
8672: currently:
8673: </p>
8674: <pre class="programlisting">
8675: c90, c99, c11, gnu90, gnu99, gnu11
8676: </pre>
8677: <p>
8678: </p>
8679: <p>Allowed values for <code class="varname">FORCE_CXX_STD</code> are
8680: currently:
8681: </p>
8682: <pre class="programlisting">
8683: c++03, c++11, c++14, c++17, c++20,
8684: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
8685: </pre>
8686: <p>
1.365 gutterid 8687: Note at present these variables only affect use of GCC and Clang.
1.358 gutterid 8688: </p>
1.87 wiz 8689: </div>
1.148 asau 8690: <div class="sect2">
1.87 wiz 8691: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8692: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87 wiz 8693: <p>If a program is written in Java, use the Java framework in
8694: pkgsrc. The package must include
8695: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8696: provides the following variables:</p>
1.148 asau 8697: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8698: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8699: dependency on the JDK is added. If
1.128 wiz 8700: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8701: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8702: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8703: JDK.</p></li>
1.128 wiz 8704: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8705: a package needs a Java2 implementation. The supported values
1.128 wiz 8706: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8707: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8708: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8709: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8710: above. This variable is not set by default.</p></li>
1.130 wiz 8711: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8712: automatically set to the runtime location of the used Java
8713: implementation dependency. It may be used to set
8714: <code class="varname">JAVA_HOME</code> to a good value if the program
8715: needs this variable to be defined.
8716: </p></li>
1.87 wiz 8717: </ul></div>
8718: </div>
1.148 asau 8719: <div class="sect2">
1.87 wiz 8720: <div class="titlepage"><div><div><h3 class="title">
1.320 wiz 8721: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
8722: <p>If a program is written in Go and has any dependencies on
8723: other Go modules, have the package include
8724: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8725: <div class="orderedlist"><ol class="orderedlist" type="1">
8726: <li class="listitem"><p>Generate a list of those dependencies with
8727: <span class="command"><strong>make clean && make patch && make show-go-modules >
8728: go-modules.mk</strong></span>.</p></li>
1.338 nia 8729: <li class="listitem"><p>Prepend
8730: <code class="literal">.include "go-modules.mk"</code> to any other
8731: <code class="literal">.include</code>s.</p></li>
8732: <li class="listitem"><p>Incorporate these modules in
8733: <code class="filename">distinfo</code> with <span class="command"><strong>make
8734: makesum</strong></span>.</p></li>
8735: </ol></div>
8736: </div>
8737: <div class="sect2">
8738: <div class="titlepage"><div><div><h3 class="title">
8739: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
8740: <p>If a program is written in Rust and uses Cargo to build,
8741: have the package include
8742: <code class="filename">../../lang/rust/cargo.mk</code>.</p>
8743: <div class="orderedlist"><ol class="orderedlist" type="1">
8744: <li class="listitem"><p>Generate a list of those dependencies with
8745: <span class="command"><strong>make CARGO_ARGS="build --release" build &&
8746: make print-cargo-depends > cargo-depends.mk</strong></span>.</p></li>
8747: <li class="listitem"><p>Prepend
8748: <code class="literal">.include "cargo-depends.mk"</code> to any other
8749: <code class="literal">.include</code>s.</p></li>
1.320 wiz 8750: <li class="listitem"><p>Incorporate these modules in
8751: <code class="filename">distinfo</code> with <span class="command"><strong>make
8752: makesum</strong></span>.</p></li>
8753: </ol></div>
8754: </div>
8755: <div class="sect2">
8756: <div class="titlepage"><div><div><h3 class="title">
1.338 nia 8757: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.318 nia 8758: <p>If your package contains interpreted Perl scripts, add
1.128 wiz 8759: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8760: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8761: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8762: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8763: that you want adjusted. Every occurrence of
8764: <code class="filename">*/bin/perl</code> in a she-bang line will be
1.325 gutterid 8765: replaced with the full path to the Perl executable.</p>
8766: <p>If a particular version of Perl is needed, set the
1.87 wiz 8767: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8768: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.318 nia 8769: <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 8770: about handling Perl modules.</p>
8771: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
8772: for the language now known as Raku.</p>
1.87 wiz 8773: </div>
1.148 asau 8774: <div class="sect2">
1.87 wiz 8775: <div class="titlepage"><div><div><h3 class="title">
1.338 nia 8776: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.147 wiz 8777: <p><code class="varname">REPLACE_SH</code>,
8778: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8779: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.340 gutterid 8780: she-bangs in files. Please use the appropriate one, preferring
8781: <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.183 wiz 8782: Each should contain a list of scripts, relative to
8783: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8784: occurrence of the matching shell in a she-bang line will be
8785: replaced with the full path to the shell executable.
1.147 wiz 8786: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8787: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8788: </div>
1.148 asau 8789: <div class="sect2">
1.147 wiz 8790: <div class="titlepage"><div><div><h3 class="title">
1.338 nia 8791: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.325 gutterid 8792: <p>There are further similar REPLACE variables available, e.g.,
8793: <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
8794: and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.326 gutterid 8795: noted above, have their actions defined centrally in
1.325 gutterid 8796: <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.326 gutterid 8797: languages define the actions of these variables within their own
8798: dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
1.359 gutterid 8799: actioned in <code class="filename">lang/php/replace.mk</code>, and
1.326 gutterid 8800: <code class="varname">REPLACE_PYTHON</code> is actioned in
1.325 gutterid 8801: <code class="filename">lang/python/application.mk</code>. For other languages,
8802: consult the mk files found within their specific directories (the
1.331 gutterid 8803: naming convention varies), or check the list found in
8804: <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.325 gutterid 8805: <p>Currently, special handling for other languages varies
1.87 wiz 8806: in pkgsrc. If a compiler package provides a
8807: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8808: just add a (build) dependency on the appropriate compiler
8809: package.</p>
8810: </div>
8811: </div>
1.148 asau 8812: <div class="sect1">
1.87 wiz 8813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8814: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8815: <p>The most common failures when building a package are that
8816: some platforms do not provide certain header files, functions or
8817: libraries, or they provide the functions in a library that the
8818: original package author didn't know. To work around this, you
8819: can rewrite the source code in most cases so that it does not
8820: use the missing functions or provides a replacement function.</p>
1.148 asau 8821: <div class="sect2">
1.77 rillig 8822: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8823: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8824: <p>If a package already comes with a GNU configure script, the
8825: preferred way to fix the build failure is to change the
8826: configure script, not the code. In the other cases, you can
8827: utilize the C preprocessor, which defines certain macros
8828: depending on the operating system and hardware architecture it
8829: compiles for. These macros can be queried using for example
8830: <code class="varname">#if defined(__i386)</code>. Almost every operating
8831: system, hardware architecture and compiler has its own macro.
8832: For example, if the macros <code class="varname">__GNUC__</code>,
8833: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8834: are all defined, you know that you are using NetBSD on an i386
8835: compatible CPU, and your compiler is GCC.</p>
8836: <p>The list of the following macros for hardware and
8837: operating system depends on the compiler that is used. For
8838: example, if you want to conditionally compile code on Solaris,
8839: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8840: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8841: <div class="sect3">
1.75 rillig 8842: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8843: <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 8844: <p>To distinguish between specific NetBSD versions,
8845: you should use the following code.</p>
8846: <pre class="programlisting">
8847: #ifdef __NetBSD__
8848: #include <sys/param.h>
8849: #if __NetBSD_Prereq__(9,99,17)
8850: /* use a newer feature */
8851: #else
8852: /* older code */
8853: #endif
8854: #endif
8855:
8856: #ifndef _WIN32
8857: /* Unix-like specific code */
8858: #endif
8859: </pre>
1.75 rillig 8860: <p>To distinguish between 4.4 BSD-derived systems and the
8861: rest of the world, you should use the following code.</p>
8862: <pre class="programlisting">
1.100 rillig 8863: #include <sys/param.h>
8864: #if (defined(BSD) && BSD >= 199306)
8865: /* BSD-specific code goes here */
8866: #else
8867: /* non-BSD-specific code goes here */
8868: #endif
1.75 rillig 8869: </pre>
1.338 nia 8870: <p>You can also test for the following macros:</p>
1.75 rillig 8871: <pre class="programlisting">
1.151 obache 8872: Cygwin __CYGWIN__
8873: DragonFly __DragonFly__
1.100 rillig 8874: FreeBSD __FreeBSD__
1.151 obache 8875: Haiku __HAIKU__
1.100 rillig 8876: Interix __INTERIX
8877: IRIX __sgi (TODO: get a definite source for this)
1.338 nia 8878: Linux __linux
1.193 dholland 8879: Mac OS X __APPLE__
1.151 obache 8880: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8881: Minix3 __minix
1.100 rillig 8882: NetBSD __NetBSD__
8883: OpenBSD __OpenBSD__
8884: Solaris sun, __sun
1.75 rillig 8885: </pre>
8886: </div>
1.148 asau 8887: <div class="sect3">
1.75 rillig 8888: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8889: <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 8890: <pre class="programlisting">
1.100 rillig 8891: i386 i386, __i386, __i386__
1.338 nia 8892: x86-64 __amd64__, __x86_64__
8893: ARM __arm__
1.100 rillig 8894: MIPS __mips
8895: SPARC sparc, __sparc
1.338 nia 8896: PowerPC __powerpc
1.75 rillig 8897: </pre>
8898: </div>
1.148 asau 8899: <div class="sect3">
1.75 rillig 8900: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8901: <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 8902: <pre class="programlisting">
1.100 rillig 8903: GCC __GNUC__ (major version), __GNUC_MINOR__
8904: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8905: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8906: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8907: </pre>
8908: </div>
8909: </div>
1.148 asau 8910: <div class="sect2">
1.78 rillig 8911: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8912: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8913: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8914: combinations of compiler version and architecture and almost
8915: always relation to optimisation being enabled. Common symptoms
8916: are gcc internal errors or never finishing compiling a
1.78 rillig 8917: file.</p>
8918: <p>Typically, a workaround involves testing the
8919: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8920: optimisation for that combination of file,
1.198 tnn 8921: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8922: <p>This used to be a big problem in the past, but is rarely
8923: needed now as compiler technology has matured. If you still need
8924: to add a compiler specific workaround, please do so in the file
8925: <code class="filename">hacks.mk</code> and describe the symptom and
8926: compiler version as detailed as possible.</p>
1.78 rillig 8927: </div>
1.148 asau 8928: <div class="sect2">
1.78 rillig 8929: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 8930: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8931: <p>Compilation sometimes fails with an error message like this:</p>
8932: <pre class="programlisting">
8933: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8934: fatal error: pango/pango.h: No such file or directory
8935: </pre>
8936: <p>The proper way to fix this problem depends on the type of the
8937: header, which is described in the following sections.</p>
8938: <div class="sect3">
8939: <div class="titlepage"><div><div><h4 class="title">
8940: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8941: <p>If the header name looks like it comes from a different package,
8942: that other package should be included via the buildlink3
8943: framework.</p>
8944: <p>First, look whether the header is somewhere in the buildlink3
8945: directory below <code class="varname">WRKDIR</code>. In the above case of
8946: the missing Pango header:</p>
8947: <pre class="programlisting">
8948: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8949: </pre>
8950: <p>In the case of Pango, the output is:</p>
8951: <pre class="programlisting">
8952: work/.buildlink/include/pango-1.0/pango/pango.h
8953: </pre>
8954: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8955: in the <code class="filename">.buildlink</code> directory, it would have been
8956: found automatically. There is an extra <code class="filename">pango-1.0</code>
8957: path component though, which means that the compiler command line must
8958: contain an option of the form
8959: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8960: most cases this option is generated by the configure script, which can be examined using:</p>
8961: <pre class="programlisting">
8962: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8963: -I/usr/pkg/include/pango-1.0
8964: -I/usr/pkg/include/pango-1.0
8965: -I/usr/pkg/include/pango-1.0
8966: -I/usr/pkg/include/pango-1.0
8967: -I/usr/pkg/include/pango-1.0
8968: </pre>
8969: <p>This looks good. These options are transformed by the buildlink
8970: wrapper to refer to the correct path inside
8971: <code class="filename">work/.buildlink</code>.</p>
8972: <p>Since the compilation fails though, examine the compiler command
8973: lines in <code class="filename">work/.work.log</code> to see whether the
8974: <code class="literal">-I</code> option is included in the particular command
8975: line.</p>
8976: <p>To further analyze the situation, run <span class="command"><strong>bmake
8977: build-env</strong></span>, which sets up an interactive, realistic environment
8978: including all the pkgsrc wrapper commands and environment variables. From
8979: there, try to compile some simple example programs that use the
8980: header.</p>
8981: </div>
8982: <div class="sect3">
8983: <div class="titlepage"><div><div><h4 class="title">
8984: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8985: <p>If the name of the header seems to come from the package itself,
8986: and if the build is run with parallel jobs, the package may have some
8987: undeclared dependencies between the <code class="filename">.c</code> and the
8988: <code class="filename">.h</code> files, and a C file is compiled before its
8989: required header is generated.</p>
8990: <p>To see whether the build runs with parallel jobs, run
8991: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8992: like this:</p>
8993: <pre class="programlisting">
8994: usr MAKE_JOBS= 7
8995: pkg MAKE_JOBS_SAFE # undefined
8996: def _MAKE_JOBS_N= 7
8997: </pre>
8998: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8999: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
9000: package could have disabled parallel builds by setting
9001: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
9002: in this case it hasn't.</p>
9003: <p>To see whether the build failure is caused by parallel builds,
9004: first save the exact error message and a bit of context, maybe you need
9005: it later for reporting a bug. Next, run:</p>
9006: <pre class="programlisting">
9007: MAKE_JOBS_SAFE=no bmake clean build
9008: </pre>
9009: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
9010: report</a> against the pkgsrc package, including the exact error
9011: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
9012: </div>
1.288 rillig 9013: <div class="sect3">
9014: <div class="titlepage"><div><div><h4 class="title">
9015: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
9016: <p>Pkgsrc does not work reliably if any of
9017: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
9018: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
9019: bootstrap program prevents installing pkgsrc in symlink-based
9020: directories. Existing pkgsrc installations are not checked for symlinks
9021: though.</p>
9022: <p>The "No such file or directory" error messages are a typical
9023: symptom of symlinks, and it's quite difficult to find out that this is
9024: the actual cause.</p>
9025: </div>
9026: <div class="sect3">
9027: <div class="titlepage"><div><div><h4 class="title">
9028: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
9029: <p>When building a hierarchy of packages, it may happen that one
9030: package is built and then pkgsrc is updated. This situation can provoke
9031: various hard to diagnose build errors. To clean up the situation:</p>
9032: <pre class="programlisting">
1.338 nia 9033: <code class="prompt">$</code> (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.288 rillig 9034: </pre>
1.338 nia 9035: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
9036: prevent running this command in the wrong directory.)</p>
1.288 rillig 9037: <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
9038: that directory as well.</p>
9039: </div>
9040: <div class="sect3">
9041: <div class="titlepage"><div><div><h4 class="title">
9042: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
9043: <p>On platforms other than BSD, third-party packages are installed in
9044: <code class="filename">/usr/include</code>, together with the base system. This
9045: means that pkgsrc cannot distinguish between headers provided by the base
9046: system (which it needs) and headers from third-party packages (which are
9047: often included in pkgsrc as well). This can lead to subtle version
9048: mismatches.</p>
9049: <p>In pkgsrc installations that have been active for several years, it
9050: may happen that some files are manually deleted. To exclude this unlikely
9051: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
9052: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
9053: check/fix dependencies.</p>
9054: <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>
9055: for contact information. Be prepared to describe what you have tried so
9056: far and what any error messages were.</p>
9057: </div>
1.287 rillig 9058: </div>
9059: <div class="sect2">
9060: <div class="titlepage"><div><div><h3 class="title">
9061: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.128 wiz 9062: </h3></div></div></div>
1.92 rillig 9063: <p>This error message often means that a package did not
1.78 rillig 9064: link to a shared library it needs. The following functions are
9065: known to cause this error message over and over.</p>
9066: <div class="informaltable">
1.216 tnn 9067: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78 rillig 9068: <colgroup>
9069: <col>
9070: <col>
9071: <col>
9072: </colgroup>
9073: <thead><tr>
9074: <th>Function</th>
9075: <th>Library</th>
9076: <th>Affected platforms</th>
9077: </tr></thead>
9078: <tbody>
9079: <tr>
9080: <td>accept, bind, connect</td>
9081: <td>-lsocket</td>
9082: <td>Solaris</td>
9083: </tr>
9084: <tr>
9085: <td>crypt</td>
9086: <td>-lcrypt</td>
9087: <td>DragonFly, NetBSD</td>
9088: </tr>
9089: <tr>
9090: <td>dlopen, dlsym</td>
9091: <td>-ldl</td>
9092: <td>Linux</td>
9093: </tr>
9094: <tr>
9095: <td>gethost*</td>
9096: <td>-lnsl</td>
9097: <td>Solaris</td>
9098: </tr>
9099: <tr>
9100: <td>inet_aton</td>
9101: <td>-lresolv</td>
9102: <td>Solaris</td>
9103: </tr>
9104: <tr>
9105: <td>nanosleep, sem_*, timer_*</td>
9106: <td>-lrt</td>
9107: <td>Solaris</td>
9108: </tr>
9109: <tr>
9110: <td>openpty</td>
9111: <td>-lutil</td>
9112: <td>Linux</td>
9113: </tr>
9114: </tbody>
9115: </table>
9116: </div>
1.338 nia 9117: <p>To fix these linker errors, it is often sufficient to add
1.87 wiz 9118: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
9119: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.338 nia 9120: <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.87 wiz 9121: bmake</strong></span>.</p>
1.148 asau 9122: <div class="sect3">
1.92 rillig 9123: <div class="titlepage"><div><div><h4 class="title">
1.338 nia 9124: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.92 rillig 9125: <p>When you are using the SunPro compiler, there is another
9126: possibility. That compiler cannot handle the following code:</p>
9127: <pre class="programlisting">
1.100 rillig 9128: extern int extern_func(int);
1.93 rillig 9129:
1.100 rillig 9130: static inline int
9131: inline_func(int x)
9132: {
1.92 rillig 9133: return extern_func(x);
1.100 rillig 9134: }
1.93 rillig 9135:
1.100 rillig 9136: int main(void)
9137: {
1.92 rillig 9138: return 0;
1.100 rillig 9139: }
1.92 rillig 9140: </pre>
9141: <p>It generates the code for <code class="function">inline_func</code> even if
9142: that function is never used. This code then refers to
9143: <code class="function">extern_func</code>, which can usually not be resolved. To
9144: solve this problem you can try to tell the package to disable inlining
9145: of functions.</p>
9146: </div>
1.343 gutterid 9147: <div class="sect3">
9148: <div class="titlepage"><div><div><h4 class="title">
9149: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
9150: <p>When building for older machine architectures (e.g., i386, PowerPC),
9151: builds may fail because the package expects modern 64-bit atomic functions
9152: which the underlying hardware either doesn't support, or will only support
9153: with specific compiler flags. This is generally handled via inclusion of
9154: mk/atomic64.mk.</p>
9155: </div>
1.87 wiz 9156: </div>
1.148 asau 9157: <div class="sect2">
1.87 wiz 9158: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 9159: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87 wiz 9160: <p>Sometimes packages fail to build because the compiler runs
9161: into an operating system specific soft limit. With the
9162: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.338 nia 9163: to unlimit the resources. The allowed values are any combination of
9164: <span class="quote">“<span class="quote">cputime</span>”</span>,
9165: <span class="quote">“<span class="quote">datasize</span>”</span>,
9166: <span class="quote">“<span class="quote">memorysize</span>”</span>,
9167: <span class="quote">“<span class="quote">stacksize</span>”</span> and
9168: <span class="quote">“<span class="quote">virtualsize</span>”</span>.
1.87 wiz 9169: Setting this variable is similar to running the shell builtin
1.110 hubertf 9170: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 9171: segment size or maximum stack size of a process, respectively, to
9172: their hard limits.</p>
1.78 rillig 9173: </div>
1.75 rillig 9174: </div>
1.148 asau 9175: <div class="sect1">
1.75 rillig 9176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9177: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 9178: <div class="sect2">
1.75 rillig 9179: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9180: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 9181: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 9182: with some operating systems cannot create more than one
9183: directory at a time. As such, you should call
9184: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
9185: <pre class="programlisting">
1.100 rillig 9186: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
9187: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222 sevan 9188: </pre>
1.338 nia 9189: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
9190: directly, you can also append <span class="quote">“<span class="quote"><code class="literal">dir1
9191: dir2</code></span>”</span> to the <code class="varname">INSTALLATION_DIRS</code>
9192: variable, which will automatically do the right thing.</p>
1.75 rillig 9193: </div>
1.148 asau 9194: <div class="sect2">
1.75 rillig 9195: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9196: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 9197: <p>In general, documentation should be installed into
1.87 wiz 9198: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.338 nia 9199: <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.87 wiz 9200: includes the version number of the package).</p>
1.84 wiz 9201: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 9202: directory where HTML documentation is installed with the
1.338 nia 9203: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag is
9204: needed because otherwise the documentation ends up in
9205: <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
9206: pkgsrc, the HTML documentation should go into the package-specific
9207: directory, just like any other documentation.</p>
1.87 wiz 9208: <p>An exception to the above is that library API documentation
1.322 leot 9209: 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 9210: browsers (devhelp) should be left at their default location, which
9211: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
9212: documentation can be recognized from files ending in
9213: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
9214: (It is also acceptable to install such files in
9215: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
9216: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
9217: <code class="filename">.devhelp*</code> file must be directly in that
9218: directory then, no additional subdirectory level is allowed in
9219: this case. This is usually achieved by using
1.128 wiz 9220: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 9221: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
9222: though.)</p>
1.75 rillig 9223: </div>
1.148 asau 9224: <div class="sect2">
1.75 rillig 9225: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9226: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 9227: <p>Certain packages, most of them in the games category, install
1.87 wiz 9228: a score file that allows all users on the system to record their
9229: highscores. In order for this to work, the binaries need to be
9230: installed setgid and the score files owned by the appropriate
1.142 wiz 9231: group and/or owner (traditionally the "games" user/group). Set
9232: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 9233: following variables, documented in more detail in
9234: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 9235: behaviour: <code class="varname">GAMEDATAMODE</code>,
9236: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210 leot 9237: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
9238: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
9239: <code class="varname">GAMEDATA_PERMS</code> and
9240: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
9241: <p>An example that illustrates some of the variables described above is
9242: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
9243: used to properly set directory permissions of the directory where the
9244: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
9245: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
9246: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
9247: binary:</p>
9248: <pre class="programlisting">
1.223 rillig 9249: USE_GAMESGROUP= yes
1.210 leot 9250:
1.223 rillig 9251: BUILD_DEFS+= VARBASE
1.210 leot 9252:
1.223 rillig 9253: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
9254: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
9255: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222 sevan 9256: </pre>
1.210 leot 9257: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
9258: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
9259: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
9260: needed to be accessed by setgid games and
9261: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114 jmcneill 9262: <p>A package should therefore never hard code file ownership or
1.210 leot 9263: access permissions but rely on <code class="varname">*_PERMS</code> as described above
9264: or alternatively on <code class="varname">INSTALL_GAME</code>,
9265: <code class="varname">INSTALL_GAME_DATA</code> and
9266: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75 rillig 9267: </div>
1.148 asau 9268: <div class="sect2">
1.75 rillig 9269: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9270: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 9271: <p><code class="varname">DESTDIR</code> support means that a package
9272: installs into a staging directory, not the final location of the
9273: files. Then a binary package is created which can be used for
9274: installation as usual. There are two ways: Either the package must
1.128 wiz 9275: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9276: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 9277: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9278: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224 leot 9279: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
9280: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145 wiz 9281: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9282: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 9283: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9284: the inclusion.</p></li>
1.128 wiz 9285: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 9286: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 9287: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 9288: automatically. Many manual rules and pre/post-install often are
9289: incorrect; fix them.</p></li>
1.128 wiz 9290: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 9291: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 9292: <li class="listitem"><p>In general, packages should support
1.103 wiz 9293: <code class="varname">UNPRIVILEGED</code> to be able to use
9294: DESTDIR.</p></li>
9295: </ul></div>
9296: </div>
1.148 asau 9297: <div class="sect2">
1.103 wiz 9298: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9299: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 9300: <p>Your package may also contain scripts with hardcoded paths to
1.318 nia 9301: other interpreters besides (or as well as) Perl. To correct the
1.87 wiz 9302: full pathname to the script interpreter, you need to set the
9303: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 9304: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 9305: <pre class="programlisting">
1.100 rillig 9306: REPLACE_INTERPRETER+= tcl
9307: REPLACE.tcl.old= .*/bin/tclsh
9308: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9309: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9310: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222 sevan 9311: </pre>
1.75 rillig 9312: </div>
1.148 asau 9313: <div class="sect2">
1.75 rillig 9314: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9315: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.75 rillig 9316: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 9317: the Makefile fragment
9318: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 9319: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 9320: configuration for such modules as well as various hooks to tune
9321: this configuration. See comments in this file for
9322: details.</p>
1.75 rillig 9323: <p>Perl5 modules will install into different places depending
1.87 wiz 9324: on the version of perl used during the build process. To
9325: address this, pkgsrc will append lines to the
9326: <code class="filename">PLIST</code> corresponding to the files listed in
9327: the installed <code class="filename">.packlist</code> file generated by
9328: most perl5 modules. This is invoked by defining
9329: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 9330: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9331: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9332: e.g.:</p>
1.75 rillig 9333: <pre class="programlisting">
1.153 wiz 9334: PERL5_PACKLIST= auto/Pg/.packlist
1.222 sevan 9335: </pre>
1.153 wiz 9336: <p>The perl5 config variables
9337: <code class="varname">installarchlib</code>,
9338: <code class="varname">installscript</code>,
9339: <code class="varname">installvendorbin</code>,
9340: <code class="varname">installvendorscript</code>,
9341: <code class="varname">installvendorarch</code>,
9342: <code class="varname">installvendorlib</code>,
9343: <code class="varname">installvendorman1dir</code>, and
9344: <code class="varname">installvendorman3dir</code> represent those
9345: locations in which components of perl5 modules may be installed,
9346: provided as variable with uppercase and prefixed with
9347: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9348: and may be used by perl5 packages that don't have a packlist.
9349: These variables are also substituted for in the
9350: <code class="filename">PLIST</code> as uppercase prefixed with
9351: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 9352: </div>
1.148 asau 9353: <div class="sect2">
1.75 rillig 9354: <div class="titlepage"><div><div><h3 class="title">
1.369 wiz 9355: <a name="faq.pkg-config-files"></a>21.6.7. Packages installing pkg-config files</h3></div></div></div>
9356: <p>Some packages, usually those providing libraries, install
9357: pkg-config files so that their headers and libraries can easily be
9358: found. The file names end with <code class="filename">.pc</code>.</p>
9359: <p>Most of the time, these files only provide the linker flags
9360: for the library, but do not include the flags for setting the
9361: rpath so the libraries can also be found at runtime. Since this is
9362: so common, pkgsrc provides <code class="varname">PKGCONFIG_OVERRIDE</code>
9363: for this. Many packages generate the <code class="filename">.pc</code> from
9364: <code class="filename">.pc.in</code>, in that case add those files to the
9365: <code class="varname">PKGCONFIG_OVERRIDE</code> variable:</p>
9366: <pre class="programlisting">
9367: PKGCONFIG_OVERRIDE+= foo.pc.in
9368: </pre>
9369: <p>For packages using meson, the files are generated during
9370: build and you also need to change the phase in which the
9371: replacement is done. For example:</p>
9372: <pre class="programlisting">
9373: PKGCONFIG_OVERRIDE+= output/meson-private/foo.pc
9374: PKGCONFIG_OVERRIDE_STAGE= post-build
9375: </pre>
9376: </div>
9377: <div class="sect2">
9378: <div class="titlepage"><div><div><h3 class="title">
9379: <a name="faq.info-files"></a>21.6.8. Packages installing info files</h3></div></div></div>
1.75 rillig 9380: <p>Some packages install info files or use the
1.128 wiz 9381: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 9382: commands. <code class="varname">INFO_FILES</code> should be defined in
9383: the package Makefile so that <code class="filename">INSTALL</code> and
9384: <code class="filename">DEINSTALL</code> scripts will be generated to
9385: handle registration of the info files in the Info directory
1.128 wiz 9386: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 9387: files registration is either provided by the system, or by a
9388: special purpose package automatically added as dependency if
9389: needed.</p>
1.75 rillig 9390: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 9391: <code class="filename">${PREFIX}</code> where info files are primarily
9392: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 9393: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 9394: <p>The info files for the package should be listed in the
1.87 wiz 9395: package <code class="filename">PLIST</code>; however any split info files
9396: need not be listed.</p>
1.128 wiz 9397: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9398: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 9399: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 9400: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 9401: should be noted with the <code class="varname">TEXINFO_REQD</code>
9402: variable in the package <code class="filename">Makefile</code>. By
9403: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 9404: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 9405: does not match the required minimum, a build dependency on the
1.322 leot 9406: <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 9407: be added automatically.</p>
1.75 rillig 9408: <p>The build and installation process of the software provided
1.87 wiz 9409: by the package should not use the
1.110 hubertf 9410: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 9411: info files is the task of the package
9412: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 9413: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 9414: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 9415: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9416: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 9417: in <code class="varname">PATH</code>.</p>
1.110 hubertf 9418: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 9419: no effect except the logging of a message. The script overriding
1.110 hubertf 9420: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 9421: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 9422: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 9423: </div>
1.148 asau 9424: <div class="sect2">
1.75 rillig 9425: <div class="titlepage"><div><div><h3 class="title">
1.369 wiz 9426: <a name="manpages"></a>21.6.9. Packages installing man pages</h3></div></div></div>
1.81 rillig 9427: <p>All packages that install manual pages should install them
1.87 wiz 9428: into the same directory, so that there is one common place to look
9429: for them. In pkgsrc, this place is
9430: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9431: should be used in packages. The default for
9432: <code class="varname">PKGMANDIR</code> is
1.128 wiz 9433: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9434: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 9435: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9436: <h3 class="title">Note</h3>
1.87 wiz 9437: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9438: is far from complete.</p>
1.75 rillig 9439: </div>
1.81 rillig 9440: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 9441: <code class="filename">man/</code> as the top level directory for the man
9442: page file entries, and the pkgsrc framework will convert as
9443: needed. In all other places, the correct
9444: <code class="varname">PKGMANDIR</code> must be used.</p>
9445: <p>Packages that are
9446: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 9447: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 9448: <code class="filename">./configure</code>
9449: --mandir switch to set where the man pages should be installed.
9450: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9451: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9452: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9453: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 9454: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 9455: Or if the <code class="filename">./configure</code> script uses
9456: a non-standard use of --mandir, you can set
9457: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299 rillig 9458: <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 9459: information on installation of compressed manual pages.</p>
1.75 rillig 9460: </div>
1.148 asau 9461: <div class="sect2">
1.75 rillig 9462: <div class="titlepage"><div><div><h3 class="title">
1.369 wiz 9463: <a name="x11-fonts"></a>21.6.10. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9464: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9465: the fonts database in the directory where they get installed at
9466: installation and deinstallation time. This can be automatically
9467: done by using the pkginstall framework.</p>
1.75 rillig 9468: <p>You can list the directories where fonts are installed in the
1.87 wiz 9469: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9470: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 9471: <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 9472: Also make sure that the database file
9473: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9474: <p>Note that you should not create new directories for fonts;
1.87 wiz 9475: instead use the standard ones to avoid that the user needs to
9476: manually configure his X server to find them.</p>
1.75 rillig 9477: </div>
1.148 asau 9478: <div class="sect2">
1.75 rillig 9479: <div class="titlepage"><div><div><h3 class="title">
1.369 wiz 9480: <a name="sgml-xml-data"></a>21.6.11. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9481: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9482: registered in system-wide catalogs (like DTDs, sub-catalogs,
9483: etc.), you need to take some extra steps:</p>
1.128 wiz 9484: <div class="orderedlist"><ol class="orderedlist" type="1">
9485: <li class="listitem"><p>Include
1.87 wiz 9486: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9487: your <code class="filename">Makefile</code>, which takes care of
9488: registering those files in system-wide catalogs at
9489: installation and deinstallation time.</p></li>
1.128 wiz 9490: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9491: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9492: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9493: any XML catalogs installed by the package.</p></li>
1.128 wiz 9494: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9495: to be added to the SGML catalog. These come in groups of
9496: three strings; see xmlcatmgr(1) for more information
9497: (specifically, arguments recognized by the 'add' action).
9498: Note that you will normally not use this variable.</p></li>
1.128 wiz 9499: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9500: to be added to the XML catalog. These come in groups of three
9501: strings; see xmlcatmgr(1) for more information (specifically,
9502: arguments recognized by the 'add' action). Note that you will
9503: normally not use this variable.</p></li>
1.75 rillig 9504: </ol></div>
9505: </div>
1.148 asau 9506: <div class="sect2">
1.75 rillig 9507: <div class="titlepage"><div><div><h3 class="title">
1.369 wiz 9508: <a name="mime-database"></a>21.6.12. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9509: <p>If a package provides extensions to the MIME database by
1.87 wiz 9510: installing <code class="filename">.xml</code> files inside
9511: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9512: need to take some extra steps to ensure that the database is kept
9513: consistent with respect to these new files:</p>
1.128 wiz 9514: <div class="orderedlist"><ol class="orderedlist" type="1">
9515: <li class="listitem"><p>Include
1.87 wiz 9516: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9517: (avoid using the <code class="filename">buildlink3.mk</code> file from
9518: this same directory, which is reserved for inclusion from
9519: other <code class="filename">buildlink3.mk</code> files). It takes
9520: care of rebuilding the MIME database at installation and
9521: deinstallation time, and disallows any access to it directly
9522: from the package.</p></li>
1.128 wiz 9523: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9524: <code class="filename">share/mime</code> directory,
9525: <span class="emphasis"><em>except</em></span> for files saved under
9526: <code class="filename">share/mime/packages</code>. The former are
9527: handled automatically by
9528: the update-mime-database program, but the latter are
9529: package-dependent and must be removed by the package that
9530: installed them in the first place.</p></li>
1.128 wiz 9531: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9532: from the PLIST. They will be handled by the shared-mime-info
9533: package.</p></li>
1.75 rillig 9534: </ol></div>
9535: </div>
1.148 asau 9536: <div class="sect2">
1.75 rillig 9537: <div class="titlepage"><div><div><h3 class="title">
1.369 wiz 9538: <a name="intltool"></a>21.6.13. Packages using intltool</h3></div></div></div>
1.93 rillig 9539: <p>If a package uses intltool during its build, add
9540: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9541: which forces it to use the intltool package provided by pkgsrc,
9542: instead of the one bundled with the distribution file.</p>
1.75 rillig 9543: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9544: latest available version; this way, the package benefits of any
9545: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9546: </div>
1.148 asau 9547: <div class="sect2">
1.75 rillig 9548: <div class="titlepage"><div><div><h3 class="title">
1.369 wiz 9549: <a name="startup-scripts"></a>21.6.14. Packages installing startup scripts</h3></div></div></div>
1.374 wiz 9550: <p>If a package contains an rc.d script, it won't be copied into
9551: the startup directory (<code class="filename">/etc/rc.d</code>) by default,
9552: but you can enable copying by setting the option
9553: <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
9554: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. With <code class="varname">PKG_RCD_SCRIPTS=YES</code>, rc.d scripts
9555: will be copied into <code class="filename">/etc/rc.d</code> when a package
9556: is installed, but only if the target does not already exist.
9557: Copies in <code class="filename">/etc/rc.d</code> will be automatically removed
9558: only if they have not been modified.
9559: </p>
9560: <p>Note that this alone does not enable the service: It must still be
9561: added to <code class="filename">/etc/rc.conf</code>.</p>
1.75 rillig 9562: </div>
1.148 asau 9563: <div class="sect2">
1.75 rillig 9564: <div class="titlepage"><div><div><h3 class="title">
1.369 wiz 9565: <a name="tex-packages"></a>21.6.15. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9566: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9567: the <code class="filename">ls-R</code> database of the tree needs to be
9568: updated.</p>
1.148 asau 9569: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9570: <h3 class="title">Note</h3>
1.125 wiz 9571: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9572: packages should install files
1.125 wiz 9573: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9574: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9575: </div>
1.128 wiz 9576: <div class="orderedlist"><ol class="orderedlist" type="1">
9577: <li class="listitem"><p>Include
1.125 wiz 9578: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9579: takes care of rebuilding the <code class="filename">ls-R</code>
9580: database at installation and deinstallation time.</p></li>
1.128 wiz 9581: <li class="listitem">
1.75 rillig 9582: <p>If your package installs files into a texmf
1.87 wiz 9583: tree other than the one
1.125 wiz 9584: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9585: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9586: trees that need database update.</p>
1.75 rillig 9587: <p>If your package also installs font map files that need
1.110 hubertf 9588: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9589: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9590: set <code class="varname">TEX_MAP_FILES</code> and/or
9591: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9592: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9593: be run automatically at installation/deinstallation to
9594: enable/disable font map files for TeX output
9595: drivers.</p>
1.75 rillig 9596: </li>
1.128 wiz 9597: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9598: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9599: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9600: </ol></div>
9601: </div>
1.148 asau 9602: <div class="sect2">
1.85 jmmv 9603: <div class="titlepage"><div><div><h3 class="title">
1.369 wiz 9604: <a name="emulation-packages"></a>21.6.16. Packages supporting running binaries in
1.87 wiz 9605: emulation</h3></div></div></div>
9606: <p>There are some packages that provide libraries and
9607: executables for running binaries from a one operating system
9608: on a different one (if the latter supports it). One example
9609: is running Linux binaries on NetBSD.</p>
1.322 leot 9610: <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 9611: helps in extracting and packaging Linux rpm packages.</p>
9612: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9613: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9614: if all libraries for each installed executable can be found by
9615: the dynamic linker. Since the standard dynamic linker is run,
9616: this fails for emulation packages, because the libraries used
9617: by the emulation are not in the standard directories.</p>
9618: </div>
1.299 rillig 9619: <div class="sect2">
9620: <div class="titlepage"><div><div><h3 class="title">
1.369 wiz 9621: <a name="hicolor-theme"></a>21.6.17. Packages installing hicolor icons</h3></div></div></div>
1.299 rillig 9622: <p>If a package installs images under the
9623: <code class="filename">share/icons/hicolor</code> and/or updates the
9624: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9625: database, you need to take some extra steps to make sure that the
9626: shared theme directory is handled appropriately and that the cache
9627: database is rebuilt:</p>
9628: <div class="orderedlist"><ol class="orderedlist" type="1">
9629: <li class="listitem"><p>Include
9630: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9631: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9632: entry that refers to the theme cache.</p></li>
9633: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9634: directories from the <code class="filename">share/icons/hicolor</code>
9635: hierarchy because they will be handled automatically.</p></li>
9636: </ol></div>
9637: <p>The best way to verify that the PLIST is correct with
9638: respect to the last two points is to regenerate it using
9639: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9640: </div>
9641: <div class="sect2">
9642: <div class="titlepage"><div><div><h3 class="title">
1.369 wiz 9643: <a name="desktop-files"></a>21.6.18. Packages installing desktop files</h3></div></div></div>
1.299 rillig 9644: <p>If a package installs <code class="filename">.desktop</code> files
9645: under <code class="filename">share/applications</code> and these include
9646: MIME information (MimeType key), you need to take extra steps to
9647: ensure that they are registered into the MIME database:</p>
9648: <div class="orderedlist"><ol class="orderedlist" type="1">
9649: <li class="listitem"><p>Include
9650: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9651: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9652: <code class="filename">share/applications/mimeinfo.cache</code> file.
9653: It will be handled automatically.</p></li>
9654: </ol></div>
9655: <p>The best way to verify that the PLIST is correct with
9656: respect to the last point is to regenerate it using <span class="command"><strong>make
9657: print-PLIST</strong></span>.</p>
9658: </div>
9659: </div>
9660: <div class="sect1">
9661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9662: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9663: <p>In some cases one does not have the time to solve a problem
9664: immediately. In this case, one can plainly mark a package as broken. For
9665: this, one just sets the variable <code class="varname">BROKEN</code> to the
9666: reason why the package is broken (similar to the
9667: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9668: the package will immediately be shown this message, and the build
9669: will not be even tried.</p>
9670: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9671: intervals.</p>
9672: </div>
9673: </div>
9674: <div class="chapter">
9675: <div class="titlepage"><div><div><h2 class="title">
9676: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9677: <div class="toc">
9678: <p><b>Table of Contents</b></p>
9679: <dl class="toc">
9680: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9681: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9682: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9683: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9684: </dl>
9685: </div>
9686: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9687: site</a>:</p>
9688: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9689: environment, an intuitive and attractive desktop for users, and the
9690: GNOME development platform, an extensive framework for building
9691: applications that integrate into the rest of the desktop.</p></blockquote></div>
9692: <p>pkgsrc provides a seamless way to automatically build and install
9693: a complete GNOME environment <span class="emphasis"><em>under many different
9694: platforms</em></span>. We can say with confidence that pkgsrc is one of
9695: the most advanced build and packaging systems for GNOME due to its
9696: included technologies buildlink3, the wrappers and tools framework and
9697: automatic configuration file management. Lots of efforts are put into
9698: achieving a completely clean deinstallation of installed software
9699: components.</p>
9700: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9701: the above also means that great efforts are put into making GNOME work
1.316 cirnatda 9702: under this operating system.</p>
1.299 rillig 9703: <p>This chapter is aimed at pkgsrc developers and other people
9704: interested in helping our GNOME porting and packaging efforts. It
9705: provides instructions on how to manage the existing packages and some
9706: important information regarding their internals.</p>
9707: <div class="sect1">
9708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9709: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9710: <p>pkgsrc includes three GNOME-related meta packages:</p>
9711: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 9712: <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 9713: the core GNOME desktop environment. It only includes the necessary
9714: bits to get it to boot correctly, although it may lack important
9715: functionality for daily operation. The idea behind this package is
9716: to let end users build their own configurations on top of this one,
9717: first installing this meta package to achieve a functional setup and
9718: then adding individual applications.</p></li>
1.322 leot 9719: <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 9720: complete installation of the GNOME platform and desktop as defined
9721: by the GNOME project; this is based on the components distributed in
9722: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9723: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9724: official FTP server. Developer-only tools found in those
9725: directories are not installed unless required by some other
9726: component to work properly. Similarly, packages from the bindings
9727: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9728: in unless required as a dependency for an end-user component. This
1.322 leot 9729: 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>
9730: <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 9731: Installs all the tools required to build a GNOME component when
9732: fetched from the CVS repository. These are required to let the
9733: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9734: </ul></div>
9735: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9736: sorted in a way that eases updates: a package may depend on other
9737: packages listed before it but not on any listed after it. It is very
9738: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9739: change it to alphabetical sorting!</em></span></p>
9740: </div>
9741: <div class="sect1">
9742: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9743: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9744: <p>Almost all GNOME applications are written in C and use a common
9745: set of tools as their build system. Things get different with the new
9746: bindings to other languages (such as Python), but the following will
9747: give you a general idea on the minimum required tools:</p>
9748: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9749: <li class="listitem">
9750: <p>Almost all GNOME applications use the GNU Autotools as their
9751: build system. As a general rule you will need to tell this to your
9752: package:</p>
9753: <pre class="programlisting">
1.338 nia 9754: GNU_CONFIGURE= yes
9755: USE_LIBTOOL= yes
9756: USE_TOOLS+= gmake
1.299 rillig 9757: </pre>
9758: </li>
9759: <li class="listitem">
9760: <p>If the package uses pkg-config to detect dependencies, add this
9761: tool to the list of required utilities:</p>
9762: <pre class="programlisting">
1.338 nia 9763: USE_TOOLS+= pkg-config
1.299 rillig 9764: </pre>
1.322 leot 9765: <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 9766: the end of the build process to ensure that you did not miss to
9767: specify any dependency in your package and that the version
9768: requirements are all correct.</p>
9769: </li>
9770: <li class="listitem"><p>If the package uses intltool, be sure to add
9771: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9772: to handle dependencies and to force the package to use the latest
9773: available version.</p></li>
9774: <li class="listitem">
9775: <p>If the package uses gtk-doc (a documentation generation
9776: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9777: tool is rather big and the distfile should come with pregenerated
9778: documentation anyway; if it does not, it is a bug that you ought to
9779: report. For such packages you should disable gtk-doc (unless it is
9780: the default):</p>
9781: <pre class="programlisting">
1.338 nia 9782: CONFIGURE_ARGS+= --disable-gtk-doc
1.299 rillig 9783: </pre>
9784: <p>The default location of installed HTML files
9785: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9786: and should not be changed unless the package insists on installing
9787: them somewhere else. Otherwise programs as
9788: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9789: do that with an entry similar to:</p>
9790: <pre class="programlisting">
1.338 nia 9791: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.299 rillig 9792: </pre>
9793: </li>
9794: </ul></div>
9795: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9796: files under the installation prefix to maintain databases. In this
9797: context, shared means that those exact same directories and files are
9798: used among several different packages, leading to conflicts in the
9799: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9800: handle the most common cases, so you have to forget about using
9801: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9802: omitting shared files from them. If you find yourself doing those,
9803: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9804: <p>The following table lists the common situations that result in
9805: using shared directories or files. For each of them, the appropriate
9806: solution is given. After applying the solution be sure to
9807: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9808: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9809: <div class="table">
9810: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9811: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9812: <colgroup>
9813: <col>
9814: <col>
9815: </colgroup>
9816: <thead><tr>
9817: <th>If the package...</th>
9818: <th>Then...</th>
9819: </tr></thead>
9820: <tbody>
9821: <tr>
9822: <td>Installs icons under the
9823: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9824: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.369 wiz 9825: <td>See <a class="xref" href="#hicolor-theme" title="21.6.17. Packages installing hicolor icons">Section 21.6.17, “Packages installing hicolor icons”</a>.</td>
1.299 rillig 9826: </tr>
9827: <tr>
9828: <td>Installs files under
9829: <code class="filename">share/mime/packages</code>.</td>
1.369 wiz 9830: <td>See <a class="xref" href="#mime-database" title="21.6.12. Packages installing extensions to the MIME database">Section 21.6.12, “Packages installing extensions to the MIME database”</a>.</td>
1.299 rillig 9831: </tr>
9832: <tr>
9833: <td>Installs <code class="filename">.desktop</code> files under
9834: <code class="filename">share/applications</code> and these include MIME
9835: information.</td>
1.369 wiz 9836: <td>See <a class="xref" href="#desktop-files" title="21.6.18. Packages installing desktop files">Section 21.6.18, “Packages installing desktop files”</a>.</td>
1.299 rillig 9837: </tr>
9838: </tbody>
9839: </table></div>
1.75 rillig 9840: </div>
1.299 rillig 9841: <br class="table-break">
1.75 rillig 9842: </div>
1.148 asau 9843: <div class="sect1">
1.87 wiz 9844: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 9845: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9846: <p>When seeing GNOME as a whole, there are two kinds of
9847: updates:</p>
9848: <div class="variablelist"><dl class="variablelist">
9849: <dt><span class="term">Major update</span></dt>
9850: <dd>
9851: <p>Given that there is still a very long way for GNOME 3 (if it
9852: ever appears), we consider a major update one that goes from a
9853: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9854: where <code class="literal">Y</code> is even and greater than
9855: <code class="literal">X</code>. These are hard to achieve because they
9856: introduce lots of changes in the components' code and almost all
9857: GNOME distfiles are updated to newer versions. Some of them can
9858: even break API and ABI compatibility with the previous major
9859: version series. As a result, the update needs to be done all at
9860: once to minimize breakage.</p>
9861: <p>A major update typically consists of around 80 package
9862: updates and the addition of some new ones.</p>
9863: </dd>
9864: <dt><span class="term">Minor update</span></dt>
9865: <dd>
9866: <p>We consider a minor update one that goes from a
9867: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9868: one where <code class="literal">Y</code> is greater than
9869: <code class="literal">X</code>. These are easy to achieve because they do
9870: not update all GNOME components, can be done in an incremental way
9871: and do not break API nor ABI compatibility.</p>
9872: <p>A minor update typically consists of around 50 package
9873: updates, although the numbers here may vary a lot.</p>
9874: </dd>
9875: </dl></div>
9876: <p>In order to update the GNOME components in pkgsrc to a new stable
9877: release (either major or minor), the following steps should be
9878: followed:</p>
9879: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128 wiz 9880: <li class="listitem">
1.299 rillig 9881: <p>Get a list of all the tarballs that form the new release by
9882: using the following commands. These will leave the full list of the
9883: components' distfiles into the <code class="filename">list.txt</code>
9884: file:</p>
9885: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9886: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9887: awk '{ print $9 }' >list.txt</code></strong>
9888: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9889: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9890: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.75 rillig 9891: </li>
1.299 rillig 9892: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9893: bump their version to the release you are updating them to. The
9894: three meta packages should be always consistent with versioning.
9895: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9896: in them.</p></li>
1.128 wiz 9897: <li class="listitem">
1.299 rillig 9898: <p>For each meta package, update all its
9899: <code class="varname">DEPENDS</code> lines to match the latest versions as
9900: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9901: newer version (even if found in the FTP) because the meta packages
9902: are supposed to list the exact versions that form a specific GNOME
9903: release. Exceptions are permitted here if a newer version solves a
9904: serious issue in the overall desktop experience; these typically
9905: come in the form of a revision bump in pkgsrc, not in newer versions
9906: from the developers.</p>
9907: <p>Packages not listed in the <code class="filename">list.txt</code> file
9908: should be updated to the latest version available (if found in
9909: pkgsrc). This is the case, for example, of the dependencies on the
1.322 leot 9910: 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 9911: </li>
1.128 wiz 9912: <li class="listitem">
1.299 rillig 9913: <p>Generate a patch from the modified meta packages and extract the
9914: list of "new" lines. This will provide you an outline on what
9915: packages need to be updated in pkgsrc and in what order:</p>
9916: <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 9917: </li>
1.299 rillig 9918: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9919: installed packages and start over from scratch at this point.</p></li>
9920: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9921: of <code class="filename">todo.txt</code> and update the packages listed in
9922: it in order. For major desktop updates none of these should be
9923: committed until the entire set is completed because there are chances
9924: of breaking not-yet-updated packages.</p></li>
9925: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9926: the tree one by one with appropriate log messages. At the end,
9927: commit the three meta package updates and all the corresponding
9928: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9929: <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>
9930: </ol></div>
9931: </div>
9932: <div class="sect1">
9933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9934: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9935: <p>GNOME is a very big component in pkgsrc which approaches 100
9936: packages. Please, it is very important that you always, always,
9937: <span class="strong"><strong>always</strong></span> feed back any portability
9938: 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
9939: their attention on portability issues and to ensure that future versions
9940: can be built out-of-the box on NetBSD. The less custom patches in
9941: pkgsrc, the easier further updates are. Those developers in charge of
9942: issuing major GNOME updates will be grateful if you do that.</p>
1.315 cirnatda 9943: <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
9944: GitLab</a>. Not all components use these to track bugs, but most
1.299 rillig 9945: of them do. Do not be short on your reports: always provide detailed
9946: explanations of the current failure, how it can be improved to achieve
1.315 cirnatda 9947: maximum portability and, if at all possible, provide a patch against the
9948: main Git branch. The more verbose you are, the higher chances of your
9949: patch being accepted.</p>
1.299 rillig 9950: <p>Also, please avoid using preprocessor magic to fix portability
9951: issues. While the FreeBSD GNOME people are doing a great job in porting
9952: GNOME to their operating system, the official GNOME sources are now
9953: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9954: and similar macros. This hurts portability. Please see our patching
9955: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9956: details.</p>
9957: </div>
1.75 rillig 9958: </div>
1.148 asau 9959: <div class="chapter">
1.75 rillig 9960: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9961: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75 rillig 9962: <div class="toc">
9963: <p><b>Table of Contents</b></p>
1.210 leot 9964: <dl class="toc">
1.267 rillig 9965: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9966: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9967: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9968: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9969: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9970: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9971: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9972: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9973: </dl>
9974: </div>
1.148 asau 9975: <div class="sect1">
1.75 rillig 9976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9977: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9978: <p>Our policy is that we accept binaries only from pkgsrc
9979: developers to guarantee that the packages don't contain any
9980: trojan horses etc. This is not to annoy anyone but rather to
9981: protect our users! You're still free to put up your home-made
9982: binary packages and tell the world where to get them. NetBSD
9983: developers doing bulk builds and wanting to upload them please
1.267 rillig 9984: 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 9985: builds)</i></a>.</p>
1.75 rillig 9986: </div>
1.148 asau 9987: <div class="sect1">
1.75 rillig 9988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9989: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.333 nia 9990: <p>Firstly, you can import new packages into
9991: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
9992: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
9993: for details.</p>
9994: <p>Next, check that your package is complete, compiles and
1.299 rillig 9995: 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 9996: 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>
9997: tool and fix any errors that appear.</p>
9998: <p>Finally, send a report to the pkgsrc bug tracking system,
1.378 ! leot 9999: either with the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 10000: that, go to the web page
1.289 leot 10001: <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 10002: which contains some instructions and a link to a form where you
10003: can submit packages. The
1.322 leot 10004: <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 10005: also available as a substitute for either of the above two tools.
10006: </p>
1.87 wiz 10007: <p>In the form of the problem report, the category should be
1.128 wiz 10008: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 10009: and version number, and the description field should contain a
10010: short description of your package (contents of the COMMENT
1.333 nia 10011: variable or DESCR file are OK).</p>
1.75 rillig 10012: </div>
1.148 asau 10013: <div class="sect1">
1.75 rillig 10014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10015: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 10016: <p>Please note all package additions, updates, moves, and
1.93 rillig 10017: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 10018: important to keep this file up to date and conforming to the
10019: existing format, because it will be used by scripts to
1.289 leot 10020: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 10021: sites. Additionally, check the
1.76 rillig 10022: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 10023: for the package you updated or removed, in case it was mentioned
10024: there.</p>
10025: <p>When the <code class="varname">PKGREVISION</code> of a package is
10026: bumped, the change should appear in
1.93 rillig 10027: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 10028: related or otherwise relevant. Mass bumps that result from a
10029: dependency being updated should not be mentioned. In all other
10030: cases it's the developer's decision.</p>
10031: <p>There is a make target that helps in creating proper
1.110 hubertf 10032: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 10033: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
10034: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 10035: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 10036: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 10037: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
10038: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 10039: For new packages, or package moves or removals, set the
10040: <code class="varname">CTYPE</code> variable on the command line to "Added",
10041: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 10042: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 10043: not the same as your NetBSD login name. The target also automatically
10044: removes possibly existing entries for the package in the
10045: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 10046: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 10047: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 10048: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
10049: makes the cvs commands use the main repository.
10050: </p>
1.75 rillig 10051: </div>
1.148 asau 10052: <div class="sect1">
1.75 rillig 10053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10054: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243 wiz 10055: <p>For several years, there have been mirrors of pkgsrc in
1.375 jkoshy 10056: fossil, git, and hg. Standard practice when using these tools is to
1.243 wiz 10057: make the first line of a commit message function as a summary that
10058: can be read without the rest, such as is commonly done with "git log
10059: --oneline". For this reason, we have the following guidelines for
10060: pkgsrc commit messages:</p>
10061: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10062: <li class="listitem"><p>Start the commit message with a line that explains the
1.244 wiz 10063: big picture in 65 characters or less. When a commit is for one
1.243 wiz 10064: package, include the name of the package. For updates, include the
10065: version to which it is updated.</p></li>
10066: <li class="listitem"><p>Leave the next line empty.</p></li>
10067: <li class="listitem"><p>Then come the details for the commit (changes in that
10068: package, reason for a change) and any relevant PRs. Wrap this
10069: section.</p></li>
10070: </ul></div>
10071: <p>Here is an example:
1.352 wiz 10072: </p>
1.243 wiz 10073: <pre class="programlisting">
1.352 wiz 10074: libxslt: update to 1.0.30
1.243 wiz 10075:
1.352 wiz 10076: Changes since 1.0.29:
10077: ...
10078: </pre>
1.243 wiz 10079: <p>
10080: </p>
10081: <p>Here is another example:
1.352 wiz 10082: </p>
1.243 wiz 10083: <pre class="programlisting">
1.352 wiz 10084: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.243 wiz 10085:
1.352 wiz 10086: (rationale)
10087: </pre>
1.243 wiz 10088: <p>
10089: </p>
10090: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
10091: allowed on the pkgsrc repository to change commit messages.</p>
10092: </div>
10093: <div class="sect1">
10094: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10095: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 10096: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 10097: access to the pkgsrc repository.</p>
10098: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
10099: Start by adding the directory and then files in the directory. Don't
10100: forget to add the new package to the category's
10101: <code class="filename">Makefile</code>. Make sure you don't forget any files;
10102: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
10103: <pre class="programlisting">
10104: <code class="prompt">$</code> cd .../pkgsrc/category
10105: <code class="prompt">$</code> cvs add pkgname
10106: <code class="prompt">$</code> cd pkgname
10107: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
10108: <code class="prompt">$</code> cvs add patches/p*
10109: <code class="prompt">$</code> cvs status | less
1.141 wiz 10110: <code class="prompt">$</code> cvs commit
1.140 wiz 10111: <code class="prompt">$</code> cd ..
1.350 gutterid 10112: <code class="prompt">$</code> vi Makefile # add SUBDIR+=pkgname line
1.141 wiz 10113: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 10114: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 10115: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 10116: </pre>
1.87 wiz 10117: <p>The commit message of the initial import should include part of the
1.76 rillig 10118: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 10119: what the package is/does.</p>
1.140 wiz 10120: <p>Also mention the new package in
10121: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
10122: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
10123: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 10124: </div>
1.148 asau 10125: <div class="sect1">
1.75 rillig 10126: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10127: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 10128: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 10129: changes between old and new versions into the commit log when updating
1.87 wiz 10130: a package. There are various reasons for this:</p>
1.148 asau 10131: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10132: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 10133: or its information may be overwritten by newer information.</p></li>
1.128 wiz 10134: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 10135: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 10136: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 10137: repository is very useful for people who read the pkgsrc-changes mailing
10138: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 10139: the package.</p></li>
1.75 rillig 10140: </ul></div>
1.87 wiz 10141: <p>Please also recognize that, just because a new version of a package
1.75 rillig 10142: has been released, it should not automatically be upgraded in the CVS
10143: repository. We prefer to be conservative in the packages that are
10144: included in pkgsrc - development or beta packages are not really the
10145: best thing for most places in which pkgsrc is used. Please use your
10146: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 10147: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 10148: </div>
1.148 asau 10149: <div class="sect1">
1.75 rillig 10150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10151: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122 reed 10152: <p>Renaming packages is not recommended.</p>
1.290 gutterid 10153: <p>When renaming packages, be sure to fix any references to the old name
1.122 reed 10154: in other Makefiles, options, buildlink files, etc.</p>
1.282 leot 10155: <p>
1.290 gutterid 10156: Also, when renaming a package, please add
1.282 leot 10157: the package name and version pattern(s) of the previous package
10158: to <code class="varname">SUPERSEDES</code>.
1.122 reed 10159: This may be repeated for multiple renames.
10160: The new package would be an exact replacement.
1.282 leot 10161: Example:
1.122 reed 10162: </p>
1.282 leot 10163: <pre class="programlisting">
10164: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
10165: SUPERSEDES+= optcomp-[0-9]*
10166: </pre>
1.128 wiz 10167: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 10168: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
10169: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
10170: not be an exact replacement but is a suggestion for the replaced
10171: functionality.</p>
10172: </div>
1.148 asau 10173: <div class="sect1">
1.122 reed 10174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10175: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122 reed 10176: <p>It is preferred that packages are not renamed or moved, but if needed
10177: please follow these steps.
10178: </p>
1.128 wiz 10179: <div class="orderedlist"><ol class="orderedlist" type="1">
10180: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
10181: <li class="listitem">
1.75 rillig 10182: <p>Remove all CVS dirs.</p>
1.87 wiz 10183: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 10184: <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 10185: <p>and use that for further work.</p>
1.75 rillig 10186: </li>
1.128 wiz 10187: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
10188: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
10189: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
10190: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 10191: <code class="varname">PREV_PKGPATH</code> to the previous category/package
10192: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
10193: for doing an update using pkgsrc building; for example, it can
1.378 ! leot 10194: search the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 10195: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
10196: new <code class="varname">PKGPATH</code> for that moved package. Note that
10197: it may have multiple matches, so the tool should also check on the
10198: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
10199: probably has no value unless <code class="varname">SUPERSEDES</code> is not
10200: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.351 gutterid 10201: <li class="listitem"><p><span class="command"><strong>cvs add</strong></span> the modified package in the new
1.75 rillig 10202: place.</p></li>
1.128 wiz 10203: <li class="listitem">
1.75 rillig 10204: <p>Check if any package depends on it:
10205: </p>
10206: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
10207: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
10208: </li>
1.128 wiz 10209: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
10210: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
10211: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
10212: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
10213: <li class="listitem">
1.75 rillig 10214: <p>Commit the changed and removed files:</p>
10215: <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 10216: <p>(and any packages from step 5, of course).</p>
1.75 rillig 10217: </li>
10218: </ol></div>
10219: </div>
10220: </div>
1.148 asau 10221: <div class="chapter">
1.75 rillig 10222: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 10223: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 10224: <p>This section contains the answers to questions that may
10225: arise when you are writing a package. If you don't find your
10226: question answered here, first have a look in the other chapters,
10227: and if you still don't have the answer, ask on the
10228: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 10229: <div class="qandaset">
1.289 leot 10230: <a name="devfaq.qandaset"></a><dl>
1.267 rillig 10231: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 10232: MAKEFLAGS, .MAKEFLAGS and
10233: MAKE_FLAGS?</a>
10234: </dt>
1.267 rillig 10235: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 10236: MAKE, GMAKE and
10237: MAKE_PROGRAM?</a>
10238: </dt>
1.267 rillig 10239: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 10240: CC, PKG_CC and
10241: PKGSRC_COMPILER?</a>
10242: </dt>
1.338 nia 10243: <dt>24.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 10244: VARNAME=BUILDLINK_PREFIX.foo
10245: say it's empty?</a>
10246: </dt>
1.338 nia 10247: <dt>24.5. <a href="#devfaq.master_sites">What does
1.78 rillig 10248: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
10249: don't understand the := inside
10250: it.</a>
10251: </dt>
1.338 nia 10252: <dt>24.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 10253: developers?</a>
10254: </dt>
1.338 nia 10255: <dt>24.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 10256: documentation?</a>
10257: </dt>
1.338 nia 10258: <dt>24.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.289 leot 10259: What shall I do?</a>
1.92 rillig 10260: </dt>
1.75 rillig 10261: </dl>
1.148 asau 10262: <table border="0" style="width: 100%;">
10263: <colgroup>
1.75 rillig 10264: <col align="left" width="1%">
1.128 wiz 10265: <col>
1.148 asau 10266: </colgroup>
1.75 rillig 10267: <tbody>
1.148 asau 10268: <tr class="question">
1.75 rillig 10269: <td align="left" valign="top">
1.289 leot 10270: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75 rillig 10271: </td>
10272: <td align="left" valign="top"><p>What is the difference between
10273: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10274: <code class="varname">MAKE_FLAGS</code>?</p></td>
10275: </tr>
10276: <tr class="answer">
1.91 rillig 10277: <td align="left" valign="top"></td>
1.338 nia 10278: <td align="left" valign="top">
10279: <p><code class="varname">MAKEFLAGS</code> are the flags passed
1.378 ! leot 10280: to the pkgsrc-internal invocations of <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.</p>
1.338 nia 10281: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
10282: passed to the <code class="varname">MAKE_PROGRAM</code> when building the
10283: package.</p>
10284: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
10285: <span class="command"><strong>bmake</strong></span> and should not be used by
10286: packages.</p>
10287: </td>
1.75 rillig 10288: </tr>
1.148 asau 10289: <tr class="question">
1.75 rillig 10290: <td align="left" valign="top">
1.289 leot 10291: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75 rillig 10292: </td>
10293: <td align="left" valign="top"><p>What is the difference between
10294: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10295: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10296: </tr>
10297: <tr class="answer">
1.91 rillig 10298: <td align="left" valign="top"></td>
1.338 nia 10299: <td align="left" valign="top">
10300: <p><code class="varname">MAKE</code> is the path to the
1.378 ! leot 10301: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.338 nia 10302: infrastructure.</p>
10303: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
10304: need to say <code class="varname">USE_TOOLS+=gmake</code> to use
10305: that.</p>
10306: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
10307: program that is used for building the package.</p>
10308: </td>
1.75 rillig 10309: </tr>
1.148 asau 10310: <tr class="question">
1.75 rillig 10311: <td align="left" valign="top">
1.289 leot 10312: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75 rillig 10313: </td>
10314: <td align="left" valign="top"><p>What is the difference between
10315: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10316: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10317: </tr>
10318: <tr class="answer">
1.91 rillig 10319: <td align="left" valign="top"></td>
1.75 rillig 10320: <td align="left" valign="top">
1.338 nia 10321: <p><code class="varname">CC</code> is the path to the real C
10322: compiler, which can be configured by the pkgsrc user.</p>
10323: <p><code class="varname">PKG_CC</code> is the path to the compiler
10324: wrapper.</p>
10325: <p><code class="varname">PKGSRC_COMPILER</code> is
10326: <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
10327: compiler that should be used. See
10328: <code class="filename">mk/compiler.mk</code> for more information about
10329: the latter variable.</p>
1.75 rillig 10330: </td>
10331: </tr>
1.148 asau 10332: <tr class="question">
1.75 rillig 10333: <td align="left" valign="top">
1.338 nia 10334: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.4.</b></p>
1.75 rillig 10335: </td>
1.110 hubertf 10336: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 10337: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10338: say it's empty?</p></td>
10339: </tr>
10340: <tr class="answer">
1.91 rillig 10341: <td align="left" valign="top"></td>
1.75 rillig 10342: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 10343: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10344: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 10345: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 10346: command.</p></td>
10347: </tr>
1.148 asau 10348: <tr class="question">
1.78 rillig 10349: <td align="left" valign="top">
1.338 nia 10350: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.5.</b></p>
1.78 rillig 10351: </td>
10352: <td align="left" valign="top"><p>What does
1.220 wiz 10353: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10354: don't understand the <code class="code">:=</code> inside
1.78 rillig 10355: it.</p></td>
10356: </tr>
10357: <tr class="answer">
1.91 rillig 10358: <td align="left" valign="top"></td>
1.338 nia 10359: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
10360: assignment operator, even though it may look like one.
1.78 rillig 10361: Instead, it is a degenerate form of
1.220 wiz 10362: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.378 ! leot 10363: which is documented in the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220 wiz 10364: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78 rillig 10365: case of <code class="varname">MASTER_SITE_*</code>,
10366: <em class="replaceable"><code>old_string</code></em> is the empty string and
10367: <em class="replaceable"><code>new_string</code></em> is
1.220 wiz 10368: <code class="code">package/</code>. That's where the
10369: <code class="code">:</code> and the <code class="code">=</code> fall
1.78 rillig 10370: together.</p></td>
10371: </tr>
1.148 asau 10372: <tr class="question">
1.78 rillig 10373: <td align="left" valign="top">
1.338 nia 10374: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.6.</b></p>
1.78 rillig 10375: </td>
10376: <td align="left" valign="top"><p>Which mailing lists are there for package
10377: developers?</p></td>
10378: </tr>
10379: <tr class="answer">
1.91 rillig 10380: <td align="left" valign="top"></td>
1.148 asau 10381: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289 leot 10382: <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 10383: <dd><p>This is a list for technical discussions related
10384: to pkgsrc development, e.g. soliciting feedback for changes to
10385: pkgsrc infrastructure, proposed new features, questions related
10386: to porting pkgsrc to a new platform, advice for maintaining a
10387: package, patches that affect many packages, help requests moved
10388: from pkgsrc-users when an infrastructure bug is found,
10389: etc.</p></dd>
1.289 leot 10390: <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 10391: <dd><p>All bug reports in category "pkg" sent with
1.378 ! leot 10392: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/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 10393: directly; use one of the other mailing
10394: lists.</p></dd>
10395: </dl></div></td>
10396: </tr>
1.148 asau 10397: <tr class="question">
1.80 rillig 10398: <td align="left" valign="top">
1.338 nia 10399: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.7.</b></p>
1.80 rillig 10400: </td>
10401: <td align="left" valign="top"><p>Where is the pkgsrc
10402: documentation?</p></td>
10403: </tr>
10404: <tr class="answer">
1.91 rillig 10405: <td align="left" valign="top"></td>
1.80 rillig 10406: <td align="left" valign="top">
10407: <p>There are many places where you can find
10408: documentation about pkgsrc:</p>
1.148 asau 10409: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10410: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 10411: of chapters that explain large parts of pkgsrc, but some
10412: chapters tend to be outdated. Which ones they are is hard to
10413: say.</p></li>
1.289 leot 10414: <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 10415: about certain features, announcements of new parts of the pkgsrc
10416: infrastructure and sometimes even announcements that a certain
10417: feature has been marked as obsolete. The benefit here is that
10418: each message has a date appended to it.</p></li>
1.128 wiz 10419: <li class="listitem"><p>Many of the files in the
1.80 rillig 10420: <code class="filename">mk/</code> directory start with a comment that
10421: describes the purpose of the file and how it can be used by the
1.92 rillig 10422: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 10423: documentation is to run <span class="command"><strong>bmake
1.92 rillig 10424: help</strong></span>.</p></li>
1.128 wiz 10425: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 10426: information, but they tend to be highly abbreviated, especially
10427: for actions that occur often. Some contain a detailed
10428: description of what has changed, but they are geared towards the
10429: other pkgsrc developers, not towards an average pkgsrc user.
10430: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10431: don't know what has been before, these messages may not be worth
10432: too much to you.</p></li>
1.128 wiz 10433: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10434: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 10435: mind of the developer who wrote the code. To get this
1.110 hubertf 10436: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 10437: to see who has written it and ask on the
10438: <code class="literal">tech-pkg</code> mailing list, so that others can
10439: find your questions later (see above). To be sure that the
10440: developer in charge reads the mail, you may CC him or
10441: her.</p></li>
10442: </ul></div>
1.299 rillig 10443: </td>
10444: </tr>
10445: <tr class="question">
10446: <td align="left" valign="top">
1.338 nia 10447: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.8.</b></p>
1.299 rillig 10448: </td>
1.338 nia 10449: <td align="left" valign="top"><p>I have a little time to kill.
1.299 rillig 10450: What shall I do?</p></td>
10451: </tr>
10452: <tr class="answer">
10453: <td align="left" valign="top"></td>
10454: <td align="left" valign="top">
10455: <p>This is not really an FAQ yet, but here's the answer
10456: anyway.</p>
1.148 asau 10457: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 10458: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.322 leot 10459: <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 10460: will tell you about newer versions of installed packages that are
10461: available, but not yet updated in pkgsrc.</p></li>
10462: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10463: — it contains a list of suggested new packages and a list of
10464: cleanups and enhancements for pkgsrc that would be nice to
10465: have.</p></li>
10466: <li class="listitem"><p>Review packages for which review was requested on
10467: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10468: mailing list.</p></li>
1.85 jmmv 10469: </ul></div>
1.299 rillig 10470: </td>
1.85 jmmv 10471: </tr>
10472: </tbody>
1.299 rillig 10473: </table>
1.85 jmmv 10474: </div>
10475: </div>
1.75 rillig 10476: </div>
1.148 asau 10477: <div class="part">
1.75 rillig 10478: <div class="titlepage"><div><div><h1 class="title">
10479: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10480: <div class="partintro">
1.75 rillig 10481: <div></div>
10482: <p>This part of the guide deals with everything
10483: from the infrastructure that is behind the interfaces described
10484: in the developer's guide. A casual package maintainer should not
10485: need anything from this part.</p>
10486: <div class="toc">
10487: <p><b>Table of Contents</b></p>
1.210 leot 10488: <dl class="toc">
1.299 rillig 10489: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10490: <dd><dl>
1.299 rillig 10491: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10492: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10493: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.75 rillig 10494: <dd><dl>
1.299 rillig 10495: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10496: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.75 rillig 10497: </dl></dd>
1.299 rillig 10498: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10499: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10500: <dd><dl>
1.299 rillig 10501: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10502: <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 10503: </dl></dd>
1.299 rillig 10504: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10505: <dd><dl>
1.299 rillig 10506: <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>
10507: <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 10508: </dl></dd>
10509: </dl></dd>
1.299 rillig 10510: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 10511: <dd><dl>
1.299 rillig 10512: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10513: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10514: <dd><dl>
1.299 rillig 10515: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10516: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10517: </dl></dd>
10518: </dl></dd>
1.299 rillig 10519: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10520: <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 10521: </dl>
10522: </div>
10523: </div>
1.148 asau 10524: <div class="chapter">
1.75 rillig 10525: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10526: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10527: <div class="toc">
10528: <p><b>Table of Contents</b></p>
1.210 leot 10529: <dl class="toc">
1.299 rillig 10530: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10531: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10532: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81 rillig 10533: <dd><dl>
1.299 rillig 10534: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10535: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81 rillig 10536: </dl></dd>
1.299 rillig 10537: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10538: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10539: <dd><dl>
1.299 rillig 10540: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10541: <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 10542: </dl></dd>
1.299 rillig 10543: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10544: <dd><dl>
1.299 rillig 10545: <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>
10546: <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 10547: </dl></dd>
10548: </dl>
10549: </div>
10550: <p>The pkgsrc infrastructure consists of many small Makefile
10551: fragments. Each such fragment needs a properly specified
10552: interface. This chapter explains how such an interface looks
10553: like.</p>
1.148 asau 10554: <div class="sect1">
1.75 rillig 10555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10556: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10557: <p>Whenever a variable is defined in the pkgsrc
10558: infrastructure, the location and the way of definition provide
10559: much information about the intended use of that variable.
10560: Additionally, more documentation may be found in a header
10561: comment or in this pkgsrc guide.</p>
10562: <p>A special file is
10563: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10564: variables that are intended to be user-defined. They are either
10565: defined using the <code class="literal">?=</code> operator or they are
10566: left undefined because defining them to anything would
1.128 wiz 10567: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10568: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10569: file.</p>
10570: <p>Outside this file, the following conventions apply:
10571: Variables that are defined using the <code class="literal">?=</code>
10572: operator may be overridden by a package.</p>
10573: <p>Variables that are defined using the <code class="literal">=</code>
10574: operator may be used read-only at run-time.</p>
10575: <p>Variables whose name starts with an underscore must not be
10576: accessed outside the pkgsrc infrastructure at all. They may
10577: change without further notice.</p>
1.148 asau 10578: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10579: <h3 class="title">Note</h3>
10580: <p>These conventions are currently not applied
10581: consistently to the complete pkgsrc
10582: infrastructure.</p>
10583: </div>
10584: </div>
1.148 asau 10585: <div class="sect1">
1.81 rillig 10586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10587: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10588: <p>All variables that contain lists of things should default
10589: to being empty. Two examples that do not follow this rule are
10590: <code class="varname">USE_LANGUAGES</code> and
10591: <code class="varname">DISTFILES</code>. These variables cannot simply be
10592: modified using the <code class="literal">+=</code> operator in package
10593: <code class="filename">Makefile</code>s (or other files included by
10594: them), since there is no guarantee whether the variable is
10595: already set or not, and what its value is. In the case of
1.128 wiz 10596: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10597: the default value and just define it as in the following
10598: example.</p>
10599: <pre class="programlisting">
1.100 rillig 10600: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10601: </pre>
10602: <p>Because of the selection of this default value, the same
10603: value appears in many package Makefiles. Similarly for
10604: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10605: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10606: doesn't stand out. Nevertheless it is mentioned in many
10607: files.</p>
10608: </div>
1.148 asau 10609: <div class="sect1">
1.81 rillig 10610: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10611: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.148 asau 10612: <div class="sect2">
1.75 rillig 10613: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10614: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.75 rillig 10615: <p>Variable evaluation takes place either at load time or at
10616: runtime, depending on the context in which they occur. The
10617: contexts where variables are evaluated at load time are:</p>
1.148 asau 10618: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10619: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10620: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10621: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10622: <code class="literal">.for</code>,</p></li>
1.128 wiz 10623: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10624: </ul></div>
10625: <p>A special exception are references to the iteration
10626: variables of <code class="literal">.for</code> loops, which are expanded
10627: inline, no matter in which context they appear.</p>
10628: <p>As the values of variables may change during load time,
10629: care must be taken not to evaluate them by accident. Typical
10630: examples for variables that should not be evaluated at load time
10631: are <code class="varname">DEPENDS</code> and
10632: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10633: clear, here is an example:</p>
10634: <pre class="programlisting">
1.100 rillig 10635: CONFIGURE_ARGS= # none
10636: CFLAGS= -O
10637: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10638:
1.100 rillig 10639: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10640:
1.100 rillig 10641: CFLAGS+= -Wall
1.222 sevan 10642: </pre>
1.75 rillig 10643: <p>This code shows how the use of the <code class="literal">:=</code>
10644: operator can quickly lead to unexpected results. The first
10645: paragraph is fairly common code. The second paragraph evaluates
10646: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10647: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10648: <code class="literal">-Wall</code> is appended to the
10649: <code class="varname">CFLAGS</code>, but this addition will not appear in
10650: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10651: paragraphs from above typically occur in completely unrelated
10652: files.</p>
10653: </div>
1.148 asau 10654: <div class="sect2">
1.75 rillig 10655: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10656: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.75 rillig 10657: <p>After all the files have been loaded, the values of the
10658: variables cannot be changed anymore. Variables that are used in
10659: the shell commands are expanded at this point.</p>
10660: </div>
10661: </div>
1.148 asau 10662: <div class="sect1">
1.75 rillig 10663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10664: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10665: <p>There are many ways in which the definition and use of a
1.218 rillig 10666: variable can be restricted in order to detect bugs and violations
10667: of the (mostly unwritten) policies. A package can be checked with
10668: <code class="literal">pkglint -Wall</code> to see whether it meets these
10669: rules.</p>
1.78 rillig 10670: </div>
1.148 asau 10671: <div class="sect1">
1.78 rillig 10672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10673: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10674: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10675: of the following classes. Cases where a file falls into more
10676: than one class should be avoided as it often leads to subtle
10677: bugs.</p>
1.148 asau 10678: <div class="sect2">
1.75 rillig 10679: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10680: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10681: <p>In a traditional imperative programming language some of
1.76 rillig 10682: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10683: procedures. They take some input parameters and—after
10684: inclusion—provide a result in output parameters. Since all
1.76 rillig 10685: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10686: care must be taken not to use parameter names that have already
10687: another meaning. For example, <code class="varname">PKGNAME</code> is a
10688: bad choice for a parameter name.</p>
10689: <p>Procedures are completely evaluated at preprocessing time.
10690: That is, when calling a procedure all input parameters must be
10691: completely resolvable. For example,
10692: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10693: parameter since it is very likely that further text will be
10694: added after calling the procedure, which would effectively apply
10695: the procedure to only a part of the variable. Also, references
1.218 rillig 10696: to other variables will be modified after calling the
1.75 rillig 10697: procedure.</p>
10698: <p>A procedure can declare its output parameters either as
10699: suitable for use in preprocessing directives or as only
10700: available at runtime. The latter alternative is for variables
10701: that contain references to other runtime variables.</p>
10702: <p>Procedures shall be written such that it is possible to
10703: call the procedure more than once. That is, the file must not
10704: contain multiple-inclusion guards.</p>
10705: <p>Examples for procedures are
1.76 rillig 10706: <code class="filename">mk/bsd.options.mk</code> and
10707: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10708: that the parameters are evaluated at load time, they should be
10709: assigned using the <code class="literal">:=</code> operator, which should
10710: be used only for this purpose.</p>
10711: </div>
1.148 asau 10712: <div class="sect2">
1.75 rillig 10713: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10714: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10715: <p>Action files take some input parameters and may define
10716: runtime variables. They shall not define loadtime variables.
10717: There are action files that are included implicitly by the
10718: pkgsrc infrastructure, while other must be included
10719: explicitly.</p>
10720: <p>An example for action files is
1.76 rillig 10721: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10722: </div>
10723: </div>
1.148 asau 10724: <div class="sect1">
1.81 rillig 10725: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10726: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10727: <p>Package <code class="filename">Makefile</code>s usually consist of
10728: a set of variable definitions, and include the file
10729: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10730: Before that, they may also include various other
10731: <code class="filename">*.mk</code> files if they need to query the
10732: availability of certain features like the type of compiler or
10733: the X11 implementation. Due to the heavy use of preprocessor
10734: directives like <code class="literal">.if</code> and
10735: <code class="literal">.for</code>, the order in which the files are loaded
10736: matters.</p>
10737: <p>This section describes at which point the various files
10738: are loaded and gives reasons for that order.</p>
1.148 asau 10739: <div class="sect2">
1.81 rillig 10740: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10741: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10742: </h3></div></div></div>
10743: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10744: is to define some essential variables like
10745: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10746: <code class="varname">MACHINE_ARCH</code>.</p>
10747: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10748: 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 10749: After that, those variables
1.81 rillig 10750: that have not been overridden by the user are loaded from
10751: <code class="filename">mk/defaults/mk.conf</code>.</p>
10752: <p>After the user settings, the system settings and platform
10753: settings are loaded, which may override the user
10754: settings.</p>
10755: <p>Then, the tool definitions are loaded. The tool wrappers
10756: are not yet in effect. This only happens when building a
10757: package, so the proper variables must be used instead of the
10758: direct tool names.</p>
10759: <p>As the last steps, some essential variables from the
10760: wrapper and the package system flavor are loaded, as well as the
10761: variables that have been cached in earlier phases of a package
10762: build.</p>
10763: </div>
1.148 asau 10764: <div class="sect2">
1.81 rillig 10765: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10766: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10767: </h3></div></div></div>
1.81 rillig 10768: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10769: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10770: loaded, which fill default values for those variables that have
1.93 rillig 10771: not been defined by the package. These variables may later
1.81 rillig 10772: be used even in unrelated files.</p>
10773: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10774: provides the target <code class="literal">error-check</code> that is added
10775: as a special dependency to all other targets that use
10776: <code class="varname">DELAYED_ERROR_MSG</code> or
10777: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10778: <p>Then, the package-specific hacks from
10779: <code class="filename">hacks.mk</code> are included.</p>
10780: <p>Then, various other files follow. Most of them don't have
10781: any dependencies on what they need to have included before or
10782: after them, though some do.</p>
10783: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10784: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10785: restricts the use of these variables to all the files that have
10786: been included before. Appearances in later files will be
10787: silently ignored.</p>
10788: <p>Then, the files for the main targets are included, in the
10789: order of later execution, though the actual order should not
10790: matter.</p>
10791: <p>At last, some more files are included that don't set any
10792: interesting variables but rather just define make targets to be
10793: executed.</p>
10794: </div>
10795: </div>
1.75 rillig 10796: </div>
1.148 asau 10797: <div class="chapter">
1.75 rillig 10798: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10799: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.75 rillig 10800: <div class="toc">
10801: <p><b>Table of Contents</b></p>
1.210 leot 10802: <dl class="toc">
1.299 rillig 10803: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10804: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10805: <dd><dl>
1.299 rillig 10806: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10807: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10808: </dl></dd>
10809: </dl>
10810: </div>
10811: <p>The pkgsrc infrastructure consists of a large codebase,
10812: and there are many corners where every little bit of a file is
10813: well thought out, making pkgsrc likely to fail as soon as
10814: anything is changed near those parts. To prevent most changes
10815: from breaking anything, a suite of regression tests should go
10816: along with every important part of the pkgsrc infrastructure.
10817: This chapter describes how regression tests work in pkgsrc and
10818: how you can add new tests.</p>
1.148 asau 10819: <div class="sect1">
1.75 rillig 10820: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10821: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.322 leot 10822: <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 10823: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10824: can simply run that command, which will run all tests in the
1.283 rillig 10825: <code class="filename">regress/</code> directory.</p>
1.75 rillig 10826: </div>
1.148 asau 10827: <div class="sect1">
1.75 rillig 10828: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10829: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.283 rillig 10830: <p>Every directory in the <code class="filename">regress/</code>
10831: directory that contains a file called <code class="filename">spec</code>
1.75 rillig 10832: is considered a regression test. This file is a shell program
1.110 hubertf 10833: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10834: The following functions can be overridden to suit your
10835: needs.</p>
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.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.218 rillig 10839: <p>These functions do not take any parameters. Although they
10840: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.289 leot 10841: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218 rillig 10842: question</a> for details.</p>
1.148 asau 10843: <div class="variablelist"><dl class="variablelist">
1.218 rillig 10844: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75 rillig 10845: <dd><p>This function prepares the environment for the
10846: test. By default it does nothing.</p></dd>
1.218 rillig 10847: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10848: <dd>
10849: <p>This function runs the actual test. By default,
1.75 rillig 10850: it calls <code class="varname">TEST_MAKE</code> with the arguments
10851: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10852: error messages into the file
1.218 rillig 10853: <code class="varname">TEST_OUTFILE</code>.</p>
10854: <p>When defining this function, make sure that all output that
10855: needs to be checked is written to the correct output file.
10856: Example:</p>
10857: <pre class="programlisting">
10858: do_test() {
1.223 rillig 10859: echo "Example output"
1.218 rillig 10860: } 1>$TEST_OUTFILE 2>&1
10861: </pre>
10862: </dd>
10863: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10864: <dd>
10865: <p>This function is run after the test and is
1.75 rillig 10866: typically used to compare the actual output from the one that is
10867: expected. It can make use of the various helper functions from
1.218 rillig 10868: the next section. Example:</p>
10869: <pre class="programlisting">
10870: check_result() {
1.223 rillig 10871: exit_status 0
10872: output_require "Example"
10873: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10874: output_prohibit "no such file or directory"
1.283 rillig 10875: regress_fail "expected $expected but got $actual for input $input"
1.218 rillig 10876: }
10877: </pre>
10878: </dd>
10879: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75 rillig 10880: <dd><p>This function cleans everything up after the
10881: test has been run. By default it does nothing.</p></dd>
10882: </dl></div>
10883: </div>
1.148 asau 10884: <div class="sect2">
1.75 rillig 10885: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10886: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.148 asau 10887: <div class="variablelist"><dl class="variablelist">
1.283 rillig 10888: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10889: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218 rillig 10890: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75 rillig 10891: <dd><p>This function compares the exitcode of the
1.218 rillig 10892: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75 rillig 10893: If they differ, the test will fail.</p></dd>
1.218 rillig 10894: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10895: <dd>
10896: <p>This function checks for each of its parameters
10897: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75 rillig 10898: extended regular expression. If it does not, the test will
1.218 rillig 10899: fail. Example:</p>
10900: <pre class="programlisting">
1.219 rillig 10901: output_require "looks fine"
10902: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218 rillig 10903: </pre>
10904: </dd>
1.292 leot 10905: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75 rillig 10906: <dd><p>This function checks for each of its parameters
1.110 hubertf 10907: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10908: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10909: If any of the regular expressions matches, the test will
10910: fail.</p></dd>
10911: </dl></div>
10912: </div>
10913: </div>
10914: </div>
1.148 asau 10915: <div class="chapter">
1.75 rillig 10916: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10917: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10918: <div class="toc">
10919: <p><b>Table of Contents</b></p>
1.299 rillig 10920: <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 10921: </div>
10922: <p>The pkgsrc system has already been ported to many
10923: operating systems, hardware architectures and compilers. This
10924: chapter explains the necessary steps to make pkgsrc even more
10925: portable.</p>
1.148 asau 10926: <div class="sect1">
1.75 rillig 10927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10928: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10929: <p>To port pkgsrc to a new operating system (called
10930: <code class="literal">MyOS</code> in this example), you need to touch the
10931: following files:</p>
1.148 asau 10932: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10933: <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 10934: <dd><p>This file contains some basic definitions, for
10935: example the name of the C
10936: compiler.</p></dd>
1.76 rillig 10937: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10938: <dd><p>Insert code that defines the variables
10939: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.327 wiz 10940: <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.75 rillig 10941: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10942: <code class="varname">APPEND_ELF</code>, and the other variables that
10943: appear in this file.</p></dd>
1.93 rillig 10944: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10945: <dd><p>This file contains the platform-specific
10946: definitions that are used by pkgsrc. Start by copying one of the
10947: other files and edit it to your
10948: needs.</p></dd>
1.93 rillig 10949: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10950: <dd><p>This file defines the paths to all the tools
10951: that are needed by one or the other package in pkgsrc, as well
10952: as by pkgsrc itself. Find out where these tools are on your
10953: platform and add them.</p></dd>
10954: </dl></div>
10955: <p>Now, you should be able to build some basic packages, like
1.322 leot 10956: <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 10957: </div>
10958: </div>
10959: </div>
1.148 asau 10960: <div class="appendix">
10961: <div class="titlepage"><div><div><h1 class="title">
10962: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10963: <div class="toc">
10964: <p><b>Table of Contents</b></p>
1.210 leot 10965: <dl class="toc">
1.75 rillig 10966: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10967: <dd><dl>
10968: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10969: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10970: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287 rillig 10971: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 10972: </dl></dd>
10973: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10974: </dl>
10975: </div>
10976: <p>We checked to find a piece of software that wasn't in the packages
10977: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10978: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10979: present in the tree is beyond us, but it's useful for the purposes of
10980: this exercise.</p>
1.148 asau 10981: <div class="sect1">
1.75 rillig 10982: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10983: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10984: <div class="sect2">
1.75 rillig 10985: <div class="titlepage"><div><div><h3 class="title">
10986: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10987: <pre class="programlisting">
1.100 rillig 10988: # $NetBSD$
10989: #
1.1 grant 10990:
1.100 rillig 10991: DISTNAME= bison-1.25
10992: CATEGORIES= devel
1.286 rillig 10993: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 grant 10994:
1.136 dholland 10995: MAINTAINER= pkgsrc-users@NetBSD.org
1.289 leot 10996: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.100 rillig 10997: COMMENT= GNU yacc clone
1.1 grant 10998:
1.100 rillig 10999: GNU_CONFIGURE= yes
1.152 wiz 11000: INFO_FILES= yes
1.1 grant 11001:
1.100 rillig 11002: .include "../../mk/bsd.pkg.mk"
1.1 grant 11003: </pre>
1.75 rillig 11004: </div>
1.148 asau 11005: <div class="sect2">
1.75 rillig 11006: <div class="titlepage"><div><div><h3 class="title">
11007: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
11008: <pre class="programlisting">
1.100 rillig 11009: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.378 ! leot 11010: improvements. Why you would want this when Berkeley <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100 rillig 11011: of the NetBSD source tree is beyond me.
1.1 grant 11012: </pre>
1.75 rillig 11013: </div>
1.148 asau 11014: <div class="sect2">
1.75 rillig 11015: <div class="titlepage"><div><div><h3 class="title">
11016: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
11017: <pre class="programlisting">
1.100 rillig 11018: @comment $NetBSD$
11019: bin/bison
11020: man/man1/bison.1.gz
11021: share/bison.simple
11022: share/bison.hairy
1.1 grant 11023: </pre>
1.75 rillig 11024: </div>
1.148 asau 11025: <div class="sect2">
1.75 rillig 11026: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 11027: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75 rillig 11028: <p>The NetBSD package system comes with
1.322 leot 11029: <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 11030: which helps to check the contents of these
11031: files. After installation it is quite easy to use, just change to the
1.286 rillig 11032: directory of the package you wish to examine and run
1.110 hubertf 11033: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 11034: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286 rillig 11035: ERROR: Makefile: Each package must define its LICENSE.
11036: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
11037: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
11038: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
11039: 1 error, 2 warnings and 1 note found.
11040: (Run "pkglint -e" to show explanations.)
11041: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287 rillig 11042: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75 rillig 11043: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285 rillig 11044: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75 rillig 11045: -Wall</strong></span> for a very thorough check.</p>
11046: </div>
11047: </div>
1.148 asau 11048: <div class="sect1">
1.75 rillig 11049: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11050: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
11051: <p>Create the directory where the package lives,
11052: plus any auxiliary directories:</p>
11053: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
11054: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
11055: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
11056: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 11057: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299 rillig 11058: <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 11059: then continue with fetching the distfile:</p>
11060: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 11061: >> bison-1.25.tar.gz doesn't seem to exist on this system.
11062: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
11063: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11064: ftp: Error retrieving file: 500 Internal error
11065:
11066: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
11067: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11068: ftp: Error retrieving file: 500 Internal error
11069:
11070: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
11071: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 11072: Successfully retrieved file.</pre>
11073: <p>Generate the checksum of the distfile into
1.76 rillig 11074: <code class="filename">distinfo</code>:</p>
1.88 wiz 11075: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 11076: <p>Now compile:</p>
11077: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 11078: >> Checksum OK for bison-1.25.tar.gz.
11079: ===> Extracting for bison-1.25
11080: ===> Patching for bison-1.25
11081: ===> Ignoring empty patch directory
11082: ===> Configuring for bison-1.25
11083: creating cache ./config.cache
11084: checking for gcc... cc
11085: checking whether we are using GNU C... yes
11086: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
11087: checking how to run the C preprocessor... cc -E
11088: checking for minix/config.h... no
11089: checking for POSIXized ISC... no
11090: checking whether cross-compiling... no
11091: checking for ANSI C header files... yes
11092: checking for string.h... yes
11093: checking for stdlib.h... yes
11094: checking for memory.h... yes
11095: checking for working const... yes
11096: checking for working alloca.h... no
11097: checking for alloca... yes
11098: checking for strerror... yes
11099: updating cache ./config.cache
11100: creating ./config.status
11101: creating Makefile
11102: ===> Building for bison-1.25
11103: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
11104: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
11105: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
11106: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
11107: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 11108: 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 11109: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
11110: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
11111: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lalr.c
11112: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lex.c
11113: 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
11114: 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
11115: 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
11116: 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
11117: 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
11118: 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
11119: 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
11120: 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
11121: 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
11122: 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
11123: 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
11124: 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
11125: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
11126: rm -f bison.s1
1.75 rillig 11127: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
11128: <p>Everything seems OK, so install the files:</p>
11129: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 11130: >> Checksum OK for bison-1.25.tar.gz.
11131: ===> Installing for bison-1.25
11132: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
11133: rm -f /usr/pkg/bin/bison
11134: cd /usr/pkg/share; rm -f bison.simple bison.hairy
11135: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
11136: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
11137: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
11138: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
11139: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
11140: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 11141: ===> Registering installation for bison-1.25</pre>
11142: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 11143: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 11144: binary package, do this now:</p>
11145: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 11146: >> Checksum OK for bison-1.25.tar.gz.
11147: ===> Building package for bison-1.25
11148: Creating package bison-1.25.tgz
11149: Registering depends:.
1.75 rillig 11150: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
11151: <p>Now that you don't need the source and object files
11152: any more, clean up:</p>
11153: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
11154: ===> Cleaning for bison-1.25</pre>
11155: </div>
11156: </div>
1.148 asau 11157: <div class="appendix">
11158: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 11159: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.75 rillig 11160: <div class="toc">
11161: <p><b>Table of Contents</b></p>
1.210 leot 11162: <dl class="toc">
1.322 leot 11163: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
11164: <dd><dl>
11165: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
11166: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
11167: </dl></dd>
11168: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
11169: <dd><dl>
11170: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
11171: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
11172: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
11173: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
11174: </dl></dd>
11175: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
11176: <dd><dl>
11177: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
11178: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
11179: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
11180: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
11181: </dl></dd>
1.75 rillig 11182: </dl>
11183: </div>
1.322 leot 11184: <p>
11185: A number of mechanisms are available in pkgsrc to improve the security of the
11186: resulting system. This page describes the mechanisms, and gives hints
11187: about detecting and fixing problems.
11188: </p>
11189: <p>
11190: Mechanisms can be enabled individually in
11191: <code class="filename">mk.conf</code>, and are
11192: individually described below.
11193: </p>
11194: <p>
11195: Typically, a feature will cause some programs to fail to build or work
11196: when first enabled. This can be due to latent problems in the
11197: program, and can be due to other reasons. After enough testing to
11198: have confidence that user problems will be quite rare, individual
11199: mechanisms will be enabled by default.
11200: </p>
11201: <p>
11202: For each mechanism, see the Caveats section below for an explanation
11203: of what might go wrong at compile time and at run time, and how to
11204: notice and address these problems.
11205: </p>
1.148 asau 11206: <div class="sect1">
1.75 rillig 11207: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11208: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
11209: <div class="sect2">
11210: <div class="titlepage"><div><div><h3 class="title">
11211: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
11212: <div class="sect3">
11213: <div class="titlepage"><div><div><h4 class="title">
11214: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
11215: <p>
11216: This allows substitute wrappers to be used for some commonly used
11217: library functions that do not have built-in bounds checking - but
11218: could in some cases.
11219: </p>
11220: <p>
11221: Two mitigation levels are available:
11222: </p>
11223: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11224: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
11225: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
11226: </ul></div>
11227: <p>
11228: "strong" has been enabled by default since pkgsrc-2017Q3.
11229: </p>
11230: </div>
11231: <div class="sect3">
11232: <div class="titlepage"><div><div><h4 class="title">
11233: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
11234: <p>
11235: This enables a stack-smashing protection mitigation. It is done by adding a
11236: guard variable to functions with vulnerable objects. The guards are initialized
11237: when a function is entered and then checked when the function exits. The guard
11238: check will fail and the program forcibly exited if the variable was modified in
11239: the meantime. This can happen in case of buffer overflows or memory corruption,
11240: and therefore exposing these bugs.
11241: </p>
11242: <p>
11243: Different mitigation levels are available:
11244: </p>
11245: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11246: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
11247: by the compiler;</p></li>
11248: <li class="listitem"><p>"all", which will protect every function;</p></li>
11249: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
11250: two settings above.</p></li>
11251: </ul></div>
11252: <p>
11253: This mitigation is supported by both GCC and clang. It may be supported in
11254: additional compilers, possibly under a different name. It is particularly useful
11255: for unsafe programming languages, such as C/C++.
11256: </p>
11257: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11258: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
11259: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
11260: </ul></div>
11261: <p>More details can be found here:</p>
11262: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11263: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
11264: </p></li></ul></div>
11265: </div>
11266: <div class="sect3">
11267: <div class="titlepage"><div><div><h4 class="title">
11268: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
11269: <p>
11270: This requests the creation of PIE (Position Independent Executables) for all
11271: executables. The PIE mechanism is normally used for shared libraries, so that
11272: they can be loaded at differing addresses at runtime. PIE itself does not have
11273: useful security properties; however, it is necessary to fully leverage some,
11274: such as ASLR. Some operating systems support Address Space Layout Randomization
11275: (ASLR), which causes different addresses to be used each time a program is run.
11276: This makes it more difficult for an attacker to guess addresses and thus makes
11277: exploits harder to construct. With PIE, ASLR can really be applied to the entire
11278: program, instead of the stack and heap only.
11279: </p>
11280: <p>
11281: PIE executables will only be built for toolchains that are known to support PIE.
11282: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
11283: </p>
11284: <p>
11285: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
11286: </p>
1.75 rillig 11287: </div>
1.325 gutterid 11288: <div class="sect3">
11289: <div class="titlepage"><div><div><h4 class="title">
1.334 nia 11290: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.322 leot 11291: <p>
11292: This also makes the exploitation of some security vulnerabilities more
11293: difficult in some cases.
11294: </p>
11295: <p>Two different mitigation levels are available:</p>
11296: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11297: <li class="listitem"><p>
1.334 nia 11298: partial (the default): the ELF sections are reordered so that internal data sections
1.322 leot 11299: precede the program's own data sections, and non-PLT GOT is read-only;
11300: </p></li>
11301: <li class="listitem"><p>
11302: full: in addition to partial RELRO, every relocation is performed immediately
1.333 nia 11303: when starting the program, allowing the entire GOT to be read-only. This
11304: can greatly slow down startup of large programs.
1.322 leot 11305: </p></li>
11306: </ul></div>
11307: <p>
11308: This is currently supported by GCC. Many software distributions now enable this
1.335 nia 11309: feature by default, at the "partial" level.
1.322 leot 11310: </p>
11311: <p>
11312: More details can be found here:
11313: </p>
11314: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11315: <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>
11316: </p></li></ul></div>
1.75 rillig 11317: </div>
1.334 nia 11318: </div>
11319: <div class="sect2">
11320: <div class="titlepage"><div><div><h3 class="title">
11321: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
11322: <div class="sect3">
11323: <div class="titlepage"><div><div><h4 class="title">
11324: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
11325: <p>
11326: With this option, pkgsrc will try to build packages reproducibly. This allows
11327: packages built from the same tree and with the same options, to produce
11328: identical results bit by bit. This option should be combined with ASLR and
11329: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
11330: attackers attempting to exploit security vulnerabilities.
11331: </p>
11332: <p>
11333: More details can be found here:
11334: </p>
11335: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11336: <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>
11337: </p></li></ul></div>
11338: <p>
11339: More work likely needs to be done before pkgsrc is fully reproducible.
11340: </p>
11341: </div>
1.322 leot 11342: <div class="sect3">
11343: <div class="titlepage"><div><div><h4 class="title">
1.334 nia 11344: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.322 leot 11345: <p>
11346: This uses <code class="literal">-fstack-check</code> with GCC for
11347: another stack protection mitigation.
11348: </p>
11349: <p>
11350: It asks the compiler to generate code verifying that it does not corrupt the
11351: stack. According to GCC's manual page, this is really only useful for
11352: multi-threaded programs.
11353: </p>
1.76 rillig 11354: </div>
11355: </div>
11356: </div>
1.148 asau 11357: <div class="sect1">
1.76 rillig 11358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11359: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
11360: <div class="sect2">
11361: <div class="titlepage"><div><div><h3 class="title">
11362: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
11363: <div class="sect3">
11364: <div class="titlepage"><div><div><h4 class="title">
11365: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
11366: <p>
11367: A number of packages may fail to build with this option enabled. The
11368: failures are often related to the absence of the <code class="literal">-fPIC</code>
11369: compilation flag when building libraries or executables (or ideally
11370: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
11371: <code class="varname">CFLAGS</code> already, but requires the package to
11372: actually support it.
11373: </p>
11374: <div class="sect4">
11375: <div class="titlepage"><div><div><h5 class="title">
11376: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
11377: <p>
11378: These instructions are meant as a reference only; they likely need to be adapted
11379: for many packages individually.
11380: </p>
11381: <p>
11382: For packages using <code class="filename">Makefiles</code>:
11383: </p>
11384: <pre class="programlisting">
11385: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
11386: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
11387: </pre>
11388: <p>
11389: For packages using <code class="filename">Imakefiles</code>:
11390: </p>
11391: <pre class="programlisting">
11392: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
11393: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
11394: </pre>
11395: </div>
11396: </div>
11397: <div class="sect3">
11398: <div class="titlepage"><div><div><h4 class="title">
11399: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
11400: <p>
11401: Some programs may fail to run, or crash at random times once built as PIE. Two
11402: scenarios are essentially possible. This is nearly always due to a bug in
11403: the program being exposed due to ASLR.
11404: </p>
11405: </div>
11406: <div class="sect3">
11407: <div class="titlepage"><div><div><h4 class="title">
11408: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
11409: <p>
11410: Ideally, packages should be fixed for compatibility with MKPIE.
11411: However, in some cases this is very difficult, due to complex build systems,
11412: packages using non-standard toolchains, or programming languages with odd
11413: bootstrapping mechanisms.
11414: </p>
11415: <p>
11416: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
11417: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
11418: <code class="filename">bsd.prefs.mk</code> is included.
11419: </p>
11420: </div>
11421: </div>
11422: <div class="sect2">
11423: <div class="titlepage"><div><div><h3 class="title">
11424: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
11425: <div class="sect3">
11426: <div class="titlepage"><div><div><h4 class="title">
11427: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
11428: <p>
11429: This feature makes use of pre-processing directives to look for hardened,
11430: alternative implementations of essential library calls. Some programs may fail
11431: to build as a result; this usually happens for those trying too hard to be
11432: portable, or otherwise abusing definitions in the standard library.
11433: </p>
11434: </div>
11435: <div class="sect3">
11436: <div class="titlepage"><div><div><h4 class="title">
11437: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
11438: <p>
11439: This feature may cause some programs to crash, usually indicating an
11440: actual bug in the program. The fix will typically involve patching the
11441: original program's source code.
11442: </p>
11443: </div>
11444: <div class="sect3">
11445: <div class="titlepage"><div><div><h4 class="title">
11446: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
11447: <p>
11448: At least in the case of GCC, FORTIFY will only be applied if optimization is
11449: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
11450: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
11451: optimization level. This cannot easily be applied globally, as some packages
11452: may require specific optimization levels.
11453: </p>
11454: </div>
11455: <div class="sect3">
11456: <div class="titlepage"><div><div><h4 class="title">
11457: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
11458: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11459: <h3 class="title">Note</h3>
11460: <p>FORTIFY should not be disabled to work around runtime crashes in
11461: the program! This is a very bad idea and will expose you to security
11462: vulnerabilities.
11463: </p>
11464: </div>
11465: <p>
11466: To disable FORTIFY on a per-package basis, set the following
11467: in the package's <code class="filename">Makefile</code>
11468: before <code class="filename">bsd.prefs.mk</code> is included:
11469: </p>
11470: <pre class="programlisting">
11471: FORTIFY_SUPPORTED= no
11472: </pre>
11473: </div>
11474: </div>
11475: <div class="sect2">
11476: <div class="titlepage"><div><div><h3 class="title">
11477: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
11478: <div class="sect3">
11479: <div class="titlepage"><div><div><h4 class="title">
11480: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
11481: <p>
11482: For better protection, full RELRO requires every symbol to be resolved when the
11483: program starts, rather than simply when required at run-time. This will have
11484: more impact on programs using a lot of symbols, or linked to libraries exposing
11485: a lot of symbols. Therefore, daemons or programs otherwise running in
11486: background are affected only when started. Programs loading plug-ins at
11487: run-time are affected when loading the plug-ins.
11488: </p>
11489: <p>
11490: The impact is not expected to be noticeable on modern hardware, except in some
11491: cases for big programs.
11492: </p>
11493: </div>
11494: <div class="sect3">
11495: <div class="titlepage"><div><div><h4 class="title">
11496: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
11497: <p>
11498: Some programs handle plug-ins and dependencies in a way that conflicts with
11499: RELRO: for instance, with an initialization routine listing any other plug-in
11500: required. With full RELRO, the missing symbols are resolved before the
11501: initialization routine can run, and the dynamic loader will not be able to find
11502: them directly and abort as a result. Unfortunately, this is how Xorg loads its
11503: drivers. Partial RELRO can be applied instead in this case.
11504: </p>
11505: </div>
11506: <div class="sect3">
11507: <div class="titlepage"><div><div><h4 class="title">
11508: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
11509: <p>
11510: To disable RELRO on a per-package basis, set the following
11511: in the package's <code class="filename">Makefile</code>
11512: before <code class="filename">bsd.prefs.mk</code> is included:
11513: </p>
11514: <pre class="programlisting">
11515: RELRO_SUPPORTED= no
11516: </pre>
1.324 nia 11517: <p>
11518: It is also possible to at most enable partial RELRO, by
11519: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
11520: </p>
1.322 leot 11521: </div>
11522: </div>
11523: <div class="sect2">
11524: <div class="titlepage"><div><div><h3 class="title">
11525: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
11526: <div class="sect3">
11527: <div class="titlepage"><div><div><h4 class="title">
11528: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
11529: <p>
11530: The stack-smashing protection provided by this option does not work for some
11531: programs. The most common situation in which this happens is when the program
11532: allocates variables on the stack, with the size determined at run-time.
11533: </p>
11534: </div>
11535: <div class="sect3">
11536: <div class="titlepage"><div><div><h4 class="title">
11537: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
11538: <p>
11539: Again, this feature may cause some programs to crash via a
11540: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
11541: </p>
11542: <p>
11543: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
11544: messages are sent and - by default -
11545: appended to <code class="filename">/var/log/messages</code>, e.g.:
11546: </p>
11547: <pre class="programlisting">
11548: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
11549: </pre>
11550: <p>
11551: (where <code class="literal">hostname</code> is the hostname(1) and
11552: <code class="literal">program</code> is the basename(1) of the program crashed).
11553: </p>
11554: <p>
11555: Patching the original program is then required.
11556: </p>
11557: <p>
11558: Rebuilding the package via:
11559: </p>
11560: <pre class="programlisting">
11561: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
11562: </pre>
11563: <p>
11564: and inspecting the backtrace of the coredump via the debugger
11565: should point out the problematic call by inspecting the frame
11566: calling the _chk() (SSP) function.
11567: </p>
11568: </div>
11569: <div class="sect3">
11570: <div class="titlepage"><div><div><h4 class="title">
11571: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
11572: <p>
11573: The compiler emits extra code when using this feature: a check for buffer
11574: overflows is performed when entering and exiting functions, requiring an extra
11575: variable on the stack. The level of protection can otherwise be adjusted to
11576: affect only those functions considered more sensitive by the compiler (with
11577: -fstack-protector instead of -fstack-protector-all).
11578: </p>
11579: <p>
11580: The impact is not expected to be noticeable on modern hardware. However,
11581: programs with a hard requirement to run at the fastest possible speed should
11582: avoid using this feature, or using libraries built with this feature.
11583: </p>
11584: </div>
11585: <div class="sect3">
11586: <div class="titlepage"><div><div><h4 class="title">
11587: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
11588: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11589: <h3 class="title">Note</h3>
11590: <p>SSP should not be disabled to work around runtime crashes in
11591: the program! This is a very bad idea and will expose you to security
11592: vulnerabilities.</p>
11593: </div>
11594: <p>
11595: To disable SSP on a per-package basis, set the following
11596: in the package's <code class="filename">Makefile</code>
11597: before <code class="filename">bsd.prefs.mk</code> is included:
11598: </p>
11599: <pre class="programlisting">
11600: SSP_SUPPORTED= no
11601: </pre>
11602: </div>
11603: </div>
11604: </div>
11605: <div class="sect1">
11606: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11607: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
11608: <p>
11609: The illusion of security is worse than having no security at all. This section
11610: lists a number of ways to ensure the security features requested are actually
11611: effective.
11612: </p>
11613: <p>
11614: These instructions were obtained and tested on a system derived from NetBSD 7
11615: (amd64). YMMV.
11616: </p>
11617: <div class="sect2">
11618: <div class="titlepage"><div><div><h3 class="title">
11619: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
11620: <p>
11621: The ELF executable type in use changes for binaries built as PIE; without:
11622: </p>
11623: <pre class="programlisting">
11624: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
11625: /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
11626: </pre>
11627: <p>as opposed to the following binary, built as PIE:</p>
11628: <pre class="programlisting">
11629: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
11630: /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
11631: </pre>
11632: <p>
11633: The latter result is then what is expected.
11634: </p>
11635: </div>
11636: <div class="sect2">
11637: <div class="titlepage"><div><div><h3 class="title">
11638: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
11639: <p>
11640: The following command should list a section called RELRO:
11641: </p>
11642: <pre class="programlisting">
11643: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
11644:
11645: /path/to/bin/ary: file format elf64-x86-64
11646:
11647: Program Header:
11648: [...]
11649: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
11650: </pre>
11651: <p>
11652: This check is now performed automatically if
11653: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
11654: </p>
11655: </div>
11656: <div class="sect2">
11657: <div class="titlepage"><div><div><h3 class="title">
11658: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
11659: <p>
11660: The dynamic loader will apply RELRO immediately when detecting the presence of
11661: the <code class="varname">BIND_NOW</code> flag:
11662: </p>
11663: <pre class="programlisting">
11664: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
11665:
11666: /path/to/bin/ary: file format elf64-x86-64
11667:
11668: Dynamic Section:
11669: [...]
11670: BIND_NOW 0x0000000000000000
11671: </pre>
11672: <p>
11673: This has to be combined with partial RELRO (see above) to be fully efficient.
11674: </p>
11675: <p>
11676: This check is now performed automatically (where supported) if
11677: <code class="varname">PKG_DEVELOPER</code> is set.
11678: </p>
11679: </div>
11680: <div class="sect2">
11681: <div class="titlepage"><div><div><h3 class="title">
11682: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.323 nia 11683: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11684: <h3 class="title">Note</h3>
11685: <p>
11686: Checking for SSP using this method only works where the operating system
11687: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
11688: on recent NetBSD/FreeBSD/Linux versions.
11689: </p>
11690: </div>
1.322 leot 11691: <p>
11692: Building objects, binaries and libraries with SSP will affect the presence of
11693: additional symbols in the resulting file:
11694: </p>
11695: <pre class="programlisting">
11696: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
11697: [...]
11698: U __stack_chk_fail
11699: 0000000000600ea0 B __stack_chk_guard
11700: </pre>
11701: <p>
11702: This is an indicator that the program was indeed built with support for SSP.
11703: </p>
11704: <p>
11705: This check is now performed automatically (where supported) if
11706: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
11707: </p>
11708: </div>
11709: </div>
11710: </div>
11711: <div class="appendix">
11712: <div class="titlepage"><div><div><h1 class="title">
11713: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
11714: <div class="toc">
11715: <p><b>Table of Contents</b></p>
11716: <dl class="toc">
11717: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
11718: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
11719: </dl>
11720: </div>
11721: <div class="sect1">
11722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11723: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
11724: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11725: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11726: => figlet221.tar.gz doesn't seem to exist on this system.
11727: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11728: => [172219 bytes]
11729: Connected to ftp.plig.net.
11730: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11731: 331 Guest login ok, send your complete e-mail address as password.
11732: 230-You are user #5 of 500 simultaneous users allowed.
11733: 230-
11734: 230- ___ _ _ _
11735: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11736: 230- | _| _| . |_| . | | | . |_| . | _| . |
11737: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11738: 230- |_| |_| |___| |___|
11739: 230-
11740: 230-** Welcome to ftp.plig.org **
11741: 230-
11742: 230-Please note that all transfers from this FTP site are logged. If you
11743: 230-do not like this, please disconnect now.
11744: 230-
11745: 230-This archive is available via
11746: 230-
11747: 230-HTTP: http://ftp.plig.org/
11748: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11749: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11750: 230-
11751: 230-Please email comments, bug reports and requests for packages to be
11752: 230-mirrored to ftp-admin@plig.org.
11753: 230-
11754: 230-
11755: 230 Logged in anonymously.
11756: Remote system type is UNIX.
11757: Using binary mode to transfer files.
11758: 200 Type okay.
11759: 250 "/pub" is new cwd.
11760: 250-"/pub/figlet" is new cwd.
11761: 250-
11762: 250-Welcome to the figlet archive at ftp.figlet.org
11763: 250-
11764: 250- ftp://ftp.figlet.org/pub/figlet/
11765: 250-
11766: 250-The official FIGlet web page is:
11767: 250- http://www.figlet.org/
11768: 250-
11769: 250-If you have questions, please mailto:info@figlet.org. If you want to
11770: 250-contribute a font or something else, you can email us.
11771: 250
11772: 250 "/pub/figlet/program" is new cwd.
11773: 250 "/pub/figlet/program/unix" is new cwd.
11774: local: figlet221.tar.gz remote: figlet221.tar.gz
11775: 502 Unimplemented command.
11776: 227 Entering Passive Mode (195,40,6,41,246,104)
11777: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11778: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11779: 226 Transfer completed.
11780: 172219 bytes received in 00:02 (75.99 KB/s)
11781: 221 Goodbye.
11782: => Checksum OK for figlet221.tar.gz.
11783: ===> Extracting for figlet-2.2.1nb2
11784: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11785: ===> Patching for figlet-2.2.1nb2
11786: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11787: ===> Overriding tools for figlet-2.2.1nb2
11788: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11789: ===> Configuring for figlet-2.2.1nb2
11790: ===> Building for figlet-2.2.1nb2
11791: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11792: chmod a+x figlet
11793: gcc -O2 -o chkfont chkfont.c
11794: => Unwrapping files-to-be-installed.
11795: <code class="prompt">#</code>
11796: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11797: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11798: ===> Installing for figlet-2.2.1nb2
11799: install -d -o root -g wheel -m 755 /usr/pkg/bin
11800: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11801: mkdir -p /usr/pkg/share/figlet
11802: cp figlet /usr/pkg/bin
11803: cp chkfont /usr/pkg/bin
11804: chmod 555 figlist showfigfonts
11805: cp figlist /usr/pkg/bin
11806: cp showfigfonts /usr/pkg/bin
11807: cp fonts/*.flf /usr/pkg/share/figlet
11808: cp fonts/*.flc /usr/pkg/share/figlet
11809: cp figlet.6 /usr/pkg/man/man6
11810: ===> Registering installation for figlet-2.2.1nb2
11811: <code class="prompt">#</code></pre>
11812: </div>
11813: <div class="sect1">
11814: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11815: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
11816: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11817: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11818: ===> Packaging figlet-2.2.1nb2
11819: ===> Building binary package for figlet-2.2.1nb2
11820: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11821: Using SrcDir value of /usr/pkg
11822: Registering depends:.
11823: <code class="prompt">#</code></pre>
11824: </div>
11825: </div>
11826: <div class="appendix">
11827: <div class="titlepage"><div><div><h1 class="title">
11828: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
11829: <div class="toc">
11830: <p><b>Table of Contents</b></p>
11831: <dl class="toc">
11832: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11833: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11834: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11835: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11836: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
11837: <code class="filename">stable</code>,
11838: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11839: source packages</a></span></dt>
11840: </dl>
11841: </div>
11842: <p>As in other big projects, the directory layout of pkgsrc
11843: is quite complex for newbies. This chapter explains where you
11844: find things on the FTP server. The base directory on
11845: <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>.
11846: On other servers it may be different, but inside this directory,
11847: everything should look the same, no matter on which server you
11848: are. This directory contains some subdirectories, which are
11849: explained below.</p>
11850: <div class="sect1">
11851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11852: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
11853: <p>The directory <code class="filename">distfiles</code> contains lots
11854: of archive files from all pkgsrc packages, which are mirrored
11855: here. The subdirectories are called after their package names
11856: and are used when the distributed files have names that don't
11857: explicitly contain a version number or are otherwise too generic
11858: (for example <code class="filename">release.tar.gz</code>).</p>
11859: </div>
11860: <div class="sect1">
11861: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11862: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
11863: <p>This directory contains things that individual pkgsrc
11864: developers find worth publishing.</p>
11865: </div>
11866: <div class="sect1">
11867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11868: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
11869: <p>This directory contains binary packages for the various
11870: platforms that are supported by pkgsrc.
11871: 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>
11872: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11873: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
11874: operating system for which the packages have been built. The
11875: name is taken from the output of the <span class="command"><strong>uname</strong></span>
11876: command, so it may differ from the one you are used to
11877: hear.</p></li>
11878: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
11879: architecture of the platform for which the packages have been
11880: built. It also includes the <code class="varname">ABI</code> (Application
11881: Binary Interface) for platforms that have several of
11882: them.</p></li>
11883: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.370 gdt 11884: the operating system. Typically it is the version defining an
11885: ABI, e.g. 9.0.</p></li>
1.322 leot 11886: <li class="listitem"><p><code class="varname">TAG</code> is either
1.370 gdt 11887: <code class="literal">20<em class="replaceable"><code>YY</code></em>Q<em class="replaceable"><code>N</code></em></code>
11888: for a stable branch, or <code class="literal">current</code> for packages
1.322 leot 11889: built from the HEAD branch. The latter should only be used when
1.370 gdt 11890: the packages are updated on a regular basis.</p></li>
1.322 leot 11891: </ul></div>
1.370 gdt 11892: <p>The rationale for this scheme is that users can first
11893: search by OPSYS and ARCH, since these are more or less
11894: unchangeable. After that, there is a management set of
11895: directories with OSVERSION and TAG.</p>
11896: <p>See also <code class="filename">README.md</code> in
11897: <code class="filename">packages</code> for more details, including
11898: about symlinks.</p>
1.322 leot 11899: <p>In each of these directories, there is a
11900: whole binary packages collection for a specific platform. It has a directory called
11901: <code class="filename">All</code> which contains all binary packages.
1.370 gdt 11902: </p>
1.322 leot 11903: </div>
11904: <div class="sect1">
11905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11906: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 11907: <p>Here are the reports from bulk builds, for those who want
11908: to fix packages that didn't build on some of the platforms. The
1.322 leot 11909: 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 11910: </div>
1.148 asau 11911: <div class="sect1">
1.108 rillig 11912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11913: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.261 leot 11914: <code class="filename">stable</code>,
1.126 jakllsch 11915: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11916: source packages</h2></div></div></div>
1.128 wiz 11917: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 11918: that is the files that define how to create binary packages from
11919: source archives.</p>
1.262 leot 11920: <p>Each of the <code class="filename">current</code>,
11921: <code class="filename">stable</code> and
11922: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11923: directories share the same structure. They each contain a
11924: <code class="filename">pkgsrc</code> directory and
11925: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76 rillig 11926: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11927: snapshot of the CVS repository, which is updated regularly. The
1.262 leot 11928: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11929: as the directory, ready to be downloaded as a whole.</p>
11930: <p>The <code class="filename">current</code> directory contains files
11931: related to the HEAD branch of the CVS repository.
11932: In this directory there is an additional file called
11933: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11934: all pkgsrc <code class="filename">README</code>s with information about
11935: categories and packages.
11936: </p>
11937: <p>The <code class="filename">stable</code> directory is a symlink to
11938: the latest
11939: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11940: </p>
11941: <p>The
11942: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11943: directories contain files related to the
11944: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11945: stable branch of the CVS repository. In these directories there is
11946: an additional file called
11947: <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 11948: which contains the state of pkgsrc when it was branched.</p>
11949: </div>
1.75 rillig 11950: </div>
1.148 asau 11951: <div class="appendix">
11952: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 11953: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.267 rillig 11954: <p>
11955: The following list contains all help topics that are available
11956: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11957: </p>
1.269 leot 11958: <table border="0" summary="Simple list" class="simplelist">
11959: <tr>
11960: <td>#!</td>
11961: <td>-lintl</td>
11962: </tr>
11963: <tr>
1.320 wiz 11964: <td>32bit</td>
1.269 leot 11965: <td>64bit</td>
1.320 wiz 11966: </tr>
11967: <tr>
1.269 leot 11968: <td>ABI</td>
1.320 wiz 11969: <td>ACCEPTABLE_LICENSES</td>
1.269 leot 11970: </tr>
11971: <tr>
11972: <td>ACROREAD_FONTPATH</td>
1.320 wiz 11973: <td>ADDITIONAL</td>
1.269 leot 11974: </tr>
11975: <tr>
11976: <td>AFAIK</td>
1.320 wiz 11977: <td>AIX</td>
1.269 leot 11978: </tr>
11979: <tr>
1.370 gdt 11980: <td>ALLOW_NETWORK_ACCESS</td>
1.357 gutterid 11981: <td>ALLOW_NEWER_COMPILER</td>
1.269 leot 11982: </tr>
11983: <tr>
1.370 gdt 11984: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.357 gutterid 11985: <td>ALL_ENV</td>
1.369 wiz 11986: </tr>
11987: <tr>
1.378 ! leot 11988: <td>ALSA_PC</td>
1.368 gutterid 11989: <td>ALTERNATIVES_SRC</td>
1.378 ! leot 11990: </tr>
! 11991: <tr>
1.377 jnemeth 11992: <td>AMANDA_TMP</td>
1.378 ! leot 11993: <td>AMANDA_USER</td>
1.376 wiz 11994: </tr>
11995: <tr>
1.377 jnemeth 11996: <td>AMANDA_VAR</td>
1.378 ! leot 11997: <td>APACHE_GROUP</td>
1.367 gdt 11998: </tr>
11999: <tr>
1.377 jnemeth 12000: <td>APACHE_MODULE_NAME</td>
1.378 ! leot 12001: <td>APACHE_MODULE_SRC</td>
1.360 leot 12002: </tr>
12003: <tr>
1.377 jnemeth 12004: <td>APACHE_MODULE_SRCDIR</td>
1.378 ! leot 12005: <td>APACHE_PKG_PREFIX</td>
1.355 rillig 12006: </tr>
12007: <tr>
1.377 jnemeth 12008: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.378 ! leot 12009: <td>APACHE_SUEXEC_DOCROOT</td>
1.352 wiz 12010: </tr>
12011: <tr>
1.377 jnemeth 12012: <td>APACHE_USER</td>
1.378 ! leot 12013: <td>ARGMAX_REQ</td>
1.348 wiz 12014: </tr>
12015: <tr>
1.377 jnemeth 12016: <td>ARG_MAX</td>
1.378 ! leot 12017: <td>ARLA_CACHE</td>
1.342 wiz 12018: </tr>
12019: <tr>
1.377 jnemeth 12020: <td>AUDIT_PACKAGES_FLAGS</td>
1.378 ! leot 12021: <td>AUTOCONF_REQD</td>
1.376 wiz 12022: </tr>
12023: <tr>
1.377 jnemeth 12024: <td>AUTOMAKE_OVERRIDE</td>
1.378 ! leot 12025: <td>AUTOMAKE_REQD</td>
1.338 nia 12026: </tr>
12027: <tr>
1.377 jnemeth 12028: <td>AUTO_MKDIRS</td>
1.378 ! leot 12029: <td>AUX</td>
1.332 rillig 12030: </tr>
12031: <tr>
1.377 jnemeth 12032: <td>BDB185_DEFAULT</td>
1.378 ! leot 12033: <td>BDBBASE</td>
1.329 leot 12034: </tr>
12035: <tr>
1.377 jnemeth 12036: <td>BDB_ACCEPTED</td>
1.378 ! leot 12037: <td>BDB_DEFAULT</td>
1.327 wiz 12038: </tr>
12039: <tr>
1.377 jnemeth 12040: <td>BDB_LIBS</td>
1.378 ! leot 12041: <td>BDB_TYPE</td>
1.311 leot 12042: </tr>
12043: <tr>
1.377 jnemeth 12044: <td>BINCIMAP_GROUP</td>
1.378 ! leot 12045: <td>BINCIMAP_LOG_USER</td>
1.292 leot 12046: </tr>
12047: <tr>
1.377 jnemeth 12048: <td>BINCIMAP_USER</td>
1.378 ! leot 12049: <td>BIND_DIR</td>
1.274 rillig 12050: </tr>
12051: <tr>
1.377 jnemeth 12052: <td>BIND_GROUP</td>
1.378 ! leot 12053: <td>BIND_USER</td>
1.269 leot 12054: </tr>
12055: <tr>
1.377 jnemeth 12056: <td>BINOWN</td>
1.378 ! leot 12057: <td>BINPKG_SITES</td>
1.369 wiz 12058: </tr>
12059: <tr>
1.377 jnemeth 12060: <td>BIN_INSTALL_FLAGS</td>
1.378 ! leot 12061: <td>BISON_PKGDATADIR</td>
1.269 leot 12062: </tr>
12063: <tr>
1.377 jnemeth 12064: <td>BLAS</td>
1.378 ! leot 12065: <td>BLAS_ACCEPTED</td>
1.269 leot 12066: </tr>
12067: <tr>
1.377 jnemeth 12068: <td>BLAS_C_INTERFACE</td>
1.378 ! leot 12069: <td>BLAS_INCLUDES</td>
1.269 leot 12070: </tr>
12071: <tr>
1.377 jnemeth 12072: <td>BLAS_INDEX64</td>
1.378 ! leot 12073: <td>BLAS_LIBS</td>
1.269 leot 12074: </tr>
12075: <tr>
1.377 jnemeth 12076: <td>BLAS_PC</td>
1.378 ! leot 12077: <td>BLAS_TYPE</td>
1.269 leot 12078: </tr>
12079: <tr>
1.377 jnemeth 12080: <td>BOOTSTRAP_DEPENDS</td>
1.378 ! leot 12081: <td>BROKEN</td>
1.269 leot 12082: </tr>
12083: <tr>
1.377 jnemeth 12084: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.378 ! leot 12085: <td>BROKEN_ON_PLATFORM</td>
1.269 leot 12086: </tr>
12087: <tr>
1.377 jnemeth 12088: <td>BSDSRCDIR</td>
1.378 ! leot 12089: <td>BSDXSRCDIR</td>
1.269 leot 12090: </tr>
12091: <tr>
1.377 jnemeth 12092: <td>BSD_MAKE_ENV</td>
1.378 ! leot 12093: <td>BUILDLINK_AUTO_DIRS</td>
1.269 leot 12094: </tr>
12095: <tr>
1.377 jnemeth 12096: <td>BUILDLINK_AUTO_VARS</td>
1.378 ! leot 12097: <td>BUILDLINK_CFLAGS</td>
1.269 leot 12098: </tr>
12099: <tr>
1.377 jnemeth 12100: <td>BUILDLINK_CONTENTS_FILTER</td>
1.378 ! leot 12101: <td>BUILDLINK_CPPFLAGS</td>
1.312 gdt 12102: </tr>
12103: <tr>
1.378 ! leot 12104: <td>BUILDLINK_DEPMETHOD</td>
1.370 gdt 12105: <td>BUILDLINK_FILES</td>
1.269 leot 12106: </tr>
12107: <tr>
1.331 gutterid 12108: <td>BUILDLINK_FILES_CMD</td>
1.370 gdt 12109: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.320 wiz 12110: </tr>
12111: <tr>
1.331 gutterid 12112: <td>BUILDLINK_LDFLAGS</td>
1.370 gdt 12113: <td>BUILDLINK_LIBS</td>
1.269 leot 12114: </tr>
12115: <tr>
1.331 gutterid 12116: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.370 gdt 12117: <td>BUILDLINK_PKGNAME</td>
1.269 leot 12118: </tr>
12119: <tr>
1.331 gutterid 12120: <td>BUILDLINK_PREFIX</td>
1.370 gdt 12121: <td>BUILDLINK_RPATHDIRS</td>
1.269 leot 12122: </tr>
12123: <tr>
1.331 gutterid 12124: <td>BUILDLINK_TREE</td>
1.370 gdt 12125: <td>BUILD_DEFS</td>
1.269 leot 12126: </tr>
12127: <tr>
1.331 gutterid 12128: <td>BUILD_DEFS_EFFECTS</td>
1.370 gdt 12129: <td>BUILD_DEPENDS</td>
1.269 leot 12130: </tr>
12131: <tr>
1.331 gutterid 12132: <td>BUILD_DIRS</td>
1.370 gdt 12133: <td>BUILD_ENV_SHELL</td>
1.269 leot 12134: </tr>
12135: <tr>
1.331 gutterid 12136: <td>BUILD_MAKE_CMD</td>
1.370 gdt 12137: <td>BUILD_MAKE_FLAGS</td>
1.269 leot 12138: </tr>
12139: <tr>
1.331 gutterid 12140: <td>BUILD_TARGET</td>
1.370 gdt 12141: <td>BUILTIN_FIND_FILES</td>
1.269 leot 12142: </tr>
12143: <tr>
1.331 gutterid 12144: <td>BUILTIN_FIND_FILES_VAR</td>
1.370 gdt 12145: <td>BUILTIN_FIND_GREP</td>
1.269 leot 12146: </tr>
12147: <tr>
1.331 gutterid 12148: <td>BUILTIN_FIND_HEADERS</td>
1.370 gdt 12149: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.269 leot 12150: </tr>
12151: <tr>
1.331 gutterid 12152: <td>BUILTIN_FIND_PKGCONFIG</td>
1.370 gdt 12153: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.269 leot 12154: </tr>
12155: <tr>
1.331 gutterid 12156: <td>BUILTIN_PKG</td>
1.370 gdt 12157: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.309 gutterid 12158: </tr>
12159: <tr>
1.331 gutterid 12160: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.370 gdt 12161: <td>BUILTIN_VERSION_SCRIPT</td>
1.269 leot 12162: </tr>
12163: <tr>
1.331 gutterid 12164: <td>BUILTIN_X11_TYPE</td>
1.370 gdt 12165: <td>BUILTIN_X11_VERSION</td>
1.269 leot 12166: </tr>
12167: <tr>
1.331 gutterid 12168: <td>CACTI_GROUP</td>
1.370 gdt 12169: <td>CACTI_USER</td>
1.269 leot 12170: </tr>
12171: <tr>
1.331 gutterid 12172: <td>CANNA_GROUP</td>
1.370 gdt 12173: <td>CANNA_USER</td>
1.269 leot 12174: </tr>
12175: <tr>
1.331 gutterid 12176: <td>CAT</td>
1.370 gdt 12177: <td>CBLAS_LIBS</td>
1.269 leot 12178: </tr>
12179: <tr>
1.344 gutterid 12180: <td>CBLAS_PC</td>
1.370 gdt 12181: <td>CCACHE_BASE</td>
1.269 leot 12182: </tr>
12183: <tr>
1.303 bacon 12184: <td>CCACHE_DIR</td>
1.370 gdt 12185: <td>CCACHE_LOGFILE</td>
1.269 leot 12186: </tr>
12187: <tr>
1.374 wiz 12188: <td>CCACHE_RECACHE</td>
1.303 bacon 12189: <td>CC_VERSION</td>
1.269 leot 12190: </tr>
12191: <tr>
1.374 wiz 12192: <td>CC_VERSION_STRING</td>
1.303 bacon 12193: <td>CDRECORD_CONF</td>
1.269 leot 12194: </tr>
12195: <tr>
1.374 wiz 12196: <td>CDROM_PKG_URL_DIR</td>
1.303 bacon 12197: <td>CDROM_PKG_URL_HOST</td>
1.338 nia 12198: </tr>
12199: <tr>
1.374 wiz 12200: <td>CHANGES</td>
1.378 ! leot 12201: <td>CHECKOUT_DATE</td>
! 12202: </tr>
! 12203: <tr>
1.377 jnemeth 12204: <td>CHECK_COMPILER</td>
1.378 ! leot 12205: <td>CHECK_FAKEHOME</td>
1.376 wiz 12206: </tr>
12207: <tr>
1.377 jnemeth 12208: <td>CHECK_FILES</td>
1.378 ! leot 12209: <td>CHECK_FILES_ONLY_PREFIX</td>
1.369 wiz 12210: </tr>
12211: <tr>
1.377 jnemeth 12212: <td>CHECK_FILES_SKIP</td>
1.378 ! leot 12213: <td>CHECK_FILES_STRICT</td>
1.367 gdt 12214: </tr>
12215: <tr>
1.377 jnemeth 12216: <td>CHECK_HEADERS</td>
1.378 ! leot 12217: <td>CHECK_HEADERS_SKIP</td>
1.360 leot 12218: </tr>
12219: <tr>
1.377 jnemeth 12220: <td>CHECK_INTERPRETER</td>
1.378 ! leot 12221: <td>CHECK_INTERPRETER_SKIP</td>
1.355 rillig 12222: </tr>
12223: <tr>
1.377 jnemeth 12224: <td>CHECK_PERMS</td>
1.378 ! leot 12225: <td>CHECK_PERMS_AUTOFIX</td>
1.352 wiz 12226: </tr>
12227: <tr>
1.377 jnemeth 12228: <td>CHECK_PERMS_SKIP</td>
1.378 ! leot 12229: <td>CHECK_PIE</td>
1.348 wiz 12230: </tr>
12231: <tr>
1.377 jnemeth 12232: <td>CHECK_PIE_SKIP</td>
1.378 ! leot 12233: <td>CHECK_PIE_SUPPORTED</td>
1.342 wiz 12234: </tr>
12235: <tr>
1.377 jnemeth 12236: <td>CHECK_PORTABILITY</td>
1.378 ! leot 12237: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.332 rillig 12238: </tr>
12239: <tr>
1.377 jnemeth 12240: <td>CHECK_PORTABILITY_SKIP</td>
1.378 ! leot 12241: <td>CHECK_RELRO</td>
1.329 leot 12242: </tr>
12243: <tr>
1.377 jnemeth 12244: <td>CHECK_RELRO_SKIP</td>
1.378 ! leot 12245: <td>CHECK_RELRO_SUPPORTED</td>
1.327 wiz 12246: </tr>
12247: <tr>
1.377 jnemeth 12248: <td>CHECK_SHLIBS</td>
1.378 ! leot 12249: <td>CHECK_SHLIBS_SKIP</td>
1.320 wiz 12250: </tr>
12251: <tr>
1.377 jnemeth 12252: <td>CHECK_SHLIBS_SUPPORTED</td>
1.378 ! leot 12253: <td>CHECK_SHLIBS_TOXIC</td>
1.311 leot 12254: </tr>
12255: <tr>
1.377 jnemeth 12256: <td>CHECK_SSP</td>
1.378 ! leot 12257: <td>CHECK_SSP_SKIP</td>
1.292 leot 12258: </tr>
12259: <tr>
1.377 jnemeth 12260: <td>CHECK_SSP_SUPPORTED</td>
1.378 ! leot 12261: <td>CHECK_STRIPPED</td>
1.274 rillig 12262: </tr>
12263: <tr>
1.377 jnemeth 12264: <td>CHECK_STRIPPED_SKIP</td>
1.378 ! leot 12265: <td>CHECK_WRKREF</td>
1.331 gutterid 12266: </tr>
12267: <tr>
1.377 jnemeth 12268: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.378 ! leot 12269: <td>CHECK_WRKREF_SKIP</td>
1.269 leot 12270: </tr>
12271: <tr>
1.377 jnemeth 12272: <td>CLAMAV_DBDIR</td>
1.378 ! leot 12273: <td>CLAMAV_GROUP</td>
1.269 leot 12274: </tr>
12275: <tr>
1.377 jnemeth 12276: <td>CLAMAV_USER</td>
1.378 ! leot 12277: <td>CLANGBASE</td>
1.269 leot 12278: </tr>
12279: <tr>
1.377 jnemeth 12280: <td>CLEANDEPENDS</td>
1.378 ! leot 12281: <td>CLT</td>
1.269 leot 12282: </tr>
12283: <tr>
1.377 jnemeth 12284: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.378 ! leot 12285: <td>CMAKE_INSTALL_NAME_DIR</td>
1.269 leot 12286: </tr>
12287: <tr>
1.377 jnemeth 12288: <td>CMAKE_INSTALL_PREFIX</td>
1.378 ! leot 12289: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.369 wiz 12290: </tr>
12291: <tr>
1.377 jnemeth 12292: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.378 ! leot 12293: <td>CMAKE_PREFIX_PATH</td>
1.269 leot 12294: </tr>
12295: <tr>
1.374 wiz 12296: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.378 ! leot 12297: <td>COMMON_LISP_DOCFILES</td>
! 12298: </tr>
! 12299: <tr>
! 12300: <td>COMMON_LISP_EXAMPLES</td>
! 12301: <td>COMMON_LISP_EXTRAFILES</td>
! 12302: </tr>
! 12303: <tr>
! 12304: <td>COMMON_LISP_PACKAGES</td>
! 12305: <td>COMMON_LISP_SYSTEM</td>
1.269 leot 12306: </tr>
12307: <tr>
1.374 wiz 12308: <td>COMPILER_RPATH_FLAG</td>
1.341 gutterid 12309: <td>COMPILER_USE_SYMLINKS</td>
1.269 leot 12310: </tr>
12311: <tr>
1.374 wiz 12312: <td>CONFIGURE_ARGS</td>
1.341 gutterid 12313: <td>CONFIGURE_DIRS</td>
1.269 leot 12314: </tr>
12315: <tr>
1.374 wiz 12316: <td>CONFIGURE_ENV</td>
1.341 gutterid 12317: <td>CONFIGURE_ENV_SHELL</td>
1.269 leot 12318: </tr>
12319: <tr>
1.374 wiz 12320: <td>CONFIGURE_HAS_INFODIR</td>
1.341 gutterid 12321: <td>CONFIGURE_HAS_MANDIR</td>
1.269 leot 12322: </tr>
12323: <tr>
1.374 wiz 12324: <td>CONFIGURE_SCRIPT</td>
1.341 gutterid 12325: <td>CONFIG_SHELL</td>
1.269 leot 12326: </tr>
12327: <tr>
1.374 wiz 12328: <td>CONFIG_SHELL_FLAGS</td>
1.341 gutterid 12329: <td>CONF_FILES</td>
1.269 leot 12330: </tr>
12331: <tr>
1.374 wiz 12332: <td>CONF_FILES_MODE</td>
1.341 gutterid 12333: <td>CONF_FILES_PERMS</td>
1.269 leot 12334: </tr>
12335: <tr>
1.374 wiz 12336: <td>CONSERVER_DEFAULTHOST</td>
1.341 gutterid 12337: <td>CONSERVER_DEFAULTPORT</td>
1.269 leot 12338: </tr>
12339: <tr>
1.374 wiz 12340: <td>CP</td>
1.347 gutterid 12341: <td>CPE</td>
12342: </tr>
12343: <tr>
1.374 wiz 12344: <td>CPE_EDITION</td>
1.347 gutterid 12345: <td>CPE_LANG</td>
12346: </tr>
12347: <tr>
1.374 wiz 12348: <td>CPE_OTHER</td>
1.347 gutterid 12349: <td>CPE_PART</td>
12350: </tr>
12351: <tr>
1.374 wiz 12352: <td>CPE_PRODUCT</td>
1.347 gutterid 12353: <td>CPE_SW_EDITION</td>
12354: </tr>
12355: <tr>
1.374 wiz 12356: <td>CPE_TARGET_HW</td>
1.347 gutterid 12357: <td>CPE_TARGET_SW</td>
12358: </tr>
12359: <tr>
1.374 wiz 12360: <td>CPE_UPDATE</td>
1.347 gutterid 12361: <td>CPE_URI</td>
12362: </tr>
12363: <tr>
1.374 wiz 12364: <td>CPE_VENDOR</td>
1.347 gutterid 12365: <td>CPE_VERSION</td>
1.269 leot 12366: </tr>
12367: <tr>
1.374 wiz 12368: <td>CPP</td>
1.347 gutterid 12369: <td>CPP_PRECOMP_FLAGS</td>
1.269 leot 12370: </tr>
12371: <tr>
1.374 wiz 12372: <td>CREATE_WRKDIR_SYMLINK</td>
1.347 gutterid 12373: <td>CROSSBASE</td>
1.269 leot 12374: </tr>
12375: <tr>
1.374 wiz 12376: <td>CTFCONVERT</td>
1.347 gutterid 12377: <td>CTF_FILES_SKIP</td>
1.269 leot 12378: </tr>
12379: <tr>
1.374 wiz 12380: <td>CTF_SUPPORTED</td>
1.347 gutterid 12381: <td>CTYPE</td>
1.269 leot 12382: </tr>
12383: <tr>
1.374 wiz 12384: <td>CUPS_GROUP</td>
1.347 gutterid 12385: <td>CUPS_SYSTEM_GROUPS</td>
1.292 leot 12386: </tr>
12387: <tr>
1.374 wiz 12388: <td>CUPS_USER</td>
1.347 gutterid 12389: <td>CURSES_DEFAULT</td>
1.342 wiz 12390: </tr>
12391: <tr>
1.374 wiz 12392: <td>CURSES_TYPE</td>
1.378 ! leot 12393: <td>CVS_EXTRACTDIR</td>
! 12394: </tr>
! 12395: <tr>
! 12396: <td>CVS_MODULE</td>
! 12397: <td>CVS_PROJECT</td>
! 12398: </tr>
! 12399: <tr>
! 12400: <td>CVS_REPOSITORIES</td>
! 12401: <td>CVS_ROOT</td>
! 12402: </tr>
! 12403: <tr>
! 12404: <td>CVS_ROOT_GNU</td>
! 12405: <td>CVS_ROOT_NONGNU</td>
! 12406: </tr>
! 12407: <tr>
! 12408: <td>CVS_ROOT_SOURCEFORGE</td>
! 12409: <td>CVS_TAG</td>
! 12410: </tr>
! 12411: <tr>
1.377 jnemeth 12412: <td>CXX</td>
1.378 ! leot 12413: <td>CYRUS_GROUP</td>
1.376 wiz 12414: </tr>
12415: <tr>
1.377 jnemeth 12416: <td>CYRUS_IDLE</td>
1.378 ! leot 12417: <td>CYRUS_USER</td>
1.369 wiz 12418: </tr>
12419: <tr>
1.377 jnemeth 12420: <td>DAEMONTOOLS_GROUP</td>
1.378 ! leot 12421: <td>DAEMONTOOLS_LOG_USER</td>
1.367 gdt 12422: </tr>
12423: <tr>
1.377 jnemeth 12424: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.378 ! leot 12425: <td>DARWIN_REQUIRES_FILTER</td>
1.360 leot 12426: </tr>
12427: <tr>
1.377 jnemeth 12428: <td>DBUS_GROUP</td>
1.378 ! leot 12429: <td>DBUS_USER</td>
1.352 wiz 12430: </tr>
12431: <tr>
1.377 jnemeth 12432: <td>DEFANG_GROUP</td>
1.378 ! leot 12433: <td>DEFANG_USER</td>
1.348 wiz 12434: </tr>
12435: <tr>
1.377 jnemeth 12436: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.378 ! leot 12437: <td>DEFAULT_DISTFILES</td>
1.332 rillig 12438: </tr>
12439: <tr>
1.377 jnemeth 12440: <td>DEFAULT_IRC_SERVER</td>
1.378 ! leot 12441: <td>DEFAULT_SERIAL_DEVICE</td>
1.329 leot 12442: </tr>
12443: <tr>
1.377 jnemeth 12444: <td>DEF_UMASK</td>
1.378 ! leot 12445: <td>DEINSTALLDEPENDS</td>
1.327 wiz 12446: </tr>
12447: <tr>
1.377 jnemeth 12448: <td>DEINSTALL_SRC</td>
1.378 ! leot 12449: <td>DEINSTALL_TEMPLATES</td>
1.320 wiz 12450: </tr>
12451: <tr>
1.377 jnemeth 12452: <td>DELAYED_ERROR_MSG</td>
1.378 ! leot 12453: <td>DELAYED_WARNING_MSG</td>
1.311 leot 12454: </tr>
12455: <tr>
1.377 jnemeth 12456: <td>DEPENDS</td>
1.378 ! leot 12457: <td>DEPENDS_TARGET</td>
1.269 leot 12458: </tr>
12459: <tr>
1.377 jnemeth 12460: <td>DEPENDS_TYPE</td>
1.378 ! leot 12461: <td>DESTDIR</td>
1.269 leot 12462: </tr>
12463: <tr>
1.377 jnemeth 12464: <td>DESTDIR_VARNAME</td>
1.378 ! leot 12465: <td>DIALER_GROUP</td>
1.269 leot 12466: </tr>
12467: <tr>
1.377 jnemeth 12468: <td>DIGEST_REQD</td>
1.378 ! leot 12469: <td>DISTDIR</td>
1.309 gutterid 12470: </tr>
12471: <tr>
1.377 jnemeth 12472: <td>DISTFILES</td>
1.378 ! leot 12473: <td>DISTINFO_FILE</td>
1.269 leot 12474: </tr>
12475: <tr>
1.377 jnemeth 12476: <td>DISTNAME</td>
1.378 ! leot 12477: <td>DIST_PATH</td>
1.269 leot 12478: </tr>
12479: <tr>
1.377 jnemeth 12480: <td>DIST_SUBDIR</td>
1.378 ! leot 12481: <td>DJBDNS_AXFR_USER</td>
1.269 leot 12482: </tr>
12483: <tr>
1.377 jnemeth 12484: <td>DJBDNS_CACHE_USER</td>
1.378 ! leot 12485: <td>DJBDNS_DJBDNS_GROUP</td>
1.269 leot 12486: </tr>
12487: <tr>
1.377 jnemeth 12488: <td>DJBDNS_LOG_USER</td>
1.378 ! leot 12489: <td>DJBDNS_RBL_USER</td>
1.269 leot 12490: </tr>
12491: <tr>
1.377 jnemeth 12492: <td>DJBDNS_TINY_USER</td>
1.378 ! leot 12493: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.269 leot 12494: </tr>
12495: <tr>
1.377 jnemeth 12496: <td>DL_AUTO_VARS</td>
1.378 ! leot 12497: <td>DL_CFLAGS</td>
1.269 leot 12498: </tr>
12499: <tr>
1.377 jnemeth 12500: <td>DL_LDFLAGS</td>
1.378 ! leot 12501: <td>DL_LIBS</td>
1.269 leot 12502: </tr>
12503: <tr>
1.377 jnemeth 12504: <td>DNS</td>
1.378 ! leot 12505: <td>DOCOWN</td>
1.269 leot 12506: </tr>
12507: <tr>
1.377 jnemeth 12508: <td>DOWNLOADED_DISTFILE</td>
1.378 ! leot 12509: <td>DQCACHE_GROUP</td>
1.269 leot 12510: </tr>
12511: <tr>
1.377 jnemeth 12512: <td>DQCACHE_USER</td>
1.378 ! leot 12513: <td>DT_LAYOUT</td>
1.269 leot 12514: </tr>
12515: <tr>
1.377 jnemeth 12516: <td>DYNAMIC_SITES_CMD</td>
1.378 ! leot 12517: <td>DYNAMIC_SITES_SCRIPT</td>
1.269 leot 12518: </tr>
12519: <tr>
1.377 jnemeth 12520: <td>ECHO</td>
1.378 ! leot 12521: <td>ECHO_N</td>
1.269 leot 12522: </tr>
12523: <tr>
1.377 jnemeth 12524: <td>ELK_GUI</td>
1.378 ! leot 12525: <td>EMACS_TYPE</td>
1.269 leot 12526: </tr>
12527: <tr>
1.377 jnemeth 12528: <td>EMULDIR</td>
1.378 ! leot 12529: <td>EMULSUBDIR</td>
1.269 leot 12530: </tr>
12531: <tr>
1.377 jnemeth 12532: <td>EMULSUBDIRSLASH</td>
1.378 ! leot 12533: <td>EMUL_ARCH</td>
1.269 leot 12534: </tr>
12535: <tr>
1.377 jnemeth 12536: <td>EMUL_DISTRO</td>
1.378 ! leot 12537: <td>EMUL_EXEC_FMT</td>
1.357 gutterid 12538: </tr>
12539: <tr>
1.377 jnemeth 12540: <td>EMUL_IS_NATIVE</td>
1.378 ! leot 12541: <td>EMUL_MODULES</td>
1.333 nia 12542: </tr>
12543: <tr>
1.377 jnemeth 12544: <td>EMUL_OPSYS</td>
1.378 ! leot 12545: <td>EMUL_PKG_FMT</td>
1.269 leot 12546: </tr>
12547: <tr>
1.377 jnemeth 12548: <td>EMUL_PLATFORM</td>
1.378 ! leot 12549: <td>EMUL_PLATFORMS</td>
1.269 leot 12550: </tr>
12551: <tr>
1.377 jnemeth 12552: <td>EMUL_PREFER</td>
1.378 ! leot 12553: <td>EMUL_REQD</td>
1.269 leot 12554: </tr>
12555: <tr>
1.377 jnemeth 12556: <td>EMUL_TYPE</td>
1.378 ! leot 12557: <td>ERROR_MSG</td>
1.269 leot 12558: </tr>
12559: <tr>
1.377 jnemeth 12560: <td>EXIM_GROUP</td>
1.378 ! leot 12561: <td>EXIM_USER</td>
1.269 leot 12562: </tr>
12563: <tr>
1.377 jnemeth 12564: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.378 ! leot 12565: <td>EXTRACTOR</td>
1.269 leot 12566: </tr>
12567: <tr>
1.377 jnemeth 12568: <td>EXTRACT_CMD</td>
1.378 ! leot 12569: <td>EXTRACT_CMD_DEFAULT</td>
1.269 leot 12570: </tr>
12571: <tr>
1.377 jnemeth 12572: <td>EXTRACT_DIR</td>
1.378 ! leot 12573: <td>EXTRACT_ELEMENTS</td>
1.269 leot 12574: </tr>
12575: <tr>
1.377 jnemeth 12576: <td>EXTRACT_ENV</td>
1.378 ! leot 12577: <td>EXTRACT_ONLY</td>
1.269 leot 12578: </tr>
12579: <tr>
1.377 jnemeth 12580: <td>EXTRACT_OPTS</td>
1.378 ! leot 12581: <td>EXTRACT_SUFX</td>
1.269 leot 12582: </tr>
12583: <tr>
1.377 jnemeth 12584: <td>EXTRACT_USING</td>
1.378 ! leot 12585: <td>FAIL</td>
1.269 leot 12586: </tr>
12587: <tr>
1.377 jnemeth 12588: <td>FAILOVER_FETCH</td>
1.378 ! leot 12589: <td>FAIL_MSG</td>
1.269 leot 12590: </tr>
12591: <tr>
1.377 jnemeth 12592: <td>FAKE_NCURSES</td>
1.378 ! leot 12593: <td>FAM</td>
1.269 leot 12594: </tr>
12595: <tr>
1.377 jnemeth 12596: <td>FAM_ACCEPTED</td>
1.378 ! leot 12597: <td>FAM_DEFAULT</td>
1.338 nia 12598: </tr>
12599: <tr>
1.377 jnemeth 12600: <td>FAM_SERVER</td>
1.378 ! leot 12601: <td>FCPATH</td>
1.269 leot 12602: </tr>
12603: <tr>
1.377 jnemeth 12604: <td>FEATURE_CPPFLAGS</td>
1.378 ! leot 12605: <td>FEATURE_LDFLAGS</td>
1.269 leot 12606: </tr>
12607: <tr>
1.377 jnemeth 12608: <td>FEATURE_LIBS</td>
1.378 ! leot 12609: <td>FETCH_AFTER_ARGS</td>
1.269 leot 12610: </tr>
12611: <tr>
1.377 jnemeth 12612: <td>FETCH_BEFORE_ARGS</td>
1.378 ! leot 12613: <td>FETCH_CMD</td>
1.269 leot 12614: </tr>
12615: <tr>
1.377 jnemeth 12616: <td>FETCH_INSECURE</td>
1.378 ! leot 12617: <td>FETCH_OUTPUT_ARGS</td>
1.269 leot 12618: </tr>
12619: <tr>
1.376 wiz 12620: <td>FETCH_PROXY</td>
1.378 ! leot 12621: <td>FETCH_RESUME_ARGS</td>
1.269 leot 12622: </tr>
12623: <tr>
1.376 wiz 12624: <td>FETCH_TIMEOUT</td>
1.378 ! leot 12625: <td>FETCH_USE_IPV4_ONLY</td>
1.269 leot 12626: </tr>
12627: <tr>
1.376 wiz 12628: <td>FETCH_USING</td>
1.378 ! leot 12629: <td>FILES_SUBST</td>
1.269 leot 12630: </tr>
12631: <tr>
1.376 wiz 12632: <td>FILES_SUBST_SED</td>
1.378 ! leot 12633: <td>FIX_SYSTEM_HEADERS</td>
1.269 leot 12634: </tr>
12635: <tr>
1.378 ! leot 12636: <td>FONTDIR</td>
1.377 jnemeth 12637: <td>FONTS_DIRS</td>
1.269 leot 12638: </tr>
12639: <tr>
1.357 gutterid 12640: <td>FONTS_VERBOSE</td>
1.377 jnemeth 12641: <td>FOO_HACKS_MK</td>
1.292 leot 12642: </tr>
12643: <tr>
1.358 gutterid 12644: <td>FORCE_CXX_STD</td>
1.374 wiz 12645: <td>FORCE_C_STD</td>
1.376 wiz 12646: </tr>
12647: <tr>
1.378 ! leot 12648: <td>FOSSIL_EXTRACTDIR</td>
! 12649: <td>FOSSIL_REPO</td>
! 12650: </tr>
! 12651: <tr>
! 12652: <td>FOSSIL_REPOSITORIES</td>
! 12653: <td>FOSSIL_VERSION</td>
! 12654: </tr>
! 12655: <tr>
1.357 gutterid 12656: <td>FOX_USE_XUNICODE</td>
1.377 jnemeth 12657: <td>FREEWNN_GROUP</td>
1.269 leot 12658: </tr>
12659: <tr>
1.357 gutterid 12660: <td>FREEWNN_USER</td>
1.377 jnemeth 12661: <td>FTP_PKG_URL_DIR</td>
1.269 leot 12662: </tr>
12663: <tr>
1.357 gutterid 12664: <td>FTP_PKG_URL_HOST</td>
1.377 jnemeth 12665: <td>GAMEDATAMODE</td>
1.269 leot 12666: </tr>
12667: <tr>
1.357 gutterid 12668: <td>GAMEDATA_PERMS</td>
1.377 jnemeth 12669: <td>GAMEDIRMODE</td>
1.269 leot 12670: </tr>
12671: <tr>
1.357 gutterid 12672: <td>GAMEDIR_PERMS</td>
1.377 jnemeth 12673: <td>GAMEGRP</td>
1.269 leot 12674: </tr>
12675: <tr>
1.357 gutterid 12676: <td>GAMEMODE</td>
1.377 jnemeth 12677: <td>GAMEOWN</td>
1.269 leot 12678: </tr>
12679: <tr>
1.357 gutterid 12680: <td>GAMES_GROUP</td>
1.377 jnemeth 12681: <td>GAMES_USER</td>
1.269 leot 12682: </tr>
12683: <tr>
1.357 gutterid 12684: <td>GCC</td>
1.377 jnemeth 12685: <td>GCCBASE</td>
1.269 leot 12686: </tr>
12687: <tr>
1.357 gutterid 12688: <td>GCC_REQD</td>
1.377 jnemeth 12689: <td>GCC_VERSION_SUFFIX</td>
1.269 leot 12690: </tr>
12691: <tr>
1.357 gutterid 12692: <td>GEM_BUILD</td>
1.377 jnemeth 12693: <td>GEM_CLEANBUILD</td>
1.269 leot 12694: </tr>
12695: <tr>
1.357 gutterid 12696: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.377 jnemeth 12697: <td>GEM_DOCDIR</td>
1.269 leot 12698: </tr>
12699: <tr>
1.357 gutterid 12700: <td>GEM_EXTSDIR</td>
1.377 jnemeth 12701: <td>GEM_HOME</td>
1.374 wiz 12702: </tr>
12703: <tr>
12704: <td>GEM_KEEPBUILD</td>
1.377 jnemeth 12705: <td>GEM_LIBDIR</td>
1.292 leot 12706: </tr>
12707: <tr>
1.374 wiz 12708: <td>GEM_NAME</td>
1.377 jnemeth 12709: <td>GEM_PATH</td>
1.269 leot 12710: </tr>
12711: <tr>
1.374 wiz 12712: <td>GEM_PLUGINSDIR</td>
1.377 jnemeth 12713: <td>GEM_SPECFILE</td>
1.269 leot 12714: </tr>
12715: <tr>
1.374 wiz 12716: <td>GENERATE_PLIST</td>
1.377 jnemeth 12717: <td>GHC</td>
1.269 leot 12718: </tr>
12719: <tr>
1.374 wiz 12720: <td>GHOSTSCRIPT_REQD</td>
1.377 jnemeth 12721: <td>GITHUB_PROJECT</td>
1.269 leot 12722: </tr>
12723: <tr>
1.374 wiz 12724: <td>GITHUB_RELEASE</td>
1.377 jnemeth 12725: <td>GITHUB_SUBMODULES</td>
1.292 leot 12726: </tr>
12727: <tr>
1.374 wiz 12728: <td>GITHUB_TAG</td>
1.377 jnemeth 12729: <td>GITHUB_TYPE</td>
1.311 leot 12730: </tr>
12731: <tr>
1.374 wiz 12732: <td>GITLAB_PROJECT</td>
1.377 jnemeth 12733: <td>GITLAB_RELEASE</td>
1.269 leot 12734: </tr>
12735: <tr>
1.374 wiz 12736: <td>GITLAB_SUBMODULES</td>
1.377 jnemeth 12737: <td>GITLAB_TAG</td>
1.338 nia 12738: </tr>
12739: <tr>
1.374 wiz 12740: <td>GITLAB_TYPE</td>
1.378 ! leot 12741: <td>GIT_BRANCH</td>
! 12742: </tr>
! 12743: <tr>
! 12744: <td>GIT_ENV</td>
! 12745: <td>GIT_EXTRACTDIR</td>
! 12746: </tr>
! 12747: <tr>
! 12748: <td>GIT_REPO</td>
! 12749: <td>GIT_REPOSITORIES</td>
! 12750: </tr>
! 12751: <tr>
! 12752: <td>GIT_REVISION</td>
! 12753: <td>GIT_TAG</td>
! 12754: </tr>
! 12755: <tr>
1.374 wiz 12756: <td>GNU</td>
1.378 ! leot 12757: <td>GNU_CONFIGURE</td>
1.376 wiz 12758: </tr>
12759: <tr>
12760: <td>GNU_CONFIGURE_ICONV</td>
1.378 ! leot 12761: <td>GNU_CONFIGURE_INFODIR</td>
1.369 wiz 12762: </tr>
12763: <tr>
1.376 wiz 12764: <td>GNU_CONFIGURE_MANDIR</td>
1.378 ! leot 12765: <td>GNU_CONFIGURE_QUIET</td>
1.369 wiz 12766: </tr>
12767: <tr>
1.376 wiz 12768: <td>GNU_CONFIGURE_STRICT</td>
1.378 ! leot 12769: <td>GODEP_REDIRECTS</td>
1.360 leot 12770: </tr>
12771: <tr>
1.376 wiz 12772: <td>GO_BUILD_PATTERN</td>
1.378 ! leot 12773: <td>GO_DEPS</td>
1.355 rillig 12774: </tr>
12775: <tr>
1.376 wiz 12776: <td>GO_DIST_BASE</td>
1.378 ! leot 12777: <td>GO_EXTRA_MOD_DIRS</td>
1.348 wiz 12778: </tr>
12779: <tr>
1.376 wiz 12780: <td>GO_MODULE_EXTRACT</td>
1.378 ! leot 12781: <td>GO_MODULE_FILES</td>
1.269 leot 12782: </tr>
12783: <tr>
1.376 wiz 12784: <td>GO_SRCPATH</td>
1.378 ! leot 12785: <td>GROUP_SPECIFIC_PKGS</td>
1.269 leot 12786: </tr>
12787: <tr>
1.376 wiz 12788: <td>GRUB_NETWORK_CARDS</td>
1.378 ! leot 12789: <td>GRUB_PRESET_COMMAND</td>
1.269 leot 12790: </tr>
12791: <tr>
1.376 wiz 12792: <td>GRUB_SCAN_ARGS</td>
1.378 ! leot 12793: <td>GZIP</td>
1.352 wiz 12794: </tr>
12795: <tr>
1.378 ! leot 12796: <td>HASKELL_COMPILER</td>
1.377 jnemeth 12797: <td>HASKELL_DISABLE_EXECUTABLES</td>
1.276 leot 12798: </tr>
12799: <tr>
1.375 jkoshy 12800: <td>HASKELL_DISABLE_LIBRARIES</td>
1.377 jnemeth 12801: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.269 leot 12802: </tr>
12803: <tr>
1.375 jkoshy 12804: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.377 jnemeth 12805: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.332 rillig 12806: </tr>
12807: <tr>
1.375 jkoshy 12808: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.377 jnemeth 12809: <td>HASKELL_ENABLE_TESTS</td>
1.341 gutterid 12810: </tr>
12811: <tr>
1.375 jkoshy 12812: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.377 jnemeth 12813: <td>HASKELL_PKG_NAME</td>
1.335 nia 12814: </tr>
12815: <tr>
1.375 jkoshy 12816: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
1.341 gutterid 12817: <td>HEADER_TEMPLATES</td>
1.376 wiz 12818: </tr>
12819: <tr>
1.378 ! leot 12820: <td>HG_REPO</td>
! 12821: <td>HG_REPOSITORIES</td>
! 12822: </tr>
! 12823: <tr>
! 12824: <td>HG_TAG</td>
1.369 wiz 12825: <td>HOMEPAGE</td>
1.378 ! leot 12826: </tr>
! 12827: <tr>
1.376 wiz 12828: <td>HOST_PKGTOOLS_ARGS</td>
1.378 ! leot 12829: <td>HOST_SPECIFIC_PKGS</td>
1.329 leot 12830: </tr>
12831: <tr>
1.376 wiz 12832: <td>HOWL_GROUP</td>
1.378 ! leot 12833: <td>HOWL_USER</td>
1.360 leot 12834: </tr>
12835: <tr>
1.376 wiz 12836: <td>ICCBASE</td>
1.378 ! leot 12837: <td>ICECAST_CHROOTDIR</td>
1.355 rillig 12838: </tr>
12839: <tr>
1.376 wiz 12840: <td>ICON_THEMES</td>
1.378 ! leot 12841: <td>IDOBASE</td>
1.348 wiz 12842: </tr>
12843: <tr>
1.376 wiz 12844: <td>IGNORE_CCACHE</td>
1.378 ! leot 12845: <td>IGNORE_INFO_DIRS</td>
1.342 wiz 12846: </tr>
12847: <tr>
1.376 wiz 12848: <td>IGNORE_INTERACTIVE_FETCH</td>
1.378 ! leot 12849: <td>IMAKE</td>
1.338 nia 12850: </tr>
12851: <tr>
1.376 wiz 12852: <td>IMAKEOPTS</td>
1.378 ! leot 12853: <td>IMAKE_MAKE</td>
1.269 leot 12854: </tr>
12855: <tr>
1.376 wiz 12856: <td>IMAKE_MANINSTALL</td>
1.378 ! leot 12857: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.305 bacon 12858: </tr>
12859: <tr>
1.376 wiz 12860: <td>IMDICTDIR</td>
1.378 ! leot 12861: <td>INCOMPAT_CURSES</td>
1.269 leot 12862: </tr>
12863: <tr>
1.376 wiz 12864: <td>INFO_DIR</td>
1.378 ! leot 12865: <td>INFO_FILES</td>
1.269 leot 12866: </tr>
12867: <tr>
1.376 wiz 12868: <td>INFO_MSG</td>
1.378 ! leot 12869: <td>INIT_SYSTEM</td>
1.269 leot 12870: </tr>
12871: <tr>
1.376 wiz 12872: <td>INN_DATA_DIR</td>
1.378 ! leot 12873: <td>INN_GROUP</td>
1.269 leot 12874: </tr>
12875: <tr>
1.376 wiz 12876: <td>INN_USER</td>
1.378 ! leot 12877: <td>INSTALLATION_DIRS</td>
1.269 leot 12878: </tr>
12879: <tr>
1.376 wiz 12880: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.378 ! leot 12881: <td>INSTALL_ENV</td>
1.269 leot 12882: </tr>
12883: <tr>
1.376 wiz 12884: <td>INSTALL_SH_OVERRIDE</td>
1.378 ! leot 12885: <td>INSTALL_SRC</td>
1.269 leot 12886: </tr>
12887: <tr>
1.376 wiz 12888: <td>INSTALL_TEMPLATES</td>
1.378 ! leot 12889: <td>INSTALL_UNSTRIPPED</td>
1.269 leot 12890: </tr>
12891: <tr>
1.376 wiz 12892: <td>IRCD_HYBRID_IRC_GROUP</td>
1.378 ! leot 12893: <td>IRCD_HYBRID_IRC_USER</td>
1.369 wiz 12894: </tr>
12895: <tr>
1.376 wiz 12896: <td>IRCD_HYBRID_MAXCONN</td>
1.378 ! leot 12897: <td>IRCD_HYBRID_NICLEN</td>
1.287 rillig 12898: </tr>
12899: <tr>
1.376 wiz 12900: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.378 ! leot 12901: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.269 leot 12902: </tr>
12903: <tr>
1.376 wiz 12904: <td>IRCD_HYBRID_TOPICLEN</td>
1.378 ! leot 12905: <td>IRIX</td>
1.269 leot 12906: </tr>
12907: <tr>
1.376 wiz 12908: <td>IRRD_USE_PGP</td>
1.378 ! leot 12909: <td>JABBERD_GROUP</td>
1.269 leot 12910: </tr>
12911: <tr>
1.376 wiz 12912: <td>JABBERD_LOGDIR</td>
1.378 ! leot 12913: <td>JABBERD_PIDDIR</td>
1.269 leot 12914: </tr>
12915: <tr>
1.376 wiz 12916: <td>JABBERD_SPOOLDIR</td>
1.378 ! leot 12917: <td>JABBERD_USER</td>
! 12918: </tr>
! 12919: <tr>
! 12920: <td>JAVA_APP_PATH</td>
! 12921: <td>JAVA_APP_TARGETS</td>
1.269 leot 12922: </tr>
12923: <tr>
1.370 gdt 12924: <td>JAVA_BINPREFIX</td>
1.378 ! leot 12925: <td>JAVA_CLASSPATH</td>
1.376 wiz 12926: </tr>
12927: <tr>
12928: <td>JAVA_HOME</td>
1.378 ! leot 12929: <td>JAVA_LD_LIBRARY_PATH</td>
1.367 gdt 12930: </tr>
12931: <tr>
1.376 wiz 12932: <td>JAVA_NAME</td>
1.378 ! leot 12933: <td>JAVA_UNLIMIT</td>
1.360 leot 12934: </tr>
12935: <tr>
1.376 wiz 12936: <td>JAVA_WRAPPERS</td>
1.378 ! leot 12937: <td>JPEG_ACCEPTED</td>
1.269 leot 12938: </tr>
12939: <tr>
1.376 wiz 12940: <td>JPEG_DEFAULT</td>
1.378 ! leot 12941: <td>KERBEROS</td>
1.348 wiz 12942: </tr>
12943: <tr>
1.376 wiz 12944: <td>KERMIT_SUID_UUCP</td>
1.378 ! leot 12945: <td>KJS_USE_PCRE</td>
1.292 leot 12946: </tr>
12947: <tr>
1.376 wiz 12948: <td>KNEWS_DOMAIN_FILE</td>
1.378 ! leot 12949: <td>KNEWS_DOMAIN_NAME</td>
1.342 wiz 12950: </tr>
12951: <tr>
1.376 wiz 12952: <td>KRB5_ACCEPTED</td>
1.378 ! leot 12953: <td>KRB5_DEFAULT</td>
1.311 leot 12954: </tr>
12955: <tr>
1.376 wiz 12956: <td>LANGUAGES</td>
1.378 ! leot 12957: <td>LAPACKE_LIBS</td>
1.269 leot 12958: </tr>
12959: <tr>
1.376 wiz 12960: <td>LAPACKE_PC</td>
1.378 ! leot 12961: <td>LAPACK_LIBS</td>
1.332 rillig 12962: </tr>
12963: <tr>
1.376 wiz 12964: <td>LAPACK_PC</td>
1.378 ! leot 12965: <td>LATEX2HTML_ICONPATH</td>
1.269 leot 12966: </tr>
12967: <tr>
1.376 wiz 12968: <td>LDCONFIG_ADD_CMD</td>
1.378 ! leot 12969: <td>LDCONFIG_REMOVE_CMD</td>
1.269 leot 12970: </tr>
12971: <tr>
1.376 wiz 12972: <td>LDD</td>
1.378 ! leot 12973: <td>LEAFNODE_DATA_DIR</td>
1.269 leot 12974: </tr>
12975: <tr>
1.376 wiz 12976: <td>LEAFNODE_GROUP</td>
1.378 ! leot 12977: <td>LEAFNODE_USER</td>
1.269 leot 12978: </tr>
12979: <tr>
1.376 wiz 12980: <td>LIBDVDCSS_HOMEPAGE</td>
1.378 ! leot 12981: <td>LIBDVDCSS_MASTER_SITES</td>
1.292 leot 12982: </tr>
12983: <tr>
1.376 wiz 12984: <td>LIBIMAGEQUANT_TYPE</td>
1.378 ! leot 12985: <td>LIBRSVG_TYPE</td>
1.271 brook 12986: </tr>
12987: <tr>
1.376 wiz 12988: <td>LIBTOOL</td>
1.378 ! leot 12989: <td>LIBTOOLIZE_PLIST</td>
1.269 leot 12990: </tr>
12991: <tr>
1.376 wiz 12992: <td>LIBTOOL_M4_OVERRIDE</td>
1.378 ! leot 12993: <td>LIBUSB_TYPE</td>
1.269 leot 12994: </tr>
12995: <tr>
1.376 wiz 12996: <td>LICENSE</td>
1.378 ! leot 12997: <td>LINKER_RPATH_FLAG</td>
1.269 leot 12998: </tr>
12999: <tr>
1.376 wiz 13000: <td>LINK_RPATH_FLAG</td>
1.378 ! leot 13001: <td>LINUX_BASE_NODEPS</td>
! 13002: </tr>
! 13003: <tr>
! 13004: <td>LINUX_BASE_PREFERRED</td>
! 13005: <td>LINUX_BASE_REQUIRED</td>
1.369 wiz 13006: </tr>
13007: <tr>
1.375 jkoshy 13008: <td>LINUX_LOCALES</td>
1.377 jnemeth 13009: <td>LOCALBASE</td>
1.355 rillig 13010: </tr>
13011: <tr>
1.375 jkoshy 13012: <td>LOCALBASE_LOCKTYPE</td>
1.377 jnemeth 13013: <td>LOCALPATCHES</td>
1.269 leot 13014: </tr>
13015: <tr>
1.375 jkoshy 13016: <td>LOVE_DATA</td>
1.377 jnemeth 13017: <td>LOVE_GAME</td>
1.352 wiz 13018: </tr>
13019: <tr>
1.375 jkoshy 13020: <td>LOVE_VERSION</td>
1.377 jnemeth 13021: <td>LOWER_OPSYS</td>
1.338 nia 13022: </tr>
13023: <tr>
1.375 jkoshy 13024: <td>LOWER_OPSYS_VERSUFFIX</td>
1.377 jnemeth 13025: <td>LOWER_VARIANT_VERSION</td>
1.370 gdt 13026: </tr>
13027: <tr>
1.375 jkoshy 13028: <td>LOWER_VENDOR</td>
1.377 jnemeth 13029: <td>LP32PLATFORMS</td>
1.370 gdt 13030: </tr>
13031: <tr>
1.375 jkoshy 13032: <td>LP64PLATFORMS</td>
1.377 jnemeth 13033: <td>LUA_BUSTED_ARGS</td>
1.269 leot 13034: </tr>
13035: <tr>
1.375 jkoshy 13036: <td>LUA_CDIR</td>
1.377 jnemeth 13037: <td>LUA_COMPILER</td>
1.329 leot 13038: </tr>
13039: <tr>
1.375 jkoshy 13040: <td>LUA_DOCDIR</td>
1.377 jnemeth 13041: <td>LUA_EXAMPLESDIR</td>
1.269 leot 13042: </tr>
13043: <tr>
1.375 jkoshy 13044: <td>LUA_INCDIR</td>
1.377 jnemeth 13045: <td>LUA_INTERPRETER</td>
1.269 leot 13046: </tr>
13047: <tr>
1.375 jkoshy 13048: <td>LUA_LDIR</td>
1.377 jnemeth 13049: <td>LUA_LINKER_MAGIC</td>
1.269 leot 13050: </tr>
13051: <tr>
1.375 jkoshy 13052: <td>LUA_PKGPREFIX</td>
1.377 jnemeth 13053: <td>LUA_SELF_CONFLICT</td>
1.336 nia 13054: </tr>
13055: <tr>
1.375 jkoshy 13056: <td>LUA_USE_BUSTED</td>
1.377 jnemeth 13057: <td>LUA_VERSIONS_ACCEPTED</td>
1.333 nia 13058: </tr>
13059: <tr>
1.375 jkoshy 13060: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.377 jnemeth 13061: <td>LUA_VERSION_DEFAULT</td>
1.333 nia 13062: </tr>
13063: <tr>
1.375 jkoshy 13064: <td>LUA_VERSION_REQD</td>
1.377 jnemeth 13065: <td>Lua</td>
1.333 nia 13066: </tr>
13067: <tr>
1.375 jkoshy 13068: <td>MACHINE_PLATFORM</td>
1.377 jnemeth 13069: <td>MAILAGENT_DOMAIN</td>
1.333 nia 13070: </tr>
13071: <tr>
1.375 jkoshy 13072: <td>MAILAGENT_EMAIL</td>
1.377 jnemeth 13073: <td>MAILAGENT_FQDN</td>
1.333 nia 13074: </tr>
13075: <tr>
1.375 jkoshy 13076: <td>MAILAGENT_ORGANIZATION</td>
1.358 gutterid 13077: <td>MAJORDOMO_HOMEDIR</td>
1.376 wiz 13078: </tr>
13079: <tr>
1.378 ! leot 13080: <td>MAJOR_OS_VERSION</td>
1.368 gutterid 13081: <td>MAKEINFO_ARGS</td>
1.378 ! leot 13082: </tr>
! 13083: <tr>
1.376 wiz 13084: <td>MAKE_DIRS</td>
1.378 ! leot 13085: <td>MAKE_DIRS_PERMS</td>
1.367 gdt 13086: </tr>
13087: <tr>
1.376 wiz 13088: <td>MAKE_ENV</td>
1.378 ! leot 13089: <td>MAKE_FILE</td>
1.360 leot 13090: </tr>
13091: <tr>
1.376 wiz 13092: <td>MAKE_FLAGS</td>
1.378 ! leot 13093: <td>MAKE_JOBS</td>
1.320 wiz 13094: </tr>
13095: <tr>
1.376 wiz 13096: <td>MAKE_JOBS_SAFE</td>
1.378 ! leot 13097: <td>MAKE_PROGRAM</td>
1.348 wiz 13098: </tr>
13099: <tr>
1.376 wiz 13100: <td>MANCOMPRESSED_IF_MANZ</td>
1.378 ! leot 13101: <td>MANINSTALL</td>
1.342 wiz 13102: </tr>
13103: <tr>
1.376 wiz 13104: <td>MANZ</td>
1.378 ! leot 13105: <td>MARIADB_VERSIONS_ALL</td>
1.269 leot 13106: </tr>
13107: <tr>
1.376 wiz 13108: <td>MASTER_SITES</td>
1.378 ! leot 13109: <td>MASTER_SITE_BACKUP</td>
1.327 wiz 13110: </tr>
13111: <tr>
1.376 wiz 13112: <td>MASTER_SITE_LOCAL</td>
1.378 ! leot 13113: <td>MASTER_SITE_MOZILLA</td>
1.269 leot 13114: </tr>
13115: <tr>
1.376 wiz 13116: <td>MASTER_SITE_OVERRIDE</td>
1.378 ! leot 13117: <td>MASTER_SITE_PERL_CPAN</td>
1.269 leot 13118: </tr>
13119: <tr>
1.376 wiz 13120: <td>MASTER_SORT</td>
1.378 ! leot 13121: <td>MASTER_SORT_RANDOM</td>
1.269 leot 13122: </tr>
13123: <tr>
1.376 wiz 13124: <td>MASTER_SORT_REGEX</td>
1.378 ! leot 13125: <td>MECAB_CHARSET</td>
1.303 bacon 13126: </tr>
13127: <tr>
1.376 wiz 13128: <td>MEDIATOMB_GROUP</td>
1.378 ! leot 13129: <td>MEDIATOMB_USER</td>
1.269 leot 13130: </tr>
13131: <tr>
1.376 wiz 13132: <td>MIPSPROBASE</td>
1.378 ! leot 13133: <td>MIREDO_GROUP</td>
1.269 leot 13134: </tr>
13135: <tr>
1.376 wiz 13136: <td>MIREDO_USER</td>
1.378 ! leot 13137: <td>MISSING_FEATURES</td>
1.269 leot 13138: </tr>
13139: <tr>
1.376 wiz 13140: <td>MKDIR</td>
1.378 ! leot 13141: <td>MKPIE_SUPPORTED</td>
1.269 leot 13142: </tr>
13143: <tr>
1.376 wiz 13144: <td>MLDONKEY_GROUP</td>
1.378 ! leot 13145: <td>MLDONKEY_HOME</td>
1.269 leot 13146: </tr>
13147: <tr>
1.376 wiz 13148: <td>MLDONKEY_USER</td>
1.378 ! leot 13149: <td>MONOTONE_GROUP</td>
1.269 leot 13150: </tr>
13151: <tr>
1.376 wiz 13152: <td>MONOTONE_USER</td>
1.378 ! leot 13153: <td>MOTIFBASE</td>
1.269 leot 13154: </tr>
13155: <tr>
1.376 wiz 13156: <td>MOTIF_TYPE</td>
1.378 ! leot 13157: <td>MOTIF_TYPE_DEFAULT</td>
1.269 leot 13158: </tr>
13159: <tr>
1.376 wiz 13160: <td>MPI_TYPE</td>
1.378 ! leot 13161: <td>MSGFMT_STRIP_MSGCTXT</td>
1.269 leot 13162: </tr>
13163: <tr>
1.376 wiz 13164: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.378 ! leot 13165: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.269 leot 13166: </tr>
13167: <tr>
1.378 ! leot 13168: <td>MUST</td>
1.377 jnemeth 13169: <td>MV</td>
1.355 rillig 13170: </tr>
13171: <tr>
1.375 jkoshy 13172: <td>MYSQL_CHARSET</td>
1.377 jnemeth 13173: <td>MYSQL_DATADIR</td>
1.269 leot 13174: </tr>
13175: <tr>
1.375 jkoshy 13176: <td>MYSQL_EXTRA_CHARSET</td>
1.377 jnemeth 13177: <td>MYSQL_GROUP</td>
1.352 wiz 13178: </tr>
13179: <tr>
1.375 jkoshy 13180: <td>MYSQL_USER</td>
1.377 jnemeth 13181: <td>MYSQL_VERSION</td>
1.338 nia 13182: </tr>
13183: <tr>
1.375 jkoshy 13184: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.377 jnemeth 13185: <td>MYSQL_VERSION_DEFAULT</td>
1.329 leot 13186: </tr>
13187: <tr>
1.375 jkoshy 13188: <td>NAGIOSCMD_GROUP</td>
1.377 jnemeth 13189: <td>NAGIOSDIR</td>
1.269 leot 13190: </tr>
13191: <tr>
1.375 jkoshy 13192: <td>NAGIOS_GROUP</td>
1.377 jnemeth 13193: <td>NAGIOS_USER</td>
1.320 wiz 13194: </tr>
13195: <tr>
1.375 jkoshy 13196: <td>NATIVE_EXEC_FMT</td>
1.377 jnemeth 13197: <td>NATIVE_LOWER_OPSYS</td>
1.269 leot 13198: </tr>
13199: <tr>
1.375 jkoshy 13200: <td>NATIVE_LOWER_VENDOR</td>
1.377 jnemeth 13201: <td>NATIVE_MACHINE_PLATFORM</td>
1.269 leot 13202: </tr>
13203: <tr>
1.375 jkoshy 13204: <td>NATIVE_OBJECT_FMT</td>
1.377 jnemeth 13205: <td>NATIVE_OPSYS_VERSION</td>
1.269 leot 13206: </tr>
13207: <tr>
1.375 jkoshy 13208: <td>NATIVE_OS_VARIANT</td>
1.377 jnemeth 13209: <td>NATIVE_OS_VERSION</td>
1.370 gdt 13210: </tr>
13211: <tr>
1.375 jkoshy 13212: <td>NBPAX_PROGRAM_PREFIX</td>
1.377 jnemeth 13213: <td>NETBSD_LOGIN_NAME</td>
1.370 gdt 13214: </tr>
13215: <tr>
1.375 jkoshy 13216: <td>NMH_EDITOR</td>
1.377 jnemeth 13217: <td>NMH_MTA</td>
1.309 gutterid 13218: </tr>
13219: <tr>
1.375 jkoshy 13220: <td>NMH_PAGER</td>
1.377 jnemeth 13221: <td>NODE_VERSIONS_ACCEPTED</td>
1.269 leot 13222: </tr>
13223: <tr>
1.375 jkoshy 13224: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.377 jnemeth 13225: <td>NODE_VERSION_DEFAULT</td>
1.269 leot 13226: </tr>
13227: <tr>
1.375 jkoshy 13228: <td>NODE_VERSION_REQD</td>
1.377 jnemeth 13229: <td>NOLOGIN</td>
1.269 leot 13230: </tr>
13231: <tr>
1.375 jkoshy 13232: <td>NOTE</td>
1.377 jnemeth 13233: <td>NOT_FOR_PLATFORM</td>
1.269 leot 13234: </tr>
13235: <tr>
1.375 jkoshy 13236: <td>NOT_PAX_ASLR_SAFE</td>
1.377 jnemeth 13237: <td>NOT_PAX_MPROTECT_SAFE</td>
1.269 leot 13238: </tr>
13239: <tr>
1.375 jkoshy 13240: <td>NO_BUILD</td>
1.377 jnemeth 13241: <td>NO_CHECKSUM</td>
1.269 leot 13242: </tr>
13243: <tr>
1.375 jkoshy 13244: <td>NO_CONFIGURE</td>
1.377 jnemeth 13245: <td>NO_SKIP</td>
1.344 gutterid 13246: </tr>
13247: <tr>
1.375 jkoshy 13248: <td>NS_PREFERRED</td>
1.377 jnemeth 13249: <td>NULLMAILER_GROUP</td>
1.333 nia 13250: </tr>
13251: <tr>
1.375 jkoshy 13252: <td>NULLMAILER_USER</td>
1.377 jnemeth 13253: <td>OBJECT_FMT</td>
1.333 nia 13254: </tr>
13255: <tr>
1.375 jkoshy 13256: <td>OBJHOSTNAME</td>
1.377 jnemeth 13257: <td>OBJMACHINE</td>
1.293 rillig 13258: </tr>
13259: <tr>
1.375 jkoshy 13260: <td>OCAML_FINDLIB_DIRS</td>
1.377 jnemeth 13261: <td>OCAML_FINDLIB_REGISTER</td>
1.269 leot 13262: </tr>
13263: <tr>
1.375 jkoshy 13264: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.377 jnemeth 13265: <td>OCAML_SITELIBDIR</td>
1.269 leot 13266: </tr>
13267: <tr>
1.375 jkoshy 13268: <td>OMF</td>
1.377 jnemeth 13269: <td>ONLY_FOR_COMPILER</td>
1.269 leot 13270: </tr>
13271: <tr>
1.375 jkoshy 13272: <td>ONLY_FOR_PLATFORM</td>
1.377 jnemeth 13273: <td>OPENSSH_CHROOT</td>
1.269 leot 13274: </tr>
13275: <tr>
1.375 jkoshy 13276: <td>OPENSSH_GROUP</td>
1.377 jnemeth 13277: <td>OPENSSH_USER</td>
1.269 leot 13278: </tr>
13279: <tr>
1.375 jkoshy 13280: <td>OPSYS</td>
1.377 jnemeth 13281: <td>OPSYS_EMULDIR</td>
1.269 leot 13282: </tr>
13283: <tr>
1.375 jkoshy 13284: <td>OPSYS_VERSION</td>
1.377 jnemeth 13285: <td>OS</td>
1.269 leot 13286: </tr>
13287: <tr>
1.375 jkoshy 13288: <td>OSS_TYPE</td>
1.377 jnemeth 13289: <td>OSX</td>
1.269 leot 13290: </tr>
13291: <tr>
1.375 jkoshy 13292: <td>OSX_PATH_TO_M4</td>
1.369 wiz 13293: <td>OSX_PATH_TO_YACC</td>
1.376 wiz 13294: </tr>
13295: <tr>
1.378 ! leot 13296: <td>OS_HAVE_ALSA</td>
! 13297: <td>OS_HAVE_RCD</td>
! 13298: </tr>
! 13299: <tr>
1.375 jkoshy 13300: <td>OS_VARIANT</td>
1.377 jnemeth 13301: <td>OS_VERSION</td>
1.369 wiz 13302: </tr>
13303: <tr>
1.375 jkoshy 13304: <td>OTF_FONTS_DIR</td>
1.377 jnemeth 13305: <td>OVERRIDE_DIRDEPTH</td>
1.352 wiz 13306: </tr>
13307: <tr>
1.375 jkoshy 13308: <td>OVERRIDE_GEMSPEC</td>
1.358 gutterid 13309: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.376 wiz 13310: </tr>
13311: <tr>
1.378 ! leot 13312: <td>OVERRIDE_ROCKSPEC</td>
1.368 gutterid 13313: <td>OWN_DIRS</td>
1.378 ! leot 13314: </tr>
! 13315: <tr>
1.376 wiz 13316: <td>OWN_DIRS_PERMS</td>
1.378 ! leot 13317: <td>P4GROUP</td>
1.367 gdt 13318: </tr>
13319: <tr>
1.376 wiz 13320: <td>P4PORT</td>
1.378 ! leot 13321: <td>P4ROOT</td>
1.360 leot 13322: </tr>
13323: <tr>
1.376 wiz 13324: <td>P4USER</td>
1.378 ! leot 13325: <td>PACKAGES</td>
1.348 wiz 13326: </tr>
13327: <tr>
1.376 wiz 13328: <td>PALMOS_DEFAULT_SDK</td>
1.378 ! leot 13329: <td>PAMBASE</td>
1.329 leot 13330: </tr>
13331: <tr>
1.376 wiz 13332: <td>PAM_DEFAULT</td>
1.378 ! leot 13333: <td>PAPERSIZE</td>
1.342 wiz 13334: </tr>
13335: <tr>
1.376 wiz 13336: <td>PASSIVE_FETCH</td>
1.378 ! leot 13337: <td>PATCHDIR</td>
1.320 wiz 13338: </tr>
13339: <tr>
1.376 wiz 13340: <td>PATCHFILES</td>
1.378 ! leot 13341: <td>PATCH_ARGS</td>
1.269 leot 13342: </tr>
13343: <tr>
1.376 wiz 13344: <td>PATCH_DEBUG</td>
1.378 ! leot 13345: <td>PATCH_DIST_ARGS</td>
1.269 leot 13346: </tr>
13347: <tr>
1.376 wiz 13348: <td>PATCH_DIST_CAT</td>
1.378 ! leot 13349: <td>PATCH_DIST_STRIP</td>
1.269 leot 13350: </tr>
13351: <tr>
1.376 wiz 13352: <td>PATCH_FUZZ_FACTOR</td>
1.378 ! leot 13353: <td>PATCH_STRIP</td>
1.269 leot 13354: </tr>
13355: <tr>
1.376 wiz 13356: <td>PATH</td>
1.378 ! leot 13357: <td>PCCBASE</td>
! 13358: </tr>
! 13359: <tr>
! 13360: <td>PEAR</td>
! 13361: <td>PEAR_CHANNEL</td>
! 13362: </tr>
! 13363: <tr>
! 13364: <td>PEAR_CHANNEL_ALIAS</td>
! 13365: <td>PEAR_CHANNEL_VERSION</td>
1.269 leot 13366: </tr>
13367: <tr>
1.374 wiz 13368: <td>PEAR_CMD</td>
1.378 ! leot 13369: <td>PEAR_LIB</td>
1.376 wiz 13370: </tr>
13371: <tr>
13372: <td>PEAR_PACKAGE_XML</td>
1.378 ! leot 13373: <td>PEP-518</td>
1.342 wiz 13374: </tr>
13375: <tr>
1.368 gutterid 13376: <td>PERL5</td>
1.378 ! leot 13377: <td>PERL5_CONFIGURE</td>
1.269 leot 13378: </tr>
13379: <tr>
1.368 gutterid 13380: <td>PERL5_CONFIGURE_DIRS</td>
1.378 ! leot 13381: <td>PERL5_LDFLAGS</td>
1.332 rillig 13382: </tr>
13383: <tr>
1.368 gutterid 13384: <td>PERL5_LICENSE</td>
1.378 ! leot 13385: <td>PERL5_MODULE_TYPE</td>
1.320 wiz 13386: </tr>
13387: <tr>
1.368 gutterid 13388: <td>PERL5_PACKLIST</td>
1.378 ! leot 13389: <td>PERL5_PACKLIST_DIR</td>
1.292 leot 13390: </tr>
13391: <tr>
1.368 gutterid 13392: <td>PERL5_PERLBASE</td>
1.378 ! leot 13393: <td>PERL5_SITEBASE</td>
1.274 rillig 13394: </tr>
13395: <tr>
1.368 gutterid 13396: <td>PERL5_USE_PACKLIST</td>
1.378 ! leot 13397: <td>PERL5_VENDORBASE</td>
1.274 rillig 13398: </tr>
13399: <tr>
1.368 gutterid 13400: <td>PFCTL</td>
1.378 ! leot 13401: <td>PFVAR_H</td>
1.269 leot 13402: </tr>
13403: <tr>
1.368 gutterid 13404: <td>PF_VERSION</td>
1.378 ! leot 13405: <td>PGGROUP</td>
1.269 leot 13406: </tr>
13407: <tr>
1.368 gutterid 13408: <td>PGHOME</td>
1.378 ! leot 13409: <td>PGPKGSRCDIR</td>
1.269 leot 13410: </tr>
13411: <tr>
1.368 gutterid 13412: <td>PGSQL_TYPE</td>
1.378 ! leot 13413: <td>PGSQL_VERSION</td>
1.269 leot 13414: </tr>
13415: <tr>
1.368 gutterid 13416: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.378 ! leot 13417: <td>PGSQL_VERSION_DEFAULT</td>
1.269 leot 13418: </tr>
13419: <tr>
1.368 gutterid 13420: <td>PGUSER</td>
1.378 ! leot 13421: <td>PG_LIB_EXT</td>
1.269 leot 13422: </tr>
13423: <tr>
1.368 gutterid 13424: <td>PHP</td>
1.378 ! leot 13425: <td>PHPCOMMON_MK</td>
1.269 leot 13426: </tr>
13427: <tr>
1.368 gutterid 13428: <td>PHPPKGSRCDIR</td>
1.378 ! leot 13429: <td>PHP_BASE_VERS</td>
1.269 leot 13430: </tr>
13431: <tr>
1.368 gutterid 13432: <td>PHP_CHECK_INSTALLED</td>
1.378 ! leot 13433: <td>PHP_EXTENSION_DIR</td>
1.269 leot 13434: </tr>
13435: <tr>
1.368 gutterid 13436: <td>PHP_INITIAL_TEENY</td>
1.378 ! leot 13437: <td>PHP_PKG_PREFIX</td>
1.269 leot 13438: </tr>
13439: <tr>
1.368 gutterid 13440: <td>PHP_VERSION</td>
1.378 ! leot 13441: <td>PHP_VERSIONS_ACCEPTED</td>
1.269 leot 13442: </tr>
13443: <tr>
1.368 gutterid 13444: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.378 ! leot 13445: <td>PHP_VERSION_DEFAULT</td>
1.269 leot 13446: </tr>
13447: <tr>
1.368 gutterid 13448: <td>PHP_VERSION_REQD</td>
1.378 ! leot 13449: <td>PILRC_USE_GTK</td>
1.269 leot 13450: </tr>
13451: <tr>
1.368 gutterid 13452: <td>PKGCONFIG_BASE</td>
1.378 ! leot 13453: <td>PKGCONFIG_FILE</td>
1.269 leot 13454: </tr>
13455: <tr>
1.368 gutterid 13456: <td>PKGCONFIG_OVERRIDE</td>
1.378 ! leot 13457: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.269 leot 13458: </tr>
13459: <tr>
1.368 gutterid 13460: <td>PKGDIR</td>
1.378 ! leot 13461: <td>PKGGNUDIR</td>
1.269 leot 13462: </tr>
13463: <tr>
1.368 gutterid 13464: <td>PKGINFODIR</td>
1.378 ! leot 13465: <td>PKGLOCALEDIR</td>
1.269 leot 13466: </tr>
13467: <tr>
1.368 gutterid 13468: <td>PKGMANDIR</td>
1.378 ! leot 13469: <td>PKGNAME</td>
1.269 leot 13470: </tr>
13471: <tr>
1.368 gutterid 13472: <td>PKGNAME_REQD</td>
1.378 ! leot 13473: <td>PKGPATH</td>
1.269 leot 13474: </tr>
13475: <tr>
1.368 gutterid 13476: <td>PKGREVISION</td>
1.378 ! leot 13477: <td>PKGSRC_BLAS_TYPES</td>
1.269 leot 13478: </tr>
13479: <tr>
1.368 gutterid 13480: <td>PKGSRC_CHANGES</td>
1.378 ! leot 13481: <td>PKGSRC_COMPILER</td>
1.269 leot 13482: </tr>
13483: <tr>
1.368 gutterid 13484: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.378 ! leot 13485: <td>PKGSRC_LOCKTYPE</td>
1.269 leot 13486: </tr>
13487: <tr>
1.368 gutterid 13488: <td>PKGSRC_MAKE_ENV</td>
1.378 ! leot 13489: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.269 leot 13490: </tr>
13491: <tr>
1.368 gutterid 13492: <td>PKGSRC_MKPIE</td>
1.378 ! leot 13493: <td>PKGSRC_MKREPRO</td>
1.269 leot 13494: </tr>
13495: <tr>
1.368 gutterid 13496: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.378 ! leot 13497: <td>PKGSRC_RUN_TEST</td>
1.292 leot 13498: </tr>
13499: <tr>
1.368 gutterid 13500: <td>PKGSRC_SETENV</td>
1.378 ! leot 13501: <td>PKGSRC_SLEEPSECS</td>
1.269 leot 13502: </tr>
13503: <tr>
1.368 gutterid 13504: <td>PKGSRC_TODO</td>
1.378 ! leot 13505: <td>PKGSRC_USE_CTF</td>
1.274 rillig 13506: </tr>
13507: <tr>
1.368 gutterid 13508: <td>PKGSRC_USE_FORTIFY</td>
1.378 ! leot 13509: <td>PKGSRC_USE_MKTOOLS</td>
1.269 leot 13510: </tr>
13511: <tr>
1.368 gutterid 13512: <td>PKGSRC_USE_RELRO</td>
1.378 ! leot 13513: <td>PKGSRC_USE_SSP</td>
1.269 leot 13514: </tr>
13515: <tr>
1.368 gutterid 13516: <td>PKGSRC_USE_STACK_CHECK</td>
1.378 ! leot 13517: <td>PKGTASKS_DATAFILE</td>
1.269 leot 13518: </tr>
13519: <tr>
1.368 gutterid 13520: <td>PKGTOOLS_ARGS</td>
1.378 ! leot 13521: <td>PKGTOOLS_ENV</td>
1.269 leot 13522: </tr>
13523: <tr>
1.368 gutterid 13524: <td>PKG_ALTERNATIVES</td>
1.378 ! leot 13525: <td>PKG_APACHE</td>
1.269 leot 13526: </tr>
13527: <tr>
1.368 gutterid 13528: <td>PKG_APACHE_ACCEPTED</td>
1.378 ! leot 13529: <td>PKG_APACHE_DEFAULT</td>
1.269 leot 13530: </tr>
13531: <tr>
1.368 gutterid 13532: <td>PKG_BEST_EXISTS</td>
1.378 ! leot 13533: <td>PKG_BUILD_OPTIONS</td>
1.269 leot 13534: </tr>
13535: <tr>
1.368 gutterid 13536: <td>PKG_COMPRESSION</td>
1.378 ! leot 13537: <td>PKG_CONFIG</td>
1.269 leot 13538: </tr>
13539: <tr>
1.368 gutterid 13540: <td>PKG_CONFIG_PERMS</td>
1.378 ! leot 13541: <td>PKG_CREATE_USERGROUP</td>
1.269 leot 13542: </tr>
13543: <tr>
1.370 gdt 13544: <td>PKG_DBDIR</td>
1.378 ! leot 13545: <td>PKG_DB_TMPDIR</td>
1.269 leot 13546: </tr>
13547: <tr>
1.370 gdt 13548: <td>PKG_DEBUG_LEVEL</td>
1.378 ! leot 13549: <td>PKG_DEFAULT_OPTIONS</td>
1.269 leot 13550: </tr>
13551: <tr>
1.370 gdt 13552: <td>PKG_DESTDIR_SUPPORT</td>
1.378 ! leot 13553: <td>PKG_DEVELOPER</td>
1.367 gdt 13554: </tr>
13555: <tr>
1.370 gdt 13556: <td>PKG_DISABLED_OPTIONS</td>
1.378 ! leot 13557: <td>PKG_FATAL_ERRORS</td>
1.269 leot 13558: </tr>
13559: <tr>
1.370 gdt 13560: <td>PKG_FC</td>
1.378 ! leot 13561: <td>PKG_FILELIST_CMD</td>
1.348 wiz 13562: </tr>
13563: <tr>
1.370 gdt 13564: <td>PKG_GECOS</td>
1.378 ! leot 13565: <td>PKG_GID</td>
1.360 leot 13566: </tr>
13567: <tr>
1.370 gdt 13568: <td>PKG_GROUPS</td>
1.378 ! leot 13569: <td>PKG_GROUPS_VARS</td>
1.269 leot 13570: </tr>
13571: <tr>
1.370 gdt 13572: <td>PKG_HOME</td>
1.378 ! leot 13573: <td>PKG_INIT_SCRIPTS</td>
1.269 leot 13574: </tr>
13575: <tr>
1.370 gdt 13576: <td>PKG_JAVA_HOME</td>
1.378 ! leot 13577: <td>PKG_JVM</td>
1.269 leot 13578: </tr>
13579: <tr>
1.370 gdt 13580: <td>PKG_JVMS_ACCEPTED</td>
1.378 ! leot 13581: <td>PKG_JVM_DEFAULT</td>
1.269 leot 13582: </tr>
13583: <tr>
1.370 gdt 13584: <td>PKG_LEGACY_OPTIONS</td>
1.378 ! leot 13585: <td>PKG_LIBTOOL</td>
1.269 leot 13586: </tr>
13587: <tr>
1.370 gdt 13588: <td>PKG_MKSYMLINKS</td>
1.378 ! leot 13589: <td>PKG_OPTIONS</td>
1.269 leot 13590: </tr>
13591: <tr>
1.370 gdt 13592: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.378 ! leot 13593: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.269 leot 13594: </tr>
13595: <tr>
1.370 gdt 13596: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.378 ! leot 13597: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.269 leot 13598: </tr>
13599: <tr>
1.370 gdt 13600: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.378 ! leot 13601: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.269 leot 13602: </tr>
13603: <tr>
1.370 gdt 13604: <td>PKG_OPTIONS_VAR</td>
1.378 ! leot 13605: <td>PKG_PHP</td>
1.341 gutterid 13606: </tr>
13607: <tr>
1.370 gdt 13608: <td>PKG_PHP_MAJOR_VERS</td>
1.378 ! leot 13609: <td>PKG_PHP_VERSION</td>
1.269 leot 13610: </tr>
13611: <tr>
1.370 gdt 13612: <td>PKG_RCD_SCRIPTS</td>
1.378 ! leot 13613: <td>PKG_REFCOUNT_DBDIR</td>
1.269 leot 13614: </tr>
13615: <tr>
1.370 gdt 13616: <td>PKG_REGISTER_SHELLS</td>
1.378 ! leot 13617: <td>PKG_RESUME_TRANSFERS</td>
1.269 leot 13618: </tr>
13619: <tr>
1.370 gdt 13620: <td>PKG_SHELL</td>
1.378 ! leot 13621: <td>PKG_SUGGESTED_OPTIONS</td>
1.269 leot 13622: </tr>
13623: <tr>
1.370 gdt 13624: <td>PKG_SUPPORTED_OPTIONS</td>
1.378 ! leot 13625: <td>PKG_SYSCONFBASE</td>
1.269 leot 13626: </tr>
13627: <tr>
1.370 gdt 13628: <td>PKG_SYSCONFBASEDIR</td>
1.378 ! leot 13629: <td>PKG_SYSCONFDIR</td>
1.269 leot 13630: </tr>
13631: <tr>
1.370 gdt 13632: <td>PKG_SYSCONFDIR_PERMS</td>
1.378 ! leot 13633: <td>PKG_SYSCONFSUBDIR</td>
1.269 leot 13634: </tr>
13635: <tr>
1.370 gdt 13636: <td>PKG_SYSCONFVAR</td>
1.378 ! leot 13637: <td>PKG_TOOLS_BIN</td>
1.269 leot 13638: </tr>
13639: <tr>
1.370 gdt 13640: <td>PKG_UID</td>
1.378 ! leot 13641: <td>PKG_UPDATE_FONTS_DB</td>
1.269 leot 13642: </tr>
13643: <tr>
1.370 gdt 13644: <td>PKG_USERS</td>
1.378 ! leot 13645: <td>PKG_USERS_VARS</td>
1.269 leot 13646: </tr>
13647: <tr>
1.370 gdt 13648: <td>PKG_VERBOSE</td>
1.378 ! leot 13649: <td>PLEASE</td>
1.269 leot 13650: </tr>
13651: <tr>
1.370 gdt 13652: <td>PLIST</td>
1.378 ! leot 13653: <td>PLIST_AWK</td>
1.269 leot 13654: </tr>
13655: <tr>
1.370 gdt 13656: <td>PLIST_AWK_ENV</td>
1.378 ! leot 13657: <td>PLIST_SRC</td>
1.269 leot 13658: </tr>
13659: <tr>
1.370 gdt 13660: <td>PLIST_SUBST</td>
1.378 ! leot 13661: <td>PLIST_TYPE</td>
1.269 leot 13662: </tr>
13663: <tr>
1.370 gdt 13664: <td>PLIST_VARS</td>
1.378 ! leot 13665: <td>POPTOP_USE_MPPE</td>
1.269 leot 13666: </tr>
13667: <tr>
1.370 gdt 13668: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.378 ! leot 13669: <td>POST_FETCH_HOOK</td>
1.269 leot 13670: </tr>
13671: <tr>
1.370 gdt 13672: <td>PREFER</td>
1.378 ! leot 13673: <td>PREFER_NATIVE</td>
1.269 leot 13674: </tr>
13675: <tr>
1.370 gdt 13676: <td>PREFER_NATIVE_PTHREADS</td>
1.378 ! leot 13677: <td>PREFER_PKGSRC</td>
1.269 leot 13678: </tr>
13679: <tr>
1.370 gdt 13680: <td>PREFIX</td>
1.378 ! leot 13681: <td>PREPEND_PATH</td>
1.269 leot 13682: </tr>
13683: <tr>
1.370 gdt 13684: <td>PRE_ROOT_CMD</td>
1.378 ! leot 13685: <td>PRIVILEGED_STAGES</td>
1.269 leot 13686: </tr>
13687: <tr>
1.370 gdt 13688: <td>PS</td>
1.378 ! leot 13689: <td>PTHREAD_AUTO_VARS</td>
1.269 leot 13690: </tr>
13691: <tr>
1.370 gdt 13692: <td>PTHREAD_CFLAGS</td>
1.378 ! leot 13693: <td>PTHREAD_LDFLAGS</td>
1.269 leot 13694: </tr>
13695: <tr>
1.370 gdt 13696: <td>PTHREAD_LIBS</td>
1.378 ! leot 13697: <td>PTHREAD_OPTS</td>
1.269 leot 13698: </tr>
13699: <tr>
1.370 gdt 13700: <td>PTHREAD_TYPE</td>
1.378 ! leot 13701: <td>PVM_SSH</td>
1.269 leot 13702: </tr>
13703: <tr>
1.370 gdt 13704: <td>PYPKGPREFIX</td>
1.378 ! leot 13705: <td>PYTHON_FOR_BUILD_ONLY</td>
1.269 leot 13706: </tr>
13707: <tr>
1.370 gdt 13708: <td>PYTHON_SELF_CONFLICT</td>
1.378 ! leot 13709: <td>PYTHON_VERSION</td>
1.269 leot 13710: </tr>
13711: <tr>
1.370 gdt 13712: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.378 ! leot 13713: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.269 leot 13714: </tr>
13715: <tr>
1.370 gdt 13716: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.378 ! leot 13717: <td>PYTHON_VERSION_DEFAULT</td>
1.269 leot 13718: </tr>
13719: <tr>
1.370 gdt 13720: <td>PYTHON_VERSION_REQD</td>
1.378 ! leot 13721: <td>PYVERSSUFFIX</td>
1.269 leot 13722: </tr>
13723: <tr>
1.370 gdt 13724: <td>QMAILDIR</td>
1.378 ! leot 13725: <td>QMAIL_ALIAS_USER</td>
1.269 leot 13726: </tr>
13727: <tr>
1.370 gdt 13728: <td>QMAIL_DAEMON_USER</td>
1.378 ! leot 13729: <td>QMAIL_LOG_USER</td>
1.269 leot 13730: </tr>
13731: <tr>
1.370 gdt 13732: <td>QMAIL_NOFILES_GROUP</td>
1.378 ! leot 13733: <td>QMAIL_PASSWD_USER</td>
1.269 leot 13734: </tr>
13735: <tr>
1.370 gdt 13736: <td>QMAIL_QMAIL_GROUP</td>
1.378 ! leot 13737: <td>QMAIL_QUEUE_DIR</td>
1.269 leot 13738: </tr>
13739: <tr>
1.370 gdt 13740: <td>QMAIL_QUEUE_EXTRA</td>
1.378 ! leot 13741: <td>QMAIL_QUEUE_USER</td>
1.269 leot 13742: </tr>
13743: <tr>
1.370 gdt 13744: <td>QMAIL_REMOTE_USER</td>
1.378 ! leot 13745: <td>QMAIL_ROOT_USER</td>
1.269 leot 13746: </tr>
13747: <tr>
1.370 gdt 13748: <td>QMAIL_SEND_USER</td>
1.378 ! leot 13749: <td>QORE_LATEST_MODULE_API</td>
1.269 leot 13750: </tr>
13751: <tr>
1.370 gdt 13752: <td>QORE_MODULE_API</td>
1.378 ! leot 13753: <td>QORE_MODULE_DIR</td>
1.269 leot 13754: </tr>
13755: <tr>
1.370 gdt 13756: <td>QORE_USER_MODULE_DIR</td>
1.378 ! leot 13757: <td>QORE_VERSION</td>
1.269 leot 13758: </tr>
13759: <tr>
1.370 gdt 13760: <td>QPOPPER_FAC</td>
1.378 ! leot 13761: <td>QPOPPER_SPOOL_DIR</td>
1.269 leot 13762: </tr>
13763: <tr>
1.370 gdt 13764: <td>QPOPPER_USER</td>
1.378 ! leot 13765: <td>RAKE_NAME</td>
1.369 wiz 13766: </tr>
13767: <tr>
1.370 gdt 13768: <td>RASMOL_DEPTH</td>
1.378 ! leot 13769: <td>RCD_DIR</td>
1.269 leot 13770: </tr>
13771: <tr>
1.378 ! leot 13772: <td>RCD_ORDER</td>
1.374 wiz 13773: <td>RCD_SCRIPTS</td>
1.378 ! leot 13774: </tr>
! 13775: <tr>
1.377 jnemeth 13776: <td>RCD_SCRIPTS_DIR</td>
1.378 ! leot 13777: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.376 wiz 13778: </tr>
13779: <tr>
1.377 jnemeth 13780: <td>RCD_SCRIPTS_MODE</td>
1.378 ! leot 13781: <td>RCD_SCRIPTS_SHELL</td>
1.360 leot 13782: </tr>
13783: <tr>
1.370 gdt 13784: <td>RCD_SCRIPT_SRC</td>
1.378 ! leot 13785: <td>RCD_SUBR</td>
1.355 rillig 13786: </tr>
13787: <tr>
1.370 gdt 13788: <td>RDOC</td>
1.375 jkoshy 13789: <td>READLINE_DEFAULT</td>
1.329 leot 13790: </tr>
13791: <tr>
1.370 gdt 13792: <td>READLINE_TYPE</td>
1.375 jkoshy 13793: <td>REAL_ROOT_GROUP</td>
1.320 wiz 13794: </tr>
13795: <tr>
1.370 gdt 13796: <td>REAL_ROOT_USER</td>
1.375 jkoshy 13797: <td>RECURSIVE_MAKE</td>
1.338 nia 13798: </tr>
13799: <tr>
1.370 gdt 13800: <td>RELAY_CTRL_DIR</td>
1.375 jkoshy 13801: <td>RELRO_SUPPORTED</td>
1.292 leot 13802: </tr>
13803: <tr>
1.370 gdt 13804: <td>REPLACE_AWK</td>
1.375 jkoshy 13805: <td>REPLACE_BASH</td>
1.329 leot 13806: </tr>
13807: <tr>
1.370 gdt 13808: <td>REPLACE_CSH</td>
1.375 jkoshy 13809: <td>REPLACE_KSH</td>
1.327 wiz 13810: </tr>
13811: <tr>
1.370 gdt 13812: <td>REPLACE_LUA</td>
1.375 jkoshy 13813: <td>REPLACE_NODEJS</td>
1.269 leot 13814: </tr>
13815: <tr>
1.370 gdt 13816: <td>REPLACE_OCTAVE</td>
1.375 jkoshy 13817: <td>REPLACE_PERL</td>
1.320 wiz 13818: </tr>
13819: <tr>
1.370 gdt 13820: <td>REPLACE_PERL6</td>
1.375 jkoshy 13821: <td>REPLACE_PHP</td>
1.311 leot 13822: </tr>
13823: <tr>
1.370 gdt 13824: <td>REPLACE_PYTHON</td>
1.375 jkoshy 13825: <td>REPLACE_QORE</td>
1.269 leot 13826: </tr>
13827: <tr>
1.370 gdt 13828: <td>REPLACE_R</td>
1.375 jkoshy 13829: <td>REPLACE_RUBY</td>
1.333 nia 13830: </tr>
13831: <tr>
1.370 gdt 13832: <td>REPLACE_RUBY_DIRS</td>
1.375 jkoshy 13833: <td>REPLACE_RUBY_PAT</td>
1.269 leot 13834: </tr>
13835: <tr>
1.370 gdt 13836: <td>REPLACE_SH</td>
1.375 jkoshy 13837: <td>REPLACE_TEXLUA</td>
1.369 wiz 13838: </tr>
13839: <tr>
1.370 gdt 13840: <td>REPLACE_TOOL_PYTHON</td>
1.375 jkoshy 13841: <td>REPLACE_WISH</td>
1.331 gutterid 13842: </tr>
13843: <tr>
1.370 gdt 13844: <td>REQD_DIRS</td>
1.375 jkoshy 13845: <td>REQD_DIRS_PERMS</td>
1.269 leot 13846: </tr>
13847: <tr>
1.370 gdt 13848: <td>REQD_FILES</td>
1.375 jkoshy 13849: <td>REQD_FILES_MODE</td>
1.333 nia 13850: </tr>
13851: <tr>
1.370 gdt 13852: <td>REQD_FILES_PERMS</td>
1.375 jkoshy 13853: <td>RESOLV_AUTO_VARS</td>
1.269 leot 13854: </tr>
13855: <tr>
1.370 gdt 13856: <td>RESOLV_LDFLAGS</td>
1.375 jkoshy 13857: <td>RESOLV_LIBS</td>
1.369 wiz 13858: </tr>
13859: <tr>
1.370 gdt 13860: <td>RM</td>
1.378 ! leot 13861: <td>ROCKSPEC_NAME</td>
! 13862: </tr>
! 13863: <tr>
! 13864: <td>ROCKSPEC_SPECFILE</td>
1.375 jkoshy 13865: <td>ROOT_CMD</td>
1.352 wiz 13866: </tr>
13867: <tr>
1.370 gdt 13868: <td>ROOT_GROUP</td>
1.375 jkoshy 13869: <td>ROOT_USER</td>
1.269 leot 13870: </tr>
13871: <tr>
1.370 gdt 13872: <td>RPCGEN</td>
1.375 jkoshy 13873: <td>RPM</td>
1.269 leot 13874: </tr>
13875: <tr>
1.370 gdt 13876: <td>RPM2PKG_PLIST</td>
1.375 jkoshy 13877: <td>RPM2PKG_PREFIX</td>
1.320 wiz 13878: </tr>
13879: <tr>
1.370 gdt 13880: <td>RPM2PKG_STAGE</td>
1.375 jkoshy 13881: <td>RPM2PKG_STRIP</td>
1.332 rillig 13882: </tr>
13883: <tr>
1.370 gdt 13884: <td>RPM2PKG_SUBPREFIX</td>
1.375 jkoshy 13885: <td>RPMFILES</td>
1.329 leot 13886: </tr>
13887: <tr>
1.370 gdt 13888: <td>RPMIGNOREPATH</td>
1.375 jkoshy 13889: <td>RPM_DB_PREFIX</td>
1.327 wiz 13890: </tr>
13891: <tr>
1.370 gdt 13892: <td>RSSH_CVS_PATH</td>
1.375 jkoshy 13893: <td>RSSH_RDIST_PATH</td>
1.269 leot 13894: </tr>
13895: <tr>
1.370 gdt 13896: <td>RSSH_RSYNC_PATH</td>
1.375 jkoshy 13897: <td>RSSH_SCP_PATH</td>
1.311 leot 13898: </tr>
13899: <tr>
1.370 gdt 13900: <td>RSSH_SFTP_SERVER_PATH</td>
1.375 jkoshy 13901: <td>RUBY</td>
1.269 leot 13902: </tr>
13903: <tr>
1.370 gdt 13904: <td>RUBYGEM</td>
1.375 jkoshy 13905: <td>RUBYGEM_MANPAGES</td>
1.269 leot 13906: </tr>
13907: <tr>
1.370 gdt 13908: <td>RUBYGEM_NAME</td>
1.375 jkoshy 13909: <td>RUBYGEM_OPTIONS</td>
1.269 leot 13910: </tr>
13911: <tr>
1.370 gdt 13912: <td>RUBYGEM_USE_MANPAGES</td>
1.375 jkoshy 13913: <td>RUBYGEM_VERBOSE</td>
1.346 jnemeth 13914: </tr>
13915: <tr>
1.370 gdt 13916: <td>RUBY_ABI_VERSION</td>
1.375 jkoshy 13917: <td>RUBY_ARCH</td>
1.269 leot 13918: </tr>
13919: <tr>
1.370 gdt 13920: <td>RUBY_ARCHINC</td>
1.375 jkoshy 13921: <td>RUBY_ARCHLIB</td>
1.269 leot 13922: </tr>
13923: <tr>
1.370 gdt 13924: <td>RUBY_BASE</td>
1.375 jkoshy 13925: <td>RUBY_BASERIDIR</td>
1.269 leot 13926: </tr>
13927: <tr>
1.370 gdt 13928: <td>RUBY_BUILD_DOCUMENT</td>
1.375 jkoshy 13929: <td>RUBY_DLEXT</td>
1.269 leot 13930: </tr>
13931: <tr>
1.370 gdt 13932: <td>RUBY_DOC</td>
1.375 jkoshy 13933: <td>RUBY_DYNAMIC_DIRS</td>
1.269 leot 13934: </tr>
13935: <tr>
1.370 gdt 13936: <td>RUBY_EG</td>
1.375 jkoshy 13937: <td>RUBY_ENCODING_ARG</td>
1.269 leot 13938: </tr>
13939: <tr>
1.370 gdt 13940: <td>RUBY_EXTCONF</td>
1.375 jkoshy 13941: <td>RUBY_EXTCONF_CHECK</td>
1.269 leot 13942: </tr>
13943: <tr>
1.370 gdt 13944: <td>RUBY_EXTCONF_DEBUG</td>
1.375 jkoshy 13945: <td>RUBY_EXTCONF_MAKEFILE</td>
1.269 leot 13946: </tr>
13947: <tr>
1.370 gdt 13948: <td>RUBY_GEM_ARCH</td>
1.375 jkoshy 13949: <td>RUBY_GEM_BASE</td>
1.269 leot 13950: </tr>
13951: <tr>
1.370 gdt 13952: <td>RUBY_INC</td>
1.375 jkoshy 13953: <td>RUBY_LIB</td>
1.269 leot 13954: </tr>
13955: <tr>
1.370 gdt 13956: <td>RUBY_LIB_BASE</td>
1.375 jkoshy 13957: <td>RUBY_NAME</td>
1.269 leot 13958: </tr>
13959: <tr>
1.370 gdt 13960: <td>RUBY_NOVERSION</td>
1.375 jkoshy 13961: <td>RUBY_PKGPREFIX</td>
1.269 leot 13962: </tr>
13963: <tr>
1.370 gdt 13964: <td>RUBY_RAILS</td>
1.375 jkoshy 13965: <td>RUBY_RAILS61_VERSION</td>
1.338 nia 13966: </tr>
13967: <tr>
1.370 gdt 13968: <td>RUBY_RAILS70_VERSION</td>
1.375 jkoshy 13969: <td>RUBY_RAILS71_VERSION</td>
1.269 leot 13970: </tr>
13971: <tr>
1.377 jnemeth 13972: <td>RUBY_RAILS72_VERSION</td>
1.378 ! leot 13973: <td>RUBY_RAILS80_VERSION</td>
! 13974: </tr>
! 13975: <tr>
1.370 gdt 13976: <td>RUBY_RAILS_ACCEPTED</td>
1.378 ! leot 13977: <td>RUBY_RAILS_DEFAULT</td>
1.269 leot 13978: </tr>
13979: <tr>
1.370 gdt 13980: <td>RUBY_RAILS_REQD</td>
1.378 ! leot 13981: <td>RUBY_RAILS_STRICT_DEP</td>
1.269 leot 13982: </tr>
13983: <tr>
1.370 gdt 13984: <td>RUBY_RIDIR</td>
1.378 ! leot 13985: <td>RUBY_SETUP</td>
1.269 leot 13986: </tr>
13987: <tr>
1.370 gdt 13988: <td>RUBY_SHLIB</td>
1.378 ! leot 13989: <td>RUBY_SHLIBALIAS</td>
1.269 leot 13990: </tr>
13991: <tr>
1.370 gdt 13992: <td>RUBY_SHLIBVER</td>
1.378 ! leot 13993: <td>RUBY_SIMPLE_INSTALL</td>
1.269 leot 13994: </tr>
13995: <tr>
1.370 gdt 13996: <td>RUBY_SITEARCHLIB</td>
1.378 ! leot 13997: <td>RUBY_SITELIB</td>
1.269 leot 13998: </tr>
13999: <tr>
1.370 gdt 14000: <td>RUBY_SITELIB_BASE</td>
1.378 ! leot 14001: <td>RUBY_SITERIDIR</td>
1.269 leot 14002: </tr>
14003: <tr>
1.370 gdt 14004: <td>RUBY_SLEXT</td>
1.378 ! leot 14005: <td>RUBY_SRCDIR</td>
1.312 gdt 14006: </tr>
14007: <tr>
1.370 gdt 14008: <td>RUBY_STATICLIB</td>
1.378 ! leot 14009: <td>RUBY_SUFFIX</td>
1.289 leot 14010: </tr>
14011: <tr>
1.370 gdt 14012: <td>RUBY_SYSRIDIR</td>
1.378 ! leot 14013: <td>RUBY_USE_PTHREAD</td>
1.269 leot 14014: </tr>
14015: <tr>
1.370 gdt 14016: <td>RUBY_VENDORARCHLIB</td>
1.378 ! leot 14017: <td>RUBY_VENDORLIB</td>
1.269 leot 14018: </tr>
14019: <tr>
1.370 gdt 14020: <td>RUBY_VENDORLIB_BASE</td>
1.378 ! leot 14021: <td>RUBY_VER</td>
1.269 leot 14022: </tr>
14023: <tr>
1.370 gdt 14024: <td>RUBY_VERSION</td>
1.378 ! leot 14025: <td>RUBY_VERSIONS_ACCEPTED</td>
1.269 leot 14026: </tr>
14027: <tr>
1.370 gdt 14028: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.378 ! leot 14029: <td>RUBY_VERSION_DEFAULT</td>
1.269 leot 14030: </tr>
14031: <tr>
1.370 gdt 14032: <td>RUBY_VERSION_REQD</td>
1.378 ! leot 14033: <td>RUBY_VER_DIR</td>
1.269 leot 14034: </tr>
14035: <tr>
1.370 gdt 14036: <td>RUN</td>
1.378 ! leot 14037: <td>RUN_LDCONFIG</td>
1.269 leot 14038: </tr>
14039: <tr>
1.370 gdt 14040: <td>RUST_TYPE</td>
1.378 ! leot 14041: <td>SCO</td>
1.269 leot 14042: </tr>
14043: <tr>
1.370 gdt 14044: <td>SCREWS_GROUP</td>
1.378 ! leot 14045: <td>SCREWS_USER</td>
1.269 leot 14046: </tr>
14047: <tr>
1.370 gdt 14048: <td>SCRIPTS_ENV</td>
1.378 ! leot 14049: <td>SCROLLKEEPER_DATADIR</td>
1.269 leot 14050: </tr>
14051: <tr>
1.370 gdt 14052: <td>SCROLLKEEPER_REBUILDDB</td>
1.378 ! leot 14053: <td>SCROLLKEEPER_UPDATEDB</td>
1.269 leot 14054: </tr>
14055: <tr>
1.370 gdt 14056: <td>SDIST_PAWD</td>
1.378 ! leot 14057: <td>SDL12_TYPE</td>
1.269 leot 14058: </tr>
14059: <tr>
1.370 gdt 14060: <td>SERIAL_DEVICES</td>
1.378 ! leot 14061: <td>SETGIDGAME</td>
1.269 leot 14062: </tr>
14063: <tr>
1.370 gdt 14064: <td>SETGID_GAMES_PERMS</td>
1.378 ! leot 14065: <td>SETUID_ROOT_PERMS</td>
1.269 leot 14066: </tr>
14067: <tr>
1.370 gdt 14068: <td>SH</td>
1.378 ! leot 14069: <td>SHLIB</td>
1.367 gdt 14070: </tr>
14071: <tr>
1.378 ! leot 14072: <td>SHORTNAME</td>
1.374 wiz 14073: <td>SIGN_PACKAGES</td>
1.376 wiz 14074: </tr>
14075: <tr>
1.370 gdt 14076: <td>SILC_CLIENT_WITH_PERL</td>
1.376 wiz 14077: <td>SITE_SPECIFIC_PKGS</td>
1.348 wiz 14078: </tr>
14079: <tr>
1.370 gdt 14080: <td>SKIP_DEPENDS</td>
1.376 wiz 14081: <td>SMF_INSTANCES</td>
1.269 leot 14082: </tr>
14083: <tr>
1.370 gdt 14084: <td>SMF_MANIFEST</td>
1.376 wiz 14085: <td>SMF_METHODS</td>
1.342 wiz 14086: </tr>
14087: <tr>
1.370 gdt 14088: <td>SMF_METHOD_SHELL</td>
1.376 wiz 14089: <td>SMF_METHOD_SRC</td>
1.269 leot 14090: </tr>
14091: <tr>
1.370 gdt 14092: <td>SMF_NAME</td>
1.376 wiz 14093: <td>SMF_PREFIX</td>
1.269 leot 14094: </tr>
14095: <tr>
1.370 gdt 14096: <td>SMF_SRCDIR</td>
1.376 wiz 14097: <td>SNIPROXY_GROUP</td>
1.292 leot 14098: </tr>
14099: <tr>
1.370 gdt 14100: <td>SNIPROXY_USER</td>
1.376 wiz 14101: <td>SOURCE_BUFFSIZE</td>
1.269 leot 14102: </tr>
14103: <tr>
1.370 gdt 14104: <td>SPECIAL_PERMS</td>
1.376 wiz 14105: <td>SPECIFIC_PKGS</td>
1.332 rillig 14106: </tr>
14107: <tr>
1.370 gdt 14108: <td>SSH_SUID</td>
1.378 ! leot 14109: <td>SSLCERTBUNDLE</td>
! 14110: </tr>
! 14111: <tr>
! 14112: <td>SSLCERTS</td>
! 14113: <td>SSLDIR</td>
! 14114: </tr>
! 14115: <tr>
! 14116: <td>SSLKEYS</td>
1.376 wiz 14117: <td>SSP_SUPPORTED</td>
1.269 leot 14118: </tr>
14119: <tr>
1.370 gdt 14120: <td>SSYNC_PAWD</td>
1.376 wiz 14121: <td>STEP_MSG</td>
1.274 rillig 14122: </tr>
14123: <tr>
1.370 gdt 14124: <td>STRIP</td>
1.376 wiz 14125: <td>STRIP_DBG</td>
1.269 leot 14126: </tr>
14127: <tr>
1.370 gdt 14128: <td>STRIP_DEBUG</td>
1.376 wiz 14129: <td>STRIP_DEBUG_SUPPORTED</td>
1.269 leot 14130: </tr>
14131: <tr>
1.370 gdt 14132: <td>STRIP_FILES_SKIP</td>
1.376 wiz 14133: <td>SU</td>
1.269 leot 14134: </tr>
14135: <tr>
1.370 gdt 14136: <td>SUBDIR</td>
1.376 wiz 14137: <td>SUBST</td>
1.269 leot 14138: </tr>
14139: <tr>
1.370 gdt 14140: <td>SUBST_CLASSES</td>
1.376 wiz 14141: <td>SUBST_FILES</td>
1.269 leot 14142: </tr>
14143: <tr>
1.370 gdt 14144: <td>SUBST_FILTER_CMD</td>
1.376 wiz 14145: <td>SUBST_MESSAGE</td>
1.269 leot 14146: </tr>
14147: <tr>
1.370 gdt 14148: <td>SUBST_NOOP_OK</td>
1.376 wiz 14149: <td>SUBST_SED</td>
1.269 leot 14150: </tr>
14151: <tr>
1.370 gdt 14152: <td>SUBST_SHOW_DIFF</td>
1.376 wiz 14153: <td>SUBST_SKIP_TEXT_CHECK</td>
1.269 leot 14154: </tr>
14155: <tr>
1.370 gdt 14156: <td>SUBST_STAGE</td>
1.376 wiz 14157: <td>SUBST_VARS</td>
1.269 leot 14158: </tr>
14159: <tr>
1.370 gdt 14160: <td>SUNWSPROBASE</td>
1.376 wiz 14161: <td>SUSE_PREFER</td>
1.360 leot 14162: </tr>
14163: <tr>
1.370 gdt 14164: <td>SU_CMD</td>
1.378 ! leot 14165: <td>SVN_EXTRACTDIR</td>
! 14166: </tr>
! 14167: <tr>
! 14168: <td>SVN_REPO</td>
! 14169: <td>SVN_REPOSITORIES</td>
! 14170: </tr>
! 14171: <tr>
! 14172: <td>SVN_REVISION</td>
1.374 wiz 14173: <td>SYSCONFBASE</td>
1.376 wiz 14174: </tr>
14175: <tr>
1.370 gdt 14176: <td>TARGET_MACHINE_ARCH</td>
1.376 wiz 14177: <td>TBL</td>
1.370 gdt 14178: </tr>
14179: <tr>
1.368 gutterid 14180: <td>TERMCAP_TYPE</td>
1.376 wiz 14181: <td>TERMINFO_DEFAULT</td>
1.352 wiz 14182: </tr>
14183: <tr>
1.368 gutterid 14184: <td>TERMINFO_TYPE</td>
1.376 wiz 14185: <td>TEST</td>
1.269 leot 14186: </tr>
14187: <tr>
1.368 gutterid 14188: <td>TEST_DEPENDS</td>
1.376 wiz 14189: <td>TEST_DIRS</td>
1.342 wiz 14190: </tr>
14191: <tr>
1.368 gutterid 14192: <td>TEST_ENV</td>
1.376 wiz 14193: <td>TEST_ENV_SHELL</td>
1.269 leot 14194: </tr>
14195: <tr>
1.368 gutterid 14196: <td>TEST_MAKE_CMD</td>
1.376 wiz 14197: <td>TEST_MAKE_FLAGS</td>
1.332 rillig 14198: </tr>
14199: <tr>
1.368 gutterid 14200: <td>TEST_TARGET</td>
1.376 wiz 14201: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.327 wiz 14202: </tr>
14203: <tr>
1.368 gutterid 14204: <td>TEXLIVE_REV</td>
1.376 wiz 14205: <td>TEXLIVE_UNVERSIONED</td>
1.332 rillig 14206: </tr>
14207: <tr>
1.368 gutterid 14208: <td>TEXMFSITE</td>
1.376 wiz 14209: <td>TEX_FORMATS</td>
1.320 wiz 14210: </tr>
14211: <tr>
1.368 gutterid 14212: <td>TEX_HYPHEN_DAT</td>
1.376 wiz 14213: <td>TEX_HYPHEN_DEF</td>
1.303 bacon 14214: </tr>
14215: <tr>
1.368 gutterid 14216: <td>TEX_TEXMF_DIRS</td>
1.376 wiz 14217: <td>THTTPD_LOG_FACILITY</td>
1.274 rillig 14218: </tr>
14219: <tr>
1.368 gutterid 14220: <td>TINYDYN_USER</td>
1.377 jnemeth 14221: <td>TLS</td>
1.269 leot 14222: </tr>
14223: <tr>
1.377 jnemeth 14224: <td>TLSWRAPPER_CHROOT</td>
1.368 gutterid 14225: <td>TO</td>
1.269 leot 14226: </tr>
14227: <tr>
1.377 jnemeth 14228: <td>TOOLDIR</td>
1.367 gdt 14229: <td>TOOLS_ALIASES</td>
1.269 leot 14230: </tr>
14231: <tr>
1.377 jnemeth 14232: <td>TOOLS_ALWAYS_WRAP</td>
1.367 gdt 14233: <td>TOOLS_ARGS</td>
1.269 leot 14234: </tr>
14235: <tr>
1.377 jnemeth 14236: <td>TOOLS_BROKEN</td>
1.367 gdt 14237: <td>TOOLS_CMD</td>
1.269 leot 14238: </tr>
14239: <tr>
1.377 jnemeth 14240: <td>TOOLS_CMDLINE_SED</td>
1.367 gdt 14241: <td>TOOLS_CREATE</td>
1.269 leot 14242: </tr>
14243: <tr>
1.377 jnemeth 14244: <td>TOOLS_CROSS_DESTDIR</td>
1.367 gdt 14245: <td>TOOLS_DIR</td>
1.269 leot 14246: </tr>
14247: <tr>
1.377 jnemeth 14248: <td>TOOLS_FAIL</td>
1.367 gdt 14249: <td>TOOLS_GNU_MISSING</td>
1.269 leot 14250: </tr>
14251: <tr>
1.377 jnemeth 14252: <td>TOOLS_LDCONFIG</td>
1.367 gdt 14253: <td>TOOLS_NOOP</td>
1.269 leot 14254: </tr>
14255: <tr>
1.377 jnemeth 14256: <td>TOOLS_PATH</td>
1.367 gdt 14257: <td>TOOLS_SCRIPT</td>
1.269 leot 14258: </tr>
14259: <tr>
1.377 jnemeth 14260: <td>TOOLS_USE_CROSS_COMPILE</td>
1.367 gdt 14261: <td>TOOL_DEPENDS</td>
1.369 wiz 14262: </tr>
14263: <tr>
1.378 ! leot 14264: <td>TTF_FONTDIR</td>
1.356 gutterid 14265: <td>TTF_FONTS_DIR</td>
1.378 ! leot 14266: </tr>
! 14267: <tr>
1.375 jkoshy 14268: <td>TYPE</td>
1.378 ! leot 14269: <td>UAC_REQD_EXECS</td>
1.355 rillig 14270: </tr>
14271: <tr>
1.375 jkoshy 14272: <td>UCSPI_SSL_GROUP</td>
1.378 ! leot 14273: <td>UCSPI_SSL_USER</td>
1.352 wiz 14274: </tr>
14275: <tr>
1.375 jkoshy 14276: <td>UNLIMIT_RESOURCES</td>
1.378 ! leot 14277: <td>UNPRIVILEGED</td>
1.269 leot 14278: </tr>
14279: <tr>
1.375 jkoshy 14280: <td>UNPRIVILEGED_GROUP</td>
1.378 ! leot 14281: <td>UNPRIVILEGED_GROUPS</td>
1.338 nia 14282: </tr>
14283: <tr>
1.375 jkoshy 14284: <td>UNPRIVILEGED_USER</td>
1.378 ! leot 14285: <td>UNWRAP_FILES</td>
1.269 leot 14286: </tr>
14287: <tr>
1.375 jkoshy 14288: <td>UNWRAP_PATTERNS</td>
1.378 ! leot 14289: <td>UPDATE_GEMSPEC</td>
1.327 wiz 14290: </tr>
14291: <tr>
1.375 jkoshy 14292: <td>UPDATE_TARGET</td>
1.378 ! leot 14293: <td>URI</td>
1.269 leot 14294: </tr>
14295: <tr>
1.375 jkoshy 14296: <td>USERGROUP_PHASE</td>
1.378 ! leot 14297: <td>USERPPP_GROUP</td>
1.269 leot 14298: </tr>
14299: <tr>
1.375 jkoshy 14300: <td>USER_SPECIFIC_PKGS</td>
1.378 ! leot 14301: <td>USE_ABI_DEPENDS</td>
1.269 leot 14302: </tr>
14303: <tr>
1.375 jkoshy 14304: <td>USE_APR</td>
1.378 ! leot 14305: <td>USE_BSD_MAKEFILE</td>
1.269 leot 14306: </tr>
14307: <tr>
1.375 jkoshy 14308: <td>USE_BUILTIN</td>
1.378 ! leot 14309: <td>USE_CC_FEATURES</td>
1.269 leot 14310: </tr>
14311: <tr>
1.375 jkoshy 14312: <td>USE_CROSS_COMPILE</td>
1.378 ! leot 14313: <td>USE_CURSES</td>
1.357 gutterid 14314: </tr>
14315: <tr>
1.375 jkoshy 14316: <td>USE_CWRAPPERS</td>
1.378 ! leot 14317: <td>USE_CXX_FEATURES</td>
1.269 leot 14318: </tr>
14319: <tr>
1.375 jkoshy 14320: <td>USE_DB185</td>
1.378 ! leot 14321: <td>USE_FEATURES</td>
1.269 leot 14322: </tr>
14323: <tr>
1.375 jkoshy 14324: <td>USE_GAMESGROUP</td>
1.378 ! leot 14325: <td>USE_GCC_RUNTIME</td>
1.269 leot 14326: </tr>
14327: <tr>
1.375 jkoshy 14328: <td>USE_IMAKE</td>
1.378 ! leot 14329: <td>USE_INDIRECT_DEPENDS</td>
1.269 leot 14330: </tr>
14331: <tr>
1.356 gutterid 14332: <td>USE_JAVA</td>
1.378 ! leot 14333: <td>USE_JAVA2</td>
1.320 wiz 14334: </tr>
14335: <tr>
1.356 gutterid 14336: <td>USE_LANGUAGES</td>
1.378 ! leot 14337: <td>USE_LIBTOOL</td>
1.269 leot 14338: </tr>
14339: <tr>
1.356 gutterid 14340: <td>USE_NATIVE_GCC</td>
1.378 ! leot 14341: <td>USE_NETBSD_REPO</td>
1.269 leot 14342: </tr>
14343: <tr>
1.356 gutterid 14344: <td>USE_PKGSRC_GCC</td>
1.378 ! leot 14345: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.269 leot 14346: </tr>
14347: <tr>
1.356 gutterid 14348: <td>USE_PKGTASKS</td>
1.378 ! leot 14349: <td>USE_PKG_ADMIN_DIGEST</td>
1.269 leot 14350: </tr>
14351: <tr>
1.356 gutterid 14352: <td>USE_RUBY_EXTCONF</td>
1.378 ! leot 14353: <td>USE_RUBY_INSTALL</td>
1.269 leot 14354: </tr>
14355: <tr>
1.356 gutterid 14356: <td>USE_RUBY_SETUP</td>
1.378 ! leot 14357: <td>USE_RUBY_SETUP_PKG</td>
1.269 leot 14358: </tr>
14359: <tr>
1.376 wiz 14360: <td>USE_TMPFILES</td>
1.378 ! leot 14361: <td>USE_TOOLS</td>
1.376 wiz 14362: </tr>
14363: <tr>
14364: <td>UUCP_GROUP</td>
1.378 ! leot 14365: <td>UUCP_USER</td>
1.269 leot 14366: </tr>
14367: <tr>
1.376 wiz 14368: <td>VARBASE</td>
1.378 ! leot 14369: <td>VARNAME</td>
1.269 leot 14370: </tr>
14371: <tr>
1.376 wiz 14372: <td>VIM_EXTRA_OPTS</td>
1.378 ! leot 14373: <td>WARNING_MSG</td>
1.269 leot 14374: </tr>
14375: <tr>
1.376 wiz 14376: <td>WCALC_CGIDIR</td>
1.378 ! leot 14377: <td>WCALC_CGIPATH</td>
1.269 leot 14378: </tr>
14379: <tr>
1.376 wiz 14380: <td>WCALC_HTMLDIR</td>
1.378 ! leot 14381: <td>WCALC_HTMLPATH</td>
1.269 leot 14382: </tr>
14383: <tr>
1.376 wiz 14384: <td>WDM_MANAGERS</td>
1.378 ! leot 14385: <td>WRAPPER_CC</td>
1.269 leot 14386: </tr>
14387: <tr>
1.376 wiz 14388: <td>WRAPPER_REORDER_CMDS</td>
1.378 ! leot 14389: <td>WRKDIR</td>
1.269 leot 14390: </tr>
14391: <tr>
1.376 wiz 14392: <td>WRKDIR_BASENAME</td>
1.378 ! leot 14393: <td>WRKDIR_LOCKTYPE</td>
1.269 leot 14394: </tr>
14395: <tr>
1.376 wiz 14396: <td>WRKLOG</td>
1.378 ! leot 14397: <td>WRKOBJDIR</td>
1.269 leot 14398: </tr>
14399: <tr>
1.376 wiz 14400: <td>WRKSRC</td>
1.378 ! leot 14401: <td>X10_PORT</td>
1.269 leot 14402: </tr>
14403: <tr>
1.376 wiz 14404: <td>X11</td>
1.378 ! leot 14405: <td>X11BASE</td>
1.269 leot 14406: </tr>
14407: <tr>
1.376 wiz 14408: <td>X11_PKGSRCDIR</td>
1.378 ! leot 14409: <td>X11_TYPE</td>
1.269 leot 14410: </tr>
14411: <tr>
1.376 wiz 14412: <td>X509_CERTIFICATE</td>
1.378 ! leot 14413: <td>X509_KEY</td>
1.269 leot 14414: </tr>
14415: <tr>
1.376 wiz 14416: <td>XAW_TYPE</td>
1.378 ! leot 14417: <td>XLOCK_DEFAULT_MODE</td>
1.303 bacon 14418: </tr>
14419: <tr>
1.376 wiz 14420: <td>XMKMF</td>
1.378 ! leot 14421: <td>XMKMF_FLAGS</td>
1.269 leot 14422: </tr>
14423: <tr>
1.376 wiz 14424: <td>XXX</td>
1.378 ! leot 14425: <td>XXXX</td>
1.269 leot 14426: </tr>
14427: <tr>
1.375 jkoshy 14428: <td>YES</td>
1.377 jnemeth 14429: <td>ZSH_STATIC</td>
1.367 gdt 14430: </tr>
14431: <tr>
1.375 jkoshy 14432: <td>__stdc__</td>
1.377 jnemeth 14433: <td>_vargroups</td>
1.360 leot 14434: </tr>
14435: <tr>
1.375 jkoshy 14436: <td>accept</td>
1.377 jnemeth 14437: <td>acquire-localbase-lock</td>
1.348 wiz 14438: </tr>
14439: <tr>
1.375 jkoshy 14440: <td>acquire-lock</td>
1.377 jnemeth 14441: <td>add</td>
1.269 leot 14442: </tr>
14443: <tr>
1.375 jkoshy 14444: <td>added</td>
1.377 jnemeth 14445: <td>administrator</td>
1.342 wiz 14446: </tr>
14447: <tr>
1.375 jkoshy 14448: <td>alloca</td>
1.377 jnemeth 14449: <td>alternatives</td>
1.269 leot 14450: </tr>
14451: <tr>
1.375 jkoshy 14452: <td>aslr</td>
1.377 jnemeth 14453: <td>asprintf</td>
1.274 rillig 14454: </tr>
14455: <tr>
1.375 jkoshy 14456: <td>atlas</td>
1.377 jnemeth 14457: <td>autoconf</td>
1.332 rillig 14458: </tr>
14459: <tr>
1.375 jkoshy 14460: <td>automake</td>
1.377 jnemeth 14461: <td>autoreconf</td>
1.269 leot 14462: </tr>
14463: <tr>
1.375 jkoshy 14464: <td>awk</td>
1.377 jnemeth 14465: <td>bash</td>
1.316 cirnatda 14466: </tr>
14467: <tr>
1.375 jkoshy 14468: <td>big-endian</td>
1.377 jnemeth 14469: <td>bin-install</td>
1.289 leot 14470: </tr>
14471: <tr>
1.375 jkoshy 14472: <td>bind</td>
1.377 jnemeth 14473: <td>binpkg-list</td>
1.269 leot 14474: </tr>
14475: <tr>
1.375 jkoshy 14476: <td>blas</td>
1.377 jnemeth 14477: <td>bootstrap-depends</td>
1.269 leot 14478: </tr>
14479: <tr>
1.375 jkoshy 14480: <td>broken</td>
1.377 jnemeth 14481: <td>broken_on_platform</td>
1.289 leot 14482: </tr>
14483: <tr>
1.375 jkoshy 14484: <td>bsd</td>
1.377 jnemeth 14485: <td>bsd.prog.mk</td>
1.269 leot 14486: </tr>
14487: <tr>
1.375 jkoshy 14488: <td>build</td>
1.377 jnemeth 14489: <td>build-env</td>
1.269 leot 14490: </tr>
14491: <tr>
1.375 jkoshy 14492: <td>buildlink-directories</td>
1.377 jnemeth 14493: <td>buildlink-oss-soundcard-h</td>
1.269 leot 14494: </tr>
14495: <tr>
1.375 jkoshy 14496: <td>built-in</td>
1.377 jnemeth 14497: <td>builtin</td>
1.271 brook 14498: </tr>
14499: <tr>
1.375 jkoshy 14500: <td>c</td>
1.377 jnemeth 14501: <td>c++</td>
1.269 leot 14502: </tr>
14503: <tr>
1.375 jkoshy 14504: <td>ccache</td>
1.377 jnemeth 14505: <td>cce</td>
1.356 gutterid 14506: </tr>
14507: <tr>
1.375 jkoshy 14508: <td>cdefs</td>
1.377 jnemeth 14509: <td>ceil</td>
1.292 leot 14510: </tr>
14511: <tr>
1.375 jkoshy 14512: <td>changes</td>
1.377 jnemeth 14513: <td>changes-entry</td>
1.274 rillig 14514: </tr>
14515: <tr>
1.375 jkoshy 14516: <td>changes-entry-noupdate</td>
1.377 jnemeth 14517: <td>check</td>
1.269 leot 14518: </tr>
14519: <tr>
1.375 jkoshy 14520: <td>check-clean</td>
1.377 jnemeth 14521: <td>check-files</td>
1.289 leot 14522: </tr>
14523: <tr>
1.375 jkoshy 14524: <td>check-files-clean</td>
1.377 jnemeth 14525: <td>check-hackage</td>
1.269 leot 14526: </tr>
14527: <tr>
1.375 jkoshy 14528: <td>check-vulnerable</td>
1.377 jnemeth 14529: <td>checksum</td>
1.370 gdt 14530: </tr>
14531: <tr>
1.375 jkoshy 14532: <td>checksum-phase</td>
1.377 jnemeth 14533: <td>clean</td>
1.269 leot 14534: </tr>
14535: <tr>
1.375 jkoshy 14536: <td>clean-depends</td>
1.377 jnemeth 14537: <td>cleandir</td>
1.269 leot 14538: </tr>
14539: <tr>
1.375 jkoshy 14540: <td>commit</td>
1.377 jnemeth 14541: <td>commit-changes-entry</td>
1.269 leot 14542: </tr>
14543: <tr>
1.375 jkoshy 14544: <td>compact</td>
1.377 jnemeth 14545: <td>compiler</td>
1.289 leot 14546: </tr>
14547: <tr>
1.375 jkoshy 14548: <td>conf</td>
1.377 jnemeth 14549: <td>config.guess</td>
1.269 leot 14550: </tr>
14551: <tr>
1.375 jkoshy 14552: <td>config.sub</td>
1.377 jnemeth 14553: <td>configuration</td>
1.269 leot 14554: </tr>
14555: <tr>
1.375 jkoshy 14556: <td>configure</td>
1.377 jnemeth 14557: <td>configure-env</td>
1.269 leot 14558: </tr>
14559: <tr>
1.375 jkoshy 14560: <td>configure-help</td>
1.377 jnemeth 14561: <td>configure_args</td>
1.269 leot 14562: </tr>
14563: <tr>
1.375 jkoshy 14564: <td>connect</td>
1.377 jnemeth 14565: <td>cos</td>
1.269 leot 14566: </tr>
14567: <tr>
1.375 jkoshy 14568: <td>cpe</td>
1.377 jnemeth 14569: <td>cputime</td>
1.269 leot 14570: </tr>
14571: <tr>
1.375 jkoshy 14572: <td>create-usergroup</td>
1.377 jnemeth 14573: <td>csh</td>
1.269 leot 14574: </tr>
14575: <tr>
1.374 wiz 14576: <td>ctf</td>
1.378 ! leot 14577: <td>cvs</td>
! 14578: </tr>
! 14579: <tr>
1.374 wiz 14580: <td>debug</td>
1.378 ! leot 14581: <td>declaration</td>
1.376 wiz 14582: </tr>
14583: <tr>
14584: <td>declare</td>
1.378 ! leot 14585: <td>defined</td>
1.355 rillig 14586: </tr>
14587: <tr>
1.376 wiz 14588: <td>depend</td>
1.378 ! leot 14589: <td>dependencies</td>
1.352 wiz 14590: </tr>
14591: <tr>
1.376 wiz 14592: <td>depends</td>
1.378 ! leot 14593: <td>depends-checksum</td>
1.338 nia 14594: </tr>
14595: <tr>
1.376 wiz 14596: <td>depends-fetch</td>
1.378 ! leot 14597: <td>deps</td>
1.289 leot 14598: </tr>
14599: <tr>
1.376 wiz 14600: <td>describe</td>
1.378 ! leot 14601: <td>destdir</td>
1.329 leot 14602: </tr>
14603: <tr>
1.376 wiz 14604: <td>disable</td>
1.378 ! leot 14605: <td>distclean</td>
1.320 wiz 14606: </tr>
14607: <tr>
1.376 wiz 14608: <td>distinfo</td>
1.378 ! leot 14609: <td>dl</td>
1.269 leot 14610: </tr>
14611: <tr>
1.376 wiz 14612: <td>dlopen</td>
1.378 ! leot 14613: <td>do-buildlink</td>
1.311 leot 14614: </tr>
14615: <tr>
1.376 wiz 14616: <td>do-clean</td>
1.378 ! leot 14617: <td>do-configure</td>
1.269 leot 14618: </tr>
14619: <tr>
1.376 wiz 14620: <td>do-configure-post-hook</td>
1.378 ! leot 14621: <td>do-extract</td>
1.269 leot 14622: </tr>
14623: <tr>
1.376 wiz 14624: <td>do-fetch</td>
1.378 ! leot 14625: <td>do-install</td>
1.269 leot 14626: </tr>
14627: <tr>
1.375 jkoshy 14628: <td>download</td>
1.377 jnemeth 14629: <td>emul</td>
1.269 leot 14630: </tr>
14631: <tr>
1.375 jkoshy 14632: <td>emul-distinfo</td>
1.377 jnemeth 14633: <td>emul-fetch</td>
1.269 leot 14634: </tr>
14635: <tr>
1.375 jkoshy 14636: <td>emulation</td>
1.377 jnemeth 14637: <td>emulator</td>
1.277 rillig 14638: </tr>
14639: <tr>
1.375 jkoshy 14640: <td>enable</td>
1.352 wiz 14641: <td>endian</td>
1.376 wiz 14642: </tr>
14643: <tr>
1.378 ! leot 14644: <td>endif</td>
1.365 gutterid 14645: <td>enomem</td>
1.378 ! leot 14646: </tr>
! 14647: <tr>
1.376 wiz 14648: <td>ensurepip</td>
1.378 ! leot 14649: <td>err</td>
1.367 gdt 14650: </tr>
14651: <tr>
1.376 wiz 14652: <td>errx</td>
1.378 ! leot 14653: <td>etc</td>
1.348 wiz 14654: </tr>
14655: <tr>
1.376 wiz 14656: <td>exp</td>
1.378 ! leot 14657: <td>extract-rpm</td>
1.269 leot 14658: </tr>
14659: <tr>
1.376 wiz 14660: <td>fabs</td>
1.378 ! leot 14661: <td>feature</td>
1.342 wiz 14662: </tr>
14663: <tr>
1.376 wiz 14664: <td>features</td>
1.378 ! leot 14665: <td>fetch</td>
1.329 leot 14666: </tr>
14667: <tr>
1.376 wiz 14668: <td>fetch-list</td>
1.378 ! leot 14669: <td>follows</td>
1.269 leot 14670: </tr>
14671: <tr>
1.376 wiz 14672: <td>forbids</td>
1.378 ! leot 14673: <td>form</td>
1.320 wiz 14674: </tr>
14675: <tr>
1.376 wiz 14676: <td>format</td>
1.378 ! leot 14677: <td>fortify</td>
1.311 leot 14678: </tr>
14679: <tr>
1.376 wiz 14680: <td>fortify_source</td>
1.378 ! leot 14681: <td>fossil</td>
1.352 wiz 14682: </tr>
14683: <tr>
1.375 jkoshy 14684: <td>friend</td>
1.377 jnemeth 14685: <td>fts</td>
1.369 wiz 14686: </tr>
14687: <tr>
1.375 jkoshy 14688: <td>fts_close</td>
1.377 jnemeth 14689: <td>fts_open</td>
1.355 rillig 14690: </tr>
14691: <tr>
1.375 jkoshy 14692: <td>fts_read</td>
1.377 jnemeth 14693: <td>fts_set</td>
1.332 rillig 14694: </tr>
14695: <tr>
1.375 jkoshy 14696: <td>gcc</td>
1.377 jnemeth 14697: <td>gethostbyaddr</td>
1.338 nia 14698: </tr>
14699: <tr>
1.375 jkoshy 14700: <td>gethostbyname</td>
1.377 jnemeth 14701: <td>gethostbyname2</td>
1.269 leot 14702: </tr>
14703: <tr>
1.375 jkoshy 14704: <td>getopt_long</td>
1.377 jnemeth 14705: <td>getprogname</td>
1.269 leot 14706: </tr>
14707: <tr>
1.375 jkoshy 14708: <td>getservbyname</td>
1.377 jnemeth 14709: <td>getservbyport</td>
1.269 leot 14710: </tr>
14711: <tr>
1.375 jkoshy 14712: <td>getservent</td>
1.352 wiz 14713: <td>gettext</td>
1.376 wiz 14714: </tr>
14715: <tr>
1.378 ! leot 14716: <td>git</td>
1.365 gutterid 14717: <td>github</td>
1.378 ! leot 14718: </tr>
! 14719: <tr>
1.376 wiz 14720: <td>gitlab</td>
1.378 ! leot 14721: <td>glob</td>
1.367 gdt 14722: </tr>
14723: <tr>
1.376 wiz 14724: <td>gnu</td>
1.378 ! leot 14725: <td>gnu_configure_strict</td>
1.348 wiz 14726: </tr>
14727: <tr>
1.376 wiz 14728: <td>go</td>
1.378 ! leot 14729: <td>go-deps</td>
1.289 leot 14730: </tr>
14731: <tr>
1.376 wiz 14732: <td>golang</td>
1.378 ! leot 14733: <td>guess-license</td>
1.342 wiz 14734: </tr>
14735: <tr>
1.376 wiz 14736: <td>hashbang</td>
1.378 ! leot 14737: <td>heimdal</td>
1.338 nia 14738: </tr>
14739: <tr>
1.376 wiz 14740: <td>help</td>
1.378 ! leot 14741: <td>hg</td>
1.352 wiz 14742: </tr>
14743: <tr>
1.375 jkoshy 14744: <td>imake</td>
1.377 jnemeth 14745: <td>in-tree</td>
1.369 wiz 14746: </tr>
14747: <tr>
1.375 jkoshy 14748: <td>increment</td>
1.377 jnemeth 14749: <td>indirect</td>
1.355 rillig 14750: </tr>
14751: <tr>
1.375 jkoshy 14752: <td>inet_aton</td>
1.377 jnemeth 14753: <td>interp</td>
1.269 leot 14754: </tr>
14755: <tr>
1.375 jkoshy 14756: <td>interpreter</td>
1.377 jnemeth 14757: <td>intl</td>
1.329 leot 14758: </tr>
14759: <tr>
1.375 jkoshy 14760: <td>ip4</td>
1.377 jnemeth 14761: <td>ip6</td>
1.269 leot 14762: </tr>
14763: <tr>
1.375 jkoshy 14764: <td>ipv4</td>
1.377 jnemeth 14765: <td>ipv6</td>
1.320 wiz 14766: </tr>
14767: <tr>
1.375 jkoshy 14768: <td>iso</td>
1.377 jnemeth 14769: <td>kerberos</td>
1.311 leot 14770: </tr>
14771: <tr>
1.375 jkoshy 14772: <td>krb</td>
1.377 jnemeth 14773: <td>krb5</td>
1.269 leot 14774: </tr>
14775: <tr>
1.375 jkoshy 14776: <td>ksh</td>
1.377 jnemeth 14777: <td>lapack</td>
1.269 leot 14778: </tr>
14779: <tr>
1.375 jkoshy 14780: <td>latex</td>
1.377 jnemeth 14781: <td>libiconv</td>
1.269 leot 14782: </tr>
14783: <tr>
1.355 rillig 14784: <td>libintl_bindtextdomain</td>
1.377 jnemeth 14785: <td>libintl_gettext</td>
1.269 leot 14786: </tr>
14787: <tr>
1.355 rillig 14788: <td>libintl_textdomain</td>
1.377 jnemeth 14789: <td>libnbcompat</td>
1.303 bacon 14790: </tr>
14791: <tr>
1.355 rillig 14792: <td>libs</td>
1.377 jnemeth 14793: <td>libtool</td>
1.303 bacon 14794: </tr>
14795: <tr>
1.355 rillig 14796: <td>licence</td>
1.377 jnemeth 14797: <td>license</td>
1.269 leot 14798: </tr>
14799: <tr>
1.355 rillig 14800: <td>lintl</td>
1.377 jnemeth 14801: <td>little-endian</td>
1.292 leot 14802: </tr>
14803: <tr>
1.355 rillig 14804: <td>lock</td>
1.377 jnemeth 14805: <td>locking</td>
1.269 leot 14806: </tr>
14807: <tr>
1.355 rillig 14808: <td>lua</td>
1.377 jnemeth 14809: <td>lvalue</td>
1.289 leot 14810: </tr>
14811: <tr>
1.355 rillig 14812: <td>make</td>
1.377 jnemeth 14813: <td>makedistinfo</td>
1.274 rillig 14814: </tr>
14815: <tr>
1.377 jnemeth 14816: <td>makepatchsum</td>
1.374 wiz 14817: <td>makesum</td>
1.377 jnemeth 14818: </tr>
14819: <tr>
14820: <td>mdi</td>
1.355 rillig 14821: <td>memory</td>
1.360 leot 14822: </tr>
14823: <tr>
1.378 ! leot 14824: <td>mercurial</td>
1.365 gutterid 14825: <td>meta</td>
1.378 ! leot 14826: </tr>
! 14827: <tr>
1.377 jnemeth 14828: <td>meta-package</td>
1.378 ! leot 14829: <td>meta_package</td>
1.376 wiz 14830: </tr>
14831: <tr>
1.377 jnemeth 14832: <td>mit-krb5</td>
1.378 ! leot 14833: <td>mk.conf</td>
1.367 gdt 14834: </tr>
14835: <tr>
1.377 jnemeth 14836: <td>mkl</td>
1.378 ! leot 14837: <td>mount</td>
1.271 brook 14838: </tr>
14839: <tr>
1.377 jnemeth 14840: <td>move</td>
1.378 ! leot 14841: <td>moved</td>
1.348 wiz 14842: </tr>
14843: <tr>
1.377 jnemeth 14844: <td>mprotect</td>
1.378 ! leot 14845: <td>mps</td>
1.342 wiz 14846: </tr>
14847: <tr>
1.376 wiz 14848: <td>mremap</td>
1.378 ! leot 14849: <td>native</td>
1.269 leot 14850: </tr>
14851: <tr>
1.376 wiz 14852: <td>nb</td>
1.378 ! leot 14853: <td>nbcompat</td>
1.269 leot 14854: </tr>
14855: <tr>
1.376 wiz 14856: <td>netlib</td>
1.378 ! leot 14857: <td>network</td>
1.292 leot 14858: </tr>
14859: <tr>
1.376 wiz 14860: <td>node</td>
1.378 ! leot 14861: <td>node.js</td>
1.370 gdt 14862: </tr>
14863: <tr>
1.376 wiz 14864: <td>nodejs</td>
1.378 ! leot 14865: <td>obstack</td>
1.274 rillig 14866: </tr>
14867: <tr>
1.376 wiz 14868: <td>obstack_ptr_grow</td>
1.378 ! leot 14869: <td>occurs</td>
1.341 gutterid 14870: </tr>
14871: <tr>
1.376 wiz 14872: <td>only</td>
1.378 ! leot 14873: <td>openblas</td>
1.269 leot 14874: </tr>
14875: <tr>
1.376 wiz 14876: <td>options</td>
1.378 ! leot 14877: <td>options.mk</td>
1.269 leot 14878: </tr>
14879: <tr>
1.376 wiz 14880: <td>order</td>
1.378 ! leot 14881: <td>override</td>
1.333 nia 14882: </tr>
14883: <tr>
1.376 wiz 14884: <td>override-intltool</td>
1.378 ! leot 14885: <td>override-message-intltool</td>
1.333 nia 14886: </tr>
14887: <tr>
1.376 wiz 14888: <td>package</td>
1.378 ! leot 14889: <td>parallel</td>
1.320 wiz 14890: </tr>
14891: <tr>
1.376 wiz 14892: <td>path</td>
1.378 ! leot 14893: <td>pax</td>
1.269 leot 14894: </tr>
14895: <tr>
1.376 wiz 14896: <td>paxctl</td>
1.378 ! leot 14897: <td>pbulk-index</td>
1.269 leot 14898: </tr>
14899: <tr>
1.376 wiz 14900: <td>pc</td>
1.378 ! leot 14901: <td>perl</td>
1.269 leot 14902: </tr>
14903: <tr>
1.376 wiz 14904: <td>perl5</td>
1.378 ! leot 14905: <td>perms</td>
1.271 brook 14906: </tr>
14907: <tr>
1.376 wiz 14908: <td>php</td>
1.378 ! leot 14909: <td>pkg-build-options</td>
1.269 leot 14910: </tr>
14911: <tr>
1.376 wiz 14912: <td>pkg-config</td>
1.378 ! leot 14913: <td>pkg_build_options</td>
1.269 leot 14914: </tr>
14915: <tr>
1.376 wiz 14916: <td>pkgsrc</td>
1.378 ! leot 14917: <td>platform</td>
1.269 leot 14918: </tr>
14919: <tr>
1.376 wiz 14920: <td>plist</td>
1.378 ! leot 14921: <td>post-extract</td>
1.269 leot 14922: </tr>
14923: <tr>
1.376 wiz 14924: <td>post-fetch</td>
1.378 ! leot 14925: <td>post-wrapper</td>
1.269 leot 14926: </tr>
14927: <tr>
1.376 wiz 14928: <td>pre-build-checks-hook</td>
1.378 ! leot 14929: <td>pre-configure-checks-hook</td>
1.269 leot 14930: </tr>
14931: <tr>
1.376 wiz 14932: <td>pre-extract</td>
1.378 ! leot 14933: <td>pre-fetch</td>
1.269 leot 14934: </tr>
14935: <tr>
1.376 wiz 14936: <td>print-go-deps</td>
1.378 ! leot 14937: <td>print-plist</td>
1.269 leot 14938: </tr>
14939: <tr>
1.376 wiz 14940: <td>print-summary-data</td>
1.378 ! leot 14941: <td>privileged-install-hook</td>
1.269 leot 14942: </tr>
14943: <tr>
1.376 wiz 14944: <td>pypi</td>
1.378 ! leot 14945: <td>python</td>
1.269 leot 14946: </tr>
14947: <tr>
1.376 wiz 14948: <td>r</td>
1.378 ! leot 14949: <td>readme-all</td>
1.269 leot 14950: </tr>
14951: <tr>
1.376 wiz 14952: <td>recursive</td>
1.378 ! leot 14953: <td>recv</td>
1.289 leot 14954: </tr>
14955: <tr>
1.376 wiz 14956: <td>recvfrom</td>
1.378 ! leot 14957: <td>regcomp</td>
1.269 leot 14958: </tr>
14959: <tr>
1.376 wiz 14960: <td>release-localbase-lock</td>
1.378 ! leot 14961: <td>release-lock</td>
1.269 leot 14962: </tr>
14963: <tr>
1.376 wiz 14964: <td>relro</td>
1.378 ! leot 14965: <td>remove</td>
1.269 leot 14966: </tr>
14967: <tr>
1.376 wiz 14968: <td>removed</td>
1.378 ! leot 14969: <td>rename</td>
1.269 leot 14970: </tr>
14971: <tr>
1.376 wiz 14972: <td>renamed</td>
1.378 ! leot 14973: <td>reorder</td>
1.269 leot 14974: </tr>
14975: <tr>
1.376 wiz 14976: <td>replace</td>
1.378 ! leot 14977: <td>replace_interpreter</td>
1.289 leot 14978: </tr>
14979: <tr>
1.376 wiz 14980: <td>reproducible</td>
1.378 ! leot 14981: <td>resolv</td>
1.289 leot 14982: </tr>
14983: <tr>
1.376 wiz 14984: <td>root</td>
1.378 ! leot 14985: <td>ruby</td>
1.269 leot 14986: </tr>
14987: <tr>
1.376 wiz 14988: <td>send</td>
1.378 ! leot 14989: <td>sendfile</td>
1.341 gutterid 14990: </tr>
14991: <tr>
1.376 wiz 14992: <td>sendto</td>
1.378 ! leot 14993: <td>setenv</td>
1.341 gutterid 14994: </tr>
14995: <tr>
1.376 wiz 14996: <td>setgid</td>
1.378 ! leot 14997: <td>setprogname</td>
1.269 leot 14998: </tr>
14999: <tr>
1.376 wiz 15000: <td>setuid</td>
1.378 ! leot 15001: <td>sh</td>
1.269 leot 15002: </tr>
15003: <tr>
1.376 wiz 15004: <td>shebang</td>
1.378 ! leot 15005: <td>show</td>
1.269 leot 15006: </tr>
15007: <tr>
1.376 wiz 15008: <td>show-all</td>
1.378 ! leot 15009: <td>show-build-defs</td>
1.289 leot 15010: </tr>
15011: <tr>
1.376 wiz 15012: <td>show-depends</td>
1.378 ! leot 15013: <td>show-depends-dirs</td>
1.269 leot 15014: </tr>
15015: <tr>
1.376 wiz 15016: <td>show-depends-pkgpaths</td>
1.378 ! leot 15017: <td>show-depends-recursive</td>
1.269 leot 15018: </tr>
15019: <tr>
1.376 wiz 15020: <td>show-deps</td>
1.378 ! leot 15021: <td>show-distfiles</td>
1.269 leot 15022: </tr>
15023: <tr>
1.376 wiz 15024: <td>show-downlevel</td>
1.378 ! leot 15025: <td>show-subdir-var</td>
1.269 leot 15026: </tr>
15027: <tr>
1.376 wiz 15028: <td>show-tools</td>
1.378 ! leot 15029: <td>show-var</td>
1.296 rillig 15030: </tr>
15031: <tr>
1.376 wiz 15032: <td>show-vars</td>
1.378 ! leot 15033: <td>snprintf</td>
1.269 leot 15034: </tr>
15035: <tr>
1.376 wiz 15036: <td>socket</td>
1.378 ! leot 15037: <td>ssp</td>
1.337 gutterid 15038: </tr>
15039: <tr>
1.376 wiz 15040: <td>st_mode</td>
1.378 ! leot 15041: <td>stage-install</td>
1.338 nia 15042: </tr>
15043: <tr>
1.376 wiz 15044: <td>strcasestr</td>
1.378 ! leot 15045: <td>strict</td>
1.269 leot 15046: </tr>
15047: <tr>
1.376 wiz 15048: <td>strip</td>
1.378 ! leot 15049: <td>strndup</td>
1.269 leot 15050: </tr>
15051: <tr>
1.376 wiz 15052: <td>strnlen</td>
1.378 ! leot 15053: <td>strsep</td>
1.269 leot 15054: </tr>
15055: <tr>
1.376 wiz 15056: <td>subst</td>
1.378 ! leot 15057: <td>substitutions</td>
1.269 leot 15058: </tr>
15059: <tr>
1.378 ! leot 15060: <td>subversion</td>
1.377 jnemeth 15061: <td>sun</td>
1.369 wiz 15062: </tr>
15063: <tr>
15064: <td>sunpro</td>
1.374 wiz 15065: <td>sunwspro</td>
1.329 leot 15066: </tr>
15067: <tr>
1.378 ! leot 15068: <td>svn</td>
1.376 wiz 15069: <td>symlink</td>
1.378 ! leot 15070: </tr>
! 15071: <tr>
1.368 gutterid 15072: <td>test</td>
1.378 ! leot 15073: <td>test-env</td>
1.367 gdt 15074: </tr>
15075: <tr>
1.368 gutterid 15076: <td>tex</td>
1.378 ! leot 15077: <td>texlive</td>
1.327 wiz 15078: </tr>
15079: <tr>
1.368 gutterid 15080: <td>tmp</td>
1.378 ! leot 15081: <td>todo</td>
1.342 wiz 15082: </tr>
15083: <tr>
1.368 gutterid 15084: <td>tool</td>
1.378 ! leot 15085: <td>tools</td>
1.338 nia 15086: </tr>
15087: <tr>
1.368 gutterid 15088: <td>tools-libtool-m4-override</td>
1.378 ! leot 15089: <td>transitive</td>
1.269 leot 15090: </tr>
15091: <tr>
1.368 gutterid 15092: <td>type</td>
1.378 ! leot 15093: <td>ulimit</td>
1.269 leot 15094: </tr>
15095: <tr>
1.368 gutterid 15096: <td>undefined</td>
1.378 ! leot 15097: <td>undo-replace</td>
1.269 leot 15098: </tr>
15099: <tr>
1.368 gutterid 15100: <td>unlimit</td>
1.378 ! leot 15101: <td>unprivileged</td>
1.269 leot 15102: </tr>
15103: <tr>
1.368 gutterid 15104: <td>unprivileged-install-hook</td>
1.378 ! leot 15105: <td>unstripped</td>
1.269 leot 15106: </tr>
15107: <tr>
1.368 gutterid 15108: <td>update</td>
1.378 ! leot 15109: <td>updated</td>
1.269 leot 15110: </tr>
15111: <tr>
1.368 gutterid 15112: <td>upload</td>
1.378 ! leot 15113: <td>upload-distfiles</td>
1.269 leot 15114: </tr>
15115: <tr>
1.368 gutterid 15116: <td>use_tools</td>
1.378 ! leot 15117: <td>user</td>
1.269 leot 15118: </tr>
15119: <tr>
1.368 gutterid 15120: <td>utimes</td>
1.378 ! leot 15121: <td>vasprintf</td>
1.269 leot 15122: </tr>
15123: <tr>
1.368 gutterid 15124: <td>verbose</td>
1.378 ! leot 15125: <td>vsnprintf</td>
1.269 leot 15126: </tr>
15127: <tr>
1.368 gutterid 15128: <td>warn</td>
1.378 ! leot 15129: <td>warning</td>
1.269 leot 15130: </tr>
15131: <tr>
1.368 gutterid 15132: <td>warnings</td>
1.378 ! leot 15133: <td>warnx</td>
1.269 leot 15134: </tr>
15135: <tr>
1.368 gutterid 15136: <td>wattr_off</td>
1.378 ! leot 15137: <td>wattr_on</td>
1.269 leot 15138: </tr>
15139: <tr>
1.368 gutterid 15140: <td>work</td>
1.378 ! leot 15141: <td>wrapper</td>
1.269 leot 15142: </tr>
15143: <tr>
1.289 leot 15144: <td>wrkdir</td>
1.378 ! leot 15145: <td> </td>
1.269 leot 15146: </tr>
15147: </table>
1.267 rillig 15148: </div>
15149: <div class="appendix">
15150: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 15151: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 15152: <div class="toc">
15153: <p><b>Table of Contents</b></p>
1.210 leot 15154: <dl class="toc">
1.322 leot 15155: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
15156: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75 rillig 15157: </dl>
15158: </div>
1.79 rillig 15159: <p>This section contains information on editing the pkgsrc
15160: guide itself.</p>
1.148 asau 15161: <div class="sect1">
1.75 rillig 15162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 15163: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.79 rillig 15164: <p>The pkgsrc guide's source code is stored in
15165: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
15166: are created from it:</p>
1.148 asau 15167: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 15168: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
15169: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289 leot 15170: <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>
15171: <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 15172: The PDF version of the pkgsrc guide.</p></li>
1.289 leot 15173: <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 15174: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 15175: </ul></div>
15176: </div>
1.148 asau 15177: <div class="sect1">
1.75 rillig 15178: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 15179: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.79 rillig 15180: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 15181: <div class="procedure"><ol class="procedure" type="1">
1.304 bacon 15182: <li class="step"><p>Make sure you have checked out the htdocs repository
15183: into a sibling directory of your pkgsrc directory. You will need
15184: the ability to commit from both pkgsrc and htdocs.</p></li>
1.148 asau 15185: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 15186: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 15187: documentation) installed. These are automatically installed when
1.322 leot 15188: 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 15189: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 15190: right directory. All further steps will take place
15191: here.</p></li>
1.148 asau 15192: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 15193: <code class="filename">files/</code>.</p></li>
1.148 asau 15194: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 15195: guide for valid XML and to build the final output files. If you
15196: get any errors at this stage, you can just edit the files, as
15197: there are only symbolic links in the working directory, pointing
15198: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 15199: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 15200: commit)</strong></span></p></li>
1.148 asau 15201: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 15202: regenerate the output files with the proper RCS
15203: Ids.</p></li>
1.148 asau 15204: <li class="step">
1.110 hubertf 15205: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 15206: commit the files in both <code class="filename">pkgsrc/doc</code> and
15207: <code class="filename">htdocs</code>.</p>
1.148 asau 15208: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 15209: <h3 class="title">Note</h3>
15210: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 15211: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
15212: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 15213: directory.</p>
15214: </div>
15215: </li>
1.79 rillig 15216: </ol></div>
1.75 rillig 15217: </div>
15218: </div>
15219: </div></body>
1.1 grant 15220: </html>
CVSweb <webmaster@jp.NetBSD.org>