Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.261
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.25 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
9: </head>
1.41 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1 dsieger 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.10 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.10 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.259 leot 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.41 asau 35: <div><div class="abstract">
1.1 dsieger 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.100 leot 48: <dl class="toc">
1.1 dsieger 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
1.154 rillig 63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1 dsieger 65: <dd><dl>
1.154 rillig 66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 67: <dd><dl>
1.154 rillig 68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 70: </dl></dd>
1.154 rillig 71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 72: <dd><dl>
1.154 rillig 73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 75: </dl></dd>
76: </dl></dd>
1.154 rillig 77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 78: <dd><dl>
1.154 rillig 79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 81: </dl></dd>
1.154 rillig 82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 83: <dd><dl>
1.154 rillig 84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 85: <dd><dl>
1.154 rillig 86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 88: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
89: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
90: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
91: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
92: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
93: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1 dsieger 94: </dl></dd>
1.154 rillig 95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 96: <dd><dl>
1.154 rillig 97: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
98: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
99: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 100: </dl></dd>
101: </dl></dd>
1.154 rillig 102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 103: <dd><dl>
1.154 rillig 104: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
105: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 106: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
107: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
108: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
109: <dd><dl>
110: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
111: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
112: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 113: </dl></dd>
1.241 rillig 114: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
115: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 116: </dl></dd>
1.154 rillig 117: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 118: <dd><dl>
1.154 rillig 119: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
120: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 121: </dl></dd>
1.154 rillig 122: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 123: builds)</a></span></dt>
1.1 dsieger 124: <dd><dl>
1.154 rillig 125: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 126: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 127: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
128: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 129: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
130: <dd><dl>
1.179 rillig 131: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
132: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.181 rillig 133: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
134: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
135: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
136: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
137: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
138: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
139: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
140: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 141: </dl></dd>
142: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
143: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 144: </dl></dd>
145: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
146: <dd><dl>
147: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
148: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
149: </dl></dd>
150: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
151: <dd><dl>
152: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
153: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
154: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
155: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
156: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
157: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
158: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
159: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
160: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
161: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 162: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 163: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.221 nia 164: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 165: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
166: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
167: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
168: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
169: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 170: </dl></dd>
171: </dl></dd>
172: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
173: <dd><dl>
1.154 rillig 174: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 175: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 176: <dd><dl>
1.184 rillig 177: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
178: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
179: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 180: <dd><dl>
1.184 rillig 181: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
182: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
183: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
184: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
185: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 186: </dl></dd>
1.184 rillig 187: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
188: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
189: <dd><dl>
190: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
191: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
192: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
193: </dl></dd>
194: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
195: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 196: </dl></dd>
1.184 rillig 197: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 198: <dd><dl>
1.184 rillig 199: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
200: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
201: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
202: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
203: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 204: <dd><dl>
1.184 rillig 205: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
206: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 207: </dl></dd>
1.184 rillig 208: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
209: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
210: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
211: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
212: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
213: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
214: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
215: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
216: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
217: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
218: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
219: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
220: </dl></dd>
221: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
222: <dd><dl>
223: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 224: <dd><dl>
1.219 nia 225: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
226: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
227: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.6 rillig 228: </dl></dd>
1.184 rillig 229: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
230: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6 rillig 231: </dl></dd>
1.184 rillig 232: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 233: <dd><dl>
1.184 rillig 234: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
235: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
236: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
237: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 238: <dd><dl>
1.184 rillig 239: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
240: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
241: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
242: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 243: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.6 rillig 244: </dl></dd>
245: </dl></dd>
1.184 rillig 246: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 247: <dd><dl>
1.184 rillig 248: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
249: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
250: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
251: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 252: </dl></dd>
1.184 rillig 253: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 254: <dd><dl>
1.184 rillig 255: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
256: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
257: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
258: </dl></dd>
259: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
260: <dd><dl>
261: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
262: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 263: <dd><dl>
1.184 rillig 264: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
265: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 266: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
267: and
268: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
269: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 270: </dl></dd>
1.184 rillig 271: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.241 rillig 272: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.184 rillig 273: </dl></dd>
274: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 275: <dd><dl>
1.184 rillig 276: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
277: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
278: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
279: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
280: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
281: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
282: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
283: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
284: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 285: </dl></dd>
1.184 rillig 286: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
287: <dd><dl>
288: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
289: <dd><dl>
290: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
291: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 292: </dl></dd>
1.184 rillig 293: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 294: <dd><dl>
1.184 rillig 295: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
296: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.239 dholland 297: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
298: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
299: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 300: </dl></dd>
301: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
302: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
303: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
304: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
305: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
306: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
307: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.154 rillig 308: </dl></dd>
309: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
310: <dd><dl>
311: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
312: <dd><dl>
313: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
314: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
315: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
316: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
317: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
318: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
319: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
320: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
321: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
322: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
323: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
324: </dl></dd>
325: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
326: <dd><dl>
327: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
328: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
329: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
330: </dl></dd>
331: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
332: <dd><dl>
333: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
334: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 336: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.260 wiz 337: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.154 rillig 338: </dl></dd>
339: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
340: <dd><dl>
341: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
342: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 343: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 344: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
345: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
346: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
347: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 348: </dl></dd>
349: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
350: <dd><dl>
351: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
352: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 353: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
354: <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>
355: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 356: </dl></dd>
357: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
358: <dd><dl>
359: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
360: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
361: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
362: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
363: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 364: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.254 wiz 365: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
366: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
367: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
368: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
369: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
370: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
371: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
372: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
373: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
374: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.1 dsieger 375: emulation</a></span></dt>
1.254 wiz 376: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
377: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.1 dsieger 378: </dl></dd>
1.154 rillig 379: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 380: </dl></dd>
1.184 rillig 381: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
382: <dd><dl>
383: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
384: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
385: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
386: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
387: </dl></dd>
1.154 rillig 388: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 389: <dd><dl>
1.154 rillig 390: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
391: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
392: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
393: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
394: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
395: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
396: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
397: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
398: </dl></dd>
399: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 400: </dl></dd>
401: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
402: <dd><dl>
1.184 rillig 403: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 404: <dd><dl>
1.184 rillig 405: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
406: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
407: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 408: <dd><dl>
1.184 rillig 409: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
410: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 411: </dl></dd>
1.184 rillig 412: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
413: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 414: <dd><dl>
1.184 rillig 415: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
416: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 417: </dl></dd>
1.184 rillig 418: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 419: <dd><dl>
1.184 rillig 420: <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>
421: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 422: </dl></dd>
423: </dl></dd>
1.184 rillig 424: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 425: <dd><dl>
1.184 rillig 426: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
427: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 428: <dd><dl>
1.184 rillig 429: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
430: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 431: </dl></dd>
432: </dl></dd>
1.184 rillig 433: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
434: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 435: </dl></dd>
436: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
437: <dd><dl>
438: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
439: <dd><dl>
440: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
441: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
442: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 443: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 444: </dl></dd>
445: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
446: </dl></dd>
1.207 leot 447: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.1 dsieger 448: <dd><dl>
1.207 leot 449: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
450: <dd><dl>
451: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
452: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
453: </dl></dd>
454: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
455: <dd><dl>
456: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
457: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
458: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
459: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
460: </dl></dd>
461: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
462: <dd><dl>
463: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
464: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
465: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
466: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
467: </dl></dd>
468: </dl></dd>
469: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
470: <dd><dl>
471: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
472: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.1 dsieger 473: </dl></dd>
1.207 leot 474: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.1 dsieger 475: <dd><dl>
1.207 leot 476: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
477: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
478: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
479: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
480: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.148 leot 481: <code class="filename">stable</code>,
1.23 wiz 482: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 483: source packages</a></span></dt>
484: </dl></dd>
1.207 leot 485: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
486: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1 dsieger 487: <dd><dl>
1.207 leot 488: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
489: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 490: </dl></dd>
491: </dl>
492: </div>
493: <div class="list-of-tables">
494: <p><b>List of Tables</b></p>
495: <dl>
496: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
497: </dt>
1.184 rillig 498: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 499: </dt>
1.184 rillig 500: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 501: </dt>
502: </dl>
503: </div>
1.41 asau 504: <div class="chapter">
505: <div class="titlepage"><div><div><h1 class="title">
506: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 507: <div class="toc">
508: <p><b>Table of Contents</b></p>
1.100 leot 509: <dl class="toc">
1.1 dsieger 510: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
511: <dd><dl>
512: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
513: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
514: </dl></dd>
515: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
516: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
517: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
518: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
519: </dl>
520: </div>
1.41 asau 521: <div class="sect1">
1.1 dsieger 522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
523: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
524: <p>There is a lot of software freely available for Unix-based
525: systems, which is usually available in form of the source code. Before
526: such software can be used, it needs to be configured to the local
527: system, compiled and installed, and this is exactly what The NetBSD
528: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
529: to handle binary packages, so that not every user has to build the
530: packages for himself, which is a time-costly task.</p>
531: <p>pkgsrc currently contains several thousand packages,
532: including:</p>
1.41 asau 533: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 534: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.1 dsieger 535: web server</p></li>
1.207 leot 536: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1 dsieger 537: web browser</p></li>
1.207 leot 538: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1 dsieger 539: Desktop Environment</p></li>
1.207 leot 540: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.1 dsieger 541: Desktop Environment</p></li>
542: </ul></div>
1.108 rillig 543: <p>… just to name a few.</p>
1.1 dsieger 544: <p>pkgsrc has built-in support for handling varying dependencies,
545: such as pthreads and X11, and extended features such as IPv6 support on
546: a range of platforms.</p>
1.41 asau 547: <div class="sect2">
1.1 dsieger 548: <div class="titlepage"><div><div><h3 class="title">
549: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
550: <p>
551: pkgsrc provides the following key features:
552: </p>
1.41 asau 553: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 554: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 555: and installation of binary packages. The source and latest
556: patches are retrieved from a master or mirror download site, checksum
557: verified, then built on your system. Support for binary-only
558: distributions is available for both native platforms and NetBSD
559: emulated platforms.</p></li>
1.23 wiz 560: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 561: including binaries, libraries, man pages and other
562: documentation.</p></li>
1.104 sevan 563: <li class="listitem"><p>Tracking of package dependencies automatically, including when
564: performing updates, to ensure required packages are installed. The
565: configuration files of various packages are handled automatically during
566: updates, so local changes are preserved.</p></li>
1.23 wiz 567: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 568: consists of highly portable code. This allows the greatest speed of
1.25 spz 569: development when porting to a new platform. This portability also
1.1 dsieger 570: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
571: platforms</em></span>.</p></li>
1.23 wiz 572: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 573: international encryption requirements and build-time options for a
574: large number of packages are all set in a simple, central
575: configuration file.</p></li>
1.23 wiz 576: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 577: freely available under a BSD license, so you may extend and adapt
578: pkgsrc to your needs. Support for local packages and patches is
579: available right out of the box, so you can configure it specifically
580: for your environment.</p></li>
581: </ul></div>
582: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 583: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 584: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 585: — That means, if a package contains bugs, it's better to find
1.1 dsieger 586: them and to complain about them rather than to just install the package
587: and hope that it works. There are numerous checks in pkgsrc that try to
1.207 leot 588: find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.1 dsieger 589: of shell scripts), and post-installation checks (installed files,
590: references to shared libraries, script interpreters).</p></li>
1.23 wiz 591: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 592: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 593: pkgsrc has been ported to many operating systems. Care is taken that
594: packages behave the same on all platforms.</p></li>
595: </ul></div>
596: </div>
1.41 asau 597: <div class="sect2">
1.1 dsieger 598: <div class="titlepage"><div><div><h3 class="title">
599: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
600: <p>pkgsrc consists of both a source distribution and a binary
601: distribution for these operating systems. After retrieving the required
602: source or binaries, you can be up and running with pkgsrc in just
603: minutes!</p>
604: <p>pkgsrc was derived from FreeBSD's ports system, and
605: initially developed for NetBSD only. Since then, pkgsrc has
606: grown a lot, and now supports the following platforms:</p>
607: <div class="table">
608: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 609: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 610: <colgroup>
611: <col>
612: <col>
1.92 sevan 613: <col>
1.1 dsieger 614: </colgroup>
615: <thead><tr>
616: <th>Platform</th>
617: <th>Date Support Added</th>
1.92 sevan 618: <th>Notes</th>
1.1 dsieger 619: </tr></thead>
620: <tbody>
621: <tr>
1.174 leot 622: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 623: <td align="center">Aug 1997</td>
1.92 sevan 624: <td class="auto-generated"> </td>
1.1 dsieger 625: </tr>
626: <tr>
1.10 hubertf 627: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 628: <td align="center">Mar 1999</td>
1.151 sevan 629: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1 dsieger 630: </tr>
631: <tr>
1.174 leot 632: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 633: <td align="center">Jun 1999</td>
1.151 sevan 634: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1 dsieger 635: </tr>
636: <tr>
637: <td>
1.118 sevan 638: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 639: </td>
640: <td align="center">Oct 2001</td>
1.191 bacon 641: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.1 dsieger 642: </tr>
643: <tr>
1.174 leot 644: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 645: <td align="center">Nov 2002</td>
1.151 sevan 646: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1 dsieger 647: </tr>
648: <tr>
1.174 leot 649: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 650: <td align="center">Nov 2002</td>
1.151 sevan 651: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1 dsieger 652: </tr>
653: <tr>
1.174 leot 654: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 655: <td align="center">Dec 2002</td>
1.92 sevan 656: <td>
1.151 sevan 657: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.92 sevan 658: </td>
1.1 dsieger 659: </tr>
660: <tr>
661: <td>BSD/OS</td>
662: <td align="center">Dec 2003</td>
1.92 sevan 663: <td class="auto-generated"> </td>
1.1 dsieger 664: </tr>
665: <tr>
1.174 leot 666: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 667: <td align="center">Dec 2003</td>
1.151 sevan 668: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1 dsieger 669: </tr>
670: <tr>
671: <td>
1.174 leot 672: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 673: (Microsoft Windows Services for Unix)
674: </td>
675: <td align="center">Mar 2004</td>
1.151 sevan 676: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1 dsieger 677: </tr>
678: <tr>
1.174 leot 679: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 680: <td align="center">Oct 2004</td>
1.92 sevan 681: <td class="auto-generated"> </td>
1.1 dsieger 682: </tr>
683: <tr>
1.10 hubertf 684: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 685: <td align="center">Nov 2004</td>
1.151 sevan 686: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1 dsieger 687: </tr>
688: <tr>
1.174 leot 689: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 690: <td align="center">Apr 2007</td>
1.151 sevan 691: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1 dsieger 692: </tr>
1.23 wiz 693: <tr>
1.174 leot 694: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.23 wiz 695: <td align="center">Sep 2010</td>
1.151 sevan 696: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23 wiz 697: </tr>
1.45 obache 698: <tr>
1.174 leot 699: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 700: <td align="center">Jan 2011</td>
1.92 sevan 701: <td class="auto-generated"> </td>
1.45 obache 702: </tr>
703: <tr>
1.174 leot 704: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.45 obache 705: <td align="center">Nov 2011</td>
1.151 sevan 706: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45 obache 707: </tr>
708: <tr>
1.174 leot 709: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.45 obache 710: <td align="center">Mar 2013</td>
1.151 sevan 711: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45 obache 712: </tr>
1.58 ryoon 713: <tr>
1.174 leot 714: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.58 ryoon 715: <td align="center">Jul 2013</td>
1.261 ! maya 716: <td>Removed from pkgsrc Mar 2025</td>
1.58 ryoon 717: </tr>
1.104 sevan 718: <tr>
1.174 leot 719: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.104 sevan 720: <td align="center">Jun 2014</td>
1.229 gutterid 721: <td>Removed from pkgsrc Sep 2022</td>
1.104 sevan 722: </tr>
1.1 dsieger 723: </tbody>
724: </table></div>
725: </div>
726: <br class="table-break">
727: </div>
728: </div>
1.41 asau 729: <div class="sect1">
1.1 dsieger 730: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
731: <a name="overview"></a>1.2. Overview</h2></div></div></div>
732: <p>This document is divided into three parts. The first,
1.10 hubertf 733: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 734: describes how one can use one of the packages in the Package
735: Collection, either by installing a precompiled binary package,
736: or by building one's own copy using the NetBSD package system.
1.10 hubertf 737: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1 dsieger 738: package so it can be easily built by other NetBSD users without
739: knowing about the package's building details. The third part,
1.10 hubertf 740: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 741: is intended for those who want to understand how pkgsrc is
742: implemented.</p>
743: <p>This document is available in various formats:
1.10 hubertf 744: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1 dsieger 745: </div>
1.41 asau 746: <div class="sect1">
1.1 dsieger 747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
748: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 749: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
750: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 751: terminology used within this document.</p>
1.41 asau 752: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 753: <dt><span class="term">Package</span></dt>
754: <dd><p>A set of files and building instructions
755: that describe what's necessary
756: to build a certain piece of software using
757: pkgsrc. Packages are traditionally stored under
1.123 wiz 758: <code class="filename">/usr/pkgsrc</code>,
759: but may be stored in any location,
760: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1 dsieger 761: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 762: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 763: is part of the NetBSD operating system and can be bootstrapped
764: to run on non-NetBSD operating systems as well. It handles
765: building (compiling), installing, and removing of
766: packages.</p></dd>
767: <dt><span class="term">Distfile</span></dt>
768: <dd><p>This term describes the file or files that are
769: provided by the author of the piece of software to
770: distribute his work. All the changes necessary to build on
771: NetBSD are reflected in the corresponding package. Usually
772: the distfile is in the form of a compressed tar-archive,
773: but other types are possible, too. Distfiles are usually
774: stored below
775: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
776: <dt><span class="term">Port</span></dt>
777: <dd><p>This is the term used by FreeBSD and OpenBSD people
778: for what we call a package.
1.23 wiz 779: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 780: architecture.</p></dd>
781: <dt><span class="term">Precompiled/binary package</span></dt>
782: <dd>
783: <p>A set of binaries built with pkgsrc from a distfile
784: and stuffed together in a single <code class="filename">.tgz</code>
785: file so it can be installed on machines of the same
786: machine architecture without the need to
787: recompile. Packages are usually generated in
788: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 789: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 790: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 791: especially in the context of precompiled packages.</p>
792: </dd>
793: <dt><span class="term">Program</span></dt>
794: <dd><p>The piece of software to be installed which will be
795: constructed from all the files in the distfile by the
796: actions defined in the corresponding package.</p></dd>
797: </dl></div>
1.41 asau 798: <div class="sect2">
1.1 dsieger 799: <div class="titlepage"><div><div><h3 class="title">
800: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 801: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 802: <dt><span class="term">pkgsrc users</span></dt>
803: <dd>
804: <p>The
805: pkgsrc users are people who use the packages provided by pkgsrc.
806: Typically they are system administrators. The people using the
1.23 wiz 807: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
808: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 809: <p>There are two kinds of pkgsrc users: Some only want to
810: install pre-built binary packages. Others build the pkgsrc
811: packages from source, either for installing them directly or for
1.10 hubertf 812: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.1 dsieger 813: documentation.</p>
814: </dd>
815: <dt><span class="term">package maintainers</span></dt>
816: <dd><p>A
1.10 hubertf 817: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.1 dsieger 818: <dt><span class="term">infrastructure developers</span></dt>
819: <dd><p>These people are involved in all those files
820: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 821: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.1 dsieger 822: too.</p></dd>
823: </dl></div>
824: </div>
825: </div>
1.41 asau 826: <div class="sect1">
1.1 dsieger 827: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
828: <a name="typography"></a>1.4. Typography</h2></div></div></div>
829: <p>When giving examples for commands, shell prompts are used to
830: show if the command should/can be issued as root, or if
1.23 wiz 831: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 832: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
833: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.229 gutterid 834: Bourne shell and derivatives.</p>
1.1 dsieger 835: </div>
836: </div>
1.41 asau 837: <div class="part">
1.1 dsieger 838: <div class="titlepage"><div><div><h1 class="title">
839: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
840: <div class="toc">
841: <p><b>Table of Contents</b></p>
1.100 leot 842: <dl class="toc">
1.154 rillig 843: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
844: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1 dsieger 845: <dd><dl>
1.154 rillig 846: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 847: <dd><dl>
1.154 rillig 848: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
849: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 850: </dl></dd>
1.154 rillig 851: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 852: <dd><dl>
1.154 rillig 853: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
854: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 855: </dl></dd>
856: </dl></dd>
1.154 rillig 857: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 858: <dd><dl>
1.154 rillig 859: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
860: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 861: </dl></dd>
1.154 rillig 862: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 863: <dd><dl>
1.154 rillig 864: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 865: <dd><dl>
1.154 rillig 866: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
867: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 868: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
869: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
870: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
871: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
872: <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>
873: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1 dsieger 874: </dl></dd>
1.154 rillig 875: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 876: <dd><dl>
1.154 rillig 877: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
878: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
879: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 880: </dl></dd>
881: </dl></dd>
1.154 rillig 882: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 883: <dd><dl>
1.154 rillig 884: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
885: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 886: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
887: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
888: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
889: <dd><dl>
890: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
891: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
892: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 893: </dl></dd>
1.241 rillig 894: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
895: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 896: </dl></dd>
1.154 rillig 897: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 898: <dd><dl>
1.154 rillig 899: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
900: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 901: </dl></dd>
1.154 rillig 902: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 903: builds)</a></span></dt>
1.1 dsieger 904: <dd><dl>
1.154 rillig 905: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 906: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 907: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
908: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 909: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
910: <dd><dl>
1.179 rillig 911: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
912: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.181 rillig 913: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
914: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
915: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
916: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
917: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
918: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
919: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
920: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 921: </dl></dd>
922: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
923: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 924: </dl></dd>
925: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
926: <dd><dl>
927: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
928: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
929: </dl></dd>
930: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
931: <dd><dl>
932: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
933: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
934: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
935: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
936: <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>
937: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
938: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
939: <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>
940: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
941: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 942: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 943: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.221 nia 944: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 945: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
946: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
947: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
948: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
949: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 950: </dl></dd>
951: </dl>
952: </div>
1.41 asau 953: <div class="chapter">
1.1 dsieger 954: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 955: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
956: <p>
957: To get help when using pkgsrc, the definitive source is this
958: document, the pkgsrc guide. If you don't find anything here,
959: there are alternatives:
960: </p>
961: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
962: <li class="listitem">
963: <p>
964: The built-in pkgsrc help, which is available after bootstrapping
965: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
966: help for any topic, such as a variable name like
967: <code class="varname">BUILD_DEFS</code>, a make target like
968: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
969: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.207 leot 970: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.154 rillig 971: </li>
972: <li class="listitem"><p>
1.163 rillig 973: To see the value of a single variable, run <span class="command"><strong>bmake
974: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
975: </p></li>
976: <li class="listitem"><p>
977: To see the values of the most common variables, run
978: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
979: topic. To see the variables for a single topic, run
980: <span class="command"><strong>bmake
981: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
982: <span class="command"><strong>bmake show-all-fetch</strong></span>.
983: </p></li>
984: <li class="listitem"><p>
1.154 rillig 985: The pkgsrc-users mailing list, to which
986: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
987: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
988: questions</a>.</p></li>
989: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
990: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
991: or by using a specialized chat program such as
992: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
993: Pick any user name and join the channel #pkgsrc.</p></li>
994: </ul></div>
995: </div>
996: <div class="chapter">
997: <div class="titlepage"><div><div><h2 class="title">
998: <a name="getting"></a>Chapter 3. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
1.1 dsieger 999: <div class="toc">
1000: <p><b>Table of Contents</b></p>
1.100 leot 1001: <dl class="toc">
1.154 rillig 1002: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 1003: <dd><dl>
1.154 rillig 1004: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
1005: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 1006: </dl></dd>
1.154 rillig 1007: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 1008: <dd><dl>
1.154 rillig 1009: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
1010: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 1011: </dl></dd>
1012: </dl>
1013: </div>
1014: <p>Before you download and extract the files, you need to decide
1015: where you want to extract them. When using pkgsrc as root user, pkgsrc
1016: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
1017: free to install the sources and binary packages wherever you want in
1018: your filesystem, provided that the pathname does not contain white-space
1019: or other characters that are interpreted specially by the shell and some
1020: other programs. A safe bet is to use only letters, digits, underscores
1021: and dashes.</p>
1.41 asau 1022: <div class="sect1">
1.1 dsieger 1023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1024: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 1025: <p>Before you download any pkgsrc files, you should decide
1026: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1027: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1028: quarterly basis from the current branch and only gets modified
1029: for security updates. The names of the stable branches are built
1030: from the year and the quarter, for example
1.259 leot 1031: <code class="literal">2024Q4</code>.</p>
1.1 dsieger 1032: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 1033: want to download pkgsrc. You can get it as a tar file or via CVS.
1034: Both ways are described here.</p>
1.51 asau 1035: <p>Note that tar archive contains CVS working copy.
1036: Thus you can switch to using CVS at any later time.</p>
1.41 asau 1037: <div class="sect2">
1.1 dsieger 1038: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1039: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 1040: <p>The primary download location for all pkgsrc files is
1.151 sevan 1041: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 1042: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1043: (it points to the same location).
1044: There are a number of subdirectories for different purposes,
1.207 leot 1045: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix D. Directory layout of the pkgsrc FTP server">Appendix D, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.51 asau 1046: <p>The tar archive for the current branch is in the directory
1.151 sevan 1047: <code class="filename">current</code> and is called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.118 sevan 1048: It is autogenerated weekly.</p>
1.51 asau 1049: <p>To save download time we provide bzip2- and
1050: xz-compressed archives which are published at
1.151 sevan 1051: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
1.51 asau 1052: and
1.151 sevan 1053: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
1.51 asau 1054: respectively.
1055: </p>
1056: <p>You can fetch the same files using FTP.</p>
1.259 leot 1057: <p>The tar file for the stable branch 2024Q4 is in the
1058: 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.136 leot 1059: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 1060: <pre class="screen">
1.259 leot 1061: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2024Q4/pkgsrc.tar.gz</code></strong></pre>
1.78 snj 1062: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1063: or your web browser.</p>
1.12 weinem 1064: <p>Then, extract it with:</p>
1.78 snj 1065: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1066: <p>This will create the directory <code class="filename">pkgsrc/</code>
1067: in <code class="filename">/usr/</code> and all the package source will be
1068: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1069: <p>To download pkgsrc-current, run:</p>
1070: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1 dsieger 1071: </div>
1.41 asau 1072: <div class="sect2">
1.1 dsieger 1073: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1074: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1075: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.259 leot 1076: <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.23 wiz 1077: </pre>
1078: <p>This will create the directory <code class="filename">pkgsrc/</code>
1079: in your <code class="filename">/usr/</code> directory and all the package source
1080: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1081: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1082: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1083: </pre>
1.174 leot 1084: <p>Refer to the <a class="ulink" href="https://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23 wiz 1085: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39 wiz 1086: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23 wiz 1087: </pre>
1088: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1089: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1090: or better globally in <code class="filename">/etc/profile</code>:</p>
1091: <pre class="programlisting">
1092: # set CVS remote shell command
1093: CVS_RSH=ssh
1094: export CVS_RSH
1095: </pre>
1096: <p>By default, CVS doesn't do things like most people would expect it to do.
1097: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1098: in your home directory and saving the following lines to it.
1099: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1100: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1101: <pre class="programlisting">
1102: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1103: cvs -q
1.2 rillig 1104: checkout -P
1.4 rillig 1105: update -dP
1106: diff -upN
1.2 rillig 1107: rdiff -u
1.23 wiz 1108: release -d
1.2 rillig 1109: </pre>
1.1 dsieger 1110: </div>
1111: </div>
1.41 asau 1112: <div class="sect1">
1.1 dsieger 1113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1114: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1115: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1116: (which also works if you have first installed it via a tar
1117: file). It saves bandwidth and hard disk activity, compared to
1118: downloading the tar file again.</p>
1.41 asau 1119: <div class="sect2">
1.1 dsieger 1120: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1121: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1122: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1123: <h3 class="title">Warning</h3>
1124: <p>When updating from a tar file, you first need to
1125: completely remove the old pkgsrc directory. Otherwise those
1126: files that have been removed from pkgsrc in the mean time will
1127: not be removed on your local disk, resulting in inconsistencies.
1128: When removing the old files, any changes that you have done to
1129: the pkgsrc files will be lost after updating. Therefore updating
1130: via CVS is strongly recommended.</p>
1131: </div>
1132: <p>Note that by default the distfiles and the binary packages
1133: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1134: before updating. You can also configure pkgsrc to store distfiles
1135: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1136: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154 rillig 1137: variables. See <a class="xref" href="#configuring" title="Chapter 6. Configuring pkgsrc">Chapter 6, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1 dsieger 1138: <p>To update pkgsrc from a tar file, download the tar file as
1139: explained above. Then, make sure that you have not made any
1140: changes to the files in the pkgsrc directory. Remove the pkgsrc
1141: directory and extract the new tar file. Done.</p>
1142: </div>
1.41 asau 1143: <div class="sect2">
1.1 dsieger 1144: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1145: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1146: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1147: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1148: </pre>
1149: <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>
1150: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1151: </pre>
1.41 asau 1152: <div class="sect3">
1.1 dsieger 1153: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1154: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1155: <p>When updating pkgsrc, the CVS program keeps track of the
1156: branch you selected. But if you, for whatever reason, want to
1157: switch from the stable branch to the current one, you can do it
1.23 wiz 1158: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1159: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1160: back to the stable branch, add the
1.259 leot 1161: <span class="quote">“<span class="quote">-rpkgsrc-2024Q4</span>”</span> option.</p>
1.1 dsieger 1162: </div>
1.41 asau 1163: <div class="sect3">
1.1 dsieger 1164: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1165: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1166: <p>When you update pkgsrc, the CVS program will only touch
1167: those files that are registered in the CVS repository. That
1168: means that any packages that you created on your own will stay
1169: unmodified. If you change files that are managed by CVS, later
1170: updates will try to merge your changes with those that have been
1171: done by others. See the CVS manual, chapter
1.23 wiz 1172: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1173: </div>
1174: </div>
1175: </div>
1176: </div>
1.41 asau 1177: <div class="chapter">
1.1 dsieger 1178: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1179: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1180: <div class="toc">
1181: <p><b>Table of Contents</b></p>
1.100 leot 1182: <dl class="toc">
1.154 rillig 1183: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1184: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1185: </dl>
1186: </div>
1.41 asau 1187: <div class="sect1">
1.1 dsieger 1188: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1189: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1190: <p>See <a class="xref" href="#using-pkg" title="5.1. Using binary packages">Section 5.1, “Using binary packages”</a>.</p>
1.1 dsieger 1191: </div>
1.41 asau 1192: <div class="sect1">
1.1 dsieger 1193: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1194: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1195: <p>pkgsrc can be bootstrapped for use in two different modes:
1196: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1197: to privileged one all programs are installed under one particular user
1.43 asau 1198: and cannot utilise privileged operations (packages don't create
1199: special users and all special file permissions like setuid are ignored).
1200: </p>
1.1 dsieger 1201: <p>Installing the bootstrap kit from source should be as simple as:</p>
1202: <pre class="screen">
1.60 asau 1203: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1204: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1205: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1206: </pre>
1.43 asau 1207: <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>
1208: <p>By default, in privileged mode pkgsrc uses
1209: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1210: where programs will be installed in,
1.118 sevan 1211: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1212: directory where pkgsrc will do its internal bookkeeping,
1213: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1214: where packages install their persistent data.
1215: In unprivileged mode pkgsrc uses
1216: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1217: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1218: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1219: </p>
1220: <p>You can change default layout using command-line arguments.
1221: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1222: </p>
1.41 asau 1223: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1224: <h3 class="title">Note</h3>
1.10 hubertf 1225: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1226: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1227: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1228: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1229: </div>
1.43 asau 1230: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1231: <h3 class="title">Note</h3>
1232: <p>It is possible to bootstrap multiple instances of pkgsrc
1233: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1234: corresponding to the installation you're working with to build
1235: and install packages.
1236: </p>
1237: </div>
1.1 dsieger 1238: </div>
1239: </div>
1.41 asau 1240: <div class="chapter">
1.1 dsieger 1241: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1242: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1243: <div class="toc">
1244: <p><b>Table of Contents</b></p>
1.100 leot 1245: <dl class="toc">
1.154 rillig 1246: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1247: <dd><dl>
1.154 rillig 1248: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1249: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 1250: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1251: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1252: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1253: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1254: <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>
1255: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.154 rillig 1256: </dl></dd>
1257: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1258: <dd><dl>
1259: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1260: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1261: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 1262: </dl></dd>
1263: </dl>
1264: </div>
1265: <p>Basically, there are two ways of using pkgsrc. The first
1266: is to only install the package tools and to use binary packages
1.23 wiz 1267: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1268: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1269: of pkgsrc, too. Then you are able to build your own packages,
1270: and you can still use binary packages from someone else.</p>
1.41 asau 1271: <div class="sect1">
1.1 dsieger 1272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1273: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.202 nia 1274: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.151 sevan 1275: site and mirrors, there are collections of binary packages,
1.9 rillig 1276: ready to be installed. These binary packages have been built using the
1277: default settings for the directories, that is:</p>
1.41 asau 1278: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1279: <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>
1280: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1281: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.9 rillig 1282: </ul></div>
1283: <p>If you cannot use these directories for whatever reasons (maybe
1284: because you're not root), you cannot use these binary packages, but
1.154 rillig 1285: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="4.2. Bootstrapping pkgsrc">Section 4.2, “Bootstrapping pkgsrc”</a>.</p>
1.41 asau 1286: <div class="sect2">
1.1 dsieger 1287: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1288: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1289: <p>To install binary packages, you first need to know from where
1290: to get them. The first place where you should look is on the main
1.202 nia 1291: pkgsrc CDN in the directory <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5 weinem 1292: <p>This directory contains binary packages for multiple
1.226 gutterid 1293: platforms. First, select your operating system. Then, select your
1294: hardware architecture, and in the third step, the OS version and
1295: the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1296: <p>In this directory, you may find a file called
1.9 rillig 1297: <code class="filename">bootstrap.tar.gz</code> which contains the package
1298: management tools. If the file is missing, it is likely that your
1299: operating system already provides those tools. Download the file and
1300: extract it in the <code class="filename">/</code> directory. It will create
1301: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1302: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1303: </div>
1.41 asau 1304: <div class="sect2">
1.1 dsieger 1305: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1306: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1307: <p>In the directory from the last section, there is a
1.85 wiz 1308: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1309: binary packages that are available for the platform, excluding those
1.202 nia 1310: that may not be distributed via HTTP or FTP.</p>
1.9 rillig 1311: <p>To install packages directly from an FTP or HTTP server, run
1312: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1313: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1314: <pre class="screen">
1.202 nia 1315: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1316: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.169 rillig 1317: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="$PKG_PATH/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.9 rillig 1318: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.202 nia 1319: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.9 rillig 1320: </pre>
1321: <p>Instead of URLs, you can also use local paths, for example if
1322: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1323: repository. If you want to install packages from multiple sources,
1324: you can separate them by a semicolon in
1325: <code class="varname">PKG_PATH</code>.</p>
1326: <p>After these preparations, installing a package is very
1327: easy:</p>
1328: <pre class="screen">
1.202 nia 1329: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1330: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1331: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1332: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1333: </pre>
1334: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1335: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1336: <p>Any prerequisite packages needed to run the
1.1 dsieger 1337: package in question will be installed, too, assuming they are
1.202 nia 1338: present in the repository.</p>
1.1 dsieger 1339: <p>After you've installed packages, be sure to have
1340: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1341: <code class="varname">PATH</code> so you can actually start the just
1342: installed program.</p>
1343: </div>
1.41 asau 1344: <div class="sect2">
1.1 dsieger 1345: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1346: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1347: <p>To update binary packages, it is recommended that you use
1348: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1349: package repository to your locally installed packages and safely
1350: replace any older packages.</p>
1351: <p>Note that pkgsrc is released as quarterly branches.
1352: If you are updating to a newer quarterly branch of pkgsrc, you may
1353: need to adjust the repository in
1354: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1355: </div>
1356: <div class="sect2">
1357: <div class="titlepage"><div><div><h3 class="title">
1358: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1359: <p>To deinstall a package, it does not matter whether it was
1.202 nia 1360: installed from source code or from a binary package. Neither the
1361: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1362: command need to know.</p>
1363: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.1 dsieger 1364: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.202 nia 1365: name can be given with or without version number.</p>
1.1 dsieger 1366: </div>
1.41 asau 1367: <div class="sect2">
1.1 dsieger 1368: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1369: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1370: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.202 nia 1371: installed packages or binary package files.
1372: As with other management tools, it works with packages installed
1373: from source or binaries.</p>
1.1 dsieger 1374: </div>
1.41 asau 1375: <div class="sect2">
1.1 dsieger 1376: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1377: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1378: <p>
1.164 leot 1379: The pkgsrc Security Team and Packages Groups maintain a list of
1.202 nia 1380: known vulnerabilities to packages which are (or have been)
1.1 dsieger 1381: included in pkgsrc. The list is available from the NetBSD
1.202 nia 1382: 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>.
1383: </p>
1384: <p>
1385: Please note that not every "vulnerability" with a CVE assignment is
1386: exploitable in every configuration.
1387: Some bugs are marked as active simply because an fix was not
1388: marked as such.
1389: Operating system specific hardening and mitigation features may also
1390: reduce the impact of bugs.
1.1 dsieger 1391: </p>
1392: <p>
1.22 jakllsch 1393: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1394: this list can be downloaded
1395: automatically, and a security audit of all packages installed on a system
1396: can take place.
1397: </p>
1398: <p>
1.22 jakllsch 1399: There are two components to auditing. The first
1400: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1401: is for downloading
1.1 dsieger 1402: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1403: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1404: installed packages are vulnerable. If a package is vulnerable, you
1405: will see output similar to the following:
1406: </p>
1407: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1408: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.1 dsieger 1409: <p>
1.22 jakllsch 1410: You may wish to have the
1.202 nia 1411: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1412: file downloaded daily so that
1413: it remains current. This may be done by adding an appropriate entry
1.259 leot 1414: 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.22 jakllsch 1415: </p>
1416: <pre class="screen">
1.121 sevan 1417: # Download vulnerabilities file
1.118 sevan 1418: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1419: # Audit the installed packages and email results to root
1420: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1421: root >/dev/null 2>&1
1.22 jakllsch 1422: </pre>
1423: <p>
1.118 sevan 1424: will update the vulnerability list every day at 3AM, followed by an audit
1425: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1426:
1.118 sevan 1427: On NetBSD this may be accomplished instead by adding the following
1428: line to <code class="filename">/etc/daily.conf</code>:
1429: </p>
1430: <pre class="screen">
1431: fetch_pkg_vulnerabilities=YES
1432: </pre>
1433: <p>
1434: to fetch the vulnerability list from the daily security script. The system
1435: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1436: desired (not required), by adding the following line to
1.118 sevan 1437: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1438: </p>
1439: <pre class="screen">
1.118 sevan 1440: check_pkg_vulnerabilities=YES
1.22 jakllsch 1441: </pre>
1442: <p>
1.259 leot 1443: 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.1 dsieger 1444: </p>
1445: </div>
1.41 asau 1446: <div class="sect2">
1.1 dsieger 1447: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1448: <a name="pkg_versions"></a>5.1.7. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.1 dsieger 1449: <p>
1.207 leot 1450: Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23 wiz 1451: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.202 nia 1452: argument to check if any packages are stale, e.g.
1.1 dsieger 1453: </p>
1454: <pre class="screen">
1455: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1456: ...
1457: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1458: </pre>
1459: </div>
1.41 asau 1460: <div class="sect2">
1.1 dsieger 1461: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1462: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.10 hubertf 1463: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1464: administrative functions on the package system.</p>
1465: </div>
1466: </div>
1.41 asau 1467: <div class="sect1">
1.1 dsieger 1468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1469: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1 dsieger 1470: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1471: directory now contains a set of packages, organized into
1472: categories. You can browse the online index of packages, or run
1.10 hubertf 1473: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1474: directory to build local <code class="filename">README.html</code> files for
1.207 leot 1475: all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/index.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.1 dsieger 1476: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1477: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1478: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1479: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1480: different <code class="varname">LOCALBASE</code> definitions on the same
1481: system (inside a chroot is an exception). </p>
1482: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1483: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.1 dsieger 1484: instructions how to create your own packages.</p>
1.41 asau 1485: <div class="sect2">
1.1 dsieger 1486: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1487: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1 dsieger 1488: <p>To build packages from source, you need a working C
1489: compiler. On NetBSD, you need to install the
1.23 wiz 1490: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1491: sets. If you want to build X11-related packages, the
1.23 wiz 1492: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1493: sets are required, too.</p>
1494: </div>
1.41 asau 1495: <div class="sect2">
1.1 dsieger 1496: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1497: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1 dsieger 1498: <p>The first step for building a package is downloading the
1499: distfiles (i.e. the unmodified source). If they have not yet been
1500: downloaded, pkgsrc will fetch them automatically.</p>
1501: <p>If you have all files that you need in the
1502: <code class="filename">distfiles</code> directory,
1503: you don't need to connect. If the distfiles are on CD-ROM, you can
1504: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1505: </p>
1506: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1507: <p>
1.10 hubertf 1508: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1509: <p>By default a list of distribution sites will be randomly
1510: intermixed to prevent huge load on servers which holding popular
1511: packages (for example, SourceForge.net mirrors). Thus, every
1512: time when you need to fetch yet another distfile all the mirrors
1513: will be tried in new (random) order. You can turn this feature
1514: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1515: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1516: <p>You can overwrite some of the major distribution sites to
1517: fit to sites that are close to your own. By setting one or two
1518: variables you can modify the order in which the master sites are
1519: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1520: delimited list of domain suffixes.
1521: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1522: contains a whitespace delimited list of regular expressions. It
1523: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1524: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1525: some examples. This may save some of your bandwidth and
1526: time.</p>
1527: <p>You can change these settings either in your shell's environment, or,
1528: if you want to keep the settings, by editing the
1.10 hubertf 1529: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1530: and adding the definitions there.</p>
1531: <p>
1532: If a package depends on many other packages (such as
1.207 leot 1533: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.1 dsieger 1534: alternate between periods of
1535: downloading source, and compiling. To ensure you have all the source
1536: downloaded initially you can run the command:
1537: </p>
1538: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1539: <p>
1540: which will output and run a set of shell commands to fetch the
1541: necessary files into the <code class="filename">distfiles</code> directory. You can
1542: also choose to download the files manually.
1543: </p>
1544: </div>
1.41 asau 1545: <div class="sect2">
1.1 dsieger 1546: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1547: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1 dsieger 1548: <p>
1549: Once the software has downloaded, any patches will be applied, then it
1550: will be compiled for you. This may take some time depending on your
1551: computer, and how many other packages the software depends on and their
1552: compile time.
1553: </p>
1.41 asau 1554: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1555: <h3 class="title">Note</h3>
1556: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1557: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1558: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1559: </div>
1560: <p>For example, type</p>
1561: <pre class="screen">
1562: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1563: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1564: </pre>
1565: <p>at the shell prompt to build the various components of the
1566: package.</p>
1567: <p>The next stage is to actually install the newly compiled
1568: program onto your system. Do this by entering:
1569:
1570: </p>
1571: <pre class="screen">
1572: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1573: </pre>
1574: <p>
1575:
1576: while you are still in the directory for whatever package you
1577: are installing.</p>
1578: <p>Installing the package on your system may require you to
1579: be root. However, pkgsrc has a
1580: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1581: to only become root for the actual installation step.</p>
1582: <p>That's it, the software should now be installed and setup for use.
1583: You can now enter:
1584:
1585: </p>
1586: <pre class="screen">
1587: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1588: </pre>
1589: <p>
1590:
1591: to remove the compiled files in the work directory, as you shouldn't need
1592: them any more. If other packages were also added to your system
1593: (dependencies) to allow your program to compile, you can tidy these up
1594: also with the command:</p>
1595: <pre class="screen">
1596: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1597: </pre>
1598: <p>Taking the figlet utility as an example, we can install it on our
1.207 leot 1599: system by building as shown in <a class="xref" href="#logs" title="Appendix C. Build logs">Appendix C, <i>Build logs</i></a>.</p>
1.1 dsieger 1600: <p>The program is installed under the default root of the
1601: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1602: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1603: variable in your environment, and it will use that value as the
1604: root of your packages tree. So, to use
1605: <code class="filename">/usr/local</code>, set
1606: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1607: Please note that you should use a directory which is dedicated to
1608: packages and not shared with other programs (i.e., do not try and
1609: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1610: to add any of your own files or directories (such as
1611: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1612: <code class="filename">pkgsrc/</code>) below the
1613: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1614: conflicts between programs and other files installed by the
1615: package system and whatever else may have been installed
1616: there.</p>
1.10 hubertf 1617: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1618: alter some configuration options at build time. Have a look at
1619: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1620: of what will be set there by default. Environment variables such
1621: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1622: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1623: set them each time you want to use pkgsrc.</p>
1.23 wiz 1624: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1625: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1626: or being installed. This may be for debugging purposes, or out of
1627: simple curiosity. A number of utility values have been added to
1628: help with this.</p>
1.23 wiz 1629: <div class="orderedlist"><ol class="orderedlist" type="1">
1630: <li class="listitem">
1.259 leot 1631: <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.1 dsieger 1632: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1633: information will be displayed. For example,</p>
1634: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1635: <p>will show all the commands that are invoked, up to and
1.23 wiz 1636: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1637: </li>
1.23 wiz 1638: <li class="listitem">
1.259 leot 1639: <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.1 dsieger 1640: definition, then the <code class="varname">VARNAME</code> definition
1641: should be used, in conjunction with the show-var
1.259 leot 1642: 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.1 dsieger 1643: variable <code class="varname">LOCALBASE</code>:</p>
1644: <pre class="screen">
1645: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1646: /usr/pkg
1647: <code class="prompt">%</code>
1648: </pre>
1649: </li>
1650: </ol></div>
1651: <p>If you want to install a binary package that you've either
1652: created yourself (see next section), that you put into
1653: pkgsrc/packages manually or that is located on a remote FTP
1654: server, you can use the "bin-install" target. This target will
1.259 leot 1655: 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.10 hubertf 1656: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1657: sites searched is kept in the variable
1658: <code class="varname">BINPKG_SITES</code>, which defaults to
1.259 leot 1659: 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.1 dsieger 1660: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1661: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1662: details.</p>
1663: <p>A final word of warning: If you set up a system that has a
1664: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1665: set that before any packages are installed, as you cannot use
1666: several directories for the same purpose. Doing so will result in
1667: pkgsrc not being able to properly detect your installed packages,
1668: and fail miserably. Note also that precompiled binary packages are
1669: usually built with the default <code class="varname">LOCALBASE</code> of
1670: <code class="filename">/usr/pkg</code>, and that you should
1671: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1672: <code class="varname">LOCALBASE</code>.</p>
1673: </div>
1674: </div>
1675: </div>
1.41 asau 1676: <div class="chapter">
1.1 dsieger 1677: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1678: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1 dsieger 1679: <div class="toc">
1680: <p><b>Table of Contents</b></p>
1.100 leot 1681: <dl class="toc">
1.154 rillig 1682: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1683: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 1684: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
1685: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
1686: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
1687: <dd><dl>
1688: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
1689: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1690: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 1691: </dl></dd>
1.241 rillig 1692: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
1693: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 1694: </dl>
1695: </div>
1.4 rillig 1696: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1697: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1698: that file depends on the installation. On NetBSD, when you use
1.259 leot 1699: <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.1 dsieger 1700: <code class="filename">/etc/</code>. In all other cases the default location is
1701: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1702: bootstrap program to install the binary packages.</p>
1703: <p>The format of the configuration file is that of the usual
1704: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1705: is done by setting variables in this file. Note that you can define all
1706: kinds of variables, and no special error checking (for example for
1.112 rillig 1707: spelling mistakes) takes place.</p>
1.41 asau 1708: <div class="sect1">
1.1 dsieger 1709: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1710: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112 rillig 1711: <p>The following variables apply to all
1.1 dsieger 1712: pkgsrc packages. A complete list of the variables that can be
1713: configured by the user is available in
1714: <code class="filename">mk/defaults/mk.conf</code>, together with some
1715: comments that describe each variable's intent.</p>
1.41 asau 1716: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1717: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1718: packages will be installed. The default is
1719: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1720: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1721: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1722: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1723: installed. The default is
1724: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1725: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1726: X11 is installed on the system. The default is
1.84 wiz 1727: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1728: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1729: downloaded copies of the original source distributions used
1730: for building pkgsrc packages. The default is
1731: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1732: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1733: database about installed packages is stored. The default is
1.118 sevan 1734: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1735: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1736: If set, override the packages'
1737: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1738: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1739: Backup location(s) for distribution files and patch files
1740: if not found locally or in
1741: <code class="filename">${MASTER_SITES}</code> or
1742: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1743: The defaults is
1744: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1745: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1746: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1747: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1748: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1749: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1750: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1751: List of acceptable licenses. License names are case-sensitive.
1752: Whenever you try to build a package whose license is not in this
1753: list, you will get an error message. If the license condition is
1754: simple enough, the error message will include specific
1755: instructions on how to change this variable.</p></li>
1.1 dsieger 1756: </ul></div>
1757: </div>
1.41 asau 1758: <div class="sect1">
1.1 dsieger 1759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1760: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1761: <p>
1.1 dsieger 1762: </p>
1.41 asau 1763: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1764: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1765: directory for the binary packages. The default is
1766: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1767: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1768: The top level directory where, if defined, the separate
1769: working directories will get created, and symbolically
1770: linked to from <code class="filename">${WRKDIR}</code> (see below).
1771: This is useful for building packages on several
1772: architectures, then <code class="filename">${PKGSRCDIR}</code>
1773: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1774: is local to every architecture. (It should be noted that
1775: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1776: — it is an internal definition which refers to the
1.1 dsieger 1777: root of the pkgsrc tree. It is possible to have many
1778: pkgsrc tree instances.)</p></li>
1.23 wiz 1779: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1780: Directory for local patches that aren't part of pkgsrc.
1.184 rillig 1781: See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> for more
1.1 dsieger 1782: information.</p></li>
1.23 wiz 1783: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1784: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1785: BSD-style Makefile. If this is not set,
1786: <code class="varname">MAKECONF</code> is set to
1787: <code class="filename">/dev/null</code> to avoid picking up
1788: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1789: </ul></div>
1790: </div>
1.41 asau 1791: <div class="sect1">
1.1 dsieger 1792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.241 rillig 1793: <a name="native-or-pkgsrc-preference"></a>6.3. Preferences for native or pkgsrc software</h2></div></div></div>
1794: <p>Whenever a package depends on a package that has a
1795: <code class="filename">builtin.mk</code> file, the dependent package can
1796: either use the built-in (native) version from the base system or the
1797: pkgsrc-provided version. This only affects dependencies, so it is
1798: 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
1799: on the native pcre++ version instead.</p>
1800: <p>To force using the pkgsrc-provided version for a particular
1801: package, define <span class="quote">“<span class="quote"><code class="varname">PREFER_PKGSRC</code> =
1802: <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
1803: using the native package, define
1804: <span class="quote">“<span class="quote"><code class="varname">PREFER_NATIVE</code> =
1805: <em class="replaceable"><code>package-ID</code></em></span>”</span>. In both cases, the
1806: <em class="replaceable"><code>package-ID</code></em> is the one from the
1807: <code class="filename">buildlink3.mk</code> of the package. In most cases,
1808: this ID is the same as the directory name of the package, but for
1809: example, <code class="filename">devel/pcre++</code> has the
1810: package ID <span class="quote">“<span class="quote">pcrexx</span>”</span>.</p>
1811: <p>For the packages that are not listed by their package ID,
1812: pkgsrc uses the pkgsrc-provided version if
1813: <code class="varname">PREFER_PKGSRC</code> contains the word
1814: <span class="quote">“<span class="quote">yes</span>”</span>. Otherwise, if <code class="varname">PREFER_NATIVE</code>
1815: contains the word <span class="quote">“<span class="quote">yes</span>”</span>, pkgsrc uses the native
1816: version. For example, to require using the pkgsrc-provided versions
1817: for all but the most basic bits on a NetBSD system, you can
1818: set:</p>
1819: <pre class="programlisting">
1820: PREFER_PKGSRC= yes
1821: PREFER_NATIVE= getopt skey tcp_wrappers
1822: </pre>
1823: <p>A package <span class="emphasis"><em>must</em></span> have a
1824: <code class="filename">builtin.mk</code> file to be listed in
1825: <code class="varname">PREFER_NATIVE</code>, otherwise it is simply ignored in
1826: that list.</p>
1827: <p><code class="varname">PREFER_PKGSRC</code> and
1828: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap to
1829: ensure that the bootstrap process does not use inapropriate native
1830: tools as dependencies for core packages.</p>
1831: <pre class="screen">
1832: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
1833: </pre>
1834: <p>Switching between settings globally at a later date can
1835: introduce complications with dependency resolution. This is caused
1836: by packages built with the opposite preference being installed
1837: alongside each other. Hence, when changing any of these variables
1838: after bootstrap, you need to rebuild all packages depending on those
1839: whose preference has been changed. This is not trivial and should
1840: be avoided.</p>
1841: <p>When using pkgsrc on Linux systems, there is high risk of
1842: <span class="quote">“<span class="quote">leakage</span>”</span>, where programs installed by pkgsrc may
1843: inadvertently use a command or library not installed by pkgsrc, e.g.
1844: those installed by yum or apt. Such foreign dependencies may be
1845: installed, removed, or upgraded to a version incompatible with the
1846: pkgsrc package at any time, causing pkgsrc packages to subsequently
1847: malfunction. Pkgsrc cannot prevent this, as it has no control over
1848: other package managers. Another potential problem is that under
1849: Redhat Enterprise and related Linux systems, yum packages are only
1850: patched and never upgraded, so eventually they may become too
1851: outdated for use by pkgsrc. Even intentionally using foreign
1852: dependencies, not considered leakage, can lead to these problems, so
1853: it is generally discouraged. In order to minimize such problems,
1854: PREFER_PKGSRC defaults to <span class="quote">“<span class="quote">yes</span>”</span> on Linux systems. This ensures that
1855: pkgsrc is aware of any changes to dependency packages and can
1856: rebuild or upgrade the entire dependency tree as needed. This
1857: default can be overridden by setting --prefer-pkgsrc to a
1858: list of packages and --prefer-native to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1859: </div>
1860: <div class="sect1">
1861: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1862: <a name="variables-affecting-installation"></a>6.4. Variables affecting the installation process</h2></div></div></div>
1.198 leot 1863: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
1.143 maya 1864: By default, binary packages of built packages are
1.150 leot 1865: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143 maya 1866: this variable to "no" prevents this.</p></li></ul></div>
1.107 jnemeth 1867: <p>Packages have to support installation into a
1.4 rillig 1868: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1869: to be built, before the actual filesystem is touched. DESTDIR
1870: support exists in two variations:</p>
1.41 asau 1871: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1872: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1873: installation and packaging is still run as root.</p></li>
1874: <li class="listitem"><p>Full DESTDIR support can run the complete
1875: build, installation and packaging as normal user. Root
1876: privileges are only needed to add packages.</p></li>
1877: </ul></div>
1.4 rillig 1878: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1879: clean</code></strong> needs to be run as root.</p>
1.17 imil 1880: <p>Considering the <code class="filename">foo/bar</code> package,
1881: DESTDIR full support can be tested using the following commands
1882:
1883: </p>
1884: <pre class="programlisting">
1885: <code class="prompt">$</code> id
1886: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1887: <code class="prompt">$</code> mkdir $HOME/packages
1888: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1889: </pre>
1890: <p>
1891:
1892: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1893: should be needed
1894:
1895: </p>
1896: <pre class="programlisting">
1.66 asau 1897: <code class="prompt">$</code> make stage-install
1.17 imil 1898: </pre>
1899: <p>
1900:
1901: Create a package without root privileges
1902:
1903: </p>
1904: <pre class="programlisting">
1.66 asau 1905: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1906: </pre>
1907: <p>
1908:
1909: For the following command, you must be able to gain root
1.259 leot 1910: 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.17 imil 1911:
1912: </p>
1913: <pre class="programlisting">
1.66 asau 1914: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1915: </pre>
1916: <p>
1917:
1918: Then, as a simple user
1919:
1920: </p>
1921: <pre class="programlisting">
1922: <code class="prompt">$</code> make clean
1923: </pre>
1924: <p>
1925:
1926: </p>
1.4 rillig 1927: </div>
1.41 asau 1928: <div class="sect1">
1.4 rillig 1929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.241 rillig 1930: <a name="conf.compiler"></a>6.5. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1931: <div class="sect2">
1.1 dsieger 1932: <div class="titlepage"><div><div><h3 class="title">
1.241 rillig 1933: <a name="selecting-the-compiler"></a>6.5.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1934: <p>By default, pkgsrc will use GCC to build packages. This may be
1935: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1936: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1937: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1938: <dd>
1939: <p>This is a list of values specifying the chain of
1940: compilers to invoke when building packages. Valid values
1941: are:</p>
1.41 asau 1942: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1943: <li class="listitem"><p><code class="varname">ccc</code>:
1944: Compaq C Compilers (Tru64)</p></li>
1945: <li class="listitem"><p><code class="varname">ccache</code>:
1946: compiler cache (chainable)</p></li>
1947: <li class="listitem"><p><code class="varname">clang</code>:
1948: Clang C and Objective-C compiler</p></li>
1.23 wiz 1949: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1950: distributed C/C++ (chainable)</p></li>
1.66 asau 1951: <li class="listitem"><p><code class="varname">f2c</code>:
1952: Fortran 77 to C compiler (chainable)</p></li>
1953: <li class="listitem"><p><code class="varname">icc</code>:
1954: Intel C++ Compiler (Linux)</p></li>
1955: <li class="listitem"><p><code class="varname">ido</code>:
1956: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1957: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1958: GNU C/C++ Compiler</p></li>
1.66 asau 1959: <li class="listitem"><p><code class="varname">hp</code>:
1960: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1961: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1962: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1963: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1964: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1965: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1966: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1967: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1968: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1969: </ul></div>
1970: <p>The default is
1.23 wiz 1971: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1972: <code class="varname">ccache</code> and/or
1973: <code class="varname">distcc</code> with an appropriate
1974: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1975: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1976: variable should always be terminated with a value for
1977: a real compiler. Note that only one real compiler
1.23 wiz 1978: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1979: is not allowed).</p>
1980: </dd>
1981: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1982: <dd><p>This specifies the minimum version of GCC to use
1983: when building packages. If the system GCC doesn't
1984: satisfy this requirement, then pkgsrc will build and
1985: install one of the GCC packages to use instead.</p></dd>
1.153 leot 1986: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114 maya 1987: <dd><p>Specifies which version of python to use when several
1988: options are available.</p></dd>
1989: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.176 gutterid 1990: <dd><p>Specifies the Fortran compiler to use.
1991: The default is <code class="varname">gfortran</code>.</p></dd>
1.114 maya 1992: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1993: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1994: <code class="varname">gfortran</code> is used, this option specifies which
1995: version to use.</p></dd>
1.1 dsieger 1996: </dl></div>
1997: </div>
1.41 asau 1998: <div class="sect2">
1.1 dsieger 1999: <div class="titlepage"><div><div><h3 class="title">
1.241 rillig 2000: <a name="conf.cflags"></a>6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2001: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2002: please make sure to use the <code class="literal">+=</code> operator
2003: instead of the <code class="literal">=</code> operator:</p>
2004: <pre class="programlisting">
2005: CFLAGS+= -your -flags
2006: </pre>
2007: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 2008: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 2009: need to add their own flags. You may want to take a look
1.207 leot 2010: at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23 wiz 2011: package if you're interested in optimization specifically
2012: for the current CPU. </p>
1.1 dsieger 2013: </div>
1.41 asau 2014: <div class="sect2">
1.1 dsieger 2015: <div class="titlepage"><div><div><h3 class="title">
1.241 rillig 2016: <a name="conf.ldflags"></a>6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2017: <p>If you want to pass flags to the linker, both in the configure
2018: step and the build step, you can do this in two ways. Either set
2019: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2020: between the two is that <code class="varname">LIBS</code> will be appended to
2021: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2022: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2023: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2024: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2025: <code class="varname">CFLAGS</code>, if you do not wish to override these
2026: settings, use the <code class="literal">+=</code> operator:</p>
2027: <pre class="programlisting">
2028: LDFLAGS+= -your -linkerflags
2029: </pre>
2030: </div>
2031: </div>
1.41 asau 2032: <div class="sect1">
1.1 dsieger 2033: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.241 rillig 2034: <a name="developer-advanced-settings"></a>6.6. Developer/advanced settings</h2></div></div></div>
1.84 wiz 2035: <p>
1.1 dsieger 2036: </p>
1.41 asau 2037: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2038: <li class="listitem">
1.1 dsieger 2039: <p><code class="varname">PKG_DEVELOPER</code>:
1.232 gutterid 2040: Run some sanity checks that package developers want:
2041: </p>
1.41 asau 2042: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2043: <li class="listitem"><p>make sure patches apply with zero
1.232 gutterid 2044: fuzz</p></li>
1.23 wiz 2045: <li class="listitem"><p>run check-shlibs to see that all
1.232 gutterid 2046: binaries will find their shared libs.</p></li>
1.1 dsieger 2047: </ul></div>
2048: </li>
1.232 gutterid 2049: <li class="listitem"><p><code class="varname">CHECK_FILES_STRICT</code>:
2050: Also check <code class="varname">VARBASE</code> and <code class="varname">PKG_SYSCONFDIR
2051: </code> values in PLIST entries.
2052: </p></li>
1.23 wiz 2053: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.232 gutterid 2054: of debugging output which is displayed whilst making and
2055: installing the package. The default value for this is 0,
2056: which will not display the commands as they are executed
2057: (normal, default, quiet operation); the value 1 will display
2058: all shell commands before their invocation, and the value 2
2059: will display both the shell commands before their invocation,
2060: as well as their actual execution progress with <span class="command"><strong>set
2061: -x</strong></span>.</p></li>
1.1 dsieger 2062: </ul></div>
2063: <p>
2064: </p>
2065: </div>
1.41 asau 2066: <div class="sect1">
1.1 dsieger 2067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.241 rillig 2068: <a name="selecting-build-options"></a>6.7. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2069: <p>Some packages have build time options, usually to select
2070: between different dependencies, enable optional support for big
2071: dependencies or enable experimental features.</p>
2072: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2073: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2074: show-options</strong></span>, for example:</p>
2075: <pre class="programlisting">
2076: The following options are supported by this package:
2077: ssl Enable SSL support.
2078: Exactly one of the following gecko options is required:
2079: firefox Use firefox as gecko rendering engine.
2080: mozilla Use mozilla as gecko rendering engine.
2081: At most one of the following database options may be selected:
2082: mysql Enable support for MySQL database.
2083: pgsql Enable support for PostgreSQL database.
2084:
2085: These options are enabled by default: firefox
2086: These options are currently enabled: mozilla ssl
2087: </pre>
2088: <p>The following variables can be defined in
1.10 hubertf 2089: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2090: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2091: which can be used to select or disable options for all packages
2092: that support them, and
2093: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2094: which can be used to select or disable options specifically for
2095: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 2096: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2097: are disabled. A few examples:</p>
2098: <pre class="screen">
1.10 hubertf 2099: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1 dsieger 2100: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2101: PKG_OPTIONS.kdebase= debug -sasl
2102: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2103: <p>It is important to note that options that were specifically
1.18 snj 2104: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2105: you do not wish to include the option. If you are unsure you can view
2106: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2107: <p>The following settings are consulted in the order given, and
2108: the last setting that selects or disables an option is
2109: used:</p>
1.23 wiz 2110: <div class="orderedlist"><ol class="orderedlist" type="1">
2111: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2112: maintainer</p></li>
1.23 wiz 2113: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2114: variables (see below)</p></li>
1.23 wiz 2115: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2116: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2117: </ol></div>
2118: <p>For groups of mutually exclusive options, the last option
2119: selected is used, all others are automatically disabled. If an
2120: option of the group is explicitly disabled, the previously
2121: selected option, if any, is used. It is an error if no option
2122: from a required group of options is selected, and building the
2123: package will fail.</p>
2124: <p>Before the options framework was introduced, build options
2125: were selected by setting a variable (often named
2126: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2127: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2128: transition to the options framework for the user, these legacy
2129: variables are converted to the appropriate options setting
2130: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2131: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2132: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2133: directly. Support for the legacy variables will be removed
2134: eventually.</p>
2135: </div>
2136: </div>
1.41 asau 2137: <div class="chapter">
1.1 dsieger 2138: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2139: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1 dsieger 2140: <div class="toc">
2141: <p><b>Table of Contents</b></p>
1.100 leot 2142: <dl class="toc">
1.154 rillig 2143: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2144: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.1 dsieger 2145: </dl>
2146: </div>
1.41 asau 2147: <div class="sect1">
1.1 dsieger 2148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2149: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1 dsieger 2150: <p>Once you have built and installed a package, you can create
2151: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.259 leot 2152: 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.1 dsieger 2153: the same package on a group of hosts and wasting CPU time. It also
2154: provides a simple means for others to install your package, should
2155: you distribute it.</p>
2156: <p>To create a binary package, change into the appropriate
1.10 hubertf 2157: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2158: package</strong></span>:</p>
2159: <pre class="screen">
1.112 rillig 2160: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2161: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2162: </pre>
1.242 gutterid 2163: <p>This will build your package (if not already done) and package
2164: it into a binary package. You can then use the
2165: <span class="command"><strong>pkg_*</strong></span> tools to manipulate it. Binary packages are
2166: created in <code class="varname">PACKAGES</code>, which defaults to
2167: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a compressed
2168: tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a continuation of
2169: 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>
2170: example.</p>
1.154 rillig 2171: <p>See <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a> for information on how to submit
1.1 dsieger 2172: such a binary package.</p>
2173: </div>
1.41 asau 2174: <div class="sect1">
1.1 dsieger 2175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2176: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.184 rillig 2177: <p>See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a>.</p>
1.6 rillig 2178: </div>
2179: </div>
1.41 asau 2180: <div class="chapter">
1.6 rillig 2181: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2182: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 2183: builds)</h2></div></div></div>
2184: <div class="toc">
2185: <p><b>Table of Contents</b></p>
1.100 leot 2186: <dl class="toc">
1.154 rillig 2187: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 2188: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 2189: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2190: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 2191: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2192: <dd><dl>
1.179 rillig 2193: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2194: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.181 rillig 2195: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
2196: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
2197: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
2198: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
2199: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
2200: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
2201: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
2202: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 2203: </dl></dd>
2204: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2205: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2206: </dl>
2207: </div>
1.175 gutterid 2208: <p>For a number of reasons, you may want to build binary packages
2209: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.71 wiz 2210: For instance, when you have multiple machines that should run the same software,
2211: it is wasted time if they all build their packages themselves from source.
2212: Or you may want to build a list of packages you want and check them before
1.175 gutterid 2213: deploying onto production systems.
1.71 wiz 2214: There is a way of getting a set of binary packages:
1.175 gutterid 2215: the bulk build system, or pbulk ("p" stands for "parallel").
1.112 rillig 2216: This chapter describes how to set it up.</p>
1.41 asau 2217: <div class="sect1">
1.6 rillig 2218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2219: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71 wiz 2220: <p>First of all, you have to decide whether you build all packages
2221: or a limited set of them. Full bulk builds usually consume a lot more resources,
2222: both space and time, than builds for some practical sets of packages.
1.175 gutterid 2223: A number of particularly heavy packages exist that are not actually
2224: interesting to a wide audience. (The approximate resource consumption for a
2225: 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>.)
2226: For limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2227: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2228: </p>
2229: <p>During bulk builds various packages are installed and deinstalled
2230: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2231: so make sure that you don't need any package during the builds.
1.112 rillig 2232: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2233: or something even more restrictive, depending on what the operating system provides,
2234: or dedicate the whole physical machine.
2235: As a useful side effect this makes sure that bulk builds cannot
2236: break anything in your system. There have been numerous cases where
1.6 rillig 2237: certain packages tried to install files outside the
2238: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2239: <code class="filename">/etc</code>.
2240: </p>
1.6 rillig 2241: </div>
1.41 asau 2242: <div class="sect1">
1.6 rillig 2243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 rillig 2244: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
2245: <p>Running a bulk build works roughly as follows:</p>
1.41 asau 2246: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2247: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2248: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2249: </ul></div>
1.41 asau 2250: <div class="sect2">
1.15 rillig 2251: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2252: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112 rillig 2253: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2254: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2255: Configure network access to fetch distribution files.
1.112 rillig 2256: Create a user with name "pbulk".</p>
1.68 asau 2257: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2258: <pre class="screen">
1.151 sevan 2259: <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>
2260: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
1.72 wiz 2261: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.68 asau 2262: </pre>
2263: <p>Or any other way that fits (e.g., curl, wget).</p>
2264: <p>Deploy and configure pbulk tools, e.g.:</p>
2265: <pre class="screen">
1.118 sevan 2266: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.68 asau 2267: <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>
2268: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2269: </pre>
2270: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2271: <h3 class="title">Note</h3>
2272: <p><code class="filename">mk.conf.frag</code> is a fragment of
2273: <code class="filename">mk.conf</code> that contains settings you want to
2274: apply to packages you build. For instance,</p>
2275: <pre class="programlisting">
1.112 rillig 2276: PKG_DEVELOPER= yes # perform more checks
2277: X11_TYPE= modular # use pkgsrc X11
2278: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2279: # when building all packages)
1.68 asau 2280: </pre>
2281: </div>
2282: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2283: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2284: <pre class="programlisting">
2285: www/firefox
2286: mail/thunderbird
2287: misc/libreoffice4
2288: </pre>
1.69 asau 2289: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2290: and make final amendments, if wanted.</p>
1.68 asau 2291: <p>Start it:</p>
2292: <pre class="screen">
2293: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2294: </pre>
2295: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2296: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2297: </p>
2298: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2299: <h3 class="title">Note</h3>
2300: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2301: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2302: The script is kept small enough for better understanding.</p>
2303: </div>
2304: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2305: <h3 class="title">Note</h3>
2306: <p>The <code class="filename">pbulk.sh</code> script supports running
1.205 wiz 2307: unprivileged bulk build and helps configuring distributed bulk builds.
2308: Distributed bulk builds support either building in worker chroots
2309: (each node is a path to a different chroot)
2310: that replicate the target system, including the pbulk prefix,
2311: or remote machines (each node is
2312: an IP address that must be accessible over SSH without a password).</p>
1.68 asau 2313: </div>
1.6 rillig 2314: </div>
2315: </div>
1.41 asau 2316: <div class="sect1">
1.6 rillig 2317: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2318: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71 wiz 2319: <p>A complete bulk build requires lots of disk space. Some of the
2320: disk space can be read-only, some other must be writable. Some can be on
2321: remote filesystems (such as NFS) and some should be local. Some can be
2322: temporary filesystems, others must survive a sudden reboot.</p>
2323: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.205 wiz 2324: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2325: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.71 wiz 2326: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2327: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2328: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2329: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2330: </ul></div>
2331: </div>
2332: <div class="sect1">
2333: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.178 rillig 2334: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2335: <p>To ensure that pkgsrc packages work in different configurations, it
2336: makes sense to run non-default bulk builds from time to time. This
2337: section lists some ideas for bulk builds that intentionally let packages
2338: fail if they don't follow the pkgsrc style.</p>
2339: <div class="sect2">
2340: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2341: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.178 rillig 2342: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2343: <pre class="programlisting">
2344: GNU_CONFIGURE_STRICT= yes
2345: </pre>
2346: <p>When a package fails this additional check, the most common cause
2347: is that the configure option was valid for an older version of the
2348: package but does not apply anymore. In that case, just remove it.</p>
2349: </div>
2350: <div class="sect2">
2351: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2352: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.178 rillig 2353: <p>The job of a compiler is not restricted to producing executable
1.179 rillig 2354: code, most compilers also detect typical programming mistakes. The pkgsrc
2355: compiler wrappers make it easy to force compiler options when the package
2356: is built. This can be used to find typical bugs across all packages that
2357: are in pkgsrc. By reporting these bugs upstream, the packages will be
2358: more reliable with the next updates.</p>
2359: <p>Add some of the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.178 rillig 2360: <pre class="programlisting">
2361: CFLAGS+= -Werror=char-subscripts
1.179 rillig 2362: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 2363: </pre>
1.179 rillig 2364: <p>When a package fails to build using these stricter compiler
2365: options, document the circumstances in which the compiler produced the
2366: error message. This includes:</p>
1.178 rillig 2367: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2368: <li class="listitem"><p>The platform
2369: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2370: <li class="listitem"><p>The source file</p></li>
2371: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2372: part of the diagnostic.</p></li>
1.179 rillig 2373: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.178 rillig 2374: </ul></div>
2375: <p>If a package produces these error messages, but the package is
1.179 rillig 2376: 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
2377: in the next builds:</p>
1.178 rillig 2378: <pre class="programlisting">
1.179 rillig 2379: .if ${PKGPATH} == category/package
1.178 rillig 2380: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2381: # error message
2382: # code
1.179 rillig 2383: # Reason why the code does not need to be fixed.
1.178 rillig 2384: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 2385: .endif
1.178 rillig 2386: </pre>
2387: <p>If the error messages from the compiler are valid and the code
1.179 rillig 2388: needs to be fixed, prepare a local patch (see
2389: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2390: authors of the package, providing them with the information you collected
2391: above.</p>
2392: <p>Patches that are not essential for the package to work should only
2393: be reported upstream but not committed to pkgsrc, to make future updates
2394: easier.</p>
1.178 rillig 2395: </div>
2396: <div class="sect2">
2397: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2398: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
2399: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2400: these apply to all phases of the package build process. Especially in the
2401: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2402: decisions. The GNU configure scripts feed many small test programs to the
2403: C compiler to see whether certain headers are available, functions are
2404: defined in a library and programs can be run. In many cases these
2405: programs would not survive a strict compiler run with <code class="literal">-Wall
2406: -Wextra -Werror</code>.</p>
2407: <p>The pkgsrc infrastructure is flexible enough to support compiler
2408: options being added between the <code class="literal">configure</code> and
2409: <code class="literal">build</code> phases. It's a little more complicated than the
2410: other examples in this section but still easy enough.</p>
2411: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2412: desired compiler options. The compiler wrapper's original task is to hide
2413: unwanted directories of include files and to normalize compiler options.
2414: It does this by wrapping the compiler command and rewriting the command
2415: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2416: package directory and examine the
2417: <code class="filename">work/.cwrappers/config</code> directory. It contains
2418: individual configurations for the C compiler and the related tools. The
2419: plan is to find a hook between the configure and build phases, and to
2420: modify these configuration files at that point.</p>
2421: <p>To find this hook, have a look at
2422: <code class="filename">mk/build/build.mk</code>, which contains among others the
2423: <code class="literal">pre-build-checks-hook</code>. The word
2424: <code class="literal">checks</code> doesn't quite fit, but the
2425: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2426: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2427: <pre class="programlisting">
2428: # Just a few example options.
2429: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2430:
2431: .if ${BUILD_ONLY_CFLAGS:U:M*}
2432: pre-build-checks-hook: add-build-only-cflags
2433:
2434: add-build-only-cflags: .PHONY
2435: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2436: ${TEST} ! -f ${.TARGET} || exit 0; \
2437: for flag in ${BUILD_ONLY_CFLAGS}; do \
2438: ${ECHO} "append=$$flag" >> cc; \
2439: done; \
2440: > ${.TARGET}
2441: .endif
2442: </pre>
2443: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2444: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2445: not with spaces.)</p>
2446: <p>The condition in the <code class="literal">.if</code> statement contains the
2447: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2448: should be undefined, possibly because it is only defined for a subset of
2449: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2450: at least one compiler option, to prevent a syntax error in the shell
2451: parser.</p>
2452: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2453: that the additional compiler options are only appended once, even if
2454: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2455: creates a marker file.</p>
2456: <p>To verify that this setup works, run <span class="command"><strong>bmake
2457: configure</strong></span> in a package directory. Up to now, everything works
2458: as usual. Examine the directory
2459: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2460: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2461: the file <code class="filename">cc</code>. Examine the tail of the
2462: <code class="filename">work/.work.log</code> file to see that the normal compiler
2463: options are used.</p>
2464: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2465: options to the file <code class="filename">cc</code> and will create the marker
2466: file in the same directory. After that, the build starts as usual, but
2467: with the added compiler options. Examine the tail of the file
2468: <code class="filename">work/.work.log</code> to see that the lines starting with
2469: <code class="literal">[*]</code> don't contain the compiler options, but the
2470: corresponding lines starting with <code class="literal"><.></code> do end
2471: with these options.</p>
2472: <p>Building packages using this setup variant and fixing the resulting
2473: 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>
2474: </div>
2475: <div class="sect2">
2476: <div class="titlepage"><div><div><h3 class="title">
2477: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.178 rillig 2478: <p>Some directories like <code class="varname">PREFIX</code>,
2479: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2480: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2481: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2482: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2483: <pre class="programlisting">
2484: PREFIX= /a-random-uuid
2485: PKG_SYSCONFDIR= /a-random-uuid
2486: VARBASE= /a-random-uuid
2487: PKGMANDIR= a-random-uuid
2488: PKG_INFODIR= a-random-uuid
2489: </pre>
2490: </div>
2491: <div class="sect2">
2492: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2493: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.178 rillig 2494: <p>When building a package, warnings are typically ignored since they
2495: just flow by and do not cause the build to fail immediately. To find
2496: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2497: <pre class="programlisting">
2498: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2499: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2500: </pre>
2501: <p>(There are many more classes of warnings in pkgsrc, and most of
2502: them can be redefined with a simple definition like above.</p>
1.179 rillig 2503: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.178 rillig 2504: the package Makefile, research whether the package actually needs Perl.
2505: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2506: Makefile, and if it doesn't, add
2507: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2508: </div>
2509: <div class="sect2">
2510: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2511: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.178 rillig 2512: <p>Using pkglint as part of the regular build process is mostly a
2513: waste of time. If you want to fix some of the warnings, just run pkglint
2514: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2515: 10), which is much faster than a complete bulk build.</p>
2516: </div>
2517: <div class="sect2">
2518: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2519: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.178 rillig 2520: <p>To ensure that the binary packages don't contain references to the
2521: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2522: that variable includes the item <code class="literal">extra</code>, it is
2523: possible to define additional patterns that must not appear in any
2524: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2525: <pre class="programlisting">
2526: CHECK_WRKREF= extra
2527: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2528: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2529: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2530: </pre>
2531: <p>The above patterns will probably generate many false positives,
2532: therefore the results need to be taken with a grain of salt.</p>
2533: </div>
2534: <div class="sect2">
2535: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2536: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.178 rillig 2537: <p>To run the test suites that come with each package, add this line
2538: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2539: <pre class="programlisting">
2540: PKGSRC_RUN_TEST= yes
2541: </pre>
2542: <p>Be prepared that even the most basic packages fail this test. When
2543: doing a bulk build with this, it will often abort in the early phase
2544: where the packages are scanned for their dependencies since there are
2545: cyclic dependencies. There is still a lot to do in this area.</p>
2546: </div>
2547: <div class="sect2">
2548: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2549: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.178 rillig 2550: <p>To catch typos in the shell snippets from the Makefile fragments,
2551: add the <code class="literal">-u</code> flag to most of the commands by adding this
2552: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2553: <pre class="programlisting">
2554: RUN= @set -eu;
2555: </pre>
1.181 rillig 2556: <p>After that, ensure that none of the bulk build log files (even
2557: those for successfully built packages) contains the string
2558: <code class="literal">parameter not set</code> or whatever error message the
2559: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.178 rillig 2560: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2561: definition.</p>
2562: </div>
2563: <div class="sect2">
2564: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2565: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.178 rillig 2566: <p>The build logs of a package are often quite long. This allows error
2567: messages or other interesting details to hide between the noise. To make
2568: the actual error message stand out more, add these lines to
2569: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2570: <pre class="programlisting">
2571: GNU_CONFIGURE_QUIET= yes
2572: MAKE_FLAGS+= -s
2573: </pre>
2574: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2575: Make. On exotic platforms with their own make, it may be a little
2576: different.</p>
2577: </div>
2578: </div>
2579: <div class="sect1">
2580: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2581: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2582: <p>After your pkgsrc bulk-build has completed, you may wish to
2583: create a CD-ROM set of the resulting binary packages to assist
2584: in installing packages on other machines. The
1.207 leot 2585: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/index.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.1 dsieger 2586: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2587: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2588: way that keeps all the dependencies for a given package on the same
2589: CD as that package.</p>
1.41 asau 2590: <div class="sect2">
1.1 dsieger 2591: <div class="titlepage"><div><div><h3 class="title">
1.178 rillig 2592: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2593: <p>Complete documentation for cdpack is found in the cdpack(1)
2594: man page. The following short example assumes that the binary
2595: packages are left in
2596: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2597: sufficient disk space exists in <code class="filename">/u2</code> to
2598: hold the ISO 9660 images.</p>
2599: <pre class="screen">
2600: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2601: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2602: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2603: </pre>
2604: <p>If you wish to include a common set of files
2605: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2606: etc.) on each CD in the collection, then you need to create a
1.175 gutterid 2607: directory which contains these files, e.g.:</p>
1.1 dsieger 2608: <pre class="screen">
2609: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2610: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2611: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2612: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2613: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2614: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2615: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2616: </pre>
2617: <p>Now create the images:</p>
2618: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2619: <p>Each image will contain <code class="filename">README</code>,
2620: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2621: in their root directories.</p>
2622: </div>
2623: </div>
2624: </div>
1.41 asau 2625: <div class="chapter">
1.1 dsieger 2626: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2627: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2628: <div class="toc">
2629: <p><b>Table of Contents</b></p>
1.100 leot 2630: <dl class="toc">
1.154 rillig 2631: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2632: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1 dsieger 2633: </dl>
2634: </div>
2635: <p>The files that are installed by pkgsrc are organized in a way that
2636: is similar to what you find in the <code class="filename">/usr</code> directory
2637: of the base system. But some details are different. This is because
2638: pkgsrc initially came from FreeBSD and had adopted its file system
2639: hierarchy. Later it was largely influenced by NetBSD. But no matter
2640: which operating system you are using pkgsrc with, you can expect the
2641: same layout for pkgsrc.</p>
2642: <p>There are mainly four root directories for pkgsrc, which are all
2643: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2644: When pkgsrc has been installed as root, the default locations
2645: are:</p>
2646: <pre class="programlisting">
2647: LOCALBASE= /usr/pkg
2648: PKG_SYSCONFBASE= /usr/pkg/etc
2649: VARBASE= /var
1.119 sevan 2650: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2651: </pre>
2652: <p>In unprivileged mode (when pkgsrc has been installed as any other
2653: user), the default locations are:</p>
2654: <pre class="programlisting">
2655: LOCALBASE= ${HOME}/pkg
2656: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2657: VARBASE= ${HOME}/pkg/var
1.119 sevan 2658: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2659: </pre>
2660: <p>What these four directories are for, and what they look like is
2661: explained below.</p>
1.41 asau 2662: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2663: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2664: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2665: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2666: the well-known subdirectories like <code class="filename">bin</code>,
2667: <code class="filename">include</code>, <code class="filename">lib</code>,
2668: <code class="filename">share</code> and
2669: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2670: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2671: <code class="filename">/var</code> in the base system. Some programs (especially
2672: games, network daemons) need write access to it during normal
2673: operation.</p></li>
1.23 wiz 2674: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2675: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2676: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 2677: itself.</p></li>
2678: </ul></div>
1.41 asau 2679: <div class="sect1">
1.1 dsieger 2680: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2681: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2682: </h2></div></div></div>
2683: <p>The following directories exist in a typical pkgsrc installation
2684: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2685: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2686: <dt><span class="term"><code class="filename">bin</code></span></dt>
2687: <dd><p>Contains executable programs that are intended to be
2688: directly used by the end user.</p></dd>
2689: <dt><span class="term"><code class="filename">emul</code></span></dt>
2690: <dd><p>Contains files for the emulation layers of various other
2691: operating systems, especially for
2692: NetBSD.</p></dd>
2693: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2694: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2695: <dd><p>Contains
2696: the configuration files.</p></dd>
2697: <dt><span class="term"><code class="filename">include</code></span></dt>
2698: <dd><p>Contains headers for the C and C++ programming
2699: languages.</p></dd>
2700: <dt><span class="term"><code class="filename">info</code></span></dt>
2701: <dd><p>Contains GNU info files of various
2702: packages.</p></dd>
2703: <dt><span class="term"><code class="filename">lib</code></span></dt>
2704: <dd><p>Contains shared and static
2705: libraries.</p></dd>
2706: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2707: <dd><p>Contains data files that don't change after
2708: installation. Other data files belong into
2709: <code class="filename">${VARBASE}</code>.</p></dd>
2710: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2711: <dd><p>Contains programs that are not intended to be used by
2712: end users, such as helper programs or network
2713: daemons.</p></dd>
2714: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2715: <dd><p>Contains programs that are intended to be executed as
2716: CGI scripts by a web server.</p></dd>
2717: <dt><span class="term"><code class="filename">man</code> (the usual value of
2718: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2719: <dd><p>Contains brief
2720: documentation in form of manual pages.</p></dd>
2721: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2722: <dd><p>Contains programs that are intended to be used only by
2723: the super-user.</p></dd>
2724: <dt><span class="term"><code class="filename">share</code></span></dt>
2725: <dd><p>Contains platform-independent data files that don't
2726: change after installation.</p></dd>
2727: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2728: <dd><p>Contains documentation files provided by the
2729: packages.</p></dd>
2730: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2731: <dd><p>Contains example files provided by the packages. Among
2732: others, the original configuration files are saved here and copied to
2733: <code class="filename">${PKG_SYSCONFDIR}</code> during
2734: installation.</p></dd>
2735: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2736: <dd><p>Contains the original files for rc.d
2737: scripts.</p></dd>
2738: <dt><span class="term"><code class="filename">var</code> (the usual location of
2739: <code class="filename">${VARBASE}</code>)</span></dt>
2740: <dd><p>Contains files
2741: that may be modified after
2742: installation.</p></dd>
2743: </dl></div>
2744: </div>
1.41 asau 2745: <div class="sect1">
1.1 dsieger 2746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2747: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2748: </h2></div></div></div>
1.41 asau 2749: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2750: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2751: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2752: <dd><p>Contains
2753: information about the currently installed
2754: packages.</p></dd>
2755: <dt><span class="term"><code class="filename">games</code></span></dt>
2756: <dd><p>Contains highscore
2757: files.</p></dd>
2758: <dt><span class="term"><code class="filename">log</code></span></dt>
2759: <dd><p>Contains log files.</p></dd>
2760: <dt><span class="term"><code class="filename">run</code></span></dt>
2761: <dd><p>Contains informational files about daemons that are
2762: currently running.</p></dd>
2763: </dl></div>
2764: </div>
2765: </div>
1.41 asau 2766: <div class="chapter">
1.1 dsieger 2767: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2768: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2769: <div class="toc">
2770: <p><b>Table of Contents</b></p>
1.100 leot 2771: <dl class="toc">
1.154 rillig 2772: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2773: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2774: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2775: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2776: <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>
2777: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2778: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2779: <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>
2780: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2781: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 2782: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 2783: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.221 nia 2784: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 2785: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2786: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2787: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2788: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2789: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 2790: </dl>
2791: </div>
2792: <p>This section contains hints, tips & tricks on special things in
2793: pkgsrc that we didn't find a better place for in the previous chapters, and
2794: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2795: <div class="sect1">
1.1 dsieger 2796: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2797: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2798: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2799: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2800: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 2801: This is a general purpose list for most issues regarding
2802: pkgsrc, regardless of platform, e.g. soliciting user help
2803: for pkgsrc configuration, unexpected build failures, using
2804: particular packages, upgrading pkgsrc installations,
2805: questions regarding the pkgsrc release branches, etc. General announcements or
2806: proposals for changes that impact the pkgsrc user community,
2807: e.g. major infrastructure changes, new features, package
2808: removals, etc., may also be posted.</p></li>
1.174 leot 2809: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 2810: A list where the results of pkgsrc bulk builds are sent and
2811: discussed.</p></li>
1.174 leot 2812: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 2813: This list is for those who are interested in getting a
2814: commit message for every change committed to pkgsrc. It is
2815: also available in digest form, meaning one daily message
2816: containing all commit messages for changes to the package
2817: source tree in that 24 hour period.</p></li>
2818: </ul></div>
2819: <p>To subscribe, do:</p>
2820: <pre class="programlisting">
2821: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2822: </pre>
2823: <p>Archives for all these mailing lists are available from
1.174 leot 2824: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2825: </div>
1.41 asau 2826: <div class="sect1">
1.1 dsieger 2827: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2828: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2829: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2830: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2831: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2832: they might be useful, and not to duplicate the documentation that comes
2833: with each package.</p>
2834: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.207 leot 2835: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/index.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1 dsieger 2836: Symlinks for use by buildlink.</p></li></ul></div>
2837: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2838: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2839: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/index.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.121 sevan 2840: Calculates various kinds of checksums (including SHA3).</p></li>
1.207 leot 2841: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/index.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.1 dsieger 2842: Compatibility library for pkgsrc tools.</p></li>
1.207 leot 2843: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/index.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.1 dsieger 2844: non-BSD systems due to lack of native mtree.</p></li>
1.207 leot 2845: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.1 dsieger 2846: Up-to-date replacement for
2847: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2848: systems where pkg_install is not present.</p></li>
2849: </ul></div>
2850: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2851: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2852: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1 dsieger 2853: Create a binary package from an
1.10 hubertf 2854: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2855: save the old package.</p></li>
1.207 leot 2856: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/index.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.1 dsieger 2857: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2858: from multiple locations. It currently supports the following
2859: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.207 leot 2860: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.16 jnemeth 2861: the best compiler flags to optimise code for your current
1.23 wiz 2862: CPU and compiler. </p></li>
1.1 dsieger 2863: </ul></div>
2864: <p>Utilities for keeping track of installed packages, being up to date,
2865: etc:</p>
1.41 asau 2866: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2867: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/index.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.65 wiz 2868: update tool similar to apt(1). Download, install, and upgrade
2869: binary packages easily.</p></li>
1.207 leot 2870: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.1 dsieger 2871: packages whose installed versions do not match the latest pkgsrc
2872: entries.</p></li>
1.207 leot 2873: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.1 dsieger 2874: dependency graphs of packages, to aid in choosing a strategy for
2875: updating.</p></li>
1.207 leot 2876: <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
2877: 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>
2878: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12 weinem 2879: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.207 leot 2880: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1 dsieger 2881: does various checks on the complete pkgsrc system.</p></li>
1.207 leot 2882: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/index.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.1 dsieger 2883: packages you have installed.</p></li>
2884: </ul></div>
2885: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2886: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2887: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.1 dsieger 2888: making and maintaining patches for a package (includes pkgdiff,
2889: pkgvi, mkpatches, etc.).</p></li>
1.207 leot 2890: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/index.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.1 dsieger 2891: converting to pkgsrc.</p></li>
2892: </ul></div>
2893: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2894: utilities)</p>
1.41 asau 2895: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2896: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/index.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.1 dsieger 2897: packages in a chrooted area.</p></li>
1.207 leot 2898: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/index.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.1 dsieger 2899: kernel version for chrooted cross builds.</p></li>
2900: </ul></div>
2901: </div>
1.41 asau 2902: <div class="sect1">
1.1 dsieger 2903: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2904: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2905: <p>To install packages from source as a non-root user, download
1.154 rillig 2906: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 3. Where to get pkgsrc and how to keep it up-to-date">Chapter 3, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
1.108 rillig 2907: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2908: --unprivileged</strong></span>.</p>
2909: <p>This will install the binary part of pkgsrc to
2910: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2911: into <code class="filename">~/pkg/etc</code>.</p>
2912: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2913: </div>
1.41 asau 2914: <div class="sect1">
1.1 dsieger 2915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2916: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2917: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2918: enable this feature by adding the option
2919: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2920: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2921: distfile is found, pkgsrc will try to resume it.</p>
2922: <p>You can also
1.61 wiz 2923: use a different program than the platform default program by changing the
1.16 jnemeth 2924: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2925: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2926: by using the value manual. A value of custom disables the system defaults
2927: and dependency tracking for the fetch program. In that case you have to
2928: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2929: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2930: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2931: <p>For example, if you want to use
1.16 jnemeth 2932: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2933: like:</p>
2934: <pre class="programlisting">
1.112 rillig 2935: FETCH_USING= wget
1.1 dsieger 2936: </pre>
2937: </div>
1.41 asau 2938: <div class="sect1">
1.1 dsieger 2939: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2940: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4 rillig 2941: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2942: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2943: you will have to add the following line into
1.10 hubertf 2944: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2945: <pre class="programlisting">
1.4 rillig 2946: X11_TYPE=modular
1.1 dsieger 2947: </pre>
2948: </div>
1.41 asau 2949: <div class="sect1">
1.1 dsieger 2950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2951: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2952: <p>If you are sitting behind a firewall which does not allow direct
2953: connections to Internet hosts (i.e. non-NAT), you may specify the
2954: relevant proxy hosts. This is done using an environment variable in the
2955: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2956: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2957: port 80 as the proxy port number. So the proxy environment variables
2958: are:</p>
2959: <pre class="programlisting">
2960: ftp_proxy=ftp://orpheus.amdahl.com:80/
2961: http_proxy=http://orpheus.amdahl.com:80/
2962: </pre>
2963: </div>
1.41 asau 2964: <div class="sect1">
1.1 dsieger 2965: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2966: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2967: <p>Some fetch tools are not prepared to support HTTPS by default
2968: (for example, the one in NetBSD 6.0), or the one installed by the
2969: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2970: dependency graph).</p>
2971: <p>Usually you won't notice, because distribution files are
2972: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2973: be often enough if you are following pkgsrc-current. In that case, set
2974: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2975: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2976: with HTTPS support by default. Of course, these tools need to be
2977: installed before you can use them this way.</p>
2978: </div>
2979: <div class="sect1">
2980: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2981: <a name="passive-ftp"></a>10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1 dsieger 2982: <p>This depends on which utility is used to retrieve distfiles. From
2983: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2984: the first available command from the following list:</p>
1.41 asau 2985: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2986: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2987: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2988: </ul></div>
2989: <p>On a default NetBSD installation, this will be
2990: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2991: connections first, and falls back to active connections if the server
2992: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2993: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2994: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2995: <p>Having that option present will prevent
2996: <code class="filename">/usr/bin/ftp</code> from falling back to active
2997: transfers.</p>
2998: </div>
1.41 asau 2999: <div class="sect1">
1.1 dsieger 3000: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3001: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3002: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3003: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 3004: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.1 dsieger 3005: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3006: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3007: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3008: resulting list to your machine at work/school and use it there. If you
1.259 leot 3009: 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.1 dsieger 3010: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3011: URL:</p>
3012: <p>At home:</p>
3013: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3014: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3015: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3016: <p>At work:</p>
3017: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3018: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3019: home.</p>
3020: <p>If you have a machine running NetBSD, and you want to get
3021: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3022: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3023: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3024: directly by running:</p>
3025: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3026: <p>If you even decide to ignore
3027: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3028: by running:</p>
3029: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3030: </div>
1.41 asau 3031: <div class="sect1">
1.1 dsieger 3032: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3033: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 3034: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.207 leot 3035: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.1 dsieger 3036: package, you get the error from make that it doesn't know how to make
3037: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 3038: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 3039: the NetBSD base distribution on your machine. It is recommended to do
3040: that to format man pages.</p>
1.207 leot 3041: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.1 dsieger 3042: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3043: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3044: </div>
1.41 asau 3045: <div class="sect1">
1.1 dsieger 3046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3047: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3048: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3049: when you installed your NetBSD machine. Please get and install it, by
3050: extracting it in <code class="filename">/</code>:</p>
3051: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3052: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3053: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3054: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3055: -r</strong></span>).</p>
3056: </div>
1.41 asau 3057: <div class="sect1">
1.1 dsieger 3058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.221 nia 3059: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.1 dsieger 3060: <p>When installing packages as non-root user and using the just-in-time
1.259 leot 3061: <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.1 dsieger 3062: password for each required package installed. To avoid this, the sudo
3063: package can be used, which does password caching over a limited time. To
1.221 nia 3064: use it, install <span class="command"><strong>sudo</strong></span> or
3065: <span class="command"><strong>priv</strong></span> (either as binary package, from
3066: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/priv/index.html" target="_top"><code class="filename">security/priv</code></a>, or
1.207 leot 3067: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/index.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.10 hubertf 3068: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3069: <span class="emphasis"><em>after</em></span> the definition of the
3070: <code class="varname">LOCALBASE</code> variable:</p>
3071: <pre class="programlisting">
3072: .if exists(${LOCALBASE}/bin/sudo)
1.260 wiz 3073: SU_CMD= ${LOCALBASE}/bin/sudo -E /bin/sh -c
1.1 dsieger 3074: .endif
3075: </pre>
1.260 wiz 3076: <p>Note the <span class="command"><strong>-E</strong></span> flag; that tells
3077: <span class="command"><strong>sudo</strong></span> to preserve the environment.
3078: Without this, the bin-install target will fail when building a
3079: package with a non-default python version.
3080: </p>
1.1 dsieger 3081: </div>
1.41 asau 3082: <div class="sect1">
1.1 dsieger 3083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3084: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3085: <p>As the system administrator, you can choose where configuration files
3086: are installed. The default settings make all these files go into
3087: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3088: be suboptimal depending on your expectations (e.g., a read-only,
3089: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3090: configuration of the provided packages).</p>
3091: <p>In order to change the defaults, you can modify the
3092: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3093: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3094: directory; some common examples include <code class="filename">/etc</code> or
3095: <code class="filename">/etc/pkg</code>.</p>
3096: <p>Furthermore, you can change this value on a per-package basis by
3097: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3098: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3099: package you would like to modify, that is, the contents of
3100: <code class="varname">PKGBASE</code>.</p>
3101: <p>Note that after changing these settings, you must rebuild and
3102: reinstall any affected packages.</p>
3103: </div>
1.41 asau 3104: <div class="sect1">
1.1 dsieger 3105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3106: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3107: <p>Please be aware that there can often be bugs in third-party software,
3108: and some of these bugs can leave a machine vulnerable to exploitation by
3109: attackers. In an effort to lessen the exposure, the NetBSD packages team
3110: maintains a database of known-exploits to packages which have at one time
3111: been included in pkgsrc. The database can be downloaded automatically, and
3112: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3113: do this, refer to the following two tools (installed as part of the
1.207 leot 3114: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.23 wiz 3115: <div class="orderedlist"><ol class="orderedlist" type="1">
3116: <li class="listitem">
1.20 snj 3117: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3118: download a list of the security vulnerabilities information. This list
1.25 spz 3119: is kept up to date by the pkgsrc security team, and is distributed
3120: from the NetBSD ftp server:</p>
1.177 leot 3121: <p><a class="ulink" href="https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a></p>
1.1 dsieger 3122: </li>
1.23 wiz 3123: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3124: current machine, checking each known vulnerability. If a
1.1 dsieger 3125: vulnerable package is installed, it will be shown by output to stdout,
3126: including a description of the type of vulnerability, and a URL
3127: containing more information.</p></li>
3128: </ol></div>
1.121 sevan 3129: <p>Use of these tools is strongly recommended!
1.202 nia 3130: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, “Checking for security vulnerabilities in installed packages”</a> for instructions on how to automate checking and
1.121 sevan 3131: reporting.</p>
3132: <p>If this database is installed, pkgsrc builds will use it to
3133: perform a security check before building any package.</p>
1.1 dsieger 3134: </div>
1.41 asau 3135: <div class="sect1">
1.1 dsieger 3136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3137: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1 dsieger 3138: <p>When you add your own preferences to the
3139: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3140: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3141: environment variables to the <code class="filename">./configure</code>
1.259 leot 3142: 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.1 dsieger 3143: <code class="varname">CFLAGS</code> from the environment variable by
3144: overriding them in the <code class="filename">Makefile</code>s of their
3145: package.</p>
3146: <p>Currently there is no solution to this problem. If you
3147: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3148: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3149: directory and then inspect any <code class="filename">Makefile</code> and
3150: <code class="filename">Makefile.in</code> for whether they define
3151: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3152: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3153: programmers write so bad code that it only works for the
3154: specific combination of <code class="varname">CFLAGS</code> they have
3155: chosen.</p>
1.172 rillig 3156: <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>
3157: <pre class="programlisting">
3158: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3159: CFLAGS+= -Dpkgsrc___CFLAGS
3160: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3161: </pre>
3162: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3163: to see whether the above flags are passed to the actual build
3164: commands in general.</p>
3165: <p>To find out whether the flags are passed to individual compiler
3166: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3167: most cases, the flags from the original command lines (the lines starting
3168: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3169: (the lines starting with <code class="literal"><.></code>). If the flag is
3170: missing from the actual compiler command, it must have been removed by
1.184 rillig 3171: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.1 dsieger 3172: </div>
1.41 asau 3173: <div class="sect1">
1.1 dsieger 3174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3175: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3176: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3177: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3178: case that occurs often is that people only update pkgsrc in
3179: parts, because of performance reasons. Since pkgsrc is one large
3180: system, not a collection of many small systems, there are
3181: sometimes changes that only work when the whole pkgsrc tree is
3182: updated.</p></li>
1.41 asau 3183: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3184: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3185: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3186: files.</p></li>
1.41 asau 3187: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3188: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3189: verify this.</p></li>
1.108 rillig 3190: <li class="step"><p>If you are a package developer who wants to invest
1.154 rillig 3191: some work, have a look at <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.41 asau 3192: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3193: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3194: </ol></div>
3195: </div>
1.41 asau 3196: <div class="sect1">
1.1 dsieger 3197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3198: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3199: <p>You have modified a file from pkgsrc, and someone else has
3200: modified that same file afterwards in the CVS repository. Both changes
3201: are in the same region of the file, so when you updated pkgsrc, the
3202: <code class="literal">cvs</code> command marked the conflicting changes in the
3203: file. Because of these markers, the file is no longer a valid
3204: <code class="filename">Makefile</code>.</p>
3205: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3206: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3207: -dP</strong></span> in that directory to download the current version.</p>
3208: </div>
3209: </div>
3210: </div>
1.41 asau 3211: <div class="part">
1.1 dsieger 3212: <div class="titlepage"><div><div><h1 class="title">
3213: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3214: <div class="partintro">
1.1 dsieger 3215: <div></div>
3216: <p>This part of the book deals with creating and
1.23 wiz 3217: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3218: guide on creating a new package. The remaining chapters are more
3219: like a reference manual for pkgsrc.</p>
3220: <div class="toc">
3221: <p><b>Table of Contents</b></p>
1.100 leot 3222: <dl class="toc">
1.154 rillig 3223: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 3224: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 3225: <dd><dl>
1.184 rillig 3226: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3227: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3228: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 3229: <dd><dl>
1.184 rillig 3230: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3231: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3232: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3233: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3234: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 3235: </dl></dd>
1.184 rillig 3236: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3237: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3238: <dd><dl>
3239: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3240: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3241: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3242: </dl></dd>
3243: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3244: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3245: </dl></dd>
1.184 rillig 3246: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 3247: <dd><dl>
1.184 rillig 3248: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3249: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3250: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3251: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3252: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 3253: <dd><dl>
1.184 rillig 3254: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3255: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 3256: </dl></dd>
1.184 rillig 3257: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3258: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3259: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3260: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3261: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3262: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3263: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3264: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3265: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3266: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3267: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3268: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3269: </dl></dd>
3270: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3271: <dd><dl>
3272: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 3273: <dd><dl>
1.219 nia 3274: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
3275: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
3276: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.6 rillig 3277: </dl></dd>
1.184 rillig 3278: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3279: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6 rillig 3280: </dl></dd>
1.184 rillig 3281: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3282: <dd><dl>
1.184 rillig 3283: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3284: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3285: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3286: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 3287: <dd><dl>
1.184 rillig 3288: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3289: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3290: <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>
3291: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 3292: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.6 rillig 3293: </dl></dd>
3294: </dl></dd>
1.184 rillig 3295: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 3296: <dd><dl>
1.184 rillig 3297: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3298: <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>
3299: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3300: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3301: </dl></dd>
1.184 rillig 3302: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 3303: <dd><dl>
1.184 rillig 3304: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3305: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3306: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3307: </dl></dd>
3308: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3309: <dd><dl>
3310: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3311: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3312: <dd><dl>
1.184 rillig 3313: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3314: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 3315: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3316: and
3317: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3318: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3319: </dl></dd>
1.184 rillig 3320: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.241 rillig 3321: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.184 rillig 3322: </dl></dd>
3323: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 3324: <dd><dl>
1.184 rillig 3325: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3326: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3327: <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>
3328: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3329: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3330: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3331: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3332: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3333: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 3334: </dl></dd>
1.184 rillig 3335: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3336: <dd><dl>
3337: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3338: <dd><dl>
3339: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3340: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 3341: </dl></dd>
1.184 rillig 3342: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 3343: <dd><dl>
1.184 rillig 3344: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3345: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.239 dholland 3346: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
3347: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
3348: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 3349: </dl></dd>
3350: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3351: <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>
3352: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3353: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3354: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3355: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3356: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.154 rillig 3357: </dl></dd>
3358: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3359: <dd><dl>
3360: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3361: <dd><dl>
3362: <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>
3363: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3364: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3365: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3366: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3367: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3368: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3369: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3370: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3371: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3372: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3373: </dl></dd>
3374: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3375: <dd><dl>
3376: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3377: <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>
3378: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3379: </dl></dd>
3380: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3381: <dd><dl>
3382: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3383: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3384: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 3385: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.260 wiz 3386: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.154 rillig 3387: </dl></dd>
3388: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3389: <dd><dl>
3390: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3391: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 3392: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 3393: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
3394: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
3395: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
3396: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 3397: </dl></dd>
3398: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3399: <dd><dl>
3400: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3401: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 3402: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3403: <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>
3404: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 3405: </dl></dd>
3406: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3407: <dd><dl>
3408: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3409: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3410: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3411: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3412: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 3413: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.254 wiz 3414: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
3415: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
3416: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
3417: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
3418: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
3419: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
3420: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
3421: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
3422: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
3423: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.1 dsieger 3424: emulation</a></span></dt>
1.254 wiz 3425: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
3426: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.1 dsieger 3427: </dl></dd>
1.154 rillig 3428: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3429: </dl></dd>
1.184 rillig 3430: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3431: <dd><dl>
3432: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3433: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3434: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3435: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3436: </dl></dd>
1.154 rillig 3437: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3438: <dd><dl>
1.154 rillig 3439: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3440: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3441: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3442: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3443: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3444: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3445: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3446: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3447: </dl></dd>
3448: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 3449: </dl>
3450: </div>
3451: </div>
1.41 asau 3452: <div class="chapter">
1.1 dsieger 3453: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3454: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3455: <p>
3456: To get help when developing pkgsrc, the definitive source is this
3457: document, the pkgsrc guide. If you don't find anything here,
3458: there are alternatives:
3459: </p>
3460: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3461: <li class="listitem">
3462: <p>
3463: The built-in pkgsrc help, which is available after bootstrapping
3464: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3465: help for any topic, such as a variable name like
3466: <code class="varname">BUILD_DEFS</code>, a make target like
3467: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3468: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.207 leot 3469: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.154 rillig 3470: </li>
3471: <li class="listitem"><p>
1.163 rillig 3472: To see the value of a single variable, run <span class="command"><strong>bmake
3473: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3474: </p></li>
3475: <li class="listitem"><p>
3476: To see the values of the most common variables, run
3477: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3478: topic. To see the variables for a single topic, run
3479: <span class="command"><strong>bmake
3480: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3481: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3482: </p></li>
3483: <li class="listitem"><p>
1.154 rillig 3484: The tech-pkg mailing list, to which
3485: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3486: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3487: questions</a>.</p></li>
3488: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3489: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3490: or by using a specialized chat program such as
3491: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3492: Pick any user name and join the channel #pkgsrc.</p></li>
3493: </ul></div>
3494: </div>
3495: <div class="chapter">
3496: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 3497: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3498: <div class="toc">
3499: <p><b>Table of Contents</b></p>
1.100 leot 3500: <dl class="toc">
1.184 rillig 3501: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3502: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3503: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3504: <dd><dl>
3505: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3506: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3507: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3508: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3509: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3510: </dl></dd>
3511: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3512: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3513: <dd><dl>
3514: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3515: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3516: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3517: </dl></dd>
1.184 rillig 3518: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3519: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3520: </dl>
3521: </div>
1.184 rillig 3522: <p>Whenever you're preparing a package, there are a number of
3523: files involved which are described in the following
3524: sections.</p>
3525: <div class="sect1">
3526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3527: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3528: </h2></div></div></div>
3529: <p>Building, installation and creation of a binary package are all
3530: controlled by the package's <code class="filename">Makefile</code>.
3531: The <code class="filename">Makefile</code> describes various things about
3532: a package, for example from where to get it, how to configure,
3533: build, and install it.</p>
3534: <p>A package <code class="filename">Makefile</code> contains several
3535: sections that describe the package.</p>
3536: <p>In the first section there are the following variables, which
3537: should appear exactly in the order given here. The order and
3538: grouping of the variables is mostly historical and has no further
3539: meaning.</p>
3540: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3541: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3542: distribution file to be downloaded from the package's
3543: website.</p></li>
3544: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3545: package, as used by pkgsrc. You need to provide it if
3546: <code class="varname">DISTNAME</code> (which is the default) is not a good
3547: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3548: provided (no distribution file is required). Usually it is the pkgsrc
3549: directory name together with the version number. It must match the
3550: regular expression
3551: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3552: starts with a letter or digit, and contains only letters, digits,
1.204 nia 3553: dashes, underscores, dots and plus signs.
3554: New packages should have entirely lower-case names, with the exception
3555: of some that must follow pre-existing conventions
3556: (e.g. R packages begin with <code class="varname">R-</code>).
3557: You can use the <code class="code">:tl</code> variable modifier to lower-case
3558: the package name.</p></li>
1.184 rillig 3559: <li class="listitem">
3560: <p><code class="varname">CATEGORIES</code> is a list of categories
3561: which the package fits in. You can choose any of the top-level
3562: directories of pkgsrc for it.</p>
3563: <p>Currently the following values are available for
3564: <code class="varname">CATEGORIES</code>. If more than
3565: one is used, they need to be separated by spaces:</p>
1.1 dsieger 3566: <pre class="programlisting">
1.184 rillig 3567: archivers cross geography meta-pkgs security
3568: audio databases graphics misc shells
3569: benchmarks devel ham multimedia sysutils
3570: biology editors inputmethod net textproc
3571: cad emulators lang news time
3572: chat finance mail parallel wm
3573: comms fonts math pkgtools www
3574: converters games mbone print x11
1.1 dsieger 3575: </pre>
3576: </li>
1.184 rillig 3577: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3578: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3579: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3580: and <code class="varname">DISTFILES</code> are discussed in detail in
3581: <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>
3582: </ul></div>
3583: <p>The second section contains information about separately
3584: downloaded patches, if any.
3585: </p>
3586: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3587: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3588: Name(s) of additional files that contain distribution patches.
3589: There is no default. pkgsrc will look for them at
3590: <code class="varname">PATCH_SITES</code>.
3591: They will automatically be uncompressed before patching if
3592: the names end with <code class="filename">.gz</code> or
3593: <code class="filename">.Z</code>.</p></li>
3594: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3595: Primary location(s) for distribution patch files (see
3596: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3597: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.259 leot 3598: 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.184 rillig 3599: help find the correct files to patch. It defaults to
3600: <span class="command"><strong>-p0</strong></span>.</p></li>
3601: </ul></div>
3602: <p>The third section contains the following variables.
3603: </p>
3604: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.253 gutterid 3605: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email address
3606: of the person who is currently responsible for this package. In
3607: theory, the maintainer will be aware of upstream release, keep it
3608: updated, and generally resolve problems. Others contemplating
3609: significant changes should ask the maintainer for advice or review
3610: of a proposed change. This is not necessary for micro updates,
3611: bug fixes, pkgsrc-wide changes affecting many packages, and other
3612: things expected to be uncontroversial. It goes with this "should
3613: ask" that the maintainer should respond to inquiries reasonably
3614: promptly (most of the time), and either approve changes or provide
3615: reasons why not. Typically, when packaging a new program, set
3616: <code class="varname">MAINTAINER</code> to yourself. If you don't intend to
3617: maintain the package (especially if you feel you have no special
3618: insight), set it to <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>. This
3619: special value is a code point indicating that there is no
3620: maintainer, but the variable is mandatory, absent
3621: <code class="varname">OWNER</code>.</p></li>
3622: <li class="listitem">
3623: <p><code class="varname">OWNER</code> can be used instead of
3624: <code class="varname">MAINTAINER</code> in relatively rare circumstances
3625: when the package is such that modifying it is riskier than normal.
3626: This is a stronger form of being the maintainer, with an
3627: expectation that others will ask for almost all changes, except
3628: revbumps and accommodating structural changes. Someone who becomes
3629: <code class="varname">OWNER</code> has a strong obligation to keep the
3630: package very well maintained, to answer queries promptly and to be
3631: a steward of the package on behalf of users. In this case,
3632: <code class="varname">MAINTAINER</code> should be omitted.</p>
3633: <p>Because of the friction that <code class="varname">OWNER</code> adds,
3634: PMC may downgrade it to <code class="varname">MAINTAINER</code> at any
3635: time.</p>
3636: </li>
1.184 rillig 3637: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3638: find more information about the package.</p></li>
3639: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3640: description of the package (should not include the package
3641: name).</p></li>
3642: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3643: 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>
3644: </ul></div>
3645: <p>Other variables that affect the build:
3646: </p>
3647: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3648: <p><code class="varname">WRKSRC</code>: The directory where the
3649: interesting distribution files of the package are found. The
3650: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3651: works for most packages.</p>
3652: <p>If a package doesn't create a subdirectory for itself
3653: (most GNU software does, for instance), but extracts itself in
3654: the current directory, you should set
3655: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3656: <p>If a package doesn't create a subdirectory with the
3657: name of <code class="varname">DISTNAME</code> but some different name,
3658: set <code class="varname">WRKSRC</code> to point to the proper name in
3659: <code class="filename">${WRKDIR}</code>, for example
3660: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.207 leot 3661: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/index.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/index.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.184 rillig 3662: <p>The name of the working directory created by pkgsrc is
3663: taken from the <code class="varname">WRKDIR_BASENAME</code>
3664: variable. By default, its value is
3665: <code class="filename">work</code>. If you want to use the same
3666: pkgsrc tree for building different kinds of binary packages,
3667: you can change the variable according to your needs. Two
3668: other variables handle common cases of setting
3669: <code class="varname">WRKDIR_BASENAME</code> individually. If
3670: <code class="varname">OBJHOSTNAME</code> is defined in
3671: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3672: the host's name is attached to the directory name. If
3673: <code class="varname">OBJMACHINE</code> is defined, the platform name
3674: is attached, which might look like
3675: <code class="filename">work.i386</code> or
3676: <code class="filename">work.sparc</code>.</p>
3677: </li></ul></div>
3678: <p>Please pay attention to the following gotchas:</p>
3679: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3680: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3681: installed in compressed form by the package. For packages using
3682: BSD-style makefiles which honor MANZ, there is
3683: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3684: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3685: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3686: below).</p></li>
1.254 wiz 3687: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.8. Packages installing info files">Section 21.6.8, “Packages installing info files”</a>.</p></li>
1.184 rillig 3688: </ul></div>
3689: </div>
1.41 asau 3690: <div class="sect1">
1.1 dsieger 3691: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 3692: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3693: </h2></div></div></div>
3694: <p>The <code class="filename">distinfo</code> file contains the message
3695: digest, or checksum, of each distfile needed for the package. This
3696: ensures that the distfiles retrieved from the Internet have not been
3697: corrupted during transfer or altered by a malign force to introduce
3698: a security hole. To provide maximum security, all distfiles are
1.243 gutterid 3699: protected using two different message digest algorithms (BLAKE2s
3700: and SHA512), as well as the file size.</p>
1.184 rillig 3701: <p>The <code class="filename">distinfo</code> file also contains the
3702: checksums for all the patches found in the
3703: <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
3704: are only applied intentionally and that they don't accidentally change,
3705: e.g. when merging different changes together. They also make sure that
3706: new patches are actually added to CVS and old ones are removed.
3707: Too see whether the patches and the <code class="filename">distinfo</code> file
3708: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3709: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3710: <span class="command"><strong>make distinfo</strong></span> command.</p>
3711: <p>Some packages have different sets of distfiles depending on
1.207 leot 3712: the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk8/index.html" target="_top"><code class="filename">lang/openjdk8</code></a>. These are kept in the same
1.184 rillig 3713: <code class="filename">distinfo</code> file and care should be taken when
3714: upgrading such a package to ensure distfile information is not
3715: lost.</p>
3716: </div>
3717: <div class="sect1">
3718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3719: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3720: </h2></div></div></div>
3721: <p>Some packages don't work out-of-the box on the various
3722: platforms that are supported by pkgsrc. These packages need
3723: to be patched to make them work. The patch files can be
3724: found in the <code class="filename">patches/</code> directory.</p>
3725: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3726: applied to the files in <code class="varname">WRKSRC</code> directory after
3727: extracting them, in alphabetic order.</p>
1.41 asau 3728: <div class="sect2">
1.1 dsieger 3729: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3730: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3731: <p>The <code class="filename">patch-*</code> files should be in
3732: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3733: problems. (To force patches to apply with fuzz you can set
3734: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3735: should contain only changes for a single file, and no file should be
3736: patched by more than one patch file. This helps to keep future
3737: modifications simple.</p>
3738: <p>Each patch file is structured as follows: In the first line,
3739: there is the RCS Id of the patch itself. The second line should be
3740: empty for aesthetic reasons. After that, there should be a comment for
3741: each change that the patch does. There are a number of standard
3742: cases:</p>
3743: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3744: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3745: mention the vulnerability ID (CAN, CVE).</p></li>
3746: <li class="listitem"><p>Patches that change source code should mention the
3747: platform and other environment (for example, the compiler) that the
3748: patch is needed for.</p></li>
3749: </ul></div>
3750: <p>The patch should be commented so that any
3751: developer who knows the code of the application can make some use of
3752: the patch. Special care should be taken for the upstream developers,
3753: since we generally want that they accept our patches, so we have less
3754: work in the future.</p>
1.1 dsieger 3755: </div>
1.41 asau 3756: <div class="sect2">
1.1 dsieger 3757: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3758: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3759: <p>One important thing to mention is to pay attention that no RCS
3760: IDs get stored in the patch files, as these will cause problems when
3761: later checked into the NetBSD CVS tree. Use the
1.207 leot 3762: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.184 rillig 3763: problems.</p>
3764: <p>For even more automation, we recommend using
3765: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.222 gutterid 3766: whole set of patches. You just have to back up files before you
3767: edit them to <code class="filename">filename.orig</code>, e.g., with
1.184 rillig 3768: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3769: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3770: you upgrade a package this way, you can easily compare the new
3771: set of patches with the previously existing one with
3772: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3773: are replaced by new files, so carefully check if you want to take all
3774: the changes.</p>
3775: <p>When you have finished a package, remember to generate
3776: the checksums for the patch files by using the <span class="command"><strong>make
3777: 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>
3778: <p>When adding a patch that corrects a problem in the
3779: distfile (rather than e.g. enforcing pkgsrc's view of where
3780: man pages should go), send the patch as a bug report to the
3781: maintainer. This benefits non-pkgsrc users of the package,
3782: and usually makes it possible to remove the patch in future
3783: version.</p>
3784: <p>The file names of the patch files are usually of the form
3785: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3786: Many packages still use the previous convention
3787: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3788: but new patches should be of the form containing the filename.
1.207 leot 3789: <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.184 rillig 3790: automatically.</p>
1.222 gutterid 3791: <p>When updating pre-existing patch files, if a file uses the old
3792: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
3793: convention, it's best not to change it to the new form, as that will
3794: just cause churn that makes it harder to track changes to patching
3795: over time. Similarly, if a patch now applies at different line offsets,
3796: but still applies cleanly as-is, there's no need to update it, as that
3797: also unnecessarily complicates the patch history.</p>
1.17 imil 3798: </div>
1.160 brook 3799: <div class="sect2">
3800: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3801: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3802: <p>If you want to share patches between multiple packages
3803: in pkgsrc, e.g. because they use the same distfiles, set
3804: <code class="varname">PATCHDIR</code> to the path where the patch files
3805: can be found, e.g.:</p>
3806: <pre class="programlisting">
3807: PATCHDIR= ../../editors/xemacs/patches
3808: </pre>
3809: <p>Patch files that are distributed by the author or other
3810: maintainers can be listed in
3811: <code class="varname">PATCHFILES</code>.</p>
3812: <p>If it is desired to store any patches that should not be
3813: committed into pkgsrc, they can be kept outside the pkgsrc
3814: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3815: directory tree there is expected to have the same
3816: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3817: patches are expected to be stored inside these dirs (also
3818: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3819: example, if you want to keep a private patch for
3820: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3821: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3822: files in the named directory are expected to be patch files,
3823: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3824: applied</em></span>.</p>
1.160 brook 3825: </div>
3826: <div class="sect2">
3827: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3828: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3829: <p>When fixing a portability issue in the code do not use
3830: preprocessor magic to check for the current operating system nor
3831: platform. Doing so hurts portability to other platforms because
3832: the OS-specific details are not abstracted appropriately.</p>
3833: <p>The general rule to follow is: instead of checking for the
3834: operating system the application is being built on, check for the
3835: specific <span class="emphasis"><em>features</em></span> you need. For example,
3836: instead of assuming that kqueue is available under NetBSD and
3837: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3838: kqueue support, add a check that detects kqueue itself —
3839: yes, this generally involves patching the
3840: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3841: that prevents some OSes from adopting interfaces from other OSes
3842: (e.g. Linux implementing kqueue), something that the above checks
3843: cannot take into account.</p>
3844: <p>Of course, checking for features generally involves more
3845: work on the developer's side, but the resulting changes are
3846: cleaner and there are chances they will work on many other
3847: platforms. Not to mention that there are higher chances of being
3848: later integrated into the mainstream sources. Remember:
3849: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3850: <p>Some typical examples:</p>
3851: <div class="table">
3852: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3853: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3854: <colgroup>
3855: <col>
3856: <col>
3857: <col>
3858: </colgroup>
3859: <thead><tr>
3860: <th>Where</th>
3861: <th>Incorrect</th>
3862: <th>Correct</th>
3863: </tr></thead>
3864: <tbody>
3865: <tr>
3866: <td>configure script</td>
3867: <td>
1.160 brook 3868: <pre class="programlisting">
1.184 rillig 3869: case ${target_os} in
3870: netbsd*) have_kvm=yes ;;
3871: *) have_kvm=no ;;
3872: esac
1.160 brook 3873: </pre>
1.184 rillig 3874: </td>
3875: <td>
1.160 brook 3876: <pre class="programlisting">
1.184 rillig 3877: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.160 brook 3878: </pre>
1.184 rillig 3879: </td>
3880: </tr>
3881: <tr>
3882: <td>C source file</td>
3883: <td>
1.1 dsieger 3884: <pre class="programlisting">
1.184 rillig 3885: #if defined(__NetBSD__)
3886: # include <sys/event.h>
3887: #endif
1.1 dsieger 3888: </pre>
1.184 rillig 3889: </td>
3890: <td>
1.1 dsieger 3891: <pre class="programlisting">
1.184 rillig 3892: #if defined(HAVE_SYS_EVENT_H)
3893: # include <sys/event.h>
3894: #endif
1.1 dsieger 3895: </pre>
1.184 rillig 3896: </td>
3897: </tr>
3898: <tr>
3899: <td>C source file</td>
3900: <td>
1.1 dsieger 3901: <pre class="programlisting">
1.184 rillig 3902: int
3903: monitor_file(...)
3904: {
3905: #if defined(__NetBSD__)
3906: int fd = kqueue();
3907: ...
3908: #else
3909: ...
3910: #endif
3911: }
1.1 dsieger 3912: </pre>
1.184 rillig 3913: </td>
3914: <td>
1.1 dsieger 3915: <pre class="programlisting">
1.184 rillig 3916: int
3917: monitor_file(...)
3918: {
3919: #if defined(HAVE_KQUEUE)
3920: int fd = kqueue();
3921: ...
3922: #else
3923: ...
3924: #endif
3925: }
1.1 dsieger 3926: </pre>
1.184 rillig 3927: </td>
3928: </tr>
3929: </tbody>
3930: </table></div>
3931: </div>
3932: <br class="table-break">
3933: </div>
3934: <div class="sect2">
3935: <div class="titlepage"><div><div><h3 class="title">
3936: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3937: <p>Always, always, <span class="strong"><strong>always</strong></span>
3938: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3939: improvements you do to a package to the mainstream developers.
3940: This is the only way to get their attention on portability issues
3941: and to ensure that future versions can be built out-of-the box on
3942: NetBSD. Furthermore, any user that gets newer distfiles will get
3943: the fixes straight from the packaged code.</p>
3944: <p>This generally involves cleaning up the patches
3945: (because sometimes the patches that are
3946: added to pkgsrc are quick hacks), filing bug reports in the
3947: appropriate trackers for the projects and working with the
3948: mainstream authors to accept your changes. It is
3949: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3950: the packages in pkgsrc are kept simple and thus further changes
3951: can be done without much hassle.</p>
3952: <p>When you have done this, please add a URL to the upstream
3953: bug report to the patch comment.</p>
3954: <p>Support the idea of free software!</p>
3955: </div>
1.1 dsieger 3956: </div>
1.184 rillig 3957: <div class="sect1">
3958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3959: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3960: <div class="variablelist"><dl class="variablelist">
3961: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3962: <dd><p>A multi-line description of the piece of software. This should include
3963: any credits where they are due. Please bear in mind that others do not
3964: share your sense of humour (or spelling idiosyncrasies), and that others
3965: will read everything that you write here.</p></dd>
3966: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3967: <dd><p>This file governs the files that are installed on your
3968: system: all the binaries, manual pages, etc. There are other
3969: directives which may be entered in this file, to control the
3970: creation and deletion of directories, and the location of
3971: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3972: information.</p></dd>
3973: </dl></div>
3974: </div>
3975: <div class="sect1">
3976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3977: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3978: <div class="sect2">
3979: <div class="titlepage"><div><div><h3 class="title">
3980: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3981: <div class="variablelist"><dl class="variablelist">
3982: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3983: <dd>
1.259 leot 3984: <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.184 rillig 3985: First time after package extraction and before files are
3986: moved in place, the second time after the files to install
3987: are moved in place. This can be used to do any custom
3988: procedures not possible with @exec commands in
1.259 leot 3989: <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
3990: <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.184 rillig 3991: Please note that you can modify variables in it easily by using
3992: <code class="varname">FILES_SUBST</code> in the package's
3993: <code class="filename">Makefile</code>:</p>
1.1 dsieger 3994: <pre class="programlisting">
1.184 rillig 3995: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3996: </pre>
1.184 rillig 3997: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3998: <code class="filename">INSTALL</code>. By default, substitution is
3999: performed for <code class="varname">PREFIX</code>,
4000: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4001: <code class="varname">VARBASE</code>, and a few others, type
4002: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4003: complete list.</p>
4004: </dd>
4005: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4006: <dd><p>This script is executed before and after any files are removed. It is
4007: this script's responsibility to clean up any additional messy details
4008: around the package's installation, since all pkg_delete knows is how to
4009: delete the files created in the original distribution.
1.259 leot 4010: 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>
4011: 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.184 rillig 4012: The same methods to replace variables can be used as for
4013: the <code class="filename">INSTALL</code> file.</p></dd>
4014: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4015: <dd>
4016: <p>This file is displayed after installation of the package.
1.198 leot 4017: While this was used often in the past, it has two
4018: problems: the display will be missed if many packages are
1.257 jkoshy 4019: installed at once, and the person installing the package
1.198 leot 4020: and the one using or configuring it may be different. It
4021: should therefore be used only in exceptional circumstances
4022: where lasting negative consequences would result from
4023: someone not reading it.</p>
4024: <p>MESSAGE should not be used for:</p>
4025: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4026: <li class="listitem"><p>exhortations to read the documentation</p></li>
4027: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
4028: <li class="listitem"><p>anything that should be explained in the
4029: installation/configuration documentation that should
4030: come with the package</p></li>
4031: </ul></div>
4032: <p>If the documentation provided by upstream needs
4033: enhancing, create e.g. files/README.pkgsrc and install it
4034: in the package's documentation directory.
4035: </p>
4036: <p>Note that MESSAGE is shown for all operating
4037: systems and all init systems. If a MESSAGE is necessary,
4038: it should be narrowed to only those operating systems and
4039: init systems to which it applies.</p>
4040: <p>Note that you can modify variables in it easily by using
1.184 rillig 4041: <code class="varname">MESSAGE_SUBST</code> in the package's
4042: <code class="filename">Makefile</code>:</p>
1.1 dsieger 4043: <pre class="programlisting">
1.184 rillig 4044: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 4045: </pre>
1.184 rillig 4046: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
4047: <code class="filename">MESSAGE</code>. By default, substitution is
4048: performed for <code class="varname">PKGNAME</code>,
4049: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4050: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4051: <code class="varname">PKG_SYSCONFDIR</code>,
4052: <code class="varname">ROOT_GROUP</code>, and
4053: <code class="varname">ROOT_USER</code>.</p>
4054: <p>You can display a different or additional files by
4055: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4056: default is <code class="filename">MESSAGE</code>, if the file
4057: exists.</p>
4058: </dd>
4059: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4060: <dd>
4061: <p>This file is used by the alternatives framework.
4062: It creates, configures, and destroys generic wrappers used to
4063: run programs with similar interfaces.
4064: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4065: for more information.</p>
4066: <p>Each line of the file contains two filenames, first
4067: the wrapper and then the alternative provided by the package.
4068: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4069: </dd>
4070: </dl></div>
4071: </div>
4072: <div class="sect2">
4073: <div class="titlepage"><div><div><h3 class="title">
4074: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
4075: <div class="variablelist"><dl class="variablelist">
4076: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4077: <dd><p>This file contains arbitrary things that could
4078: also go into a <code class="filename">Makefile</code>, but its purpose is
4079: to be used by more than one package. This file should only be
4080: used when the packages that will use the file are known in
4081: advance. For other purposes it is often better to write a
4082: <code class="filename">*.mk</code> file and give it a good name that
4083: describes what it does.</p></dd>
4084: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4085: <dd><p>This file contains the dependency information
4086: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
4087: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4088: <dd><p>This file contains workarounds for compiler bugs
4089: and similar things. It is included automatically by the pkgsrc
4090: infrastructure, so you don't need an extra
4091: <code class="literal">.include</code> line for
4092: it.</p></dd>
4093: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4094: <dd><p>This file contains the code for the
4095: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
4096: selected by the user. If a package has only one or two options,
4097: it is equally acceptable to put the code directly into the
4098: <code class="filename">Makefile</code>.</p></dd>
4099: </dl></div>
4100: </div>
4101: <div class="sect2">
4102: <div class="titlepage"><div><div><h3 class="title">
4103: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
4104: <div class="variablelist"><dl class="variablelist">
4105: <dt><span class="term"><code class="filename">README*</code></span></dt>
4106: <dd><p>These files do not take place in the creation of
4107: a package and thus are purely informative to the package
4108: developer.</p></dd>
4109: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4110: <dd><p>This file contains things that need to be done
4111: to make the package even
4112: better.</p></dd>
4113: </dl></div>
4114: </div>
4115: </div>
4116: <div class="sect1">
4117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4118: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
4119: </h2></div></div></div>
4120: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4121: unpacked into the directory denoted by
4122: <code class="varname">WRKDIR</code>. It can be removed by running
4123: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4124: directory is also used to keep various timestamp files.
4125: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4126: The default is <code class="filename">${.CURDIR}/work</code>
4127: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4128: if <code class="varname">OBJMACHINE</code> is set.</p>
1.1 dsieger 4129: </div>
1.184 rillig 4130: <div class="sect1">
4131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4132: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
4133: </h2></div></div></div>
4134: <p>If you have any files that you wish to be placed in the package
4135: prior to configuration or building, you can place these files here
4136: and use a <span class="command"><strong>${CP}</strong></span> command in the
4137: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4138: <p>If you want to share files in this way with other
4139: packages, set the <code class="varname">FILESDIR</code> variable to point
4140: to the other package's <code class="filename">files</code> directory,
4141: e.g.:</p>
1.1 dsieger 4142: <pre class="programlisting">
1.184 rillig 4143: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 4144: </pre>
4145: </div>
4146: </div>
1.41 asau 4147: <div class="chapter">
1.1 dsieger 4148: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 4149: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.1 dsieger 4150: <div class="toc">
4151: <p><b>Table of Contents</b></p>
1.100 leot 4152: <dl class="toc">
1.184 rillig 4153: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4154: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4155: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4156: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4157: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4158: <dd><dl>
4159: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4160: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4161: </dl></dd>
4162: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4163: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4164: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4165: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4166: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4167: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4168: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4169: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4170: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4171: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4172: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4173: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.1 dsieger 4174: </dl>
4175: </div>
1.41 asau 4176: <div class="sect1">
1.1 dsieger 4177: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4178: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4179: <p>This chapter gives a detailed description on how a package is
4180: built. Building a package is separated into different
4181: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4182: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4183: described in the following sections. Each phase is split into
4184: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4185: containing phase, prefixed by one of <code class="varname">pre-</code>,
4186: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4187: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4188: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4189: <p>Never override the regular targets (like
4190: <code class="varname">fetch</code>), if you have to, override the
4191: <code class="varname">do-*</code> ones instead.</p>
4192: <p>The basic steps for building a program are always the same. First
4193: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4194: the local system and then extracted. After any pkgsrc-specific patches
4195: to compile properly are applied, the software can be configured, then
4196: built (usually by compiling), and finally the generated binaries, etc.
4197: can be put into place on the system.</p>
4198: <p>To get more details about what is happening at each step,
4199: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4200: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4201: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4202: </div>
4203: <div class="sect1">
4204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4205: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4206: <p>Before outlining the process performed by the NetBSD package system in
4207: the next section, here's a brief discussion on where programs are
4208: installed, and which variables influence this.</p>
4209: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4210: where all files of the final program shall be installed. It is
4211: usually set to <code class="varname">LOCALBASE</code>
4212: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4213: for pkgs in the <code class="filename">cross</code> category. The value of
4214: <code class="varname">PREFIX</code> needs to be put
4215: into the various places in the program's source where paths to
4216: 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>
4217: <p>When choosing which of these variables to use,
4218: follow the following rules:</p>
1.41 asau 4219: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 4220: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4221: where the current pkg will be installed. When referring to a
4222: pkg's own installation path, use
4223: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
1.223 nia 4224: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.184 rillig 4225: are installed. If you need to construct a -I or -L argument
4226: to the compiler to find includes and libraries installed by
1.223 nia 4227: another pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.184 rillig 4228: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4229: installed all packages in <code class="filename">/usr/local</code>. As
4230: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4231: administrator, this variable is a misnomer.</p></li>
4232: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4233: distribution (from xsrc, etc.) is installed. When looking for
4234: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4235: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4236: <li class="listitem"><p>X11-based packages using imake must set
4237: <code class="varname">USE_IMAKE</code> to be installed correctly under
4238: <code class="varname">LOCALBASE</code>.</p></li>
4239: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.259 leot 4240: 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.184 rillig 4241: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4242: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4243: </ul></div>
4244: </div>
4245: <div class="sect1">
4246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4247: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4248: <p>When building a package, various directories are used to store
4249: source files, temporary files, pkgsrc-internal files, and so on. These
4250: directories are explained here.</p>
4251: <p>Some of the directory variables contain relative pathnames. There
4252: are two common base directories for these relative directories:
4253: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4254: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4255: inside the package itself.</p>
4256: <div class="variablelist"><dl class="variablelist">
4257: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4258: <dd><p>This is an absolute pathname that points to the pkgsrc
4259: root directory. Generally, you don't need
4260: it.</p></dd>
4261: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4262: <dd><p>This is an absolute pathname that points to the
4263: current package.</p></dd>
4264: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.228 gutterid 4265: <dd>
4266: <p>This is a pathname relative to
4267: <code class="varname">PKGSRCDIR</code> that points to the current package.
4268: It is defined after including <code class="filename">bsd.prefs.mk</code>
4269: and can be used in makefile fragments that are used by several
4270: packages to distinguish between these packages. Other variables
4271: that would serve the same purpose are <code class="varname">PKGBASE</code>
4272: and <code class="varname">PKGNAME</code>, but these are only defined after
4273: including <code class="filename">bsd.pkg.mk</code>, which is too
4274: late.</p>
4275: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
4276: <code class="varname">PKGPATH</code> to tweak variables like
4277: <code class="varname">MAKE_JOBS</code> and
4278: <code class="varname">CFLAGS</code>.</p>
4279: </dd>
1.184 rillig 4280: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4281: <dd><p>This is an absolute pathname pointing to the directory
4282: where all work takes place. The distfiles are extracted to this
4283: directory. It also contains temporary directories and log files used by
4284: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4285: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4286: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4287: <dd><p>This is an absolute pathname pointing to the directory
4288: where the distfiles are extracted. It is usually a direct subdirectory
4289: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4290: that isn't hidden. This variable may be changed by a package
4291: <code class="filename">Makefile</code>.</p></dd>
4292: </dl></div>
4293: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4294: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4295: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4296: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4297: If users would like to have their pkgsrc trees behave in a
4298: read-only manner, then the value of
4299: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4300: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 4301: </div>
1.41 asau 4302: <div class="sect1">
1.1 dsieger 4303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4304: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4305: <p>You can run a particular phase by typing <span class="command"><strong>make
1.228 gutterid 4306: <em class="replaceable"><code>phase</code></em></strong></span>, where
4307: <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
4308: automatically run all phases that are required for this phase. The
4309: default phase is <code class="varname">build</code>, that is, when you run
4310: <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.184 rillig 4311: the package will be built, but not installed.</p>
1.1 dsieger 4312: </div>
1.41 asau 4313: <div class="sect1">
1.1 dsieger 4314: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4315: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4316: <p>The first step in building a package is to fetch the
4317: distribution files (distfiles) from the sites that are providing
4318: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4319: phase.</p>
1.41 asau 4320: <div class="sect2">
1.1 dsieger 4321: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 4322: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4323: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4324: defines all URLs from where the distfile, whose name is
4325: derived from the <code class="varname">DISTNAME</code> variable, is
4326: fetched. The more complicated cases are described
4327: below.</p>
4328: <p>The variable <code class="varname">DISTFILES</code> specifies
4329: the list of distfiles that have to be fetched. Its value
4330: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4331: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4332: so that most packages don't need to define it at all.
4333: <code class="varname">EXTRACT_SUFX</code> is
4334: <code class="literal">.tar.gz</code> by default, but can be changed
4335: freely. Note that if your package requires additional
4336: distfiles to the default one, you cannot just append the
4337: additional filenames using the <code class="literal">+=</code>
4338: operator, but you have write for example:</p>
4339: <pre class="programlisting">
4340: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4341: </pre>
4342: <p>Each distfile is fetched from a list of sites, usually
4343: <code class="varname">MASTER_SITES</code>. If the package has multiple
4344: <code class="varname">DISTFILES</code> or multiple
4345: <code class="varname">PATCHFILES</code> from different sites, you can
4346: set
4347: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4348: to the list of URLs where the file
4349: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4350: (including the suffix) can be found.</p>
4351: <pre class="programlisting">
4352: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4353: DISTFILES+= foo-file.tar.gz
4354: SITES.foo-file.tar.gz= \
4355: https://www.somewhere.com/somehow/ \
4356: https://www.somewhereelse.com/mirror/somehow/
4357: </pre>
4358: <p>When actually fetching the distfiles, each item from
4359: <code class="varname">MASTER_SITES</code> or
4360: <code class="varname">SITES.*</code> gets the name of each distfile
4361: appended to it, without an intermediate slash. Therefore,
4362: all site values have to end with a slash or other separator
4363: character. This allows for example to set
4364: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4365: that gets the name of the distfile as a parameter. In this
4366: case, the definition would look like:</p>
4367: <pre class="programlisting">
4368: MASTER_SITES= https://www.example.com/download.cgi?file=
4369: </pre>
4370: <p> The exception to this rule are URLs starting with a dash.
4371: In that case the URL is taken as is, fetched and the result
4372: stored under the name of the distfile. You can use this style
4373: for the case when the download URL style does not match the
4374: above common case. For example, if permanent download URL is a
4375: redirector to the real download URL, or the download file name
4376: is offered by an HTTP Content-Disposition header. In the
4377: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4378: created instead of the default
4379: <code class="filename">v1.0.0.tar.gz</code>.</p>
4380: <pre class="programlisting">
4381: DISTNAME= foo-1.0.0
4382: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4383: </pre>
4384: <p>There are some predefined values for
4385: <code class="varname">MASTER_SITES</code>, which can be used in
4386: packages. The names of the variables should speak for
4387: themselves.</p>
4388: <table border="0" summary="Simple list" class="simplelist">
4389: <tr>
4390: <td>MASTER_SITE_APACHE</td>
4391: <td>MASTER_SITE_BACKUP</td>
4392: </tr>
4393: <tr>
4394: <td>MASTER_SITE_CRATESIO</td>
4395: <td>MASTER_SITE_CYGWIN</td>
4396: </tr>
4397: <tr>
4398: <td>MASTER_SITE_DEBIAN</td>
4399: <td>MASTER_SITE_FREEBSD</td>
4400: </tr>
4401: <tr>
4402: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4403: <td>MASTER_SITE_GENTOO</td>
4404: </tr>
4405: <tr>
4406: <td>MASTER_SITE_GITHUB</td>
1.225 gutterid 4407: <td>MASTER_SITE_GITLAB</td>
4408: </tr>
4409: <tr>
1.184 rillig 4410: <td>MASTER_SITE_GNOME</td>
1.225 gutterid 4411: <td>MASTER_SITE_GNU</td>
1.184 rillig 4412: </tr>
4413: <tr>
1.260 wiz 4414: <td>MASTER_SITE_GNUPG</td>
1.184 rillig 4415: <td>MASTER_SITE_GNUSTEP</td>
4416: </tr>
4417: <tr>
1.260 wiz 4418: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.184 rillig 4419: <td>MASTER_SITE_IFARCHIVE</td>
4420: </tr>
4421: <tr>
1.260 wiz 4422: <td>MASTER_SITE_KDE</td>
1.184 rillig 4423: <td>MASTER_SITE_MOZILLA</td>
4424: </tr>
4425: <tr>
1.260 wiz 4426: <td>MASTER_SITE_MOZILLA_ALL</td>
1.184 rillig 4427: <td>MASTER_SITE_MYSQL</td>
4428: </tr>
4429: <tr>
1.260 wiz 4430: <td>MASTER_SITE_NETLIB</td>
1.184 rillig 4431: <td>MASTER_SITE_OPENBSD</td>
4432: </tr>
4433: <tr>
1.260 wiz 4434: <td>MASTER_SITE_OPENOFFICE</td>
1.184 rillig 4435: <td>MASTER_SITE_OSDN</td>
4436: </tr>
4437: <tr>
1.260 wiz 4438: <td>MASTER_SITE_PERL_CPAN</td>
1.184 rillig 4439: <td>MASTER_SITE_PGSQL</td>
4440: </tr>
4441: <tr>
1.260 wiz 4442: <td>MASTER_SITE_PYPI</td>
1.184 rillig 4443: <td>MASTER_SITE_RUBYGEMS</td>
4444: </tr>
4445: <tr>
1.260 wiz 4446: <td>MASTER_SITE_R_CRAN</td>
1.184 rillig 4447: <td>MASTER_SITE_SOURCEFORGE</td>
4448: </tr>
1.1 dsieger 4449: <tr>
1.260 wiz 4450: <td>MASTER_SITE_SUNSITE</td>
1.184 rillig 4451: <td>MASTER_SITE_SUSE</td>
1.1 dsieger 4452: </tr>
4453: <tr>
1.260 wiz 4454: <td>MASTER_SITE_TEX_CTAN</td>
1.184 rillig 4455: <td>MASTER_SITE_XCONTRIB</td>
1.1 dsieger 4456: </tr>
4457: <tr>
1.260 wiz 4458: <td>MASTER_SITE_XEMACS</td>
1.184 rillig 4459: <td>MASTER_SITE_XORG</td>
4460: </tr>
4461: </table>
4462: <p>Some explanations for the less self-explaining ones:
4463: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.254 wiz 4464: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.184 rillig 4465: 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>
4466: <p>If you choose one of these predefined sites, you may
4467: want to specify a subdirectory of that site. Since these
4468: macros may expand to more than one actual site, you
4469: <span class="emphasis"><em>must</em></span> use the following construct to
4470: specify a subdirectory:</p>
1.1 dsieger 4471: <pre class="programlisting">
1.184 rillig 4472: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4473: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 4474: </pre>
1.184 rillig 4475: <p>Note the trailing slash after the subdirectory
4476: name.</p>
4477: </div>
4478: <div class="sect2">
4479: <div class="titlepage"><div><div><h3 class="title">
4480: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4481: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4482: all the distfiles exist in a local directory
4483: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4484: user). If the files do not exist, they are fetched using
4485: commands of the form</p>
1.1 dsieger 4486: <pre class="programlisting">
1.184 rillig 4487: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4488: </pre>
4489: <p>where <code class="literal">${site}</code> varies through
4490: several possibilities in turn: first,
4491: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4492: sites specified in either <code class="varname">SITES.file</code> if
4493: defined, else <code class="varname">MASTER_SITES</code> or
4494: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4495: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4496: all except the first and the last can be optionally sorted
4497: by the user, via setting either
4498: <code class="varname">MASTER_SORT_RANDOM</code>, and
4499: <code class="varname">MASTER_SORT_AWK</code> or
4500: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4501: <p> The specific command and arguments used depend on the
4502: <code class="varname">FETCH_USING</code> parameter. The example above is
4503: for <code class="literal">FETCH_USING=custom</code>.</p>
4504: <p>The distfiles mirror run by the NetBSD Foundation uses the
4505: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4506: distfiles, if they are freely distributable. Packages setting
4507: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4508: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4509: mirrored.</p>
1.1 dsieger 4510: </div>
4511: </div>
1.184 rillig 4512: <div class="sect1">
4513: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4514: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4515: <p>After the distfile(s) are fetched, their checksum is
4516: generated and compared with the checksums stored in the
4517: distinfo file. If the checksums don't match, the build is
4518: aborted. This is to ensure the same distfile is used for
4519: building, and that the distfile wasn't changed, e.g. by some
4520: malign force, deliberately changed distfiles on the master
4521: distribution site or network lossage.</p>
1.1 dsieger 4522: </div>
1.41 asau 4523: <div class="sect1">
1.1 dsieger 4524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4525: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4526: <p>When the distfiles are present on the local system, they
4527: need to be extracted, as they usually come in the form of some
4528: compressed archive format.</p>
4529: <p>By default, all <code class="varname">DISTFILES</code> are
4530: extracted. If you only need some of them, you can set the
4531: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4532: files.</p>
4533: <p>Extracting the files is usually done by a little
4534: program, <code class="filename">mk/extract/extract</code>, which
4535: already knows how to extract various archive formats, so most
4536: likely you will not need to change anything here. But if you
4537: need, the following variables may help you:</p>
1.41 asau 4538: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4539: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4540: <dd><p>Use these variables to override the default
4541: options for an extract command, which are defined in
4542: <code class="filename">mk/extract/extract</code>.</p></dd>
4543: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4544: <dd><p>This variable can be set to
4545: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4546: (which is the default value), <code class="literal">pax</code>, or an
4547: absolute pathname pointing to the command with which tar
4548: archives should be extracted. It is preferred to choose bsdtar over gtar
4549: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 4550: </dl></div>
1.184 rillig 4551: <p>If the <code class="filename">extract</code> program doesn't
4552: serve your needs, you can also override the
4553: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4554: command used for extracting the files. This command is
4555: executed in the <code class="filename">${WRKSRC}</code>
4556: directory. During execution of this command, the shell
4557: variable <code class="varname">extract_file</code> holds the absolute
4558: pathname of the file that is going to be extracted.</p>
4559: <p>And if that still does not suffice, you can override the
4560: <code class="varname">do-extract</code> target in the package
4561: Makefile.</p>
1.1 dsieger 4562: </div>
1.41 asau 4563: <div class="sect1">
1.1 dsieger 4564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4565: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4566: <p>After extraction, all the patches named by the
4567: <code class="varname">PATCHFILES</code>, those present in the patches
4568: subdirectory of the package as well as in
4569: $LOCALPATCHES/$PKGPATH (e.g.
4570: <code class="filename">/usr/local/patches/graphics/png</code>) are
4571: applied. Patchfiles ending in <code class="filename">.Z</code> or
4572: <code class="filename">.gz</code> are uncompressed before they are
4573: applied, files ending in <code class="filename">.orig</code> or
4574: <code class="filename">.rej</code> are ignored. Any special options to
1.259 leot 4575: <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.184 rillig 4576: <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.259 leot 4577: <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.184 rillig 4578: fail if the expected text from the patch context is not found in the
4579: patched file. If that happens, fix the patch file by comparing it
4580: with the actual text in the file to be patched.</p>
1.1 dsieger 4581: </div>
1.41 asau 4582: <div class="sect1">
1.1 dsieger 4583: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4584: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4585: <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>.
4586: </p>
1.1 dsieger 4587: </div>
1.41 asau 4588: <div class="sect1">
1.1 dsieger 4589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4590: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4591: <p>This phase creates wrapper programs for the compilers and
4592: linkers. The following variables can be used to tweak the
4593: wrappers.</p>
4594: <div class="variablelist"><dl class="variablelist">
4595: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4596: <dd><p>The command used to print progress
4597: messages. Does nothing by default. Set to
4598: <code class="literal">${ECHO}</code> to see the progress
4599: messages.</p></dd>
4600: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4601: <dd><p>This variable can be set to
4602: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4603: depending on whether you want additional information in the
4604: wrapper log file.</p></dd>
4605: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4606: <dd><p>This variable can be set to
4607: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4608: on whether the wrapper should use its cache, which will
4609: improve the speed. The default value is
4610: <code class="literal">yes</code>, but is forced to
4611: <code class="literal">no</code> if the platform does not support
4612: it.</p></dd>
4613: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4614: <dd><p>A list of reordering commands. A reordering
4615: command has the form
4616: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4617: It ensures that that
4618: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4619: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4620: </p></dd>
4621: </dl></div>
4622: </div>
4623: <div class="sect1">
4624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4625: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4626: <p>Most pieces of software need information on the header
4627: files, system calls, and library routines which are available
4628: on the platform they run on. The process of determining this
4629: information is known as configuration, and is usually
4630: automated. In most cases, a script is supplied with the
4631: distfiles, and its invocation results in generation of header
4632: files, Makefiles, etc.</p>
4633: <p>If the package contains a configure script, this can be
4634: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4635: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4636: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.187 rillig 4637: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4638: <p>In the <code class="literal">do-configure</code> stage, a rough
4639: equivalent of the following command is run. See
4640: <code class="filename">mk/configure/configure.mk</code>, target
4641: <code class="literal">do-configure-script</code> for the exact
4642: definition.</p>
4643: <pre class="programlisting">
4644: .for dir in ${CONFIGURE_DIRS}
4645: cd ${WRKSRC} && cd ${dir} \
4646: && env ${CONFIGURE_ENV} \
4647: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 4648: .endfor
1.1 dsieger 4649: </pre>
1.184 rillig 4650: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4651: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4652: <code class="varname">WRKSRC</code>. In each of these directories, the
4653: configure script is run with the environment
4654: <code class="varname">CONFIGURE_ENV</code> and arguments
4655: <code class="varname">CONFIGURE_ARGS</code>. The variables
4656: <code class="varname">CONFIGURE_ENV</code>,
4657: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4658: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4659: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4660: package.</p>
4661: <p>If the program uses the Perl way of configuration (mainly Perl
4662: modules, but not only), i.e. a file called
4663: <code class="filename">Makefile.PL</code>, it should include
4664: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4665: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4666: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4667: <p>If the program uses an <code class="filename">Imakefile</code>
4668: for configuration, the appropriate steps can be invoked by
4669: setting <code class="varname">USE_IMAKE</code> to
4670: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4671: You can add variables to xmkmf's environment by adding them to the
4672: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4673: <p>If the program uses <code class="filename">cmake</code>
4674: for configuration, the appropriate steps can be invoked by
1.233 wiz 4675: including <code class="filename">../../devel/cmake/build.mk</code>.
1.184 rillig 4676: You can add variables to cmake's environment by adding them to the
4677: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
1.256 wiz 4678: by adding them to the <code class="varname">CMAKE_CONFIGURE_ARGS</code> variable.
1.233 wiz 4679: If you want to add arguments only for particular stages, you can use the
4680: <code class="varname">CMAKE_CONFIGURE_ARGS</code>,
4681: <code class="varname">CMAKE_BUILD_ARGS</code>, and
4682: <code class="varname">CMAKE_INSTALL_ARGS</code> variables.
4683: You can set the <code class="varname">CONFIGURE_DIRS</code> variable to the
4684: directories in which CMake should be run, relative to
4685: <code class="varname">WRKSRC</code>. This defaults to to <span class="quote">“<span class="quote">.</span>”</span>.
4686: </p>
1.256 wiz 4687: <p>Any package using the now-deprecated
4688: <code class="varname">USE_CMAKE=yes</code> should be converted.
4689: Essentially, replace with an include of
4690: <code class="filename">../../devel/cmake/build.mk</code>, prune creation of a build
4691: directory and settings to use it, and check/fix settings that
4692: intend to perform the build in a subdirectory.
4693: </p>
1.184 rillig 4694: <p>If there is no configure step at all, set
4695: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4696: </div>
1.41 asau 4697: <div class="sect1">
1.1 dsieger 4698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4699: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.187 rillig 4700: <p>For building a package, a rough equivalent of the following
4701: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4702: <code class="literal">do-build</code> for the exact definition.</p>
1.1 dsieger 4703: <pre class="programlisting">
1.187 rillig 4704: .for dir in ${BUILD_DIRS}
4705: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 4706: && env ${MAKE_ENV} \
1.187 rillig 4707: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 4708: -f ${MAKE_FILE} \
4709: ${BUILD_TARGET}
4710: .endfor
1.1 dsieger 4711: </pre>
1.184 rillig 4712: <p><code class="varname">BUILD_DIRS</code> (default:
4713: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4714: <code class="varname">WRKSRC</code>. In each of these directories,
4715: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4716: <code class="varname">MAKE_ENV</code> and arguments
4717: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4718: <code class="varname">MAKE_ENV</code>,
4719: <code class="varname">BUILD_MAKE_FLAGS</code>,
4720: <code class="varname">MAKE_FILE</code> and
4721: <code class="varname">BUILD_TARGET</code> may all be changed by the
4722: package.</p>
4723: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4724: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4725: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4726: default value of <code class="varname">MAKE_FILE</code> is
4727: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4728: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4729: <p>If there is no build step at all, set
4730: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4731: </div>
1.41 asau 4732: <div class="sect1">
1.1 dsieger 4733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4734: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4735: <p>[TODO]</p>
1.1 dsieger 4736: </div>
1.41 asau 4737: <div class="sect1">
1.1 dsieger 4738: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4739: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4740: <p>Once the build stage has completed, the final step is to
4741: install the software in public directories, so users can
4742: access the programs and files.</p>
1.187 rillig 4743: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4744: of the following code is executed; see
4745: <code class="filename">mk/install/install.mk</code>, target
4746: <code class="literal">do-install</code> for the exact definition. Additionally,
4747: before and after this code, several consistency checks are run
4748: against the files-to-be-installed, see
4749: <code class="filename">mk/check/*.mk</code> for details.</p>
4750: <pre class="programlisting">
4751: .for dir in ${INSTALL_DIRS}
4752: cd ${WRKSRC} && cd ${dir} \
4753: && env ${INSTALL_ENV} ${MAKE_ENV} \
4754: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4755: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 4756: .endfor
1.1 dsieger 4757: </pre>
1.184 rillig 4758: <p>The variable's meanings are analogous to the ones in the
4759: <span class="emphasis"><em>build</em></span> phase.
4760: <code class="varname">INSTALL_DIRS</code> defaults to
4761: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4762: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4763: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4764: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4765: defined.</p>
4766: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4767: variables are useful. They are all variations of the
1.259 leot 4768: <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.184 rillig 4769: permissions preset. <code class="varname">INSTALL</code> is the plain
4770: install command. The specialized variants, together with their
4771: intended use, are:</p>
4772: <div class="variablelist"><dl class="variablelist">
4773: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4774: <dd><p>directories that contain
4775: binaries</p></dd>
4776: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4777: <dd><p>directories that contain
4778: scripts</p></dd>
4779: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4780: <dd><p>directories that contain shared and static
4781: libraries</p></dd>
4782: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4783: <dd><p>directories that contain data
4784: files</p></dd>
4785: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4786: <dd><p>directories that contain man
4787: pages</p></dd>
4788: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4789: <dd><p>directories that contain data files for games
4790: </p></dd>
4791: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4792: <dd><p>binaries that can be stripped from debugging
4793: symbols</p></dd>
4794: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4795: <dd><p>binaries that cannot be
4796: stripped</p></dd>
4797: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4798: <dd><p>game
4799: binaries</p></dd>
4800: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4801: <dd><p>shared and static
4802: libraries</p></dd>
4803: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4804: <dd><p>data files</p></dd>
4805: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4806: <dd><p>data files for
4807: games</p></dd>
4808: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4809: <dd><p>man pages</p></dd>
4810: </dl></div>
4811: <p>Some other variables are:</p>
4812: <div class="variablelist"><dl class="variablelist">
4813: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.259 leot 4814: <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.184 rillig 4815: when installing binaries. Any debugging sections and symbols present in
4816: binaries will be preserved.
4817: </p></dd>
4818: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4819: <dd><p>A list of directories relative to
4820: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4821: beginning of the <span class="emphasis"><em>install</em></span> phase.
4822: The package is supposed to create all needed directories itself
4823: before installing files to it and list all other directories here.
4824: </p></dd>
4825: </dl></div>
4826: <p>In the rare cases that a package shouldn't install anything,
4827: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4828: mostly relevant for packages in the <code class="filename">regress</code>
4829: category.</p>
1.1 dsieger 4830: </div>
1.41 asau 4831: <div class="sect1">
1.1 dsieger 4832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4833: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4834: <p>Once the install stage has completed, a binary package of
4835: the installed files can be built. These binary packages can be
4836: used for quick installation without previous compilation, e.g. by
4837: the <span class="command"><strong>make bin-install</strong></span> or by using
4838: <span class="command"><strong>pkg_add</strong></span>.</p>
4839: <p>By default, the binary packages are created in
4840: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4841: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4842: one for each category in the <code class="varname">CATEGORIES</code>
4843: variable. <code class="varname">PACKAGES</code> defaults to
4844: <code class="filename">pkgsrc/packages</code>.</p>
1.1 dsieger 4845: </div>
1.41 asau 4846: <div class="sect1">
1.1 dsieger 4847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4848: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4849: <p>Once you're finished with a package, you can clean the work
4850: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4851: to clean the work directories of all dependencies too, use
4852: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 4853: </div>
1.41 asau 4854: <div class="sect1">
1.1 dsieger 4855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4856: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.41 asau 4857: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4858: <dt><span class="term">pre/post-*</span></dt>
4859: <dd>
4860: <p>For any of the main targets described in the previous
4861: section (configure, build, install, etc.), two auxiliary
4862: targets exist with
4863: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4864: prefix for the main target's name. These targets are
4865: invoked before and after the main target is called,
4866: allowing extra configuration or installation steps be
4867: performed from a package's Makefile, for example, which
4868: a program's configure script or install target
4869: omitted.</p>
4870: <p>About 5% of the pkgsrc packages define their custom
4871: post-extract target, another 5% define pre-configure, and 10%
4872: define post-install. The other pre/post-* targets are defined
4873: even less often.</p>
4874: </dd>
4875: <dt><span class="term">do-*</span></dt>
1.1 dsieger 4876: <dd>
1.184 rillig 4877: <p>Should one of the main targets do the wrong thing,
4878: and should there be no variable to fix this, you can
4879: redefine it with the do-* target. (Note that redefining
4880: the target itself instead of the do-* target is a bad
4881: idea, as the pre-* and post-* targets won't be called
4882: anymore, etc.)</p>
4883: <p>About 15% of the pkgsrc packages override the default
4884: do-install, the other do-* targets are overridden even less
4885: often.</p>
1.1 dsieger 4886: </dd>
1.184 rillig 4887: <dt><span class="term">reinstall</span></dt>
1.1 dsieger 4888: <dd>
1.184 rillig 4889: <p>If you did a <span class="command"><strong>make install</strong></span> and
4890: you noticed some file was not installed properly, you
4891: can repeat the installation with this target, which will
4892: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4893: <p>This is the default value of
4894: <code class="varname">DEPENDS_TARGET</code> except in the case of
4895: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4896: package</strong></span>, where the defaults are
4897: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4898: respectively.</p>
1.1 dsieger 4899: </dd>
1.184 rillig 4900: <dt><span class="term">deinstall</span></dt>
4901: <dd>
1.259 leot 4902: <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.184 rillig 4903: current directory, effectively de-installing the
4904: package. The following variables can be used to tune the
4905: behaviour:</p>
4906: <div class="variablelist"><dl class="variablelist">
4907: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.259 leot 4908: <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.184 rillig 4909: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4910: <dd><p>Remove all packages that require (depend on)
4911: the given package. This can be used to remove any
4912: packages that may have been pulled in by a given
4913: package, e.g. if <span class="command"><strong>make deinstall
4914: DEINSTALLDEPENDS=1</strong></span> is done in
4915: <code class="filename">pkgsrc/x11/kde</code>, this is
4916: likely to remove whole KDE. Works by adding
1.259 leot 4917: <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.184 rillig 4918: command line.</p></dd>
4919: </dl></div>
4920: </dd>
4921: <dt><span class="term">bin-install</span></dt>
4922: <dd><p>Install a binary package from local disk and via FTP
4923: from a list of sites (see the
4924: <code class="varname">BINPKG_SITES</code> variable), and do a
4925: <span class="command"><strong>make package</strong></span> if no binary package is
4926: available anywhere. The arguments given to
4927: <span class="command"><strong>pkg_add</strong></span> can be set via
4928: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4929: operation, etc.</p></dd>
4930: <dt><span class="term">install-clean</span></dt>
4931: <dd><p>This target removes the state files for the "install" and later
4932: phases so that the "install" target may be re-invoked. This can be
4933: used after editing the PLIST to install the package without
4934: rebuilding it.</p></dd>
4935: <dt><span class="term">build-clean</span></dt>
4936: <dd><p>This target removes the state files for the "build" and later
4937: phases so that the "build" target may be re-invoked.</p></dd>
4938: <dt><span class="term">update</span></dt>
4939: <dd>
4940: <p>This target causes the current package to be
4941: updated to the latest version. The package and all
4942: depending packages first get de-installed, then current
4943: versions of the corresponding packages get compiled and
4944: installed. This is similar to manually noting which
4945: packages are currently installed, then performing a
4946: series of <span class="command"><strong>make deinstall</strong></span> and
4947: <span class="command"><strong>make install</strong></span> (or whatever
4948: <code class="varname">UPDATE_TARGET</code> is set to) for these
4949: packages.</p>
4950: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4951: resume package updating in case a previous <span class="command"><strong>make
4952: update</strong></span> was interrupted for some reason.
4953: However, in this case, make sure you don't call
4954: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4955: list of dependent packages in <code class="varname">WRKDIR</code>.
4956: Otherwise, you lose the ability to automatically update
4957: the current package along with the dependent packages
4958: you have installed.</p>
4959: <p>Resuming an interrupted <span class="command"><strong>make
4960: update</strong></span> will only work as long as the package
4961: tree remains unchanged. If the source code for one of
4962: the packages to be updated has been changed, resuming
4963: <span class="command"><strong>make update</strong></span> will most certainly
4964: fail!</p>
4965: <p>The following variables can be used either on the
4966: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4967: alter the behaviour of <span class="command"><strong>make
4968: update</strong></span>:</p>
4969: <div class="variablelist"><dl class="variablelist">
4970: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4971: <dd><p>Install target to recursively use for the
4972: updated package and the dependent packages.
4973: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4974: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4975: <span class="command"><strong>make update</strong></span>. Other good
4976: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4977: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4978: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4979: endless loop!</p></dd>
4980: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4981: <dd><p>Don't clean up after updating. Useful if
4982: you want to leave the work sources of the updated
4983: packages around for inspection or other purposes.
4984: Be sure you eventually clean up the source tree
4985: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4986: or you may run into troubles with old source code
4987: still lying around on your next
4988: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4989: update</strong></span>.</p></dd>
4990: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4991: <dd><p>Deinstall each package before installing
4992: (making <code class="varname">DEPENDS_TARGET</code>). This
4993: may be necessary if the
4994: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4995: called after interrupting a running <span class="command"><strong>make
4996: update</strong></span>.</p></dd>
4997: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4998: <dd><p>Allows you to disable recursion and hardcode
4999: the target for packages. The default is
5000: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
5001: facilitating a recursive update of prerequisite
5002: packages. Only set
5003: <code class="varname">DEPENDS_TARGET</code> if you want to
5004: disable recursive updates. Use
5005: <code class="varname">UPDATE_TARGET</code> instead to just
5006: set a specific target for each package to be
5007: installed during <span class="command"><strong>make update</strong></span>
5008: (see above).</p></dd>
5009: </dl></div>
5010: </dd>
5011: <dt><span class="term">clean-update</span></dt>
5012: <dd>
5013: <p>Clean the source tree for all packages that would
5014: get updated if <span class="command"><strong>make update</strong></span> was called
5015: from the current directory. This target should not be
5016: used if the current package (or any of its depending
5017: packages) have already been de-installed (e.g., after
5018: calling <span class="command"><strong>make update</strong></span>) or you may lose
5019: some packages you intended to update. As a rule of
5020: thumb: only use this target <span class="emphasis"><em>before</em></span>
5021: the first time you run <span class="command"><strong>make update</strong></span>
5022: and only if you have a dirty package tree (e.g., if you
5023: used <code class="varname">NOCLEAN</code>).</p>
5024: <p>If you are unsure about whether your tree is
5025: clean, you can either perform a <span class="command"><strong>make
5026: clean</strong></span> at the top of the tree, or use the
5027: following sequence of commands from the directory of the
5028: package you want to update (<span class="emphasis"><em>before</em></span>
5029: running <span class="command"><strong>make update</strong></span> for the first
5030: time, otherwise you lose all the packages you wanted to
5031: update!):</p>
5032: <pre class="screen">
5033: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
5034: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
5035: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
5036: </pre>
5037: <p>The following variables can be used either on the
5038: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
5039: <span class="command"><strong>make clean-update</strong></span>:</p>
5040: <div class="variablelist"><dl class="variablelist">
5041: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
5042: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
5043: reconstruct the list of directories to update for
5044: this package. Only use this if <span class="command"><strong>make
5045: update</strong></span> successfully installed all
5046: packages you wanted to update. Normally, this is
5047: done automatically on <span class="command"><strong>make
5048: update</strong></span>, but may have been suppressed by
5049: the <code class="varname">NOCLEAN</code> variable (see
5050: above).</p></dd>
5051: </dl></div>
5052: </dd>
5053: <dt><span class="term">replace</span></dt>
5054: <dd>
5055: <p>Update the installation of the current package. This
5056: differs from update in that it does not replace dependent
1.207 leot 5057: packages. You will need to install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.184 rillig 5058: target to work.</p>
5059: <p><span class="emphasis"><em>Be careful when using this
5060: target!</em></span> There are no guarantees that dependent
5061: packages will still work, in particular they will most
5062: certainly break if you <span class="command"><strong>make replace</strong></span> a
5063: library package whose shared library major version changed
5064: between your installed version and the new one. For this
5065: reason, this target is not officially supported and only
5066: recommended for advanced users.</p>
5067: </dd>
5068: <dt><span class="term">info</span></dt>
1.259 leot 5069: <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.184 rillig 5070: package. You can use this to check which version of a
5071: package is installed.</p></dd>
5072: <dt><span class="term">index</span></dt>
5073: <dd>
5074: <p>This is a top-level command, i.e. it should be used in
5075: the <code class="filename">pkgsrc</code> directory. It creates a
5076: database of all packages in the local pkgsrc tree, including
5077: dependencies, comment, maintainer, and some other useful
5078: information. Individual entries are created by running
5079: <span class="command"><strong>make describe</strong></span> in the packages'
5080: directories. This index file is saved as
5081: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
5082: verbose format by running <span class="command"><strong>make
5083: print-index</strong></span>. You can search in it with
5084: <span class="command"><strong>make search
5085: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
5086: extract a list of all packages that depend on a particular
5087: one by running <span class="command"><strong>make show-deps
5088: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
5089: <p>Running this command takes a very long time, some
5090: hours even on fast machines!</p>
5091: </dd>
5092: <dt><span class="term">readme</span></dt>
5093: <dd>
5094: <p>This target generates a
1.199 nia 5095: <code class="filename">index.html</code> file, which can be
1.207 leot 5096: viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/index.html" target="_top"><code class="filename">www/links</code></a>. The generated files
1.184 rillig 5097: contain references to any packages which are in the
5098: <code class="varname">PACKAGES</code> directory on the local
5099: host. The generated files can be made to refer to URLs
5100: based on <code class="varname">FTP_PKG_URL_HOST</code> and
5101: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.199 nia 5102: wanted to generate <code class="filename">index.html</code>
1.184 rillig 5103: files which pointed to binary packages on the local
5104: machine, in the directory
5105: <code class="filename">/usr/packages</code>, set
5106: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
5107: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
5108: <code class="varname">${PACKAGES}</code> directory and its
5109: subdirectories will be searched for all the binary
5110: packages.</p>
5111: <p>The target can be run at the toplevel or in category
5112: directories, in which case it descends recursively.</p>
5113: </dd>
5114: <dt><span class="term">readme-all</span></dt>
5115: <dd><p>This is a top-level command, run it in
5116: <code class="filename">pkgsrc</code>. Use this target to create a
5117: file <code class="filename">README-all.html</code> which contains a
5118: list of all packages currently available in the NetBSD
5119: Packages Collection, together with the category they belong
5120: to and a short description. This file is compiled from the
1.199 nia 5121: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.184 rillig 5122: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
5123: readme</strong></span>.</p></dd>
5124: <dt><span class="term">cdrom-readme</span></dt>
5125: <dd><p>This is very much the same as the
5126: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
5127: used when generating a pkgsrc tree to be written to a
5128: CD-ROM. This target also produces
1.199 nia 5129: <code class="filename">index.html</code> files, and can be made
1.184 rillig 5130: to refer to URLs based on
5131: <code class="varname">CDROM_PKG_URL_HOST</code> and
5132: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
5133: <dt><span class="term">show-distfiles</span></dt>
5134: <dd><p>This target shows which distfiles and patchfiles
5135: are needed to build the package
5136: (<code class="varname">ALLFILES</code>, which contains all
5137: <code class="varname">DISTFILES</code> and
5138: <code class="varname">PATCHFILES</code>, but not
5139: <code class="filename">patches/*</code>).</p></dd>
5140: <dt><span class="term">show-downlevel</span></dt>
5141: <dd><p>This target shows nothing if the package is not
5142: installed. If a version of this package is installed,
5143: but is not the version provided in this version of
5144: pkgsrc, then a warning message is displayed. This target
5145: can be used to show which of your installed packages are
5146: downlevel, and so the old versions can be deleted, and
5147: the current ones added.</p></dd>
5148: <dt><span class="term">show-pkgsrc-dir</span></dt>
5149: <dd><p>This target shows the directory in the pkgsrc
5150: hierarchy from which the package can be built and
5151: installed. This may not be the same directory as the one
5152: from which the package was installed. This target is
5153: intended to be used by people who may wish to upgrade
5154: many packages on a single host, and can be invoked from
5155: the top-level pkgsrc Makefile by using the
5156: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
5157: <dt><span class="term">show-installed-depends</span></dt>
5158: <dd><p>This target shows which installed packages match
5159: the current package's <code class="varname">DEPENDS</code>. Useful
5160: if out of date dependencies are causing build
5161: problems.</p></dd>
5162: <dt><span class="term">print-build-depends-list</span></dt>
5163: <dd><p>This target shows the list of packages that the current package
5164: depends on for building.</p></dd>
5165: <dt><span class="term">print-run-depends-list</span></dt>
5166: <dd><p>This target shows the list of packages that the current package
5167: depends on for running.</p></dd>
5168: <dt><span class="term">check-shlibs</span></dt>
5169: <dd><p>After a package is installed, check all its
5170: binaries and (on ELF platforms) shared libraries to see
5171: if they find the shared libs they need. Run by default
5172: 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>
5173: <dt><span class="term">print-PLIST</span></dt>
5174: <dd>
5175: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5176: upgraded pkg, this prints out an attempt to generate a
5177: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5178: -newer work/.extract_done</strong></span>. An attempt is made
5179: to care for shared libs etc., but it is
5180: <span class="emphasis"><em>strongly</em></span> recommended to review the
5181: result before putting it into
5182: <code class="filename">PLIST</code>. On upgrades, it's useful to
5183: diff the output of this command against an already
5184: existing <code class="filename">PLIST</code> file.</p>
1.259 leot 5185: <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.184 rillig 5186: other methods that don't update file access times, be
5187: sure to add these files manually to your
5188: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5189: -newer</span>”</span> command used by this target won't catch
5190: them!</p>
5191: <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
5192: information on this target.</p>
5193: </dd>
1.255 wiz 5194: <dt><span class="term">rebuild</span></dt>
5195: <dd><p>If you did a <span class="command"><strong>make build</strong></span> and you
5196: noticed some further modifications of sources are needed,
5197: you can repeat the build with this target, which will ignore
5198: the <span class="quote">“<span class="quote">already built</span>”</span> flag. This target is
5199: helpful while working with patches.</p></dd>
5200: <dt><span class="term">repackage</span></dt>
5201: <dd><p>If you did a <span class="command"><strong>make package</strong></span> and you
5202: noticed some further modifications of sources are needed,
5203: you can repeat the package with this target, which will ignore
5204: the <span class="quote">“<span class="quote">already packaged</span>”</span> flag. This target is
5205: helpful while working with patches, PLIST* files etc.</p></dd>
5206: <dt><span class="term">retest</span></dt>
5207: <dd><p>If you did a <span class="command"><strong>make test</strong></span> and you
5208: noticed some further modifications of sources are needed,
5209: you can repeat the test with this target, which will ignore
5210: the <span class="quote">“<span class="quote">already tested</span>”</span> flag. This target is
5211: helpful while working with patches.</p></dd>
1.184 rillig 5212: </dl></div>
5213: </div>
5214: </div>
5215: <div class="chapter">
5216: <div class="titlepage"><div><div><h2 class="title">
5217: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5218: <div class="toc">
5219: <p><b>Table of Contents</b></p>
5220: <dl class="toc">
5221: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5222: <dd><dl>
1.219 nia 5223: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
5224: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
5225: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.184 rillig 5226: </dl></dd>
5227: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5228: <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>
5229: </dl>
5230: </div>
5231: <p>When you find a package that is not yet in pkgsrc, you
5232: most likely have a URL from where you can download the source
5233: code. Starting with this URL, creating a package involves only a
5234: few steps.</p>
5235: <div class="procedure"><ol class="procedure" type="1">
5236: <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
5237: enable the basic quality checks.</p></li>
5238: <li class="step">
1.207 leot 5239: <p>Install the package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkg_developer/index.html" target="_top"><code class="filename">meta-pkgs/pkg_developer</code></a>, which among others will
1.184 rillig 5240: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5241: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5242: <span class="command"><strong>mkpatches</strong></span>:</p>
5243: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5244: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5245: </li>
5246: <li class="step">
5247: <p>Choose one of the top-level directories as the category in
5248: which you want to place your package. You can also create a directory of
1.219 nia 5249: your own (maybe called <code class="filename">local</code>). Change into that
5250: category directory:</p>
5251: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em></code></strong></pre>
1.184 rillig 5252: </li>
5253: <li class="step">
1.219 nia 5254: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
5255: argument the URL of the distribution file (in most cases a
5256: <code class="filename">.tar.gz</code> file). This will download the distribution
5257: file and create the necessary files of the package, based on what's in
5258: the distribution file:</p>
1.184 rillig 5259: <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>
5260: </li>
5261: <li class="step">
5262: <p>Examine the extracted files to determine the dependencies of
5263: your package. Ideally, this is mentioned in some
5264: <code class="filename">README</code> file, but things may differ. For each of
5265: these dependencies, look where it exists in pkgsrc, and if there is a
5266: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5267: line to your package <code class="filename">Makefile</code> which includes that
5268: file just before the last line. If the
5269: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5270: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5271: that the package's include files and libraries are provided.</p>
1.219 nia 5272: <p>If you just need binaries from a dependent package, add a
1.184 rillig 5273: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5274: version of the dependency and where it can be found in pkgsrc. This line
5275: should be placed in the third paragraph. If the dependency is only
5276: needed for building the package, but not when using it, use
5277: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5278: instead of <code class="varname">DEPENDS</code>.
5279: The difference between <code class="varname">TOOL_DEPENDS</code> and
5280: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5281: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.219 nia 5282: packages, i.e. packages for the platform where the package is built;
1.184 rillig 5283: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.219 nia 5284: packages, i.e. packages for the platform for which the package
5285: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
5286: specifies a dependency used only for testing the resulting package
5287: built, using the upstream project's included test suite, on the native
5288: platform.
1.184 rillig 5289: Your package may then look like this:</p>
5290: <pre class="programlisting">
5291: [...]
5292:
5293: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5294: DEPENDS+= screen-[0-9]*:../../misc/screen
5295: DEPENDS+= screen>=4.0:../../misc/screen
5296:
5297: [...]
5298:
5299: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5300: .include "../../devel/glib2/buildlink3.mk"
5301: .include "../../mk/bsd.pkg.mk"
5302: </pre>
5303: </li>
5304: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5305: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5306: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5307: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5308: additional explanations.</p></li>
5309: <li class="step"><p>In many cases the package is not yet ready to build. You can
5310: 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
5311: over there, you can hopefully continue here.</p></li>
5312: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5313: directory from the extracted files. Besides these files, a lot of cache
1.219 nia 5314: files and other system information have been saved in the working
5315: directory, which may have become outdated after you edited the
1.184 rillig 5316: <code class="filename">Makefile</code>.</p></li>
5317: <li class="step">
5318: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5319: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p>
1.219 nia 5320: <p>If the extracted files from the package need to be fixed, run
5321: multiple rounds of these commands:</p>
5322: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.184 rillig 5323: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5324: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.219 nia 5325: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
5326: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.184 rillig 5327: </li>
5328: <li class="step"><p>When the package builds fine, the next step is to install
5329: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5330: everything works.</p></li>
5331: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5332: contains a list of the files that are installed by the package, is
5333: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5334: >PLIST</strong></span> to generate a probably correct list. Check
5335: the file using your preferred text editor to see if the list of
5336: files looks plausible.</p></li>
5337: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5338: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5339: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5340: had been registered in the database of installed files, but with an
5341: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5342: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5343: registered with the list of files from
5344: <code class="filename">PLIST</code>.</p></li>
5345: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5346: from above again in a single step, making sure that the PLIST is correct
5347: and the whole package is created as intended.</p></li>
1.219 nia 5348: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
5349: left to do.</p></li>
1.184 rillig 5350: <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>
5351: </ol></div>
5352: <div class="sect1">
5353: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5354: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5355: <div class="sect2">
5356: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5357: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.184 rillig 5358: <p>Python modules and programs packages are easily created using a
5359: set of predefined variables.</p>
5360: <p>
5361: If some Python versions are not supported by the software, set the
5362: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5363: that are not supported, e.g.
5364: </p>
5365: <pre class="programlisting">
5366: PYTHON_VERSIONS_INCOMPATIBLE= 27
5367: </pre>
5368: <p>
1.249 gutterid 5369: If the packaged software is a Python module, include
1.255 wiz 5370: <code class="filename">../../lang/python/wheel.mk</code>. Note per PEP-518,
1.258 wiz 5371: 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
5372: other possible tools that projects can use. Thus inclusion of
1.255 wiz 5373: <code class="filename">wheel.mk</code> does not imply these defaults are
5374: defined as <code class="varname">TOOL_DEPENDS</code>. Whatever the project
5375: specifically requires as packaging tools must be defined in the
5376: package Makefile.
1.215 wiz 5377: </p>
1.248 wiz 5378: <p>The package directory should be called
1.184 rillig 5379: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5380: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5381: </p>
5382: <pre class="programlisting">
5383: DISTNAME= foopymodule-1.2.10
5384: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5385: </pre>
1.226 gutterid 5386: <p>
5387: For software in PyPi, the name should match what PyPi specifies for
5388: "pip install software".
5389: </p>
1.184 rillig 5390: <p>If it is an application, include
5391: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5392: In order to correctly set the path to the Python interpreter, use the
5393: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5394: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5395: For example:
5396: </p>
5397: <pre class="programlisting">
5398: REPLACE_PYTHON= *.py
5399: </pre>
5400: </div>
5401: <div class="sect2">
5402: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5403: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.184 rillig 5404: <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>
5405: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.207 leot 5406: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/index.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
1.184 rillig 5407: Individual packages (and optionally their dependencies) may be created
5408: and updated. R packages generally follow the same form, and most of
5409: the relevant information needed is contained in a
5410: <code class="filename">DESCRIPTION</code> file as part of each R package on
5411: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5412: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5413: creates or updates a package in the canonical form. The resulting
5414: package should be reviewed for correctness.</p>
5415: </div>
5416: <div class="sect2">
5417: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5418: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.184 rillig 5419: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.207 leot 5420: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/index.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
1.184 rillig 5421: <p>If the TeXlive package name is not known, it may be useful to
5422: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5423: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5424: 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
5425: archive</a>.</p>
5426: <p>If the TeXlive package name is known, download the files from
5427: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5428: archive</a>. For package <code class="filename">foo</code>, you will need
5429: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5430: also have associated documentation packages, so download
5431: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5432: should be placed in the appropriate category directory, which is often
5433: but not always <code class="filename">print</code>. Then run the following
5434: command in the category directory.</p>
5435: <pre class="programlisting">
5436: texlive2pkg foo.tar.xz foo.doc.tar.xz
5437: </pre>
5438: <p>This will create two packages, <code class="filename">tex-foo</code> and
5439: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5440: are correct.</p>
5441: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5442: currently does not include version information in package filenames
5443: and changes their contents periodically when updates occur.
5444: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5445: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5446: main one and the corresponding documentation, upload the distfiles
5447: with the following command in each package directory.</p>
5448: <pre class="programlisting">
5449: make upload-distfiles
5450: </pre>
5451: </div>
5452: </div>
5453: <div class="sect1">
5454: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5455: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5456: <div class="sect2">
5457: <div class="titlepage"><div><div><h3 class="title">
5458: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5459: <div class="sect3">
5460: <div class="titlepage"><div><div><h4 class="title">
5461: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5462: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5463: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5464: pkgsrc. As the description says it has to do with the web, the obvious
5465: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5466: <pre class="programlisting">
5467: <code class="prompt">$</code> mkdir www/nvu
5468: <code class="prompt">$</code> cd www/nvu
5469: </pre>
5470: <p>The web site says that the sources are available as a tar file, so
5471: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5472: <pre class="programlisting">
5473: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5474: </pre>
5475: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5476: below the <code class="varname">DISTNAME</code> line, as the package name should
5477: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5478: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5479: <code class="varname">COMMENT</code> fields. Then the package
5480: <code class="filename">Makefile</code> looked like that:</p>
5481: <pre class="programlisting">
5482: # $NetBSD $
5483: #
5484:
5485: DISTNAME= nvu-1.0-sources
5486: PKGNAME= nvu-1.0
5487: CATEGORIES= www
5488: MASTER_SITES= http://cvs.nvu.com/download/
5489: EXTRACT_SUFX= .tar.bz2
5490:
5491: MAINTAINER= rillig@NetBSD.org
5492: HOMEPAGE= http://cvs.nvu.com/
5493: COMMENT= Web Authoring System
5494:
5495: # url2pkg-marker (please do not remove this line.)
5496: .include "../../mk/bsd.pkg.mk"
5497: </pre>
5498: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5499: this is a workaround to prevent CVS expanding to the filename of the
5500: guide.</p>
5501: <p>Then, I quit the editor and watched pkgsrc downloading a large
5502: source archive:</p>
5503: <pre class="programlisting">
5504: url2pkg> Running "make makesum" ...
5505: => Required installed package digest>=20010302: digest-20060826 found
5506: => Fetching nvu-1.0-sources.tar.bz2
5507: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5508: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5509: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5510: url2pkg> Running "make extract" ...
5511: => Required installed package digest>=20010302: digest-20060826 found
5512: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5513: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5514: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5515: ===> Installing dependencies for nvu-1.0
5516: ===> Overriding tools for nvu-1.0
5517: ===> Extracting for nvu-1.0
5518: url2pkg> Adjusting the Makefile.
5519:
5520: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5521:
5522: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5523: </pre>
5524: </div>
5525: <div class="sect3">
5526: <div class="titlepage"><div><div><h4 class="title">
5527: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5528: <p>Now that the package has been extracted, let's see what's inside
5529: it. The package has a <code class="filename">README.txt</code>, but that only
5530: says something about mozilla, so it's probably useless for seeing what
5531: dependencies this package has. But since there is a GNU configure script
5532: in the package, let's hope that it will complain about everything it
5533: needs.</p>
5534: <pre class="programlisting">
5535: <code class="prompt">$</code> bmake
5536: => Required installed package digest>=20010302: digest-20060826 found
5537: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5538: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5539: ===> Patching for nvu-1.0
5540: ===> Creating toolchain wrappers for nvu-1.0
5541: ===> Configuring for nvu-1.0
5542: [...]
5543: configure: error: Perl 5.004 or higher is required.
5544: [...]
5545: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5546: [...]
5547: </pre>
5548: <p>That worked quite well. So I opened the package Makefile in my
5549: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5550: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5551: package have changed now, and since a perl wrapper is automatically
5552: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5553: from scratch.</p>
5554: <pre class="programlisting">
5555: <code class="prompt">$</code> bmake clean
5556: ===> Cleaning for nvu-1.0
5557: <code class="prompt">$</code> bmake
5558: [...]
5559: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5560: GNU Make. You will not be able to build Mozilla without GNU Make.
5561: [...]
5562: </pre>
5563: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5564: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5565: <pre class="programlisting">
5566: [...]
5567: checking for GTK - version >= 1.2.0... no
5568: *** Could not run GTK test program, checking why...
5569: [...]
5570: </pre>
5571: <p>Now to the other dependencies. The first question is: Where is the
5572: GTK package hidden in pkgsrc?</p>
5573: <pre class="programlisting">
5574: <code class="prompt">$</code> echo ../../*/gtk*
5575: [many packages ...]
5576: <code class="prompt">$</code> echo ../../*/gtk
5577: ../../x11/gtk
5578: <code class="prompt">$</code> echo ../../*/gtk2
5579: ../../x11/gtk2
5580: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5581: ../../x11/gtk2/buildlink3.mk
5582: </pre>
5583: <p>The first try was definitely too broad. The second one had exactly
5584: one result, which is very good. But there is one pitfall with GNOME
5585: packages. Before GNOME 2 had been released, there were already many
5586: GNOME 1 packages in pkgsrc. To be able to continue to use these
5587: packages, the GNOME 2 packages were imported as separate packages, and
5588: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5589: whether this was the case here, and indeed it was.</p>
5590: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5591: file, adding the dependency is very easy. I just inserted an
5592: <code class="literal">.include</code> line before the last line of the package
5593: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5594: <pre class="programlisting">
5595: [...]
5596: .include "../../x11/gtk2/buildlink3.mk"
5597: .include "../../mk/bsd.pkg.mk
5598: </pre>
5599: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5600: was:</p>
1.1 dsieger 5601: <pre class="programlisting">
1.184 rillig 5602: [...]
5603: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5604: checking for GTK - version >= 1.2.0... no
5605: *** Could not run GTK test program, checking why...
5606: *** The test program failed to compile or link. See the file config.log for the
5607: *** exact error that occured. This usually means GTK was incorrectly installed
5608: *** or that you have moved GTK since it was installed. In the latter case, you
5609: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5610: configure: error: Test for GTK failed.
5611: [...]
1.111 sevan 5612: </pre>
1.184 rillig 5613: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5614: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5615: told me that this package really wanted to have the GNOME 1 version of
5616: GTK. If the package had looked for GTK2, it would have looked for
5617: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5618: So I changed the <code class="literal">x11/gtk2</code> to
5619: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5620: and tried again.</p>
1.18 snj 5621: <pre class="programlisting">
1.184 rillig 5622: [...]
5623: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5624: In file included from xpidl.c:42:
5625: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5626: In file included from xpidl.c:42:
5627: xpidl.h:132: error: parse error before "IDL_ns"
5628: [...]
1.111 sevan 5629: </pre>
1.184 rillig 5630: <p>The package still does not find all of its dependencies. Now the
5631: question is: Which package provides the
5632: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.18 snj 5633: <pre class="programlisting">
1.184 rillig 5634: <code class="prompt">$</code> echo ../../*/*idl*
5635: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5636: <code class="prompt">$</code> echo ../../*/*IDL*
5637: ../../net/libIDL
1.111 sevan 5638: </pre>
1.184 rillig 5639: <p>Let's take the one from the second try. So I included the
5640: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5641: again. But the error didn't change. After digging through some of the
5642: code, I concluded that the build process of the package was broken and
5643: couldn't have ever worked, but since the Mozilla source tree is quite
5644: large, I didn't want to fix it. So I added the following to the package
5645: <code class="filename">Makefile</code> and tried again:</p>
1.86 wiz 5646: <pre class="programlisting">
1.184 rillig 5647: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5648: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.111 sevan 5649: </pre>
1.184 rillig 5650: <p>The latter line is needed because the package expects the library
5651: <code class="filename">libIDL.so</code>, but only
5652: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5653: wrapper to rewrite that on the fly.</p>
5654: <p>The next problem was related to a recent change of the FreeType
1.207 leot 5655: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/index.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.184 rillig 5656: which patch files were relevant for this issue and copied them to the
5657: <code class="filename">patches</code> directory. Then I retried, fixed the
5658: patches so that they applied cleanly and retried again. This time,
5659: everything worked.</p>
1.86 wiz 5660: </div>
1.184 rillig 5661: <div class="sect3">
5662: <div class="titlepage"><div><div><h4 class="title">
5663: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 5664: <pre class="programlisting">
1.184 rillig 5665: <code class="prompt">$</code> bmake CHECK_FILES=no install
5666: [...]
5667: <code class="prompt">$</code> bmake print-PLIST >PLIST
5668: <code class="prompt">$</code> bmake deinstall
5669: <code class="prompt">$</code> bmake install
1.111 sevan 5670: </pre>
1.184 rillig 5671: </div>
5672: </div>
1.1 dsieger 5673: </div>
5674: </div>
1.41 asau 5675: <div class="chapter">
1.1 dsieger 5676: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 5677: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 5678: <div class="toc">
5679: <p><b>Table of Contents</b></p>
1.100 leot 5680: <dl class="toc">
1.184 rillig 5681: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5682: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5683: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5684: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5685: <dd><dl>
5686: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5687: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5688: <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>
5689: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 5690: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.1 dsieger 5691: </dl></dd>
5692: </dl>
5693: </div>
1.184 rillig 5694: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5695: each of which forms a well-defined part of the pkgsrc system. Using
1.259 leot 5696: 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.184 rillig 5697: like pkgsrc requires some discipline to keep the code correct and
5698: understandable.</p>
5699: <p>The basic ingredients for <code class="filename">Makefile</code>
5700: programming are variables and shell
5701: commands. Among these shell commands may even be more complex ones
1.259 leot 5702: 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.184 rillig 5703: as intended it is necessary to quote all variables correctly when they
5704: are used.</p>
5705: <p>This chapter describes some patterns that appear quite often in
5706: <code class="filename">Makefile</code>s, including the pitfalls that come along
5707: with them.</p>
1.41 asau 5708: <div class="sect1">
1.1 dsieger 5709: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5710: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5711: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5712: <p>When you are creating a file as a
5713: target of a rule, always write the data to a temporary file first
5714: and finally rename that file. Otherwise there might occur an error
5715: in the middle of generating the file, and when the user runs
1.259 leot 5716: <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.184 rillig 5717: regenerated properly. Example:</p>
1.1 dsieger 5718: <pre class="programlisting">
1.184 rillig 5719: wrong:
5720: @echo "line 1" > ${.TARGET}
5721: @echo "line 2" >> ${.TARGET}
5722: @false
5723:
5724: correct:
5725: @echo "line 1" > ${.TARGET}.tmp
5726: @echo "line 2" >> ${.TARGET}.tmp
5727: @false
5728: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 5729: </pre>
1.184 rillig 5730: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5731: <code class="filename">wrong</code> will exist, although there was an error
5732: message in the first run. On the other hand, running <span class="command"><strong>make
5733: correct</strong></span> gives an error message twice, as expected.</p>
1.259 leot 5734: <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.184 rillig 5735: <code class="literal">${.TARGET}</code> in case of error, but this only
5736: happens when it is interrupted, for example by pressing
5737: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.259 leot 5738: 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.184 rillig 5739: </li></ul></div>
5740: </div>
5741: <div class="sect1">
5742: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5743: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5744: <p><code class="filename">Makefile</code> variables contain strings that
5745: can be processed using the five operators <code class="code">=</code>,
5746: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.259 leot 5747: <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.184 rillig 5748: page.</p>
5749: <p>When a variable's value is parsed from a
5750: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5751: the backslash character <code class="code">\</code> are handled specially. If a
5752: backslash is the last character in a line, that backslash is removed
5753: from the line and the line continues with the next line of the file.</p>
5754: <p>The <code class="code">#</code> character starts a comment that reaches
5755: until the end of the line. To get an actual <code class="code">#</code> character,
5756: such as in a URL, write <code class="code">\#</code> instead.</p>
5757: <p>The evaluation of variables either happens immediately or lazy.
5758: It happens immediately when the variable occurs on the right-hand
5759: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5760: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5761: In the other cases, it is evaluated lazily.</p>
5762: <p>Some of the modifiers split the string into words and then
5763: operate on the words, others operate on the string as a whole. When a
5764: string is split into words, double quotes and single quotes are
1.259 leot 5765: 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.184 rillig 5766: <div class="sect2">
5767: <div class="titlepage"><div><div><h3 class="title">
5768: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5769: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5770: <li class="listitem"><p>All variable names starting with an underscore
5771: are reserved for use by the pkgsrc infrastructure. They shall
5772: not be used by packages.</p></li>
5773: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5774: lowercase variable names for the iteration
5775: variables.</p></li>
5776: <li class="listitem"><p>All list variables should have a plural name,
5777: such as <code class="varname">PKG_OPTIONS</code> or
5778: <code class="varname">DISTFILES</code>.</p></li>
5779: </ul></div>
5780: </div>
5781: </div>
5782: <div class="sect1">
5783: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5784: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5785: <div class="sect2">
5786: <div class="titlepage"><div><div><h3 class="title">
5787: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5788: <p>When adding a string that possibly contains whitespace or quotes to
5789: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5790: modifier.</p>
5791: <p>When adding another list to a list (example 2), it must not be
5792: quoted, since its elements are already quoted.</p>
1.1 dsieger 5793: <pre class="programlisting">
1.184 rillig 5794: STRING= foo * bar `date`
5795: LIST= # empty
5796: ANOTHER_LIST= a=b c=d
5797:
5798: LIST+= ${STRING:Q} # 1
5799: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 5800: </pre>
1.184 rillig 5801: </div>
5802: <div class="sect2">
5803: <div class="titlepage"><div><div><h3 class="title">
5804: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5805: <p>Echoing a string containing special characters needs special
5806: work.</p>
1.1 dsieger 5807: <pre class="programlisting">
1.184 rillig 5808: STRING= foo bar < > * `date` $$HOME ' "
5809: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5810:
5811: all:
5812: echo ${STRING} # 1
5813: echo ${STRING:Q} # 2
5814: printf '%s\n' ${STRING:Q}'' # 3
5815: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 5816: </pre>
1.184 rillig 5817: <p>Example 1 leads to a syntax error in the shell, as the characters
5818: are just copied.</p>
5819: <p>Example 2 quotes the string so that the shell interprets it
5820: correctly. But the echo command may additionally interpret strings with a
5821: leading dash or those containing backslashes.</p>
1.259 leot 5822: <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.184 rillig 5823: interprets the format string, but not the next argument. The trailing
5824: single quotes handle the case when the string is empty. In that case, the
5825: :Q modifier would result in an empty string too, which would then be
1.259 leot 5826: 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.184 rillig 5827: but other programs may care.</p>
5828: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5829: need to be quoted because the quoting has already been done
5830: when adding elements to the list.</p>
1.1 dsieger 5831: </div>
1.41 asau 5832: <div class="sect2">
1.1 dsieger 5833: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 5834: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5835: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5836: GNU-style configure script (especially those that call other configure
5837: scripts), it must not have leading or trailing whitespace, since
5838: otherwise the configure script gets confused. To trim leading and
5839: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5840: following example:</p>
1.1 dsieger 5841: <pre class="programlisting">
1.184 rillig 5842: CPPFLAGS= # empty
5843: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5844: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 5845:
1.184 rillig 5846: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 5847:
1.184 rillig 5848: all:
5849: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5850: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5851: </pre>
5852: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5853: trailing whitespace because the <code class="code">+=</code> operator always adds a
5854: space.</p>
5855: </div>
5856: <div class="sect2">
5857: <div class="titlepage"><div><div><h3 class="title">
5858: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5859: <p>When a possibly empty variable is used in a shell program, it may
5860: lead to a syntax error.</p>
5861: <pre class="programlisting">
5862: EGFILES= # empty
1.1 dsieger 5863:
1.184 rillig 5864: install-examples: # produces a syntax error in the shell
5865: for egfile in ${EGFILES}; do \
5866: echo "Installing $$egfile"; \
5867: done
5868: </pre>
5869: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.259 leot 5870: <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.184 rillig 5871: To fix this syntax error, use one of the snippets below.</p>
5872: <pre class="programlisting">
1.229 gutterid 5873: EGFILES= # empty
1.1 dsieger 5874:
1.184 rillig 5875: install-examples:
5876: for egfile in ${EGFILES} ""; do \
5877: [ -n "$$egfile" ] || continue; \
5878: echo "Installing $$egfile"; \
5879: done
5880: </pre>
5881: <p>In this case, an empty string is appended to the iteration list (to
5882: prevent the syntax error) and filtered out later.</p>
5883: <pre class="programlisting">
5884: EGFILES= # empty
1.1 dsieger 5885:
1.184 rillig 5886: install-examples:
5887: .for egfile in ${EGFILES}
5888: echo "Installing ${egfile}"
5889: .endfor
1.1 dsieger 5890: </pre>
1.184 rillig 5891: <p>If one of the filenames contains special characters, it should be
5892: enclosed in single or double quotes.</p>
5893: <p>To have a shell command test whether a make variable is empty, use
5894: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5895: </div>
1.229 gutterid 5896: <div class="sect2">
5897: <div class="titlepage"><div><div><h3 class="title">
5898: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
5899: <p>When a variable can have the values <code class="literal">yes</code> or
5900: <code class="literal">no</code>, use the following pattern to test the variable:</p>
5901: <pre class="programlisting">
5902: .if ${VAR:U:tl} == "yes"
5903: # do something
5904: .endif
5905: </pre>
5906: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
5907: can be undefined. If the variable is guaranteed to be defined, the
5908: <code class="literal">:U</code> can be omitted.</p>
5909: <p>The <code class="literal">:tl</code> modifier converts the variable value to
5910: lowercase, allowing for the values <code class="literal">yes</code>,
5911: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
5912: </div>
1.184 rillig 5913: </div>
5914: </div>
5915: <div class="chapter">
5916: <div class="titlepage"><div><div><h2 class="title">
5917: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5918: <div class="toc">
5919: <p><b>Table of Contents</b></p>
5920: <dl class="toc">
5921: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5922: <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>
5923: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5924: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5925: </dl>
1.1 dsieger 5926: </div>
1.184 rillig 5927: <p>Many packages have the ability to be built to support different
5928: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5929: in pkgsrc that provides generic handling of those options that
5930: determine different ways in which the packages can be built. It's
5931: possible for the user to specify exactly which sets of options will be
5932: built into a package or to allow a set of global default options
5933: apply.</p>
5934: <p>There are two broad classes of behaviors that one might want to
5935: control via options. One is whether some particular feature is
5936: enabled in a program that will be built anyway, often by including or
5937: not including a dependency on some other package. The other is
5938: whether or not an additional program will be built as part of the
5939: package. Generally, it is better to make a split package for such
5940: additional programs instead of using options, because it enables
5941: binary packages to be built which can then be added separately. For
5942: example, the foo package might have minimal dependencies (those
5943: packages without which foo doesn't make sense), and then the foo-gfoo
5944: package might include the GTK frontend program gfoo. This is better
5945: than including a gtk option to foo that adds gfoo, because either that
5946: option is default, in which case binary users can't get foo without
5947: gfoo, or not default, in which case they can't get gfoo. With split
5948: packages, they can install foo without having GTK, and later decide to
5949: install gfoo (pulling in GTK at that time). This is an advantage to
5950: source users too, avoiding the need for rebuilds.</p>
5951: <p>Plugins with widely varying dependencies should usually be split
5952: instead of options.</p>
5953: <p>It is often more work to maintain split packages, especially if
5954: the upstream package does not support this. The decision of split
5955: vs. option should be made based on the likelihood that users will want
5956: or object to the various pieces, the size of the dependencies that are
5957: included, and the amount of work.</p>
5958: <p>A further consideration is licensing. Non-free parts, or parts
5959: that depend on non-free dependencies (especially plugins) should
5960: almost always be split if feasible.</p>
5961: <div class="sect1">
5962: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5963: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5964: <p>Global default options are listed in
5965: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5966: that should be built into every package if that option is supported.
5967: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5968: </div>
1.41 asau 5969: <div class="sect1">
1.1 dsieger 5970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5971: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5972: </h2></div></div></div>
5973: <p>The following example shows how
5974: <code class="filename">bsd.options.mk</code> should be used
5975: by the hypothetical ``wibble'' package, either in the package
5976: <code class="filename">Makefile</code>, or in a file,
5977: e.g. <code class="filename">options.mk</code>, that is included by the
5978: main package <code class="filename">Makefile</code>.</p>
1.1 dsieger 5979: <pre class="programlisting">
1.184 rillig 5980: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5981: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5982: PKG_OPTIONS_OPTIONAL_GROUPS= database
5983: PKG_OPTIONS_GROUP.database= mysql pgsql
5984: PKG_SUGGESTED_OPTIONS= wibble-foo
5985: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5986: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5987:
5988: .include "../../mk/bsd.prefs.mk"
5989:
5990: # this package was previously named wibble2
5991: .if defined(PKG_OPTIONS.wibble2)
5992: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5993: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5994: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5995: .endif
5996:
5997: .include "../../mk/bsd.options.mk"
5998:
5999: # Package-specific option-handling
1.1 dsieger 6000:
1.184 rillig 6001: ###
6002: ### FOO support
6003: ###
6004: .if !empty(PKG_OPTIONS:Mwibble-foo)
6005: CONFIGURE_ARGS+= --enable-foo
6006: .endif
1.1 dsieger 6007:
1.184 rillig 6008: ###
6009: ### LDAP support
6010: ###
6011: .if !empty(PKG_OPTIONS:Mldap)
6012: . include "../../databases/openldap-client/buildlink3.mk"
6013: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6014: .endif
1.1 dsieger 6015:
1.184 rillig 6016: ###
6017: ### database support
6018: ###
6019: .if !empty(PKG_OPTIONS:Mmysql)
6020: . include "../../mk/mysql.buildlink3.mk"
6021: .endif
6022: .if !empty(PKG_OPTIONS:Mpgsql)
6023: . include "../../mk/pgsql.buildlink3.mk"
6024: .endif
6025: </pre>
6026: <p>The first section contains the information about which build
6027: options are supported by the package, and any default options settings
6028: if needed.</p>
6029: <div class="orderedlist"><ol class="orderedlist" type="1">
6030: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.259 leot 6031: <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.184 rillig 6032: options. It should be set to
6033: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6034: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6035: at the point where the options are processed.</p></li>
6036: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6037: build options supported by the package.</p></li>
6038: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6039: list of names of groups of mutually exclusive options. The options in
6040: each group are listed in
6041: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6042: The most specific setting of any option from the group takes
6043: precedence over all other options in the group. Options from the
6044: groups will be automatically added to
6045: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6046: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6047: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6048: packages will fail if no option from the group is
6049: selected.</p></li>
6050: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6051: of names of sets of options. At least one option from each set must
6052: be selected. The options in each set are listed in
6053: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6054: Options from the sets will be automatically added to
6055: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6056: fail if no option from the set is selected.</p></li>
6057: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6058: build options which are enabled by default.</p></li>
6059: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6060: of
6061: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
6062: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
6063: their option counterparts. Pairs should be added with
6064: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
6065: warning will be issued if the user uses a legacy
6066: variable.</p></li>
6067: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6068: of
6069: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
6070: pairs that map options that have been renamed to their new
6071: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
6072: the listing of global legacy options. A warning will be issued if
6073: the user uses a legacy option.</p></li>
6074: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6075: options implied by deprecated variables used. This can be used for
6076: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6077: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6078: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6079: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6080: a list of warnings about deprecated variables or options used, and
6081: what to use instead.</p></li>
6082: </ol></div>
6083: <p>A package should never modify
6084: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6085: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6086: To suggest a default set of options, use
6087: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6088: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6089: including <code class="filename">bsd.options.mk</code>. If none of
6090: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6091: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6092: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6093: happen with platform-specific options if none of them is supported on
6094: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6095: empty list and the package is otherwise treated as not using the
6096: options framework.</p>
6097: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6098: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6099: build options, properly filtered to remove unsupported and duplicate
6100: options.</p>
6101: <p>The remaining sections contain the logic that is specific to
6102: each option. The correct way to check for an option is to check
6103: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6104: <pre class="programlisting">
6105: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.1 dsieger 6106: </pre>
6107: </div>
1.184 rillig 6108: <div class="sect1">
6109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6110: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
6111: <p>Options that enable similar features in different packages (like
6112: optional support for a library) should use a common name in all
6113: packages that support it (like the name of the library). If another
6114: package already has an option with the same meaning, use the same
6115: name.</p>
6116: <p>Options that enable features specific to one package, where it's
6117: unlikely that another (unrelated) package has the same (or a similar)
6118: optional feature, should use a name prefixed with
6119: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6120: <p>If a group of related packages share an optional feature
6121: specific to that group, prefix it with the name of the
6122: <span class="quote">“<span class="quote">main</span>”</span> package
6123: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6124: <p>For new options, add a line to
6125: <code class="filename">mk/defaults/options.description</code>. Lines have two
6126: fields, separated by tab. The first field is the option name, the
6127: second its description. The description should be a whole sentence
6128: (starting with an uppercase letter and ending with a period) that
6129: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6130: support.</span>”</span> The file is sorted by option names.</p>
6131: </div>
6132: <div class="sect1">
6133: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6134: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
6135: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6136: different dependencies based on the options with which the package was
6137: built. For querying these options, the file
6138: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6139: typical example looks like this:</p>
1.1 dsieger 6140: <pre class="programlisting">
1.184 rillig 6141: pkgbase := libpurple
6142: .include "../../mk/pkg-build-options.mk"
6143:
6144: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6145: ...
6146: .endif
1.117 sevan 6147: </pre>
1.184 rillig 6148: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6149: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6150: options of the libpurple package, which can then be queried like
6151: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6152: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6153: details.</p>
1.1 dsieger 6154: </div>
6155: </div>
1.41 asau 6156: <div class="chapter">
1.1 dsieger 6157: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 6158: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6159: <div class="toc">
6160: <p><b>Table of Contents</b></p>
1.100 leot 6161: <dl class="toc">
1.184 rillig 6162: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
6163: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
6164: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6165: </dl>
6166: </div>
1.184 rillig 6167: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6168: by pkgsrc and also for individual packages to define what commands
6169: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6170: or for later run-time of an installed packaged (such as
6171: <code class="varname">DEPENDS</code>).
6172: If the native system provides an adequate tool, then in many cases, a pkgsrc
6173: package will not be used.</p>
6174: <p>When building a package, the replacement tools are
6175: made available in a directory (as symlinks or wrapper scripts)
6176: that is early in the executable search path. Just like the buildlink
6177: system, this helps with consistent builds.</p>
6178: <p>A tool may be needed to help build a specific package. For example,
6179: perl, GNU make (gmake) or yacc may be needed.</p>
6180: <p>Also a tool may be needed, for example, because the native system's supplied
6181: tool may be inefficient for building a package with pkgsrc.
6182: For example, a package may need GNU awk, bison (instead of
6183: yacc) or a better sed.</p>
6184: <p>The tools used by a package can be listed by running
6185: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6186: <div class="sect1">
1.1 dsieger 6187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6188: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6189: <p>The default set of tools used by pkgsrc is defined in
6190: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6191: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6192: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6193: These can be seen by running:
6194: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6195: <p>If a package needs a specific program to build
6196: then the <code class="varname">USE_TOOLS</code> variable can be used
6197: to define the tools needed.</p>
1.1 dsieger 6198: </div>
1.184 rillig 6199: <div class="sect1">
6200: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6201: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6202: <p>In the following examples, the :run means that it is needed at
6203: run-time (and becomes a DEPENDS).
6204: The default is a build dependency which can be set with
6205: :build. (So in this example, it is the same as gmake:build
6206: and pkg-config:build.)</p>
1.1 dsieger 6207: <pre class="programlisting">
1.184 rillig 6208: USE_TOOLS+= gmake perl:run pkg-config
1.1 dsieger 6209: </pre>
1.184 rillig 6210: <p>When using the tools framework, a
6211: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6212: which contains the full path to the appropriate tool. For example,
6213: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6214: on Linux systems.</p>
6215: <p>If you always need a pkgsrc version of the
6216: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6217: </p>
1.1 dsieger 6218: </div>
1.184 rillig 6219: <div class="sect1">
6220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6221: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6222: <p>When improving or porting pkgsrc to a new platform, have a look
6223: at (or create) the corresponding platform specific make file fragment under
6224: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6225: the name of the common tools. For example:</p>
1.1 dsieger 6226: <pre class="programlisting">
1.184 rillig 6227: .if exists(/usr/bin/bzcat)
6228: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6229: .elif exists(/usr/bin/bzip2)
6230: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6231: .endif
6232:
6233: TOOLS_PLATFORM.true?= true # shell builtin
1.1 dsieger 6234: </pre>
6235: </div>
6236: </div>
1.184 rillig 6237: <div class="chapter">
6238: <div class="titlepage"><div><div><h2 class="title">
6239: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6240: <div class="toc">
6241: <p><b>Table of Contents</b></p>
6242: <dl class="toc">
6243: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6244: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6245: <dd><dl>
6246: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6247: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6248: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6249: and
6250: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6251: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6252: </dl></dd>
6253: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.241 rillig 6254: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.184 rillig 6255: </dl>
1.1 dsieger 6256: </div>
1.184 rillig 6257: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6258: are seen by a package's configure and build processes. This is implemented
6259: in a two step process:</p>
6260: <div class="orderedlist"><ol class="orderedlist" type="1">
6261: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6262: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6263: of <code class="varname">WRKDIR</code>.</p></li>
6264: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6265: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6266: <code class="option">-L${LOCALBASE}/lib</code> into references to
6267: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6268: native compiler on some operating systems look like GCC, so that
6269: packages that expect GCC won't require modifications to build with
6270: those native compilers.</p></li>
6271: </ol></div>
6272: <p>This normalizes the environment in which a package is built so that the
6273: package may be built consistently despite what other software may be
6274: installed. Please note that the normal system header and library paths,
6275: e.g. <code class="filename">/usr/include</code>,
6276: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6277: designed to insulate the package build from non-system-supplied
6278: software.</p>
1.41 asau 6279: <div class="sect1">
1.1 dsieger 6280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6281: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6282: <p>The process of converting packages to use the buildlink3
6283: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6284: The things to keep in mind are:</p>
1.23 wiz 6285: <div class="orderedlist"><ol class="orderedlist" type="1">
1.184 rillig 6286: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6287: instead of the actual toolchain. Some packages are tricky,
6288: and the only way to know for sure is the check
6289: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6290: wrappers are being invoked.</p></li>
6291: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6292: the package Makefile, e.g. Java VMs, standalone shells,
6293: etc., because the code to symlink files into
6294: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6295: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6296: </p></li>
6297: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6298: <code class="filename">buildlink3.mk</code> files that you list in a
6299: package's Makefile are added as dependencies for that package.
6300: </p></li>
6301: </ol></div>
6302: <p>If a dependency on a particular package is required for its libraries and
6303: headers, then we replace:</p>
6304: <pre class="programlisting">
6305: DEPENDS+= foo>=1.1.0:../../category/foo
6306: </pre>
6307: <p>with</p>
6308: <pre class="programlisting">
6309: .include "../../category/foo/buildlink3.mk"
6310: </pre>
6311: <p>The buildlink3.mk files usually define the required dependencies.
6312: If you need a newer version of the dependency when using buildlink3.mk
6313: files, then you can define it in your Makefile; for example:</p>
1.1 dsieger 6314: <pre class="programlisting">
1.184 rillig 6315: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6316: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 6317: </pre>
1.184 rillig 6318: <p>There are several <code class="filename">buildlink3.mk</code>
6319: files in <code class="filename">pkgsrc/mk</code>
6320: that handle special package issues:</p>
6321: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6322: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6323: the native or a pkgsrc Berkeley DB implementation based on
6324: the values of <code class="varname">BDB_ACCEPTED</code> and
6325: <code class="varname">BDB_DEFAULT</code>.</p></li>
6326: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6327: comes with neither Curses nor NCurses, this will take care
1.207 leot 6328: to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/index.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.184 rillig 6329: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6330: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6331: adding a dependency on Heimdal or MIT-krb5 for packages that
6332: require a Kerberos 5 implementation.</p></li>
6333: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6334: system-provided Motif installation or adds a dependency on
1.207 leot 6335: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/index.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/index.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.184 rillig 6336: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6337: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6338: to choose which Motif version will be used.</p></li>
6339: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6340: system-provided GNU readline or editline (libedit) installation,
1.207 leot 6341: 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>,
6342: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/index.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.184 rillig 6343: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6344: If your package really needs GNU readline library, its Makefile
6345: should include <code class="filename">devel/readline/buildlink3.mk</code>
6346: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6347: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6348: variables that may be used by packages that use the
6349: Open Sound System (OSS) API.</p></li>
6350: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6351: any of the Postgres versions in the variable
6352: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6353: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6354: the file for more information.</p></li>
6355: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6356: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.207 leot 6357: a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/index.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.184 rillig 6358: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6359: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6360: library.</p></li>
6361: </ul></div>
6362: <p>The comments in those <code class="filename">buildlink3.mk</code>
6363: files provide a more complete
6364: description of how to use them properly.</p>
1.1 dsieger 6365: </div>
1.41 asau 6366: <div class="sect1">
1.1 dsieger 6367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6368: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6369: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6370: included by Makefiles to indicate the need to compile and link
6371: against header files and libraries provided by the package. A
6372: <code class="filename">buildlink3.mk</code> file should always provide
6373: enough information to add the correct type of dependency
6374: relationship and include any other
6375: <code class="filename">buildlink3.mk</code> files that it needs to find
6376: headers and libraries that it needs in turn.</p>
6377: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.207 leot 6378: file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/index.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.184 rillig 6379: package is highly recommended. For most packages, the following
6380: command will generate a good starting point for
6381: <code class="filename">buildlink3.mk</code> files:</p>
6382: <pre class="screen">
6383: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6384: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6385: </pre>
1.41 asau 6386: <div class="sect2">
1.1 dsieger 6387: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6388: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6389: <p>The following real-life example
6390: <code class="filename">buildlink3.mk</code> is taken
6391: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.1 dsieger 6392: <pre class="programlisting">
1.184 rillig 6393: BUILDLINK_TREE+= tiff
6394:
6395: .if !defined(TIFF_BUILDLINK3_MK)
6396: TIFF_BUILDLINK3_MK:=
6397:
6398: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6399: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6400: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6401:
6402: .include "../../devel/zlib/buildlink3.mk"
6403: .include "../../graphics/jpeg/buildlink3.mk"
6404: .endif # TIFF_BUILDLINK3_MK
6405:
6406: BUILDLINK_TREE+= -tiff
1.1 dsieger 6407: </pre>
1.184 rillig 6408: <p>The header and footer manipulate
6409: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6410: <code class="filename">buildlink3.mk</code> files and is used to track
6411: the dependency tree.</p>
6412: <p>The main section is protected from multiple inclusion
6413: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6414: added. Several important variables are set in the section:</p>
6415: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6416: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6417: is the dependency version recorded in the installed
1.184 rillig 6418: package; this should always be set using
6419: <span class="command"><strong>+=</strong></span> to ensure that
6420: we're appending to any pre-existing list of values. This
1.185 wiz 6421: variable should be set to the last version of the
1.184 rillig 6422: package that had an backwards-incompatible API change.
6423: </p></li>
6424: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6425: is the location of the <em class="replaceable"><code>pkg</code></em>
6426: pkgsrc directory.</p></li>
6427: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6428: (not shown above) controls whether we use
1.236 gutterid 6429: <code class="varname">BUILD_DEPENDS</code> or
1.184 rillig 6430: <code class="varname">DEPENDS</code> to add the dependency on
6431: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6432: selected by setting
6433: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.236 gutterid 6434: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.184 rillig 6435: used.</p></li>
6436: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6437: and
6438: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6439: (not shown above) are lists of subdirectories of
6440: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6441: to add to the header and library search paths. These
6442: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6443: respectively.</p></li>
6444: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6445: (not shown above) is the list of preprocessor flags to add
6446: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6447: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6448: should be avoided and instead be handled using
6449: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6450: above.</p></li>
6451: </ul></div>
6452: <p>The following variables are all optionally defined within
6453: this second section (protected against multiple inclusion) and
6454: control which package files are symlinked into
6455: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6456: transformed during the symlinking:</p>
6457: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6458: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6459: (not shown above) is a shell glob pattern relative to
6460: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6461: to be symlinked into
6462: <code class="filename">${BUILDLINK_DIR}</code>,
6463: e.g. <code class="filename">include/*.h</code>.</p></li>
6464: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6465: (not shown above) is a shell pipeline that
6466: outputs to stdout a list of files relative to
6467: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6468: The resulting files are to be symlinked
6469: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6470: this takes the <code class="filename">+CONTENTS</code> of a
6471: <em class="replaceable"><code>pkg</code></em> and filters it through
6472: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6473: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6474: (not shown above) is a filter command that filters
6475: <code class="filename">+CONTENTS</code> input into a list of files
6476: relative to
6477: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6478: on stdout. By default,
6479: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6480: outputs the contents of the <code class="filename">include</code>
6481: and <code class="filename">lib</code> directories in the package
6482: <code class="filename">+CONTENTS</code>.</p></li>
6483: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6484: (not shown above) is a list of sed arguments used to
6485: transform the name of the source filename into a
6486: destination filename, e.g. <span class="command"><strong>-e
6487: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6488: </ul></div>
6489: <p>This section can additionally include any
6490: <code class="filename">buildlink3.mk</code> needed for
6491: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6492: Including these <code class="filename">buildlink3.mk</code> files
6493: means that the headers and libraries for these
6494: dependencies are also symlinked into
6495: <code class="filename">${BUILDLINK_DIR}</code>
6496: whenever the <em class="replaceable"><code>pkg</code></em>
6497: <code class="filename">buildlink3.mk</code>
6498: file is included. Dependencies are only added for directly
6499: include <code class="filename">buildlink3.mk</code> files.</p>
6500: <p>When providing a <code class="filename">buildlink3.mk</code> and
6501: including other <code class="filename">buildlink3.mk</code> files in it,
6502: please only add necessary ones, i.e., those whose libraries or
6503: header files are automatically exposed when the package is
6504: use.</p>
6505: <p>In particular, if only an executable
6506: (<code class="filename">bin/foo</code>) is linked against a library, that
6507: library does not need to be propagated in the
6508: <code class="filename">buildlink3.mk</code> file.</p>
6509: <p>The following steps should help you decide if a
6510: <code class="filename">buildlink3.mk</code> file needs to be included:
6511: </p>
6512: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6513: <li class="listitem"><p>Look at the installed header files: What
6514: headers do they include? The packages providing these files
6515: must be buildlinked.</p></li>
6516: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6517: libraries and look against what other libraries they link.
6518: Some of the packages providing these probably need to be
6519: buildlinked; however, it's not automatic, since e.g. GTK on
6520: some systems pulls in the X libraries, so they will show up in
6521: the <code class="filename">ldd</code> output, while on others (like OS
6522: X) it won't. <code class="filename">ldd</code> output can thus only be
6523: used as a hint.</p></li>
6524: </ul></div>
6525: <p>
6526: </p>
6527: </div>
1.41 asau 6528: <div class="sect2">
1.1 dsieger 6529: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6530: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6531: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6532: and
6533: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6534: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.185 wiz 6535: <p>Both variables set lower bounds for a version of this package.
6536: The two variables differ in that one describes source
1.184 rillig 6537: compatibility (API) and the other binary compatibility (ABI).
6538: The difference is that a change in the API breaks compilation of
6539: programs while changes in the ABI stop compiled programs from
6540: running.</p>
1.185 wiz 6541: <p>The
6542: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6543: variable in a <code class="filename">buildlink3.mk</code> should be
6544: changed very rarely. (One possible scenario: If all packages
6545: using this package need a higher version than defined in the
6546: <code class="filename">buildlink3.mk</code>,
1.184 rillig 6547: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6548: could be updated to that higher version.)</p>
6549: <p>On the other hand, changes to
1.184 rillig 6550: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6551: are more common. The variable will need to be updated every
6552: time the major version of one of its shared libraries is changed,
6553: or any other change where a binary built against the previous
6554: version of the package will not run against the new version any
6555: longer.</p>
6556: <p>In such a case, the package's
1.184 rillig 6557: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6558: must be increased to require the new package version. Then the
6559: <code class="varname">PKGREVISION</code> of all packages
6560: <em class="replaceable"><code>foo</code></em> that depend on this package need
6561: to be increased, and if they have
6562: <code class="filename">buildlink3.mk</code> files,
6563: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6564: in their <code class="filename">buildlink3.mk</code> files must be
6565: increased to the new version as well. This is required so that a
6566: package will pull in the versions of the packages that use the
6567: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6568: uniquely identify the packages built against the new ABI. The
1.207 leot 6569: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/revbump/index.html" target="_top"><code class="filename">pkgtools/revbump</code></a> package can
1.185 wiz 6570: help with these updates.</p>
6571: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6572: about dependencies on other packages, including the
6573: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.184 rillig 6574: <p>Please take careful consideration before adjusting
6575: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6576: or
6577: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6578: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6579: cause unneeded package deletions and rebuilds. In many cases,
6580: new versions of packages work just fine with older
6581: dependencies.</p>
1.211 gutterid 6582: <p>Also, it is not needed to set
1.184 rillig 6583: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6584: when it is identical to
1.211 gutterid 6585: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
6586: <p>Note there is also the distinction that users are able to disable
6587: enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
6588: variable, but there is no equivalent option for API dependencies.</p>
1.1 dsieger 6589: </div>
6590: </div>
1.41 asau 6591: <div class="sect1">
1.1 dsieger 6592: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6593: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6594: <p>Some packages in pkgsrc install headers and libraries that
6595: coincide with headers and libraries present in the base system.
6596: Aside from a <code class="filename">buildlink3.mk</code> file, these
6597: packages should also include a <code class="filename">builtin.mk</code>
6598: file that includes the necessary checks to decide whether using
6599: the built-in software or the pkgsrc software is
6600: appropriate.</p>
6601: <p>The only requirements of a builtin.mk file for
6602: <em class="replaceable"><code>pkg</code></em> are:</p>
6603: <div class="orderedlist"><ol class="orderedlist" type="1">
6604: <li class="listitem"><p>It should set
6605: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6606: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6607: after it is included.</p></li>
6608: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6609: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6610: which is already set before the
6611: <code class="filename">builtin.mk</code> file is included.</p></li>
6612: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6613: is <span class="emphasis"><em>very</em></span> important and takes careful
6614: attention to <code class="filename">Makefile</code> coding.</p></li>
6615: </ol></div>
6616: <div class="sect2">
6617: <div class="titlepage"><div><div><h3 class="title">
6618: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6619: <p>The following is the recommended template for builtin.mk
6620: files:</p>
1.1 dsieger 6621: <pre class="programlisting">
1.184 rillig 6622: .if !defined(IS_BUILTIN.foo)
6623: #
6624: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6625: # genuinely exists in the system or not.
6626: #
6627: IS_BUILTIN.foo?= no
1.1 dsieger 6628:
1.184 rillig 6629: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6630: # version can be determined.
6631: #
6632: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6633: BUILTIN_PKG.foo?= foo-1.0
6634: . endif
6635: .endif # IS_BUILTIN.foo
1.1 dsieger 6636:
1.184 rillig 6637: .if !defined(USE_BUILTIN.foo)
6638: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6639: . if defined(BUILTIN_PKG.foo)
6640: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6641: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6642: USE_BUILTIN.foo!= \
6643: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6644: && ${ECHO} "yes" || ${ECHO} "no"
6645: . endif
6646: . endfor
6647: . endif
6648: .endif # USE_BUILTIN.foo
1.1 dsieger 6649:
1.184 rillig 6650: CHECK_BUILTIN.foo?= no
6651: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6652: #
6653: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6654: # "yes" or "no".
6655: #
6656: .endif # CHECK_BUILTIN.foo
1.1 dsieger 6657: </pre>
1.184 rillig 6658: <p>The first section sets
6659: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6660: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6661: in the base system. This should not be a base system software
6662: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6663: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6664: included as part of the base system. This variable is only
6665: used internally within the <code class="filename">builtin.mk</code>
6666: file.</p>
6667: <p>The second section sets
6668: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6669: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6670: system if it exists (if
6671: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6672: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6673: within the <code class="filename">builtin.mk</code> file.</p>
6674: <p>The third section sets
6675: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6676: and is <span class="emphasis"><em>required</em></span> in all
6677: <code class="filename">builtin.mk</code> files. The code in this
6678: section must make the determination whether the built-in
6679: software is adequate to satisfy the dependencies listed in
6680: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6681: This is typically done by comparing
6682: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6683: against each of the dependencies in
6684: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6685: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6686: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6687: end of the <code class="filename">builtin.mk</code> file. Note that
6688: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6689: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6690: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6691: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6692: that the built-in version of the software is similar enough to
6693: be used as a replacement.</p>
6694: <p>The last section is guarded by
6695: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6696: and includes code that uses the value of
6697: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6698: set in the previous section. This typically includes, e.g.,
6699: adding additional dependency restrictions and listing additional
6700: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6701: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6702: </div>
1.7 rillig 6703: </div>
1.1 dsieger 6704: </div>
1.41 asau 6705: <div class="chapter">
1.1 dsieger 6706: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 6707: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.1 dsieger 6708: <div class="toc">
6709: <p><b>Table of Contents</b></p>
1.100 leot 6710: <dl class="toc">
1.184 rillig 6711: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6712: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6713: <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>
6714: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6715: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6716: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6717: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6718: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6719: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 6720: </dl>
6721: </div>
1.184 rillig 6722: <p>The <code class="filename">PLIST</code> file contains a package's
6723: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6724: the package (relative to the <code class="filename">${PREFIX}</code>
6725: directory it's been installed in) plus some additional statements
1.259 leot 6726: - 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.184 rillig 6727: This chapter addresses some issues that need attention when
6728: dealing with the <code class="filename">PLIST</code> file (or files, see
6729: below!).</p>
1.41 asau 6730: <div class="sect1">
1.1 dsieger 6731: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6732: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6733: <p>Be sure to add a RCS ID line as the first thing in any
6734: <code class="filename">PLIST</code> file you write:</p>
6735: <pre class="programlisting">
6736: @comment $NetBSD $
6737: </pre>
6738: <p>An artificial space has been added between NetBSD and $, this is a
6739: workaround here to prevent CVS expanding to the filename of the guide. When
6740: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6741: </div>
1.41 asau 6742: <div class="sect1">
1.1 dsieger 6743: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6744: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6745: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6746: to output a PLIST that matches any new files since the package
6747: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6748: more information on this target.</p>
1.1 dsieger 6749: </div>
1.41 asau 6750: <div class="sect1">
1.1 dsieger 6751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6752: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6753: </h2></div></div></div>
6754: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6755: of AWK patterns and actions that are used to filter the output of
6756: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6757: scripting you like to it, but be careful with quoting.</p>
6758: <p>For example, to get all files inside the
6759: <code class="filename">libdata/foo</code> directory removed from the
6760: resulting PLIST:</p>
1.1 dsieger 6761: <pre class="programlisting">
1.184 rillig 6762: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 6763: </pre>
1.185 wiz 6764: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6765: evaluated after the file list and directory list are sorted.
6766: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6767: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6768: list and directory list are sorted.</p>
1.184 rillig 6769: </div>
6770: <div class="sect1">
6771: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6772: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6773: <p>A number of variables are substituted automatically in
6774: PLISTs when a package is installed on a system. This includes the
6775: following variables:</p>
6776: <div class="variablelist"><dl class="variablelist">
6777: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6778: <dd>
6779: <p>Some packages like emacs and perl embed information
6780: about which architecture they were built on into the
6781: pathnames where they install their files. To handle this
6782: case, PLIST will be preprocessed before actually used, and
6783: the symbol
6784: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6785: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6786: same is done if the string
6787: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6788: PLIST somewhere - use this on packages that have GNU
6789: autoconf-created configure scripts.</p>
6790: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6791: <h3 class="title">Legacy note</h3>
6792: <p>There used to be a symbol
6793: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6794: was replaced by the output of <span class="command"><strong>uname
6795: -m</strong></span>, but that's no longer supported and has
6796: been removed.</p>
6797: </div>
6798: </dd>
6799: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6800: <dd>
6801: <p>Some packages want to embed the OS name and version
6802: into some paths. To do this, use these variables in the
6803: <code class="filename">PLIST</code>:
6804: </p>
6805: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6806: <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>
6807: <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>
6808: <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>
6809: </ul></div>
6810: </dd>
6811: </dl></div>
6812: <p>For a list of values which are replaced by
6813: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6814: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6815: <code class="varname">PLIST_SUBST</code> should help.</p>
6816: <p>If you want to change other variables not listed above, you
6817: can add variables and their expansions to this variable in the
6818: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="12.5. Optional files">Section 12.5, “Optional files”</a>):</p>
1.1 dsieger 6819: <pre class="programlisting">
1.184 rillig 6820: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 6821: </pre>
1.184 rillig 6822: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6823: in the <code class="filename">PLIST</code> with
6824: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6825: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6826: the common case of conditionally including some
6827: <code class="filename">PLIST</code> entries. It can be done by adding
6828: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6829: setting the corresponding <code class="varname">PLIST.foo</code> variable
6830: to <code class="literal">yes</code> if the entry should be included.
6831: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6832: in the <code class="filename">PLIST</code> with either
6833: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6834: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6835: For example, in <code class="filename">Makefile</code>:</p>
1.66 asau 6836: <pre class="programlisting">
1.184 rillig 6837: PLIST_VARS+= foo
6838: .if <em class="replaceable"><code>condition</code></em>
6839: PLIST.foo= yes
6840: .else
1.66 asau 6841: </pre>
1.184 rillig 6842: <p>And then in <code class="filename">PLIST</code>:</p>
1.1 dsieger 6843: <pre class="programlisting">
1.184 rillig 6844: @comment $NetBSD $
6845: bin/bar
6846: man/man1/bar.1
6847: ${PLIST.foo}bin/foo
6848: ${PLIST.foo}man/man1/foo.1
6849: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 6850: </pre>
1.184 rillig 6851: <p>An artificial space has been added between NetBSD and $, this is a
6852: workaround here to prevent CVS expanding to the filename of the guide. When
1.195 gutterid 6853: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6854: </div>
1.184 rillig 6855: <div class="sect1">
6856: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6857: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6858: <p>Man pages should be installed in compressed form if
6859: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6860: and uncompressed otherwise. To handle this in the
6861: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6862: appended/removed automatically for man pages according to
6863: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6864: or not, see above for details. This modification of the
6865: <code class="filename">PLIST</code> file is done on a copy of it, not
6866: <code class="filename">PLIST</code> itself.</p>
1.1 dsieger 6867: </div>
1.41 asau 6868: <div class="sect1">
1.1 dsieger 6869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6870: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6871: </h2></div></div></div>
6872: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6873: in generating the binary package, set the variable
6874: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.259 leot 6875: 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.184 rillig 6876: important. The default for <code class="varname">PLIST_SRC</code> is
6877: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.1 dsieger 6878: </div>
1.41 asau 6879: <div class="sect1">
1.1 dsieger 6880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6881: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6882: <p>Some packages decide to install a different set of files based on
6883: the operating system being used. These differences can be
6884: automatically handled by using the following files:</p>
6885: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6886: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6887: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6888: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6889: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6890: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6891: </ul></div>
1.1 dsieger 6892: </div>
1.41 asau 6893: <div class="sect1">
1.1 dsieger 6894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6895: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6896: <p>Some packages decide to generate hard-to-guess file names
6897: during installation that are hard to wire down.</p>
6898: <p>In such cases, you can set the
6899: <code class="varname">GENERATE_PLIST</code> variable to shell code
6900: terminated (with a semicolon) that will output PLIST entries which
6901: will be appended to the PLIST</p>
6902: <p>You can find one example in editors/xemacs:</p>
6903: <pre class="programlisting">
6904: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6905: </pre>
6906: <p>which will append something like
6907: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6908: <code class="filename">PLIST</code>.
6909: </p>
1.1 dsieger 6910: </div>
1.41 asau 6911: <div class="sect1">
1.1 dsieger 6912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6913: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6914: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6915: multiple (and unrelated) packages install files. These
6916: directories were problematic because you had to add special
6917: tricks in the PLIST to conditionally remove them, or have some
6918: centralized package handle them.</p>
6919: <p>In pkgsrc, it is now easy: Each package should create
6920: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6921: will remove any directories left empty after uninstalling a
6922: package.</p>
6923: <p>If a package needs an empty directory to work, create
6924: the directory during installation as usual, and also add an
6925: entry to the PLIST:
6926:
6927: </p>
6928: <pre class="programlisting">
6929: @pkgdir path/to/empty/directory
6930: </pre>
6931: <p>
6932:
6933: or take a look at <code class="varname">MAKE_DIRS</code> and
6934: <code class="varname">OWN_DIRS</code>.
1.1 dsieger 6935: </p>
6936: </div>
1.184 rillig 6937: </div>
6938: <div class="chapter">
6939: <div class="titlepage"><div><div><h2 class="title">
6940: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6941: <div class="toc">
6942: <p><b>Table of Contents</b></p>
6943: <dl class="toc">
6944: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6945: <dd><dl>
6946: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6947: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6948: </dl></dd>
6949: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6950: <dd><dl>
6951: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6952: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.239 dholland 6953: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
6954: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
6955: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 6956: </dl></dd>
6957: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6958: <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>
6959: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6960: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6961: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6962: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6963: <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>
6964: </dl>
6965: </div>
6966: <p>This chapter describes the framework known as
6967: <code class="literal">pkginstall</code>, whose key features are:</p>
6968: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6969: <li class="listitem"><p>Generic installation and manipulation of directories and files
6970: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6971: <li class="listitem"><p>Automatic handling of configuration files during installation,
6972: provided that packages are correctly designed.</p></li>
6973: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6974: <li class="listitem"><p>Registration of system users and groups.</p></li>
6975: <li class="listitem"><p>Registration of system shells.</p></li>
6976: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6977: </ul></div>
6978: <p>The following sections inspect each of the above points in detail.</p>
6979: <p>You may be thinking that many of the things described here could be
6980: easily done with simple code in the package's post-installation target
6981: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6982: as the code in them is only executed when building from source. Machines
6983: using binary packages could not benefit from it at all (as the code itself
6984: could be unavailable). Therefore, the only way to achieve any of the items
6985: described above is by means of the installation scripts, which are
6986: automatically generated by pkginstall.</p>
1.41 asau 6987: <div class="sect1">
1.1 dsieger 6988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6989: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6990: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6991: of files and directories that belong to a package. The names used in it
6992: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6993: which means that it cannot register files outside this directory (absolute
6994: path names are not allowed). Despite this restriction, some packages need
6995: to install files outside this location; e.g., under
6996: <code class="filename">${VARBASE}</code> or
6997: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6998: is to create such files during installation time by using
6999: installation scripts.</p>
7000: <p>The generic installation scripts are shell scripts that can
7001: contain arbitrary code. The list of scripts to execute is taken from
7002: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
7003: <code class="filename">INSTALL</code>. A similar variable exists for package
7004: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
7005: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
7006: commands, so they have the potential to create and manage files
7007: anywhere in the file system.</p>
7008: <p>Using these general installation files is not recommended, but
7009: may be needed in some special cases. One reason for avoiding them is
7010: that the user has to trust the packager that there is no unwanted or
7011: simply erroneous code included in the installation script. Also,
7012: previously there were many similar scripts for the same functionality,
7013: and fixing a common error involved finding and changing all of
7014: them.</p>
7015: <p>The pkginstall framework offers another, standardized way. It
7016: provides generic scripts to abstract the manipulation of such files
7017: and directories based on variables set in the package's
7018: <code class="filename">Makefile</code>. The rest of this section describes
7019: these variables.</p>
7020: <div class="sect2">
7021: <div class="titlepage"><div><div><h3 class="title">
7022: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
7023: <p>The following variables can be set to request the creation of
7024: directories anywhere in the file system:</p>
7025: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7026: <li class="listitem">
7027: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
7028: contain a list of directories that should be created and should attempt
7029: to be destroyed by the installation scripts. The difference between
7030: the two is that the latter prompts the administrator to remove any
7031: directories that may be left after deinstallation (because they were
7032: not empty), while the former does not. Example:</p>
7033: <pre class="programlisting">
7034: MAKE_DIRS+= ${VARBASE}/foo/private
7035: </pre>
7036: </li>
7037: <li class="listitem">
7038: <p><code class="varname">MAKE_DIRS_PERMS</code> and
7039: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
7040: which directories should be created and should attempt to be destroyed
7041: by the installation scripts. Each tuple holds the following values,
7042: separated by spaces: the directory name, its owner, its group and its
7043: numerical mode. For example:</p>
7044: <pre class="programlisting">
7045: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
7046: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
7047: </pre>
7048: <p>The difference between the two is exactly the same as their
7049: non-<code class="varname">PERMS</code> counterparts.</p>
7050: </li>
7051: </ul></div>
1.1 dsieger 7052: </div>
1.184 rillig 7053: <div class="sect2">
7054: <div class="titlepage"><div><div><h3 class="title">
7055: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
7056: <p>Creating non-empty files outside the installation prefix is tricky
7057: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.239 dholland 7058: To overcome this problem, the only solution is to extract the file in a
1.184 rillig 7059: known place (i.e., inside the installation prefix) and copy it to the
7060: appropriate location during installation (done by the installation scripts
1.239 dholland 7061: generated by pkginstall). We will call the former the <span class="emphasis"><em>reference
1.184 rillig 7062: file</em></span> in the following paragraphs, which describe the variables
7063: that can be used to automatically and consistently handle files outside the
7064: installation prefix:</p>
7065: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.239 dholland 7066: <li class="listitem"><p><code class="varname">REQD_FILES</code> is a list of pairs of reference
7067: and target files. At installation time, the reference file is copied
7068: to the target if and only if the latter does not exist. Upon
7069: deinstallation, the reference file is removed provided that it was
7070: not modified by the installation.</p></li>
1.184 rillig 7071: <li class="listitem">
1.239 dholland 7072: <p><code class="varname">REQD_FILES_PERMS</code> contains tuples describing
7073: reference files and targets, including owner, group, and numeric
7074: permissions that should be set. For example:</p>
1.1 dsieger 7075: <pre class="programlisting">
1.184 rillig 7076: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
7077: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 7078: </pre>
1.184 rillig 7079: </li>
1.239 dholland 7080: <li class="listitem"><p><code class="varname">CONF_FILES</code> and
7081: <code class="varname">CONF_FILES_PERMS</code> have the same syntax as
7082: <code class="varname">REQD_FILES</code> and
7083: <code class="varname">REQD_FILES_PERMS</code> respectively. The difference
7084: is that these variables are specifically intended for handling
7085: configuration files, for which additional conventions and
7086: constraints apply. See <a class="xref" href="#conf-files" title="20.2. Configuration files">Section 20.2, “Configuration files”</a> for further
7087: discussion. Note in particular that while handling of
7088: 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
7089: <code class="varname">REQD_FILES</code> and
7090: <code class="varname">REQD_FILES_PERMS</code>.</p></li>
1.184 rillig 7091: </ul></div>
1.239 dholland 7092: <p>To install an empty file, one can use these macros and
7093: <code class="filename">/dev/null</code> as the reference file.</p>
1.184 rillig 7094: </div>
1.1 dsieger 7095: </div>
1.41 asau 7096: <div class="sect1">
1.1 dsieger 7097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7098: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
1.239 dholland 7099: <p>There are two principles that govern the handling of
7100: configuration files in pkgsrc: first, the user's configuration must
7101: not be lost or overwritten by upgrades or reinstallations; and second,
7102: the default configuration should always be available for reference.
7103: To that end, pkgsrc has a framework specifically for handling
7104: configuration files. In general, configuration files are installed
7105: into <code class="filename">${PREFIX}/share/examples</code>, and copied from
7106: there to the pertinent <code class="filename">etc</code> directory as a
7107: separate step and only as needed.</p>
7108: <p>To make this work, there are three things that need to happen,
7109: any of which may require patching. First, the package must be told to
7110: read its configuration from the correct place at runtime; this place
7111: is <code class="filename">${PKG_SYSCONFDIR}</code> (or possibly a subdirectory
7112: of it) which is often but not always
7113: <code class="filename">${PREFIX}/etc</code>. Second, the package must be
7114: taught to install its default configuration files in
7115: <code class="filename">${PREFIX}/share/examples/${PKGBASE}</code>; this is the
7116: point at which patching often becomes required because it is not the
7117: same place as the runtime location. Third, the configuration files
7118: need to be declared in the package makefile; this is the easy part.
7119: </p>
7120: <p>With those elements in place, the right things will happen: the
7121: package install phase and resulting binary package will not touch
7122: <code class="filename">${PKG_SYSCONFDIR}</code>, and the default configuration
7123: will be copied into place by the pkgsrc framework only if not already
7124: present. Similarly, upon deinstall the configuration will not be
7125: removed if it has been modified. (This means that in the case of
7126: reinstallation and upgrades, unmodified configuration files are
7127: updated but modifications are never discarded.)</p>
7128: <p>The following sections describe how to make these things happen
7129: and document other relevant knobs available in the pkgsrc
7130: infrastructure.</p>
1.184 rillig 7131: <div class="sect2">
7132: <div class="titlepage"><div><div><h3 class="title">
7133: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7134: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7135: specifies where configuration files shall be installed. Its contents are
7136: set based upon the following variables:</p>
7137: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7138: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7139: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.239 dholland 7140: be overridden by the user to point to their preferred location (e.g.,
1.184 rillig 7141: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7142: Packages must not use it directly.</p></li>
7143: <li class="listitem">
7144: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7145: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7146: for the package being built shall be installed. The definition of this
7147: variable only makes sense in the package's
7148: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7149: <p>As an example, consider the Apache package,
1.207 leot 7150: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.184 rillig 7151: configuration files under the
7152: <code class="filename">httpd/</code> subdirectory of
7153: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7154: Makefile.</p>
7155: </li>
7156: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7157: variable that holds this package's configuration directory (if
7158: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7159: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7160: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7161: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7162: directory where the configuration files for the package identified by
7163: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7164: </ul></div>
7165: <p>Based on the above variables, pkginstall determines the value of
7166: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
1.239 dholland 7167: variable that may be used within a package to refer to its configuration
1.184 rillig 7168: directory. The algorithm used to set its value is basically the
7169: following:</p>
7170: <div class="orderedlist"><ol class="orderedlist" type="1">
7171: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7172: its value is used.</p></li>
7173: <li class="listitem"><p>If the previous variable is not defined but
7174: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7175: <code class="filename">Makefile</code>, the resulting value is
7176: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7177: <li class="listitem"><p>Otherwise, it is set to
7178: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7179: </ol></div>
7180: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.239 dholland 7181: automatically added to <code class="filename">OWN_DIRS</code>. This causes it
7182: 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
7183: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>; they must be manually
7184: created with <code class="varname">OWN_DIRS</code> or
7185: <code class="varname">MAKE_DIRS</code>.</p>
1.184 rillig 7186: </div>
7187: <div class="sect2">
7188: <div class="titlepage"><div><div><h3 class="title">
7189: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7190: <p>Given that pkgsrc (and users!) expect configuration files to be in a
1.239 dholland 7191: known place, you need to teach each package where to install its files. In
7192: some cases you will have to patch the package Makefiles to achieve it. If
7193: you are lucky, though, it may be as easy as passing an extra flag to the
7194: configuration script. This is the case for packages using GNU
7195: autoconf:</p>
1.1 dsieger 7196: <pre class="programlisting">
1.184 rillig 7197: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 7198: </pre>
1.184 rillig 7199: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
1.239 dholland 7200: for</em></span> its configuration files, not where they will be installed.
7201: Fortunately, there is a different way to specify the latter, as seen
1.240 gutterid 7202: in the next section, although the combination is rather confusing at
1.239 dholland 7203: first glance.</p>
1.1 dsieger 7204: </div>
1.184 rillig 7205: <div class="sect2">
7206: <div class="titlepage"><div><div><h3 class="title">
1.239 dholland 7207: <a name="conf-files-patching"></a>20.2.3. Patching installation</h3></div></div></div>
7208: <p>As discussed above, <span class="strong"><strong>packages themselves must not
1.184 rillig 7209: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7210: directly</strong></span>. Bad news is that many software installation scripts
7211: will, out of the box, mess with the contents of that directory. So what is
7212: the correct procedure to fix this issue?</p>
7213: <p>You must teach the package (usually by manually patching it) to
7214: install any configuration files under the examples hierarchy,
7215: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7216: <code class="filename">PLIST</code> registers them and the administrator always
7217: has the original copies available.</p>
1.239 dholland 7218: <p>It turns out that for packages using GNU autoconf it is possible
7219: to create the desired effect by setting <code class="varname">sysconfdir</code>
7220: on the make command line at install time. Consider this example taken
7221: 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>
7222: <pre class="programlisting">
7223: EGDIR= ${PREFIX}/share/examples/mutt
7224: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
7225: </pre>
7226: <p>Note that the <code class="varname">EGDIR</code> variable, though commonly
7227: used for this purpose, is local to that package and has no meaning
7228: outside it.</p>
7229: </div>
7230: <div class="sect2">
7231: <div class="titlepage"><div><div><h3 class="title">
7232: <a name="conf-files-declare"></a>20.2.4. Declaring configuration files</h3></div></div></div>
1.184 rillig 7233: <p>Once the required configuration files are in place (i.e., under the
1.239 dholland 7234: examples hierarchy), the pkginstall framework can use them as reference copies
1.184 rillig 7235: during the package installation to update what is in
7236: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7237: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.239 dholland 7238: 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
7239: information about their syntax and their purpose. Here is an example,
7240: 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>
7241: <pre class="programlisting">
7242: EGDIR= ${PREFIX}/share/examples/mutt
7243: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7244: </pre>
7245: <p>Note that (as in the previous section's example) the
7246: <code class="varname">EGDIR</code> variable is specific to the package and has
7247: no meaning outside it.</p>
7248: <p>For reference, the complete example from Mutt is as follows:</p>
1.1 dsieger 7249: <pre class="programlisting">
1.239 dholland 7250: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
7251: EGDIR= ${PREFIX}/share/examples/mutt
7252: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7253: INSTALLATION_DIRS+= ${EGDIR}
7254: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.1 dsieger 7255: </pre>
7256: </div>
1.184 rillig 7257: <div class="sect2">
7258: <div class="titlepage"><div><div><h3 class="title">
1.239 dholland 7259: <a name="conf-files-disable"></a>20.2.5. Disabling handling of configuration files</h3></div></div></div>
1.184 rillig 7260: <p>The automatic copying of config files can be toggled by setting the
7261: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7262: installation.</p>
1.1 dsieger 7263: </div>
7264: </div>
1.41 asau 7265: <div class="sect1">
1.1 dsieger 7266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7267: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7268: <p>System startup scripts are special files because they must be
7269: installed in a place known by the underlying OS, usually outside the
7270: 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
7271: can be used. However, pkginstall provides a special mechanism to handle
7272: these files.</p>
7273: <p>In order to provide system startup scripts, the package has
7274: to:</p>
7275: <div class="orderedlist"><ol class="orderedlist" type="1">
7276: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7277: the <code class="literal">.sh</code> suffix appended. Considering the
1.223 nia 7278: <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
7279: has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.184 rillig 7280: <li class="listitem">
7281: <p>Tell pkginstall to handle it, appending the name of the script,
7282: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7283: Continuing the previous example:</p>
7284: <pre class="programlisting">
7285: RCD_SCRIPTS+= cupsd
7286: </pre>
7287: </li>
7288: </ol></div>
7289: <p>Once this is done, pkginstall will do the following steps for each
7290: script in an automated fashion:</p>
7291: <div class="orderedlist"><ol class="orderedlist" type="1">
7292: <li class="listitem"><p>Process the file found in the files directory applying all the
7293: substitutions described in the <code class="filename">FILES_SUBST</code>
7294: variable.</p></li>
7295: <li class="listitem"><p>Copy the script from the files directory to the examples
7296: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.239 dholland 7297: that this reference file must be explicitly registered in the
1.184 rillig 7298: <code class="filename">PLIST</code>.</p></li>
7299: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7300: from the examples hierarchy into the system-wide startup scripts
7301: directory.</p></li>
7302: </ol></div>
7303: <div class="sect2">
7304: <div class="titlepage"><div><div><h3 class="title">
7305: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7306: <p>The automatic copying of config files can be toggled by setting the
7307: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7308: installation. Note that the scripts will be always copied inside the
7309: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7310: matter what the value of this variable is.</p>
1.1 dsieger 7311: </div>
7312: </div>
1.184 rillig 7313: <div class="sect1">
7314: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7315: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7316: <p>If a package needs to create special users and/or groups during
7317: installation, it can do so by using the pkginstall framework.</p>
7318: <p>Users can be created by adding entries to the
7319: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7320: syntax:</p>
7321: <pre class="programlisting">
7322: user:group
7323: </pre>
7324: <p>Further specification of user details may be done by setting
7325: per-user variables.
7326: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7327: numeric UID for the user.
7328: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7329: user's description or comment.
7330: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7331: user's home directory, and defaults to
7332: <code class="filename">/nonexistent</code> if not specified.
7333: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7334: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7335: not specified.</p>
7336: <p>Similarly, groups can be created by adding entries to the
7337: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7338: <pre class="programlisting">
7339: group
7340: </pre>
7341: <p>The numeric GID of the group may be set by defining
7342: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7343: <p>If a package needs to create the users and groups at an earlier
7344: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7345: <code class="literal">configure</code>,<code class="literal">build</code>, or
7346: <code class="literal">pre-install</code> to indicate the phase before which the
7347: users and groups are created. In this case, the numeric UIDs and GIDs
7348: of the created users and groups are automatically hardcoded into the
7349: final installation scripts.</p>
1.1 dsieger 7350: </div>
1.41 asau 7351: <div class="sect1">
1.1 dsieger 7352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7353: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7354: <p>Packages that install system shells should register them in the shell
7355: database, <code class="filename">/etc/shells</code>, to make things easier to the
7356: administrator. This must be done from the installation scripts to keep
7357: binary packages working on any system. pkginstall provides an easy way to
7358: accomplish this task.</p>
7359: <p>When a package provides a shell interpreter, it has to set the
7360: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7361: add some hooks to the installation scripts to handle it. Consider the
1.207 leot 7362: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/index.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.184 rillig 7363: <pre class="programlisting">
7364: PKG_SHELL= ${PREFIX}/bin/zsh
7365: </pre>
7366: <div class="sect2">
7367: <div class="titlepage"><div><div><h3 class="title">
7368: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7369: <p>The automatic registration of shell interpreters can be disabled by
7370: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7371: environment variable to <code class="literal">NO</code>.</p>
7372: </div>
1.1 dsieger 7373: </div>
1.41 asau 7374: <div class="sect1">
1.1 dsieger 7375: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7376: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7377: <p>Packages that install X11 fonts should update the database files
7378: that index the fonts within each fonts directory. This can easily be
7379: accomplished within the pkginstall framework.</p>
7380: <p>When a package installs X11 fonts, it must list the directories in
7381: which fonts are installed in the
7382: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7383: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7384: <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
7385: installation scripts to run the appropriate commands to update the fonts
7386: database files within each of those directories. For convenience, if the
7387: directory path is relative, it is taken to be relative to the package's
1.207 leot 7388: installation prefix. Consider the following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/index.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.1 dsieger 7389: <pre class="programlisting">
1.184 rillig 7390: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 7391: </pre>
1.184 rillig 7392: <div class="sect2">
7393: <div class="titlepage"><div><div><h3 class="title">
7394: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7395: <p>The automatic update of fonts databases can be disabled by
7396: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7397: environment variable to <code class="literal">NO</code>.</p>
1.1 dsieger 7398: </div>
7399: </div>
7400: </div>
1.41 asau 7401: <div class="chapter">
1.1 dsieger 7402: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 7403: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 7404: <div class="toc">
7405: <p><b>Table of Contents</b></p>
1.100 leot 7406: <dl class="toc">
1.154 rillig 7407: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 7408: <dd><dl>
1.154 rillig 7409: <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>
7410: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7411: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7412: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7413: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7414: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7415: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7416: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7417: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7418: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7419: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7420: </dl></dd>
7421: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7422: <dd><dl>
7423: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7424: <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>
7425: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7426: </dl></dd>
7427: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7428: <dd><dl>
7429: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7430: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7431: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 7432: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.260 wiz 7433: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.154 rillig 7434: </dl></dd>
7435: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7436: <dd><dl>
7437: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7438: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 7439: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 7440: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
7441: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
7442: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
7443: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 7444: </dl></dd>
7445: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7446: <dd><dl>
7447: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7448: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 7449: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7450: <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>
7451: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 7452: </dl></dd>
7453: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7454: <dd><dl>
7455: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7456: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7457: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7458: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7459: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 7460: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.254 wiz 7461: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
7462: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
7463: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
7464: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
7465: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
7466: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
7467: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
7468: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
7469: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
7470: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.1 dsieger 7471: emulation</a></span></dt>
1.254 wiz 7472: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
7473: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.1 dsieger 7474: </dl></dd>
1.154 rillig 7475: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7476: </dl>
7477: </div>
1.41 asau 7478: <div class="sect1">
1.1 dsieger 7479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7480: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 7481: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 7482: different platforms. As a result, it is important to ensure,
7483: where possible, that packages in pkgsrc are portable. This
7484: chapter mentions some particular details you should pay
7485: attention to while working on pkgsrc.</p>
1.41 asau 7486: <div class="sect2">
1.1 dsieger 7487: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7488: <a name="pulling-vars-from-etc-mk.conf"></a>21.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 7489: </h3></div></div></div>
7490: <p>The pkgsrc user can configure pkgsrc by overriding several
7491: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7492: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7493: want to use those variables in the preprocessor directives of
1.259 leot 7494: <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.1 dsieger 7495: <code class="literal">.for</code>), you need to include the file
7496: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7497: loads the user preferences.</p>
7498: <p>But note that some variables may not be completely defined
7499: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7500: included, as they may contain references to variables that are
1.108 rillig 7501: not yet defined. In shell commands (the lines in
7502: <code class="filename">Makefile</code> that are indented with a tab) this
7503: is no problem, since variables are only expanded when they are
7504: used. But in the preprocessor directives mentioned above and in
7505: dependency lines (of the form <code class="literal">target:
1.1 dsieger 7506: dependencies</code>) the variables are expanded at load
7507: time.</p>
1.41 asau 7508: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7509: <h3 class="title">Note</h3>
1.108 rillig 7510: <p>To check whether a variable can be used at load time,
7511: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 7512: </div>
7513: </div>
1.41 asau 7514: <div class="sect2">
1.1 dsieger 7515: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7516: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 7517: <p>Occasionally, packages require interaction from the user,
7518: and this can be in a number of ways:</p>
1.41 asau 7519: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7520: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7521: interaction such as entering username/password or accepting a
7522: license on a web page.</p></li>
1.23 wiz 7523: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7524: passwords.</p></li>
1.23 wiz 7525: <li class="listitem"><p>help to configure the package before it is built</p></li>
7526: <li class="listitem"><p>help during the build process</p></li>
7527: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7528: </ul></div>
1.108 rillig 7529: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7530: variable to define which stages need interaction. This should be
7531: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 7532: <pre class="programlisting">
7533: INTERACTIVE_STAGE= configure install
1.111 sevan 7534: </pre>
1.1 dsieger 7535: <p>The user can then decide to skip this package by setting the
1.108 rillig 7536: <code class="varname">BATCH</code> variable. Packages that require interaction
7537: are also excluded from bulk builds.</p>
1.1 dsieger 7538: </div>
1.41 asau 7539: <div class="sect2">
1.1 dsieger 7540: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7541: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 7542: <p>Authors of software can choose the licence under which software
7543: can be copied. The Free Software Foundation has declared some
7544: licenses "Free", and the Open Source Initiative has a definition of
7545: "Open Source".</p>
7546: <p>By default, pkgsrc allows packages with Free or Open Source
7547: licenses to be built. To allow packages with other licenses to be
7548: built as well, the pkgsrc user needs to add these licenses to the
7549: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7550: that this variable only affects which packages may be
7551: <span class="emphasis"><em>built</em></span>, while the license terms often also
7552: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 7553: <p>One might want to only install packages with a BSD license,
1.108 rillig 7554: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 7555: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 7556: user can override the default by setting the
7557: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 7558: of "+=". The licenses accepted by default are defined in the
7559: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7560: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7561: <p>The license tag mechanism is intended to address
7562: copyright-related issues surrounding building, installing and
7563: using a package, and not to address redistribution issues (see
7564: <code class="varname">RESTRICTED</code> and
1.111 sevan 7565: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7566: Packages with redistribution restrictions should set these
7567: tags.</p>
1.1 dsieger 7568: <p>Denoting that a package may be copied according to a
7569: particular license is done by placing the license in
7570: <code class="filename">pkgsrc/licenses</code> and setting the
7571: <code class="varname">LICENSE</code> variable to a string identifying the
1.207 leot 7572: license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/index.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.1 dsieger 7573: <pre class="programlisting">
7574: LICENSE= xv-license
1.111 sevan 7575: </pre>
1.1 dsieger 7576: <p>When trying to build, the user will get a notice that the
7577: package is covered by a license which has not been placed in the
7578: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7579: <pre class="programlisting">
7580: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7581: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7582: ===> To view the license, enter "/usr/bin/make show-license".
7583: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7584: ===> ACCEPTABLE_LICENSES+=xv-license
7585: *** Error code 1
1.111 sevan 7586: </pre>
1.260 wiz 7587: <p>In case a package requires multiple licenses, you can add all of
7588: them to the LICENSE variable, connected with the upper-case keyword
7589: <code class="varname">AND</code>. If the user has a choice between multiple
7590: licenses, you can add them connected with the upper-case keyword
7591: <code class="varname">OR</code>, for example:</p>
7592: <pre class="programlisting">
7593: LICENSE= isc AND apache-2.0
7594: LICENSE= 2-clause-bsd OR ruby-license
7595: </pre>
1.10 hubertf 7596: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7597: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7598: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7599: convey to pkgsrc that it should not in the future fail because of
7600: that license:</p>
7601: <pre class="programlisting">
7602: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7603: </pre>
7604: <p>The use of <code class="varname">LICENSE=shareware</code>,
7605: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7606: is deprecated because it does not crisply refer to a particular
7607: license text. Another problem with such usage is that it does not
7608: enable a user to tell pkgsrc to proceed for a single package
7609: without also telling pkgsrc to proceed for all packages with that
7610: tag.</p>
7611: <div class="sect3">
7612: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7613: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7614: <p>When adding a package with a new license, the following steps
7615: are required:</p>
7616: <div class="orderedlist"><ol class="orderedlist" type="1">
7617: <li class="listitem">
1.169 rillig 7618: <p>Check whether the license qualifies as Free or Open Source by
7619: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7620: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111 sevan 7621: Open Source Initiative</a>. If this is the case, the filename in
7622: <code class="filename">pkgsrc/licenses/</code> does not need the
7623: <code class="filename">-license</code> suffix, and the license name should be
7624: added to:</p>
1.48 rodent 7625: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7626: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7627: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7628: <li class="listitem"><p>default_acceptable_licenses in
7629: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48 rodent 7630: </ul></div>
7631: </li>
1.169 rillig 7632: <li class="listitem"><p>The license text should be added to
7633: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7634: licenses can be seen in this directory.</p></li>
1.48 rodent 7635: </ol></div>
1.111 sevan 7636: </div>
7637: <div class="sect3">
7638: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7639: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7640: <p>When the license changes (in a way other than formatting),
1.111 sevan 7641: make sure that the new license has a different name (e.g.,
1.1 dsieger 7642: append the version number if it exists, or the date). Just
7643: because a user told pkgsrc to build programs under a previous
7644: version of a license does not mean that pkgsrc should build
7645: programs under the new licenses. The higher-level point is that
7646: pkgsrc does not evaluate licenses for reasonableness; the only
7647: test is a mechanistic test of whether a particular text has been
1.111 sevan 7648: approved by either of two bodies (FSF or OSI).</p>
7649: </div>
1.1 dsieger 7650: </div>
1.41 asau 7651: <div class="sect2">
1.1 dsieger 7652: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7653: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7654: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7655: By declaring the restrictions, package tools can
1.1 dsieger 7656: automatically refrain from e.g. placing binary packages on FTP
7657: sites.</p>
1.111 sevan 7658: <p>There are four possible restrictions, which are
1.1 dsieger 7659: the cross product of sources (distfiles) and binaries not being
7660: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7661: language in any license, and because non-Free licenses tend to be
7662: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7663: CD-ROM.
7664:
7665: "FTP" means making the source or binary file available over the
7666: Internet at no charge.
7667:
7668: "CD-ROM" means making the source or binary available on some kind of
7669: media, together with other source and binary packages, which is sold
7670: for a distribution charge.
1.1 dsieger 7671: </p>
7672: <p>In order to encode these restrictions, the package system
7673: defines five make variables that can be set to note these
7674: restrictions:</p>
1.41 asau 7675: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7676: <li class="listitem">
1.1 dsieger 7677: <p><code class="varname">RESTRICTED</code></p>
7678: <p>This variable should be set whenever a restriction
7679: exists (regardless of its kind). Set this variable to a
7680: string containing the reason for the restriction. It should
7681: be understood that those wanting to understand the restriction
7682: will have to read the license, and perhaps seek advice of
7683: counsel.</p>
7684: </li>
1.23 wiz 7685: <li class="listitem">
1.1 dsieger 7686: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7687: <p>Binaries may not be placed on CD-ROM containing other
7688: binary packages, for which a distribution charge may be made.
7689: In this case, set this variable to
7690: <code class="varname">${RESTRICTED}</code>.</p>
7691: </li>
1.23 wiz 7692: <li class="listitem">
1.1 dsieger 7693: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7694: <p>Binaries may not made available on the Internet without
7695: charge. In this case, set this variable to
7696: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7697: binary packages will not be included on ftp.NetBSD.org.</p>
7698: </li>
1.23 wiz 7699: <li class="listitem">
1.1 dsieger 7700: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7701: <p>Distfiles may not be placed on CD-ROM, together with
7702: other distfiles, for which a fee may be charged. In this
7703: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7704: </p>
7705: </li>
1.23 wiz 7706: <li class="listitem">
1.1 dsieger 7707: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7708: <p>Distfiles may not made available via FTP at no charge.
7709: In this case, set this variable to
7710: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7711: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7712: </li>
7713: </ul></div>
1.111 sevan 7714: <p>Please note that packages will be removed from pkgsrc when the
7715: distfiles are not distributable and cannot be obtained for a period
7716: of one full quarter branch. Packages with manual/interactive fetch
7717: must have a maintainer and it is his/her responsibility to ensure
7718: this.</p>
1.1 dsieger 7719: </div>
1.41 asau 7720: <div class="sect2">
1.1 dsieger 7721: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7722: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.175 gutterid 7723: <p>Your package may depend on some other package being present,
7724: and there are various ways of expressing this dependency.
7725: pkgsrc supports the <code class="varname">DEPENDS</code>,
7726: <code class="varname">BUILD_DEPENDS</code>,
7727: <code class="varname">TOOL_DEPENDS</code>, and
7728: <code class="varname">TEST_DEPENDS</code> definitions, the
1.1 dsieger 7729: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7730: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7731: to handle dependencies, and which uses the variables named above.
1.184 rillig 7732: See <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a> for more information.</p>
1.175 gutterid 7733: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7734: definition registers that pre-requisite in the binary package so it
7735: will be pulled in when the binary package is later installed, whilst
7736: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7737: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7738: dependency that is only needed for building or testing the resulting
1.184 rillig 7739: package. See also <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> for more information.</p>
1.1 dsieger 7740: <p>This means that if you only need a package present whilst
1.175 gutterid 7741: you are building or testing, it should be noted as a
7742: <code class="varname">TOOL_DEPENDS</code>,
7743: <code class="varname">BUILD_DEPENDS</code>, or
7744: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.156 leot 7745: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7746: packages, i.e. packages for the architecture where the package
7747: is built;
7748: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.175 gutterid 7749: packages, i.e., packages for the architecture for which the package
1.156 leot 7750: is built.</p>
1.175 gutterid 7751: <p>The format for a <code class="varname">DEPENDS</code>,
7752: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7753: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.1 dsieger 7754: <pre class="programlisting">
7755: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7756: </pre>
1.23 wiz 7757: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7758: may include any of the wildcard version numbers recognized by
1.259 leot 7759: <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.23 wiz 7760: <div class="orderedlist"><ol class="orderedlist" type="1">
7761: <li class="listitem">
1.1 dsieger 7762: <p>If your package needs another package's binaries or
1.54 wiz 7763: libraries to build and run, and if that package has a
1.1 dsieger 7764: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7765: <pre class="programlisting">
7766: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7767: </pre>
1.1 dsieger 7768: </li>
1.23 wiz 7769: <li class="listitem">
1.54 wiz 7770: <p>If your package needs another package's binaries or
7771: libraries only for building, and if that package has a
7772: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7773: <pre class="programlisting">
7774: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7775: </pre>
1.54 wiz 7776: <p>but set
7777: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7778: to make it a build dependency only. This case is rather
7779: rare.</p>
7780: </li>
7781: <li class="listitem">
1.25 spz 7782: <p>If your package needs binaries from another package to build,
1.156 leot 7783: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7784: <pre class="programlisting">
1.156 leot 7785: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7786: </pre>
1.1 dsieger 7787: </li>
1.156 leot 7788: <li class="listitem"><p>If your package needs static libraries to link against, header
7789: files to include, etc. from another package to build,
7790: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7791: <li class="listitem"><p>If your package needs a library with which to link and
7792: there is no <code class="filename">buildlink3.mk</code> file
7793: available, create one. Using
7794: <code class="varname">DEPENDS</code> won't be sufficient because the
7795: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7796: <li class="listitem">
1.25 spz 7797: <p>If your package needs some executable to be able to run
7798: correctly and if there's no
7799: <code class="filename">buildlink3.mk</code> file, this is specified
7800: using the <code class="varname">DEPENDS</code> variable. The
1.207 leot 7801: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/index.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.129 wiz 7802: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7803: when it runs, and that is specified:</p>
1.1 dsieger 7804: <pre class="programlisting">
1.129 wiz 7805: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7806: </pre>
1.25 spz 7807: </li>
1.175 gutterid 7808: <li class="listitem"><p>If your package includes a test suite that has extra
7809: dependencies only required for this purpose (frequently this
7810: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7811: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.25 spz 7812: <li class="listitem">
7813: <p>You can use wildcards in package dependencies. Note that
7814: such wildcard dependencies are retained when creating binary
7815: packages. The dependency is checked when installing the binary
7816: package and any package which matches the pattern will be
7817: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7818: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7819: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7820: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7821: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7822: <p>Wildcards can also be used to specify that a package
7823: will only build against a certain minimum version of a
7824: pre-requisite:</p>
7825: <pre class="programlisting">
1.25 spz 7826: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7827: </pre>
1.25 spz 7828: <p>This means that the package will build using version 6.0
7829: of ImageMagick or newer. Such a dependency may be warranted
7830: if, for example, the command line options of an executable
7831: have changed.</p>
7832: <p>If you need to depend on minimum versions of libraries,
1.183 wiz 7833: set
7834: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7835: to the appropriate pattern before including its
7836: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7837: <pre class="programlisting">
7838: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7839: .include "../../graphics/jpeg/buildlink3.mk"
7840: </pre>
1.1 dsieger 7841: <p>For security fixes, please update the package
1.154 rillig 7842: vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, “Handling packages with security problems”</a> for more
1.1 dsieger 7843: information.</p>
7844: </li>
7845: </ol></div>
7846: <p>If your package needs files from another package to build,
7847: add the relevant distribution files to
7848: <code class="varname">DISTFILES</code>, so they will be extracted
1.207 leot 7849: automatically. See the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/index.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.1 dsieger 7850: (It relies on the jpeg sources being present in source form
7851: during the build.)</p>
7852: </div>
1.41 asau 7853: <div class="sect2">
1.1 dsieger 7854: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7855: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.226 gutterid 7856: <p>Your package may conflict with other packages users might
7857: already have installed on their system, e.g., if your package
1.1 dsieger 7858: installs the same set of files as another package in the pkgsrc
1.227 wiz 7859: tree.</p>
1.207 leot 7860: <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>
7861: and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/index.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.142 leot 7862: install the same shared library, thus you set in
7863: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7864: <pre class="programlisting">
7865: CONFLICTS= Xaw-Xpm-[0-9]*
1.238 wiz 7866: </pre>
1.142 leot 7867: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7868: <pre class="programlisting">
7869: CONFLICTS= libXaw3d-[0-9]*
1.238 wiz 7870: </pre>
1.259 leot 7871: <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.142 leot 7872: that conflict with existing packages and abort. However, in many
7873: situations this is too late in the process. Binary package managers
7874: will not know about the conflict until they attempt to install the
7875: package after already downloading it and all its dependencies.
7876: Users may also waste time building a package and its dependencies
7877: only to find out at the end that it conflicts with another package
7878: they have installed.</p>
7879: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7880: should be added in all cases where it is known that packages conflict
7881: with each other. These <code class="varname">CONFLICTS</code> entries are
1.259 leot 7882: 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.142 leot 7883: managers to inform users that packages cannot be installed onto
7884: the target system.</p>
1.1 dsieger 7885: </div>
1.41 asau 7886: <div class="sect2">
1.1 dsieger 7887: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7888: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7889: <p>There are several reasons why a package might be
7890: instructed to not build under certain circumstances. If the
7891: package builds and runs on most platforms, the exceptions
1.83 dholland 7892: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7893: the package builds and runs on a small handful of platforms,
7894: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7895: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7896: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7897: (OS-version-platform) that can use glob-style
7898: wildcards.</p>
7899: <p>If a package is not appropriate for some platforms (as
1.114 maya 7900: opposed to merely broken), a different set of variables should be
1.83 dholland 7901: used as this affects failure reporting and statistics.
7902: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7903: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7904: the package is appropriate for only a small handful of platforms
7905: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7906: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7907: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7908: (OS-version-platform) that can use glob-style
7909: wildcards.</p>
7910: <p>Some packages are tightly bound to a specific version of an
1.207 leot 7911: operating system, e.g. LKMs or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/index.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
1.1 dsieger 7912: backwards compatible with other versions of the OS, and should be
7913: uploaded to a version specific directory on the FTP server. Mark
7914: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7915: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7916: the package system internals, but may be used in the
7917: future.</p>
7918: <p>If the package should be skipped (for example, because it
7919: provides functionality already provided by the system), set
7920: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7921: the package should fail because some preconditions are not met,
7922: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7923: message.</p>
7924: </div>
1.41 asau 7925: <div class="sect2">
1.1 dsieger 7926: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7927: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7928: <p>To ensure that a package may not be deleted, once it has been
7929: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7930: be set in the package Makefile. This will be carried into any
7931: binary package that is made from this pkgsrc entry. A
1.23 wiz 7932: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.259 leot 7933: 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.23 wiz 7934: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7935: </div>
1.41 asau 7936: <div class="sect2">
1.1 dsieger 7937: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7938: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7939: <p>When a vulnerability is found, this should be noted in
1.247 wiz 7940: <code class="filename">pkgsrc/doc/pkg-vulnerabilities</code>.
1.205 wiz 7941: Entries in that file consist of three parts:</p>
7942: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7943: <li class="listitem"><p>package version pattern</p></li>
7944: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
7945: <li class="listitem"><p>URL providing additional information about the issue</p></li>
7946: </ul></div>
7947: <p>For the package version pattern please always use `<' to
7948: mark an upper bound (not `<='!). This will avoid possible
7949: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
7950: related to security fixes. Lower bounds can be added too, using
7951: '>' or '>='. For example,
1.206 wiz 7952: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.205 wiz 7953: versions 1.0 (included) to 1.2 (excluded) of
7954: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
7955: issue.</p>
7956: <p>Entries should always be added at the bottom of the file.</p>
7957: <p>When fixing packages, please modify the upper bound of the
7958: corresponding entry. To continue the previous example, if a fix
7959: was backported to version 1.1nb2, change the previous pattern to
1.206 wiz 7960: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.205 wiz 7961: <p>To locally test a package version pattern against a
7962: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
7963: pmatch</strong></span> command.</p>
7964: <p>The URL should be as permanent as possible and provide as
7965: much information about the issue as possible. CVE entries are
7966: preferred.</p>
7967: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.31 wiz 7968: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7969: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7970: <code class="varname">PKGREVISION</code> should be increased (this is of
7971: course not necessary if the problem is fixed by using a newer
7972: release of the software), and the pattern in the
7973: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7974: <p>Also, if the fix should be applied to the stable pkgsrc
7975: branch, be sure to submit a pullup request!</p>
7976: <p>Binary packages already on ftp.NetBSD.org will be handled
7977: semi-automatically by a weekly cron job.</p>
1.205 wiz 7978: <p>In case a security issue is disputed, please contact
7979: pkgsrc-security@NetBSD.org.</p>
1.1 dsieger 7980: </div>
1.41 asau 7981: <div class="sect2">
1.1 dsieger 7982: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7983: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1 dsieger 7984: <p>When making fixes to an existing package it can be useful
7985: to change the version number in <code class="varname">PKGNAME</code>. To
7986: avoid conflicting with future versions by the original author, a
1.23 wiz 7987: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.1 dsieger 7988: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7989: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7990: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7991: <pre class="programlisting">
7992: DISTNAME= foo-17.42
7993: PKGREVISION= 9
1.111 sevan 7994: </pre>
1.1 dsieger 7995: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7996: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7997: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7998: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7999: <code class="varname">PKGNAME_NOREV</code>.</p>
8000: <p>When a new release of the package is released, the
8001: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8002: minor release of the above package, things should be like:</p>
8003: <pre class="programlisting">
8004: DISTNAME= foo-17.43
1.111 sevan 8005: </pre>
1.1 dsieger 8006: <p><code class="varname">PKGREVISION</code> should be incremented for any
8007: non-trivial change in the resulting binary package. Without a
8008: <code class="varname">PKGREVISION</code> bump, someone with the previous
8009: version installed has no way of knowing that their package is out
8010: of date. Thus, changes without increasing
8011: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8012: trivial that no reasonable person would want to upgrade", and this
8013: is the rough test for when increasing
8014: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8015: changes that do not merit increasing
8016: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 8017: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8018: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169 rillig 8019: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
8020: comments in Makefile.</p></li>
8021: <li class="listitem"><p>Changing build variables if the resulting binary
8022: package is the same.</p></li>
8023: <li class="listitem"><p>Changing
8024: <code class="filename">DESCR</code>.</p></li>
8025: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
8026: default options don't change.</p></li>
1.1 dsieger 8027: </ul></div>
8028: <p>Examples of changes that do merit an increase to
8029: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 8030: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 8031: <li class="listitem"><p>Security fixes</p></li>
8032: <li class="listitem"><p>Changes or additions to a patch
8033: file</p></li>
8034: <li class="listitem"><p>Changes to the
8035: <code class="filename">PLIST</code></p></li>
8036: <li class="listitem"><p>A dependency is changed or
8037: renamed.</p></li>
1.1 dsieger 8038: </ul></div>
8039: <p>PKGREVISION must also be incremented when dependencies have ABI
8040: changes.</p>
8041: </div>
1.41 asau 8042: <div class="sect2">
1.1 dsieger 8043: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8044: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.180 rillig 8045: <p>When you want to replace the same text in multiple files, or
8046: multiple times in the same file, it is cumbersome to maintain a patch
8047: file for this. This is where the SUBST framework steps in. It provides an
8048: easy-to-use interface for replacing text in files. It just needs the
8049: following information:</p>
8050: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8051: <li class="listitem"><p>In which phase of the package build cycle should the
8052: replacement happen?</p></li>
8053: <li class="listitem"><p>In which files should the replacement
1.172 rillig 8054: happen?</p></li>
1.180 rillig 8055: <li class="listitem"><p>Which text should be replaced with
8056: what?</p></li>
1.172 rillig 8057: </ul></div>
8058: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.180 rillig 8059: variables. A minimal example is:</p>
8060: <pre class="programlisting">
8061: SUBST_CLASSES+= paths
8062: SUBST_STAGE.paths= pre-configure
8063: SUBST_FILES.paths= src/*.c
8064: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
8065: </pre>
8066: <p>Translated into English, it means: In the pre-configure stage (that
8067: is, after applying the patches from the patches/ directory and before
8068: running the configure script and the portability check), replace the text
8069: <code class="literal">/usr/local</code> with the content of the variable
8070: <code class="varname">PREFIX</code>.</p>
8071: <p>Each SUBST block starts by appending an identifier to
8072: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
8073: identifier can be chosen freely by the package. If there should ever be
8074: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
8075: early, so don't worry about name collisions.</p>
8076: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
8077: SUBST block are parameterized using this identifier. In the remainder of
8078: this section, these parameterized variables are written as
8079: <code class="varname">SUBST_STAGE.*</code>.</p>
8080: <pre class="programlisting">
8081: SUBST_CLASSES+= paths
8082: SUBST_STAGE.paths= pre-configure
8083: SUBST_MESSAGE.paths= Fixing absolute paths.
8084: SUBST_FILES.paths= src/*.c
8085: SUBST_FILES.paths+= scripts/*.sh
8086: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
8087: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8088: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
8089: </pre>
8090: <p>To get a complete picture about the SUBST substitutions, run
8091: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
8092: expected, run pkglint on the package, which detects several typical
8093: mistakes surrounding the SUBST blocks. For any questions that might
8094: remain after this, have a look at
8095: <code class="filename">mk/subst.mk</code>.</p>
8096: <div class="sect3">
8097: <div class="titlepage"><div><div><h4 class="title">
8098: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
8099: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
8100: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
8101: <code class="literal">pre-configure</code> is used most often, by far. The most
8102: popular stages are, in chronological order:</p>
8103: <div class="variablelist"><dl class="variablelist">
8104: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
8105: <dd>
8106: <p>The substitutions are applied immediately after the
8107: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
8108: package will leave no traces of the original files.</p>
8109: <p>When the substitution applies to files for which there is also a
8110: patch in the <code class="filename">patches/</code> directory, this means that the
8111: patches will be computed based on the result of the substitution. When
8112: these patches are sent to the upstream maintainer later, to be fixed in
8113: the upstream package, these patches may no longer match what the upstream
8114: author is used to. Because of this, <code class="literal">pre-configure</code> is
8115: often a better choice.</p>
8116: </dd>
8117: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
8118: <dd>
8119: <p>The substitutions are applied after the patches from the
8120: <code class="filename">patches/</code> directory. This makes it possible to run
8121: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.207 leot 8122: can be edited using the tools pkgvi and mkpatches from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package.</p>
1.180 rillig 8123: <p>When updating the patches, it is helpful to explicitly separate the
8124: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
8125: configure</strong></span>, and to only edit the patches between these commands.
8126: Otherwise the substitutions from the SUBST block will end up in the patch
8127: file. When this happens in really obvious ways, pkglint will complain
8128: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
8129: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
8130: can only detect these really obvious
8131: cases.</p>
8132: </dd>
8133: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
8134: <dd><p>This stage should only be used if the package defines a
8135: <code class="literal">pre-configure</code> action itself, and the substitution must
8136: happen after that. Typical examples are packages that use the
8137: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
8138: script from
8139: <code class="filename">configure.ac</code>.</p></dd>
8140: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
8141: <dd><p>This stage is used to fix up any mistakes by the
8142: configure stage.</p></dd>
8143: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
8144: <dd><p>This stage should only be used for substitutions that are
8145: clearly related to building the package, not for fixing the
8146: configuration. Substitutions for pathnames (such as replacing
8147: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
8148: user names (such as replacing <code class="literal">@MY_USER@</code> with the
8149: actual username) belong in pre-configure or post-configure
8150: instead.</p></dd>
8151: <dt><span class="term"><code class="literal">post-build</code></span></dt>
8152: <dd>
8153: <p>Just as with pre-build, this stage should only be used
8154: for substitutions that are clearly related to building the package, not
8155: for fixing the configuration. Substitutions for pathnames (such as
8156: replacing <code class="filename">/usr/local</code> with
8157: <code class="literal">${PREFIX}</code>) or user names (such as replacing
8158: <code class="literal">@MY_USER@</code> with the actual username) belong in
8159: pre-configure or post-configure instead.</p>
8160: <p>A typical use is to update pkg-config files to include the rpath
8161: compiler options.</p>
8162: </dd>
8163: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8164: <dd><p>In general, the install phase should be as simple as
8165: possible. As with the pre-build and post-build stages, it should not be
8166: used to fix pathnames or user names, these belong in pre-configure
8167: instead. There are only few legitimate use cases for applying
8168: substitutions in this stage.</p></dd>
8169: </dl></div>
8170: </div>
8171: <div class="sect3">
8172: <div class="titlepage"><div><div><h4 class="title">
1.181 rillig 8173: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.180 rillig 8174: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8175: filename patterns. These patterns are relative to
8176: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8177: A typical example is:</p>
8178: <pre class="programlisting">
8179: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8180: </pre>
8181: <p>The above patterns, especially the last, are quite broad. The SUBST
8182: implementation checks that each filename pattern that is mentioned here
8183: has an effect. For example, if none of the
8184: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8185: and substituted, that filename pattern is redundant and should be left
1.181 rillig 8186: out. By default, the SUBST framework will complain with an error message.
8187: If the text to be substituted occurs in some of the files from a single
8188: pattern, but not in all of them, that is totally ok, and the SUBST
1.180 rillig 8189: framework will only print an INFO message for those files.</p>
8190: <p>If there is a good reason for having redundant filename patterns,
1.181 rillig 8191: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.180 rillig 8192: <p>Another popular way of choosing the files for the substitutions is
8193: via a shell command, like this:</p>
8194: <pre class="programlisting">
1.181 rillig 8195: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 8196: SUBST_FILES.path= ${C_FILES_CMD:sh}
8197: </pre>
8198: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8199: freely chosen and independent of the SUBST framework.</p>
8200: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8201: lists each file individually. Thereby chances are higher that there are
8202: filename patterns in which no substitution happens. Since the SUBST
8203: framework cannot know whether the filename patterns in
8204: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8205: Makefile (where any redundant filename pattern would be suspicious) or
8206: been generated by a shell command (in which redundant filename patterns
8207: are more likely and to be expected), it will complain about these
8208: redundant filename patterns. Therefore, SUBST blocks that use a shell
8209: command to generate the list of filename patterns often need to set
8210: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8211: </div>
8212: <div class="sect3">
8213: <div class="titlepage"><div><div><h4 class="title">
8214: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8215: <p>In most cases, the substitutions are given using one or more
1.259 leot 8216: <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.180 rillig 8217: <pre class="programlisting">
8218: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8219: </pre>
8220: <p>Each of the sed commands needs to be preceded by the
8221: <code class="literal">-e</code> option and should be specified on a line of its
8222: own, to avoid hiding short sed commands at the end of a line.</p>
8223: <p>Since the sed commands often contain shell metacharacters as the
8224: separator (the <code class="literal">|</code> in the above example), it is common
8225: to enclose them in single quotes.</p>
8226: <p>A common substitution is to replace placeholders of the form
8227: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8228: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8229: <pre class="programlisting">
8230: SUBST_VARS.path= PREFIX
8231: </pre>
8232: <p>This type of substitutions is typically done by the GNU configure
1.181 rillig 8233: scripts during the do-configure stage, but in some cases these need to be
8234: overridden. The same pattern is also used when a package defines patches
8235: that replace previously hard-coded paths like
8236: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8237: placeholder first, which then gets substituted by the actual
8238: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8239: cases, it works equally well to just use the SUBST framework to directly
8240: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8241: thereby omitting the intermediate patch file.</p>
1.180 rillig 8242: <p>If the above is not flexible enough, it is possible to not use sed
8243: at all for the substitution but to specify an entirely different command,
8244: like this:</p>
1.1 dsieger 8245: <pre class="programlisting">
1.180 rillig 8246: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8247: </pre>
8248: <p>This is used for the few remaining packages in which the
8249: distributed files use Windows-style line endings that need to be
8250: converted to UNIX-style line endings.</p>
8251: </div>
8252: <div class="sect3">
8253: <div class="titlepage"><div><div><h4 class="title">
8254: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8255: <p>When a SUBST block is applied during a package build, a message is
8256: logged. The default message is fine for most purposes but can be
8257: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8258: message.</p>
8259: </div>
1.1 dsieger 8260: </div>
8261: </div>
1.41 asau 8262: <div class="sect1">
1.1 dsieger 8263: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8264: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 8265: <div class="sect2">
1.1 dsieger 8266: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8267: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1 dsieger 8268: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8269: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8270: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8271: with the name of each file to download as an argument, expecting
8272: it to output the URL of the directory from which to download
1.207 leot 8273: it. <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/index.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.1 dsieger 8274: example of this usage.</p>
8275: <p>If the download can't be automated, because the user must
8276: submit personal information to apply for a password, or must pay
8277: for the source, or whatever, you can set
8278: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8279: displayed to the user before aborting the build. Example:</p>
8280: <pre class="programlisting">
8281: FETCH_MESSAGE= "Please download the files"
8282: FETCH_MESSAGE+= " "${DISTFILES:Q}
8283: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 8284: </pre>
1.1 dsieger 8285: </div>
1.41 asau 8286: <div class="sect2">
1.1 dsieger 8287: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8288: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1 dsieger 8289: <p>Sometimes authors of a software package make some
8290: modifications after the software was released, and they put up a
8291: new distfile without changing the package's version number. If a
8292: package is already in pkgsrc at that time, the checksum will
8293: no longer match. The contents of the new distfile should be
8294: compared against the old one before changing anything, to make
8295: sure the distfile was really updated on purpose, and that
8296: no trojan horse or so crept in.
8297: Please mention that the distfiles were compared and what was found
1.53 rodent 8298: in your commit message.</p>
1.109 wiz 8299: <p>Then, the correct way to work around this is to set
8300: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8301: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8302: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8303: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 8304: <code class="varname">PATCHFILES</code> for this package will be put in that
1.154 rillig 8305: subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="21.1.10. How to handle incrementing versions when fixing an existing package">Section 21.1.10, “How to handle incrementing versions when fixing an existing package”</a> for more details.) In case this
1.1 dsieger 8306: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 8307: including the <code class="filename">nbX</code> suffix) or a date stamp can
8308: be appended, like
8309: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169 rillig 8310: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8311: name does not contain a version and the distfile is apt to change. In
8312: cases where the likelihood of this is very small,
8313: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8314: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8315: distfile name changes, even if a package is being moved or
8316: renamed.</p>
1.53 rodent 8317: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8318: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8319: path in the filenames.
1.53 rodent 8320: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8321: Furthermore, a mail to the package's authors seems appropriate
8322: telling them that changing distfiles after releases without
8323: changing the file names is not good practice.</p>
8324: </div>
1.88 tnn 8325: <div class="sect2">
8326: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8327: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169 rillig 8328: <p>Helper methods exist for packages hosted on github.com which
8329: will often have distfile names that clash with other packages, for
8330: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8331: from below:</p>
1.88 tnn 8332: <div class="sect3">
8333: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8334: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169 rillig 8335: <p>If your distfile URL looks similar to
1.189 bacon 8336: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.169 rillig 8337: then you are packaging a tagged release.</p>
1.88 tnn 8338: <pre class="programlisting">
1.189 bacon 8339: DISTNAME= example-1.0
1.90 tnn 8340: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8341: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8342: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 8343: EXTRACT_SUFX= .zip
8344: </pre>
1.230 gutterid 8345: <p>Here, DISTNAME combined with use of GITHUB_TAG leads the
8346: file fetching infrastructure to save the resulting file locally as
8347: <code class="literal">example-1.0.zip</code>.</p>
1.88 tnn 8348: </div>
8349: <div class="sect3">
8350: <div class="titlepage"><div><div><h4 class="title">
1.189 bacon 8351: <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>
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 before the first
8354: release, then set the package version to 0.0.0.N, where N is the number
8355: of commits to the repository, and set GITHUB_TAG to the commit hash.
8356: This will (almost) ensure that the first tagged release will have a
8357: version greater than this one so that package upgrades will function
8358: properly.</p>
8359: <pre class="programlisting">
8360: DISTNAME= example-0.0.0.347
8361: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8362: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8363: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8364: </pre>
8365: </div>
8366: <div class="sect3">
8367: <div class="titlepage"><div><div><h4 class="title">
8368: <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>
8369: <p>If your distfile looks similar to
8370: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8371: then include the last release version and the commit count since that
8372: release in the package version and set GITHUB_TAG to the commit hash.
8373: The latest release and commit count are shown in the output of
8374: "git describe --tags":
8375: </p>
8376: <pre class="screen">
8377: # git clone https://github.com/username/example
8378: # cd example
8379: # git describe --tags
8380: 1.2.3-5-g988881a
8381: </pre>
1.88 tnn 8382: <pre class="programlisting">
1.189 bacon 8383: DISTNAME= example-1.2.3.5
8384: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8385: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8386: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 8387: </pre>
1.88 tnn 8388: </div>
8389: <div class="sect3">
8390: <div class="titlepage"><div><div><h4 class="title">
1.189 bacon 8391: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.169 rillig 8392: <p>If your distfile URL looks similar to
1.189 bacon 8393: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.169 rillig 8394: then you are packaging a release.</p>
1.88 tnn 8395: <pre class="programlisting">
8396: DISTNAME= offensive-1.6
1.90 tnn 8397: PKGNAME= ${DISTNAME:S/offensive/proper/}
8398: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8399: GITHUB_PROJECT= example
1.90 tnn 8400: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8401: EXTRACT_SUFX= .zip
1.111 sevan 8402: </pre>
1.88 tnn 8403: </div>
8404: </div>
1.1 dsieger 8405: </div>
1.41 asau 8406: <div class="sect1">
1.1 dsieger 8407: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8408: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8409: <div class="sect2">
1.1 dsieger 8410: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8411: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8412: <p>pkgsrc supports many different machines, with different
8413: object formats like a.out and ELF, and varying abilities to do
8414: shared library and dynamic loading at all. To accompany this,
8415: varying commands and options have to be passed to the
8416: compiler, linker, etc. to get the Right Thing, which can be
8417: pretty annoying especially if you don't have all the machines
8418: at your hand to test things. The
1.207 leot 8419: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/index.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.23 wiz 8420: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8421: both static and dynamic libraries from a set of source files,
8422: thus being platform-independent.</p>
8423: <p>Here's how to use libtool in a package in seven simple
8424: steps:</p>
1.23 wiz 8425: <div class="orderedlist"><ol class="orderedlist" type="1">
8426: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8427: Makefile.</p></li>
1.23 wiz 8428: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8429: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8430: add it to the definition of <code class="varname">CC</code>, if only
8431: libraries are being built in a given Makefile. This one command
8432: will build both PIC and non-PIC library objects, so you need not
8433: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8434: <li class="listitem">
1.1 dsieger 8435: <p>For the linking of the library, remove any
1.23 wiz 8436: <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
8437: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8438: <pre class="programlisting">
8439: ${LIBTOOL} --mode=link \
8440: ${CC} -o ${.TARGET:.a=.la} \
8441: ${OBJS:.o=.lo} \
8442: -rpath ${PREFIX}/lib \
8443: -version-info major:minor
1.111 sevan 8444: </pre>
1.1 dsieger 8445: <p>Note that the library is changed to have a
8446: <code class="filename">.la</code> extension, and the objects are
8447: changed to have a <code class="filename">.lo</code>
8448: extension. Change <code class="varname">OBJS</code> as
8449: necessary. This automatically creates all of the
8450: <code class="filename">.a</code>,
8451: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8452: necessary) in the build directory. Be sure to include
1.23 wiz 8453: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8454: minor are zero, as libtool will otherwise strip off the
8455: shared library version.</p>
8456: <p>From the libtool manual:</p>
8457: <pre class="programlisting">
8458: So, libtool library versions are described by three integers:
8459:
8460: CURRENT
8461: The most recent interface number that this library implements.
8462:
8463: REVISION
8464: The implementation number of the CURRENT interface.
8465:
8466: AGE
8467: The difference between the newest and oldest interfaces that
8468: this library implements. In other words, the library implements
8469: all the interface numbers in the range from number `CURRENT -
8470: AGE' to `CURRENT'.
8471:
8472: If two libraries have identical CURRENT and AGE numbers, then the
8473: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 8474: </pre>
1.23 wiz 8475: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8476: different results for a.out and ELF (excluding symlinks)
8477: in only one case. An ELF library of the form
1.23 wiz 8478: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8479: will have a symlink of
1.23 wiz 8480: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8481: on an a.out platform. This is handled
8482: automatically.</p>
1.23 wiz 8483: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8484: directory of the library being built.</p>
8485: <p>In the <code class="filename">PLIST</code>, include only the
8486: <code class="filename">.la</code> file, the other files will be
8487: added automatically.</p>
8488: </li>
1.23 wiz 8489: <li class="listitem">
1.1 dsieger 8490: <p>When linking shared object (<code class="filename">.so</code>)
1.259 leot 8491: 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.23 wiz 8492: shared libraries, use <span class="quote">“<span class="quote">-module
8493: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8494: tacked on.</p>
8495: <p>The <code class="filename">PLIST</code> file gets the
8496: <code class="filename">foo.so</code> entry.</p>
8497: </li>
1.23 wiz 8498: <li class="listitem">
1.1 dsieger 8499: <p>When linking programs that depend on these libraries
8500: <span class="emphasis"><em>before</em></span> they are installed, preface
1.259 leot 8501: 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.23 wiz 8502: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8503: libraries (static or shared), but please be aware that
8504: libtool will not allow you to specify a relative path in
1.23 wiz 8505: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8506: expects you to change that argument to be the
8507: <code class="filename">.la</code> file. e.g.</p>
8508: <pre class="programlisting">
8509: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 8510: </pre>
1.1 dsieger 8511: <p>should be changed to:</p>
8512: <pre class="programlisting">
8513: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 8514: </pre>
1.1 dsieger 8515: <p>and it will do the right thing with the libraries.</p>
8516: </li>
1.23 wiz 8517: <li class="listitem">
1.259 leot 8518: <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>
8519: 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.23 wiz 8520: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8521: <code class="filename">.la</code>. e.g.</p>
8522: <pre class="programlisting">
1.22 jakllsch 8523: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 8524: </pre>
1.1 dsieger 8525: <p>This will install the static <code class="filename">.a</code>,
8526: shared library, any needed symlinks, and run
1.259 leot 8527: <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.1 dsieger 8528: </li>
1.23 wiz 8529: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8530: the <code class="filename">.la</code>
8531: file (this is a change from previous behaviour).</p></li>
8532: </ol></div>
8533: </div>
1.41 asau 8534: <div class="sect2">
1.1 dsieger 8535: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8536: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8537: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8538: package Makefile. This will override the package's own libtool
8539: in most cases. For older libtool using packages, libtool is
8540: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8541: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8542: configure; find work*/ -name libtool</strong></span>.</p>
8543: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8544: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8545: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8546: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8547: package's libtool script(s), set it as appropriate.</p>
8548: <p>If you do not need <code class="filename">*.a</code> static
8549: libraries built and installed, then use
8550: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8551: <p>If your package makes use of the platform-independent library
8552: for loading dynamic shared objects, that comes with libtool
8553: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8554: <p>Some packages use libtool incorrectly so that the package
8555: may not work or build in some circumstances. Some of the more
8556: common errors are:</p>
1.41 asau 8557: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8558: <li class="listitem">
1.1 dsieger 8559: <p>The inclusion of a shared object (-module) as a dependent library in an
8560: executable or library. This in itself isn't a problem if one of two things
8561: has been done:</p>
1.23 wiz 8562: <div class="orderedlist"><ol class="orderedlist" type="1">
8563: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8564: <code class="filename">libfoo.la</code>, not
8565: <code class="filename">foo.la</code></p></li>
1.23 wiz 8566: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8567: </ol></div>
8568: </li>
1.23 wiz 8569: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8570: The function lt_dlinit() should be called and the macro
8571: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8572: executables.</p></li>
8573: </ul></div>
8574: </div>
1.41 asau 8575: <div class="sect2">
1.1 dsieger 8576: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8577: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8578: <p>If a package needs GNU autoconf or automake to be executed
1.223 nia 8579: to regenerate the
8580: <code class="filename">configure</code>
8581: script and <code class="filename">Makefile.in</code> makefile
8582: templates from <code class="filename">configure.ac</code> and
8583: <code class="filename">Makefile.am</code>,
8584: then they should be executed in a pre-configure target:</p>
1.1 dsieger 8585: <pre class="programlisting">
1.223 nia 8586: USE_TOOLS+= autoconf automake autoreconf
8587: GNU_CONFIGURE= yes
1.1 dsieger 8588: ...
8589:
8590: pre-configure:
1.223 nia 8591: set -e; cd ${WRKSRC} && autoreconf -fi
1.1 dsieger 8592: ...
1.111 sevan 8593: </pre>
1.223 nia 8594: <p>Packages which use GNU Automake will sometimes
8595: require GNU Make (<code class="literal">gmake</code> in
8596: <code class="varname">USE_TOOLS</code>),
8597: but not always. Note that autoreconf
8598: only needs to be executed if <code class="filename">configure.ac</code>
8599: or Makefiles are modified, or <code class="filename">configure</code>
8600: is not present.</p>
1.1 dsieger 8601: <p>There are times when the configure process makes
8602: additional changes to the generated files, which then causes
8603: the build process to try to re-execute the automake sequence.
8604: This is prevented by touching various files in the configure
8605: stage. If this causes problems with your package you can set
8606: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8607: Makefile.</p>
8608: </div>
1.223 nia 8609: <div class="sect2">
8610: <div class="titlepage"><div><div><h3 class="title">
8611: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
8612: <p>Packages using Meson to configure need to include:
8613:
8614: </p>
8615: <pre class="programlisting">
8616: .include "../../devel/meson/build.mk"
8617: </pre>
8618: <p>In nearly all cases (any program with dependencies),
8619: pkg-config needs to be added to
8620: <code class="varname">USE_TOOLS</code>. If the package installs
8621: translation files for non-English languages, also
8622: add msgfmt and xgettext:
8623:
8624: </p>
8625: <pre class="programlisting">
8626: USE_TOOLS+= pkg-config msgfmt xgettext
8627: </pre>
8628: <p>If any options need to be passed to Meson, use
8629: <code class="varname">MESON_ARGS</code> instead of
8630: <code class="varname">CONFIGURE_ARGS</code>:
8631:
8632: </p>
8633: <pre class="programlisting">
8634: MESON_ARGS+= -Dx11=false
8635: </pre>
8636: </div>
1.260 wiz 8637: <div class="sect2">
8638: <div class="titlepage"><div><div><h3 class="title">
8639: <a name="endian"></a>21.3.5. Determining the endianness</h3></div></div></div>
8640: <p>To determine the endianness of the target platform,
8641: have a look at <code class="filename">mk/endian.mk</code>.</p>
8642: </div>
1.1 dsieger 8643: </div>
1.41 asau 8644: <div class="sect1">
1.1 dsieger 8645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8646: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41 asau 8647: <div class="sect2">
1.1 dsieger 8648: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8649: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.244 gutterid 8650: <p>Compilers for the C and C++ languages come with
1.1 dsieger 8651: the NetBSD base system. By default, pkgsrc assumes that a package
8652: is written in C and will hide all other compilers (via the wrapper
1.184 rillig 8653: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.243 gutterid 8654: <p>To declare which languages should be made available through
8655: pkgsrc's compiler wrappers, use
1.1 dsieger 8656: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.212 wiz 8657: currently are:
1.238 wiz 8658: </p>
1.212 wiz 8659: <pre class="programlisting">
1.244 gutterid 8660: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.238 wiz 8661: </pre>
1.212 wiz 8662: <p>
8663: (and any combination). The default is
1.23 wiz 8664: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8665: written in C++, usually need a C compiler for the configure
1.244 gutterid 8666: phase.</p>
1.250 jnemeth 8667: <p>To declare which features a package requires from the
1.243 gutterid 8668: compiler, set either <code class="varname">USE_CC_FEATURES</code>
8669: or <code class="varname">USE_CXX_FEATURES</code>. Allowed values for
8670: <code class="varname">USE_CC_FEATURES</code> are currently:
8671: </p>
8672: <pre class="programlisting">
8673: c11, c99, has_include
8674: </pre>
8675: <p>
8676: Allowed values for <code class="varname">USE_CXX_FEATURES</code> are
8677: currently:
8678: </p>
8679: <pre class="programlisting">
8680: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
8681: charconv, parallelism_ts, unique_ptr, put_time,
8682: is_trivially_copy_constructible
8683: </pre>
8684: <p>
1.251 gutterid 8685: Note at present these variables only affect use of GCC, not other
8686: compilers.
1.243 gutterid 8687: </p>
1.244 gutterid 8688: <p>Language variants like <code class="literal">gnu99</code> and
8689: <code class="literal">c++11</code> can be specified in <code class="varname">FORCE_C_STD</code>
8690: and <code class="varname">FORCE_CXX_STD</code> if the package does not explicitly set
8691: <code class="literal">-std=...</code> when compiling (i.e. the package
8692: assumes the compiler defaults to C++11 or some other standard).
8693: This is a common bug in upstream build systems.</p>
8694: <p>Allowed values for <code class="varname">FORCE_C_STD</code> are
8695: currently:
8696: </p>
8697: <pre class="programlisting">
8698: c90, c99, c11, gnu90, gnu99, gnu11
8699: </pre>
8700: <p>
8701: </p>
8702: <p>Allowed values for <code class="varname">FORCE_CXX_STD</code> are
8703: currently:
8704: </p>
8705: <pre class="programlisting">
8706: c++03, c++11, c++14, c++17, c++20,
8707: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
8708: </pre>
8709: <p>
1.251 gutterid 8710: Note at present these variables only affect use of GCC and Clang.
1.244 gutterid 8711: </p>
1.1 dsieger 8712: </div>
1.41 asau 8713: <div class="sect2">
1.1 dsieger 8714: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8715: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 8716: <p>If a program is written in Java, use the Java framework in
8717: pkgsrc. The package must include
8718: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8719: provides the following variables:</p>
1.41 asau 8720: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8721: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8722: dependency on the JDK is added. If
1.23 wiz 8723: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8724: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8725: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8726: JDK.</p></li>
1.23 wiz 8727: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8728: a package needs a Java2 implementation. The supported values
1.23 wiz 8729: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8730: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8731: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8732: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8733: above. This variable is not set by default.</p></li>
1.24 wiz 8734: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8735: automatically set to the runtime location of the used Java
8736: implementation dependency. It may be used to set
8737: <code class="varname">JAVA_HOME</code> to a good value if the program
8738: needs this variable to be defined.
8739: </p></li>
1.1 dsieger 8740: </ul></div>
8741: </div>
1.41 asau 8742: <div class="sect2">
1.1 dsieger 8743: <div class="titlepage"><div><div><h3 class="title">
1.205 wiz 8744: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
8745: <p>If a program is written in Go and has any dependencies on
8746: other Go modules, have the package include
8747: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8748: <div class="orderedlist"><ol class="orderedlist" type="1">
8749: <li class="listitem"><p>Generate a list of those dependencies with
8750: <span class="command"><strong>make clean && make patch && make show-go-modules >
8751: go-modules.mk</strong></span>.</p></li>
1.223 nia 8752: <li class="listitem"><p>Prepend
8753: <code class="literal">.include "go-modules.mk"</code> to any other
8754: <code class="literal">.include</code>s.</p></li>
8755: <li class="listitem"><p>Incorporate these modules in
8756: <code class="filename">distinfo</code> with <span class="command"><strong>make
8757: makesum</strong></span>.</p></li>
8758: </ol></div>
8759: </div>
8760: <div class="sect2">
8761: <div class="titlepage"><div><div><h3 class="title">
8762: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
8763: <p>If a program is written in Rust and uses Cargo to build,
8764: have the package include
8765: <code class="filename">../../lang/rust/cargo.mk</code>.</p>
8766: <div class="orderedlist"><ol class="orderedlist" type="1">
8767: <li class="listitem"><p>Generate a list of those dependencies with
8768: <span class="command"><strong>make CARGO_ARGS="build --release" build &&
8769: make print-cargo-depends > cargo-depends.mk</strong></span>.</p></li>
8770: <li class="listitem"><p>Prepend
8771: <code class="literal">.include "cargo-depends.mk"</code> to any other
8772: <code class="literal">.include</code>s.</p></li>
1.205 wiz 8773: <li class="listitem"><p>Incorporate these modules in
8774: <code class="filename">distinfo</code> with <span class="command"><strong>make
8775: makesum</strong></span>.</p></li>
8776: </ol></div>
8777: </div>
8778: <div class="sect2">
8779: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8780: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.203 nia 8781: <p>If your package contains interpreted Perl scripts, add
1.23 wiz 8782: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8783: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8784: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8785: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8786: that you want adjusted. Every occurrence of
8787: <code class="filename">*/bin/perl</code> in a she-bang line will be
1.210 gutterid 8788: replaced with the full path to the Perl executable.</p>
8789: <p>If a particular version of Perl is needed, set the
1.1 dsieger 8790: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8791: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.203 nia 8792: <p>See <a class="xref" href="#perl-modules" title="21.6.6. Packages installing Perl modules">Section 21.6.6, “Packages installing Perl modules”</a> for information
1.210 gutterid 8793: about handling Perl modules.</p>
8794: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
8795: for the language now known as Raku.</p>
1.1 dsieger 8796: </div>
1.41 asau 8797: <div class="sect2">
1.1 dsieger 8798: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8799: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 8800: <p><code class="varname">REPLACE_SH</code>,
8801: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8802: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.225 gutterid 8803: she-bangs in files. Please use the appropriate one, preferring
8804: <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.74 wiz 8805: Each should contain a list of scripts, relative to
8806: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8807: occurrence of the matching shell in a she-bang line will be
8808: replaced with the full path to the shell executable.
1.40 wiz 8809: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8810: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8811: </div>
1.41 asau 8812: <div class="sect2">
1.40 wiz 8813: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8814: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.210 gutterid 8815: <p>There are further similar REPLACE variables available, e.g.,
8816: <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
8817: and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.211 gutterid 8818: noted above, have their actions defined centrally in
1.210 gutterid 8819: <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.211 gutterid 8820: languages define the actions of these variables within their own
8821: dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
1.245 gutterid 8822: actioned in <code class="filename">lang/php/replace.mk</code>, and
1.211 gutterid 8823: <code class="varname">REPLACE_PYTHON</code> is actioned in
1.210 gutterid 8824: <code class="filename">lang/python/application.mk</code>. For other languages,
8825: consult the mk files found within their specific directories (the
1.216 gutterid 8826: naming convention varies), or check the list found in
8827: <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.210 gutterid 8828: <p>Currently, special handling for other languages varies
1.1 dsieger 8829: in pkgsrc. If a compiler package provides a
8830: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8831: just add a (build) dependency on the appropriate compiler
8832: package.</p>
8833: </div>
8834: </div>
1.41 asau 8835: <div class="sect1">
1.1 dsieger 8836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8837: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8838: <p>The most common failures when building a package are that
8839: some platforms do not provide certain header files, functions or
8840: libraries, or they provide the functions in a library that the
8841: original package author didn't know. To work around this, you
8842: can rewrite the source code in most cases so that it does not
8843: use the missing functions or provides a replacement function.</p>
1.41 asau 8844: <div class="sect2">
1.1 dsieger 8845: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8846: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8847: <p>If a package already comes with a GNU configure script, the
8848: preferred way to fix the build failure is to change the
8849: configure script, not the code. In the other cases, you can
8850: utilize the C preprocessor, which defines certain macros
8851: depending on the operating system and hardware architecture it
8852: compiles for. These macros can be queried using for example
8853: <code class="varname">#if defined(__i386)</code>. Almost every operating
8854: system, hardware architecture and compiler has its own macro.
8855: For example, if the macros <code class="varname">__GNUC__</code>,
8856: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8857: are all defined, you know that you are using NetBSD on an i386
8858: compatible CPU, and your compiler is GCC.</p>
8859: <p>The list of the following macros for hardware and
8860: operating system depends on the compiler that is used. For
8861: example, if you want to conditionally compile code on Solaris,
8862: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8863: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8864: <div class="sect3">
1.1 dsieger 8865: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8866: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.223 nia 8867: <p>To distinguish between specific NetBSD versions,
8868: you should use the following code.</p>
8869: <pre class="programlisting">
8870: #ifdef __NetBSD__
8871: #include <sys/param.h>
8872: #if __NetBSD_Prereq__(9,99,17)
8873: /* use a newer feature */
8874: #else
8875: /* older code */
8876: #endif
8877: #endif
8878:
8879: #ifndef _WIN32
8880: /* Unix-like specific code */
8881: #endif
8882: </pre>
1.1 dsieger 8883: <p>To distinguish between 4.4 BSD-derived systems and the
8884: rest of the world, you should use the following code.</p>
8885: <pre class="programlisting">
8886: #include <sys/param.h>
8887: #if (defined(BSD) && BSD >= 199306)
8888: /* BSD-specific code goes here */
8889: #else
8890: /* non-BSD-specific code goes here */
8891: #endif
8892: </pre>
1.223 nia 8893: <p>You can also test for the following macros:</p>
1.1 dsieger 8894: <pre class="programlisting">
1.45 obache 8895: Cygwin __CYGWIN__
8896: DragonFly __DragonFly__
1.1 dsieger 8897: FreeBSD __FreeBSD__
1.45 obache 8898: Haiku __HAIKU__
1.1 dsieger 8899: Interix __INTERIX
8900: IRIX __sgi (TODO: get a definite source for this)
1.223 nia 8901: Linux __linux
1.83 dholland 8902: Mac OS X __APPLE__
1.45 obache 8903: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8904: Minix3 __minix
1.1 dsieger 8905: NetBSD __NetBSD__
8906: OpenBSD __OpenBSD__
8907: Solaris sun, __sun
8908: </pre>
8909: </div>
1.41 asau 8910: <div class="sect3">
1.1 dsieger 8911: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8912: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1 dsieger 8913: <pre class="programlisting">
8914: i386 i386, __i386, __i386__
1.223 nia 8915: x86-64 __amd64__, __x86_64__
8916: ARM __arm__
1.1 dsieger 8917: MIPS __mips
8918: SPARC sparc, __sparc
1.223 nia 8919: PowerPC __powerpc
1.1 dsieger 8920: </pre>
8921: </div>
1.41 asau 8922: <div class="sect3">
1.1 dsieger 8923: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8924: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1 dsieger 8925: <pre class="programlisting">
8926: GCC __GNUC__ (major version), __GNUC_MINOR__
8927: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8928: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8929: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8930: </pre>
8931: </div>
8932: </div>
1.41 asau 8933: <div class="sect2">
1.1 dsieger 8934: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8935: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8936: <p>Some source files trigger bugs in the compiler, based on
8937: combinations of compiler version and architecture and almost
8938: always relation to optimisation being enabled. Common symptoms
8939: are gcc internal errors or never finishing compiling a
8940: file.</p>
8941: <p>Typically, a workaround involves testing the
8942: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8943: optimisation for that combination of file,
1.87 tnn 8944: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8945: <p>This used to be a big problem in the past, but is rarely
8946: needed now as compiler technology has matured. If you still need
8947: to add a compiler specific workaround, please do so in the file
8948: <code class="filename">hacks.mk</code> and describe the symptom and
8949: compiler version as detailed as possible.</p>
1.1 dsieger 8950: </div>
1.41 asau 8951: <div class="sect2">
1.1 dsieger 8952: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8953: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8954: <p>Compilation sometimes fails with an error message like this:</p>
8955: <pre class="programlisting">
8956: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8957: fatal error: pango/pango.h: No such file or directory
8958: </pre>
8959: <p>The proper way to fix this problem depends on the type of the
8960: header, which is described in the following sections.</p>
8961: <div class="sect3">
8962: <div class="titlepage"><div><div><h4 class="title">
8963: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8964: <p>If the header name looks like it comes from a different package,
8965: that other package should be included via the buildlink3
8966: framework.</p>
8967: <p>First, look whether the header is somewhere in the buildlink3
8968: directory below <code class="varname">WRKDIR</code>. In the above case of
8969: the missing Pango header:</p>
8970: <pre class="programlisting">
8971: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8972: </pre>
8973: <p>In the case of Pango, the output is:</p>
8974: <pre class="programlisting">
8975: work/.buildlink/include/pango-1.0/pango/pango.h
8976: </pre>
8977: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8978: in the <code class="filename">.buildlink</code> directory, it would have been
8979: found automatically. There is an extra <code class="filename">pango-1.0</code>
8980: path component though, which means that the compiler command line must
8981: contain an option of the form
8982: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8983: most cases this option is generated by the configure script, which can be examined using:</p>
8984: <pre class="programlisting">
8985: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8986: -I/usr/pkg/include/pango-1.0
8987: -I/usr/pkg/include/pango-1.0
8988: -I/usr/pkg/include/pango-1.0
8989: -I/usr/pkg/include/pango-1.0
8990: -I/usr/pkg/include/pango-1.0
8991: </pre>
8992: <p>This looks good. These options are transformed by the buildlink
8993: wrapper to refer to the correct path inside
8994: <code class="filename">work/.buildlink</code>.</p>
8995: <p>Since the compilation fails though, examine the compiler command
8996: lines in <code class="filename">work/.work.log</code> to see whether the
8997: <code class="literal">-I</code> option is included in the particular command
8998: line.</p>
8999: <p>To further analyze the situation, run <span class="command"><strong>bmake
9000: build-env</strong></span>, which sets up an interactive, realistic environment
9001: including all the pkgsrc wrapper commands and environment variables. From
9002: there, try to compile some simple example programs that use the
9003: header.</p>
9004: </div>
9005: <div class="sect3">
9006: <div class="titlepage"><div><div><h4 class="title">
9007: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
9008: <p>If the name of the header seems to come from the package itself,
9009: and if the build is run with parallel jobs, the package may have some
9010: undeclared dependencies between the <code class="filename">.c</code> and the
9011: <code class="filename">.h</code> files, and a C file is compiled before its
9012: required header is generated.</p>
9013: <p>To see whether the build runs with parallel jobs, run
9014: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
9015: like this:</p>
9016: <pre class="programlisting">
9017: usr MAKE_JOBS= 7
9018: pkg MAKE_JOBS_SAFE # undefined
9019: def _MAKE_JOBS_N= 7
9020: </pre>
9021: <p>In this case the pkgsrc user has asked pkgsrc to build packages
9022: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
9023: package could have disabled parallel builds by setting
9024: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
9025: in this case it hasn't.</p>
9026: <p>To see whether the build failure is caused by parallel builds,
9027: first save the exact error message and a bit of context, maybe you need
9028: it later for reporting a bug. Next, run:</p>
9029: <pre class="programlisting">
9030: MAKE_JOBS_SAFE=no bmake clean build
9031: </pre>
9032: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
9033: report</a> against the pkgsrc package, including the exact error
9034: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
9035: </div>
1.173 rillig 9036: <div class="sect3">
9037: <div class="titlepage"><div><div><h4 class="title">
9038: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
9039: <p>Pkgsrc does not work reliably if any of
9040: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
9041: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
9042: bootstrap program prevents installing pkgsrc in symlink-based
9043: directories. Existing pkgsrc installations are not checked for symlinks
9044: though.</p>
9045: <p>The "No such file or directory" error messages are a typical
9046: symptom of symlinks, and it's quite difficult to find out that this is
9047: the actual cause.</p>
9048: </div>
9049: <div class="sect3">
9050: <div class="titlepage"><div><div><h4 class="title">
9051: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
9052: <p>When building a hierarchy of packages, it may happen that one
9053: package is built and then pkgsrc is updated. This situation can provoke
9054: various hard to diagnose build errors. To clean up the situation:</p>
9055: <pre class="programlisting">
1.223 nia 9056: <code class="prompt">$</code> (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.173 rillig 9057: </pre>
1.223 nia 9058: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
9059: prevent running this command in the wrong directory.)</p>
1.173 rillig 9060: <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
9061: that directory as well.</p>
9062: </div>
9063: <div class="sect3">
9064: <div class="titlepage"><div><div><h4 class="title">
9065: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
9066: <p>On platforms other than BSD, third-party packages are installed in
9067: <code class="filename">/usr/include</code>, together with the base system. This
9068: means that pkgsrc cannot distinguish between headers provided by the base
9069: system (which it needs) and headers from third-party packages (which are
9070: often included in pkgsrc as well). This can lead to subtle version
9071: mismatches.</p>
9072: <p>In pkgsrc installations that have been active for several years, it
9073: may happen that some files are manually deleted. To exclude this unlikely
9074: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
9075: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
9076: check/fix dependencies.</p>
9077: <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>
9078: for contact information. Be prepared to describe what you have tried so
9079: far and what any error messages were.</p>
9080: </div>
1.172 rillig 9081: </div>
9082: <div class="sect2">
9083: <div class="titlepage"><div><div><h3 class="title">
9084: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 9085: </h3></div></div></div>
1.1 dsieger 9086: <p>This error message often means that a package did not
9087: link to a shared library it needs. The following functions are
9088: known to cause this error message over and over.</p>
9089: <div class="informaltable">
1.106 tnn 9090: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 9091: <colgroup>
9092: <col>
9093: <col>
9094: <col>
9095: </colgroup>
9096: <thead><tr>
9097: <th>Function</th>
9098: <th>Library</th>
9099: <th>Affected platforms</th>
9100: </tr></thead>
9101: <tbody>
9102: <tr>
9103: <td>accept, bind, connect</td>
9104: <td>-lsocket</td>
9105: <td>Solaris</td>
9106: </tr>
9107: <tr>
9108: <td>crypt</td>
9109: <td>-lcrypt</td>
9110: <td>DragonFly, NetBSD</td>
9111: </tr>
9112: <tr>
9113: <td>dlopen, dlsym</td>
9114: <td>-ldl</td>
9115: <td>Linux</td>
9116: </tr>
9117: <tr>
9118: <td>gethost*</td>
9119: <td>-lnsl</td>
9120: <td>Solaris</td>
9121: </tr>
9122: <tr>
9123: <td>inet_aton</td>
9124: <td>-lresolv</td>
9125: <td>Solaris</td>
9126: </tr>
9127: <tr>
9128: <td>nanosleep, sem_*, timer_*</td>
9129: <td>-lrt</td>
9130: <td>Solaris</td>
9131: </tr>
9132: <tr>
9133: <td>openpty</td>
9134: <td>-lutil</td>
9135: <td>Linux</td>
9136: </tr>
9137: </tbody>
9138: </table>
9139: </div>
1.223 nia 9140: <p>To fix these linker errors, it is often sufficient to add
1.1 dsieger 9141: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
9142: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.223 nia 9143: <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.1 dsieger 9144: bmake</strong></span>.</p>
1.41 asau 9145: <div class="sect3">
1.1 dsieger 9146: <div class="titlepage"><div><div><h4 class="title">
1.223 nia 9147: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.1 dsieger 9148: <p>When you are using the SunPro compiler, there is another
9149: possibility. That compiler cannot handle the following code:</p>
9150: <pre class="programlisting">
9151: extern int extern_func(int);
9152:
9153: static inline int
9154: inline_func(int x)
9155: {
9156: return extern_func(x);
9157: }
9158:
9159: int main(void)
9160: {
9161: return 0;
9162: }
9163: </pre>
9164: <p>It generates the code for <code class="function">inline_func</code> even if
9165: that function is never used. This code then refers to
9166: <code class="function">extern_func</code>, which can usually not be resolved. To
9167: solve this problem you can try to tell the package to disable inlining
9168: of functions.</p>
9169: </div>
1.228 gutterid 9170: <div class="sect3">
9171: <div class="titlepage"><div><div><h4 class="title">
9172: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
9173: <p>When building for older machine architectures (e.g., i386, PowerPC),
9174: builds may fail because the package expects modern 64-bit atomic functions
9175: which the underlying hardware either doesn't support, or will only support
9176: with specific compiler flags. This is generally handled via inclusion of
9177: mk/atomic64.mk.</p>
9178: </div>
1.1 dsieger 9179: </div>
1.41 asau 9180: <div class="sect2">
1.1 dsieger 9181: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 9182: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1 dsieger 9183: <p>Sometimes packages fail to build because the compiler runs
9184: into an operating system specific soft limit. With the
9185: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.223 nia 9186: to unlimit the resources. The allowed values are any combination of
9187: <span class="quote">“<span class="quote">cputime</span>”</span>,
9188: <span class="quote">“<span class="quote">datasize</span>”</span>,
9189: <span class="quote">“<span class="quote">memorysize</span>”</span>,
9190: <span class="quote">“<span class="quote">stacksize</span>”</span> and
9191: <span class="quote">“<span class="quote">virtualsize</span>”</span>.
1.1 dsieger 9192: Setting this variable is similar to running the shell builtin
1.10 hubertf 9193: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 9194: segment size or maximum stack size of a process, respectively, to
9195: their hard limits.</p>
9196: </div>
9197: </div>
1.41 asau 9198: <div class="sect1">
1.1 dsieger 9199: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9200: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 9201: <div class="sect2">
1.1 dsieger 9202: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9203: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 9204: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 9205: with some operating systems cannot create more than one
9206: directory at a time. As such, you should call
9207: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
9208: <pre class="programlisting">
9209: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
9210: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 9211: </pre>
1.223 nia 9212: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
9213: directly, you can also append <span class="quote">“<span class="quote"><code class="literal">dir1
9214: dir2</code></span>”</span> to the <code class="varname">INSTALLATION_DIRS</code>
9215: variable, which will automatically do the right thing.</p>
1.1 dsieger 9216: </div>
1.41 asau 9217: <div class="sect2">
1.1 dsieger 9218: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9219: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 9220: <p>In general, documentation should be installed into
9221: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.223 nia 9222: <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.1 dsieger 9223: includes the version number of the package).</p>
9224: <p>Many modern packages using GNU autoconf allow to set the
9225: directory where HTML documentation is installed with the
1.223 nia 9226: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag is
9227: needed because otherwise the documentation ends up in
9228: <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
9229: pkgsrc, the HTML documentation should go into the package-specific
9230: directory, just like any other documentation.</p>
1.1 dsieger 9231: <p>An exception to the above is that library API documentation
1.207 leot 9232: generated with the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/index.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.1 dsieger 9233: browsers (devhelp) should be left at their default location, which
9234: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
9235: documentation can be recognized from files ending in
9236: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
9237: (It is also acceptable to install such files in
9238: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
9239: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
9240: <code class="filename">.devhelp*</code> file must be directly in that
9241: directory then, no additional subdirectory level is allowed in
9242: this case. This is usually achieved by using
1.23 wiz 9243: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 9244: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
9245: though.)</p>
9246: </div>
1.41 asau 9247: <div class="sect2">
1.1 dsieger 9248: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9249: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 9250: <p>Certain packages, most of them in the games category, install
9251: a score file that allows all users on the system to record their
9252: highscores. In order for this to work, the binaries need to be
9253: installed setgid and the score files owned by the appropriate
1.35 wiz 9254: group and/or owner (traditionally the "games" user/group). Set
9255: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 9256: following variables, documented in more detail in
9257: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 9258: behaviour: <code class="varname">GAMEDATAMODE</code>,
9259: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 9260: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
9261: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
9262: <code class="varname">GAMEDATA_PERMS</code> and
9263: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
9264: <p>An example that illustrates some of the variables described above is
9265: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
9266: used to properly set directory permissions of the directory where the
9267: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
9268: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
9269: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
9270: binary:</p>
9271: <pre class="programlisting">
1.112 rillig 9272: USE_GAMESGROUP= yes
1.100 leot 9273:
1.112 rillig 9274: BUILD_DEFS+= VARBASE
1.100 leot 9275:
1.112 rillig 9276: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
9277: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
9278: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 9279: </pre>
1.100 leot 9280: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
9281: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
9282: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
9283: needed to be accessed by setgid games and
9284: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 9285: <p>A package should therefore never hard code file ownership or
1.100 leot 9286: access permissions but rely on <code class="varname">*_PERMS</code> as described above
9287: or alternatively on <code class="varname">INSTALL_GAME</code>,
9288: <code class="varname">INSTALL_GAME_DATA</code> and
9289: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 9290: </div>
1.41 asau 9291: <div class="sect2">
1.1 dsieger 9292: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9293: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 9294: <p><code class="varname">DESTDIR</code> support means that a package
9295: installs into a staging directory, not the final location of the
9296: files. Then a binary package is created which can be used for
9297: installation as usual. There are two ways: Either the package must
1.23 wiz 9298: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9299: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 9300: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9301: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 9302: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
9303: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 9304: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9305: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 9306: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9307: the inclusion.</p></li>
1.23 wiz 9308: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 9309: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 9310: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 9311: automatically. Many manual rules and pre/post-install often are
9312: incorrect; fix them.</p></li>
1.23 wiz 9313: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 9314: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 9315: <li class="listitem"><p>In general, packages should support
1.4 rillig 9316: <code class="varname">UNPRIVILEGED</code> to be able to use
9317: DESTDIR.</p></li>
9318: </ul></div>
9319: </div>
1.41 asau 9320: <div class="sect2">
1.4 rillig 9321: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9322: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 9323: <p>Your package may also contain scripts with hardcoded paths to
1.203 nia 9324: other interpreters besides (or as well as) Perl. To correct the
1.1 dsieger 9325: full pathname to the script interpreter, you need to set the
9326: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 9327: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 9328: <pre class="programlisting">
9329: REPLACE_INTERPRETER+= tcl
9330: REPLACE.tcl.old= .*/bin/tclsh
9331: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9332: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9333: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 9334: </pre>
1.1 dsieger 9335: </div>
1.41 asau 9336: <div class="sect2">
1.1 dsieger 9337: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9338: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.1 dsieger 9339: <p>Makefiles of packages providing perl5 modules should include
9340: the Makefile fragment
9341: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 9342: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 9343: configuration for such modules as well as various hooks to tune
9344: this configuration. See comments in this file for
9345: details.</p>
9346: <p>Perl5 modules will install into different places depending
9347: on the version of perl used during the build process. To
9348: address this, pkgsrc will append lines to the
9349: <code class="filename">PLIST</code> corresponding to the files listed in
9350: the installed <code class="filename">.packlist</code> file generated by
9351: most perl5 modules. This is invoked by defining
9352: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 9353: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9354: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9355: e.g.:</p>
1.1 dsieger 9356: <pre class="programlisting">
1.47 wiz 9357: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 9358: </pre>
1.47 wiz 9359: <p>The perl5 config variables
9360: <code class="varname">installarchlib</code>,
9361: <code class="varname">installscript</code>,
9362: <code class="varname">installvendorbin</code>,
9363: <code class="varname">installvendorscript</code>,
9364: <code class="varname">installvendorarch</code>,
9365: <code class="varname">installvendorlib</code>,
9366: <code class="varname">installvendorman1dir</code>, and
9367: <code class="varname">installvendorman3dir</code> represent those
9368: locations in which components of perl5 modules may be installed,
9369: provided as variable with uppercase and prefixed with
9370: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9371: and may be used by perl5 packages that don't have a packlist.
9372: These variables are also substituted for in the
9373: <code class="filename">PLIST</code> as uppercase prefixed with
9374: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 9375: </div>
1.41 asau 9376: <div class="sect2">
1.1 dsieger 9377: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9378: <a name="faq.pkg-config-files"></a>21.6.7. Packages installing pkg-config files</h3></div></div></div>
9379: <p>Some packages, usually those providing libraries, install
9380: pkg-config files so that their headers and libraries can easily be
9381: found. The file names end with <code class="filename">.pc</code>.</p>
9382: <p>Most of the time, these files only provide the linker flags
9383: for the library, but do not include the flags for setting the
9384: rpath so the libraries can also be found at runtime. Since this is
9385: so common, pkgsrc provides <code class="varname">PKGCONFIG_OVERRIDE</code>
9386: for this. Many packages generate the <code class="filename">.pc</code> from
9387: <code class="filename">.pc.in</code>, in that case add those files to the
9388: <code class="varname">PKGCONFIG_OVERRIDE</code> variable:</p>
9389: <pre class="programlisting">
9390: PKGCONFIG_OVERRIDE+= foo.pc.in
9391: </pre>
9392: <p>For packages using meson, the files are generated during
9393: build and you also need to change the phase in which the
9394: replacement is done. For example:</p>
9395: <pre class="programlisting">
9396: PKGCONFIG_OVERRIDE+= output/meson-private/foo.pc
9397: PKGCONFIG_OVERRIDE_STAGE= post-build
9398: </pre>
9399: </div>
9400: <div class="sect2">
9401: <div class="titlepage"><div><div><h3 class="title">
9402: <a name="faq.info-files"></a>21.6.8. Packages installing info files</h3></div></div></div>
1.1 dsieger 9403: <p>Some packages install info files or use the
1.23 wiz 9404: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 9405: commands. <code class="varname">INFO_FILES</code> should be defined in
9406: the package Makefile so that <code class="filename">INSTALL</code> and
9407: <code class="filename">DEINSTALL</code> scripts will be generated to
9408: handle registration of the info files in the Info directory
1.23 wiz 9409: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 9410: files registration is either provided by the system, or by a
9411: special purpose package automatically added as dependency if
9412: needed.</p>
9413: <p><code class="varname">PKGINFODIR</code> is the directory under
9414: <code class="filename">${PREFIX}</code> where info files are primarily
9415: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 9416: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 9417: <p>The info files for the package should be listed in the
9418: package <code class="filename">PLIST</code>; however any split info files
9419: need not be listed.</p>
1.23 wiz 9420: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9421: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 9422: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 9423: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 9424: should be noted with the <code class="varname">TEXINFO_REQD</code>
9425: variable in the package <code class="filename">Makefile</code>. By
9426: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 9427: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 9428: does not match the required minimum, a build dependency on the
1.207 leot 9429: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/index.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.1 dsieger 9430: be added automatically.</p>
9431: <p>The build and installation process of the software provided
9432: by the package should not use the
1.10 hubertf 9433: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 9434: info files is the task of the package
9435: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 9436: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 9437: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 9438: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9439: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 9440: in <code class="varname">PATH</code>.</p>
1.10 hubertf 9441: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 9442: no effect except the logging of a message. The script overriding
1.10 hubertf 9443: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 9444: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 9445: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 9446: </div>
1.41 asau 9447: <div class="sect2">
1.1 dsieger 9448: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9449: <a name="manpages"></a>21.6.9. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9450: <p>All packages that install manual pages should install them
9451: into the same directory, so that there is one common place to look
9452: for them. In pkgsrc, this place is
9453: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9454: should be used in packages. The default for
9455: <code class="varname">PKGMANDIR</code> is
1.23 wiz 9456: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9457: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 9458: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9459: <h3 class="title">Note</h3>
9460: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9461: is far from complete.</p>
9462: </div>
9463: <p>The <code class="filename">PLIST</code> files can just use
9464: <code class="filename">man/</code> as the top level directory for the man
9465: page file entries, and the pkgsrc framework will convert as
9466: needed. In all other places, the correct
9467: <code class="varname">PKGMANDIR</code> must be used.</p>
9468: <p>Packages that are
9469: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 9470: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 9471: <code class="filename">./configure</code>
9472: --mandir switch to set where the man pages should be installed.
9473: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9474: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9475: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9476: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 9477: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 9478: Or if the <code class="filename">./configure</code> script uses
9479: a non-standard use of --mandir, you can set
9480: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.184 rillig 9481: <p>See <a class="xref" href="#manpage-compression" title="19.5. Man page compression">Section 19.5, “Man page compression”</a> for
1.1 dsieger 9482: information on installation of compressed manual pages.</p>
9483: </div>
1.41 asau 9484: <div class="sect2">
1.1 dsieger 9485: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9486: <a name="x11-fonts"></a>21.6.10. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9487: <p>If a package installs font files, you will need to rebuild
9488: the fonts database in the directory where they get installed at
9489: installation and deinstallation time. This can be automatically
9490: done by using the pkginstall framework.</p>
9491: <p>You can list the directories where fonts are installed in the
9492: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9493: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 9494: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.1 dsieger 9495: Also make sure that the database file
9496: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9497: <p>Note that you should not create new directories for fonts;
9498: instead use the standard ones to avoid that the user needs to
9499: manually configure his X server to find them.</p>
9500: </div>
1.41 asau 9501: <div class="sect2">
1.1 dsieger 9502: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9503: <a name="sgml-xml-data"></a>21.6.11. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9504: <p>If a package installs SGML or XML data files that need to be
9505: registered in system-wide catalogs (like DTDs, sub-catalogs,
9506: etc.), you need to take some extra steps:</p>
1.23 wiz 9507: <div class="orderedlist"><ol class="orderedlist" type="1">
9508: <li class="listitem"><p>Include
1.1 dsieger 9509: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9510: your <code class="filename">Makefile</code>, which takes care of
9511: registering those files in system-wide catalogs at
9512: installation and deinstallation time.</p></li>
1.23 wiz 9513: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9514: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9515: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9516: any XML catalogs installed by the package.</p></li>
1.23 wiz 9517: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9518: to be added to the SGML catalog. These come in groups of
9519: three strings; see xmlcatmgr(1) for more information
9520: (specifically, arguments recognized by the 'add' action).
9521: Note that you will normally not use this variable.</p></li>
1.23 wiz 9522: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9523: to be added to the XML catalog. These come in groups of three
9524: strings; see xmlcatmgr(1) for more information (specifically,
9525: arguments recognized by the 'add' action). Note that you will
9526: normally not use this variable.</p></li>
9527: </ol></div>
9528: </div>
1.41 asau 9529: <div class="sect2">
1.1 dsieger 9530: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9531: <a name="mime-database"></a>21.6.12. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9532: <p>If a package provides extensions to the MIME database by
9533: installing <code class="filename">.xml</code> files inside
9534: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9535: need to take some extra steps to ensure that the database is kept
9536: consistent with respect to these new files:</p>
1.23 wiz 9537: <div class="orderedlist"><ol class="orderedlist" type="1">
9538: <li class="listitem"><p>Include
1.1 dsieger 9539: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9540: (avoid using the <code class="filename">buildlink3.mk</code> file from
9541: this same directory, which is reserved for inclusion from
9542: other <code class="filename">buildlink3.mk</code> files). It takes
9543: care of rebuilding the MIME database at installation and
9544: deinstallation time, and disallows any access to it directly
9545: from the package.</p></li>
1.23 wiz 9546: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9547: <code class="filename">share/mime</code> directory,
9548: <span class="emphasis"><em>except</em></span> for files saved under
9549: <code class="filename">share/mime/packages</code>. The former are
9550: handled automatically by
9551: the update-mime-database program, but the latter are
9552: package-dependent and must be removed by the package that
9553: installed them in the first place.</p></li>
1.23 wiz 9554: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9555: from the PLIST. They will be handled by the shared-mime-info
9556: package.</p></li>
9557: </ol></div>
9558: </div>
1.41 asau 9559: <div class="sect2">
1.1 dsieger 9560: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9561: <a name="intltool"></a>21.6.13. Packages using intltool</h3></div></div></div>
1.1 dsieger 9562: <p>If a package uses intltool during its build, add
9563: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9564: which forces it to use the intltool package provided by pkgsrc,
9565: instead of the one bundled with the distribution file.</p>
9566: <p>This tracks intltool's build-time dependencies and uses the
9567: latest available version; this way, the package benefits of any
9568: bug fixes that may have appeared since it was released.</p>
9569: </div>
1.41 asau 9570: <div class="sect2">
1.1 dsieger 9571: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9572: <a name="startup-scripts"></a>21.6.14. Packages installing startup scripts</h3></div></div></div>
1.256 wiz 9573: <p>If a package contains an rc.d script, it won't be copied into
9574: the startup directory (<code class="filename">/etc/rc.d</code>) by default,
9575: but you can enable copying by setting the option
9576: <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
9577: <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
9578: will be copied into <code class="filename">/etc/rc.d</code> when a package
9579: is installed, but only if the target does not already exist.
9580: Copies in <code class="filename">/etc/rc.d</code> will be automatically removed
9581: only if they have not been modified.
9582: </p>
9583: <p>Note that this alone does not enable the service: It must still be
9584: added to <code class="filename">/etc/rc.conf</code>.</p>
1.1 dsieger 9585: </div>
1.41 asau 9586: <div class="sect2">
1.1 dsieger 9587: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9588: <a name="tex-packages"></a>21.6.15. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9589: <p>If a package installs TeX packages into the texmf tree,
9590: the <code class="filename">ls-R</code> database of the tree needs to be
9591: updated.</p>
1.41 asau 9592: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9593: <h3 class="title">Note</h3>
1.22 jakllsch 9594: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9595: packages should install files
1.22 jakllsch 9596: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9597: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9598: </div>
1.23 wiz 9599: <div class="orderedlist"><ol class="orderedlist" type="1">
9600: <li class="listitem"><p>Include
1.22 jakllsch 9601: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9602: takes care of rebuilding the <code class="filename">ls-R</code>
9603: database at installation and deinstallation time.</p></li>
1.23 wiz 9604: <li class="listitem">
1.1 dsieger 9605: <p>If your package installs files into a texmf
9606: tree other than the one
1.22 jakllsch 9607: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9608: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9609: trees that need database update.</p>
9610: <p>If your package also installs font map files that need
1.10 hubertf 9611: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9612: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9613: set <code class="varname">TEX_MAP_FILES</code> and/or
9614: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9615: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9616: be run automatically at installation/deinstallation to
9617: enable/disable font map files for TeX output
9618: drivers.</p>
9619: </li>
1.23 wiz 9620: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9621: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9622: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9623: </ol></div>
9624: </div>
1.41 asau 9625: <div class="sect2">
1.1 dsieger 9626: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9627: <a name="emulation-packages"></a>21.6.16. Packages supporting running binaries in
1.1 dsieger 9628: emulation</h3></div></div></div>
9629: <p>There are some packages that provide libraries and
9630: executables for running binaries from a one operating system
9631: on a different one (if the latter supports it). One example
9632: is running Linux binaries on NetBSD.</p>
1.207 leot 9633: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/index.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.1 dsieger 9634: helps in extracting and packaging Linux rpm packages.</p>
9635: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9636: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9637: if all libraries for each installed executable can be found by
9638: the dynamic linker. Since the standard dynamic linker is run,
9639: this fails for emulation packages, because the libraries used
9640: by the emulation are not in the standard directories.</p>
9641: </div>
1.184 rillig 9642: <div class="sect2">
9643: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9644: <a name="hicolor-theme"></a>21.6.17. Packages installing hicolor icons</h3></div></div></div>
1.184 rillig 9645: <p>If a package installs images under the
9646: <code class="filename">share/icons/hicolor</code> and/or updates the
9647: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9648: database, you need to take some extra steps to make sure that the
9649: shared theme directory is handled appropriately and that the cache
9650: database is rebuilt:</p>
9651: <div class="orderedlist"><ol class="orderedlist" type="1">
9652: <li class="listitem"><p>Include
9653: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9654: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9655: entry that refers to the theme cache.</p></li>
9656: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9657: directories from the <code class="filename">share/icons/hicolor</code>
9658: hierarchy because they will be handled automatically.</p></li>
9659: </ol></div>
9660: <p>The best way to verify that the PLIST is correct with
9661: respect to the last two points is to regenerate it using
9662: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9663: </div>
9664: <div class="sect2">
9665: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9666: <a name="desktop-files"></a>21.6.18. Packages installing desktop files</h3></div></div></div>
1.184 rillig 9667: <p>If a package installs <code class="filename">.desktop</code> files
9668: under <code class="filename">share/applications</code> and these include
9669: MIME information (MimeType key), you need to take extra steps to
9670: ensure that they are registered into the MIME database:</p>
9671: <div class="orderedlist"><ol class="orderedlist" type="1">
9672: <li class="listitem"><p>Include
9673: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9674: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9675: <code class="filename">share/applications/mimeinfo.cache</code> file.
9676: It will be handled automatically.</p></li>
9677: </ol></div>
9678: <p>The best way to verify that the PLIST is correct with
9679: respect to the last point is to regenerate it using <span class="command"><strong>make
9680: print-PLIST</strong></span>.</p>
9681: </div>
9682: </div>
9683: <div class="sect1">
9684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9685: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9686: <p>In some cases one does not have the time to solve a problem
9687: immediately. In this case, one can plainly mark a package as broken. For
9688: this, one just sets the variable <code class="varname">BROKEN</code> to the
9689: reason why the package is broken (similar to the
9690: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9691: the package will immediately be shown this message, and the build
9692: will not be even tried.</p>
9693: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9694: intervals.</p>
9695: </div>
9696: </div>
9697: <div class="chapter">
9698: <div class="titlepage"><div><div><h2 class="title">
9699: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9700: <div class="toc">
9701: <p><b>Table of Contents</b></p>
9702: <dl class="toc">
9703: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9704: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9705: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9706: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9707: </dl>
9708: </div>
9709: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9710: site</a>:</p>
9711: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9712: environment, an intuitive and attractive desktop for users, and the
9713: GNOME development platform, an extensive framework for building
9714: applications that integrate into the rest of the desktop.</p></blockquote></div>
9715: <p>pkgsrc provides a seamless way to automatically build and install
9716: a complete GNOME environment <span class="emphasis"><em>under many different
9717: platforms</em></span>. We can say with confidence that pkgsrc is one of
9718: the most advanced build and packaging systems for GNOME due to its
9719: included technologies buildlink3, the wrappers and tools framework and
9720: automatic configuration file management. Lots of efforts are put into
9721: achieving a completely clean deinstallation of installed software
9722: components.</p>
9723: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9724: the above also means that great efforts are put into making GNOME work
1.201 cirnatda 9725: under this operating system.</p>
1.184 rillig 9726: <p>This chapter is aimed at pkgsrc developers and other people
9727: interested in helping our GNOME porting and packaging efforts. It
9728: provides instructions on how to manage the existing packages and some
9729: important information regarding their internals.</p>
9730: <div class="sect1">
9731: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9732: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9733: <p>pkgsrc includes three GNOME-related meta packages:</p>
9734: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 9735: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/index.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.184 rillig 9736: the core GNOME desktop environment. It only includes the necessary
9737: bits to get it to boot correctly, although it may lack important
9738: functionality for daily operation. The idea behind this package is
9739: to let end users build their own configurations on top of this one,
9740: first installing this meta package to achieve a functional setup and
9741: then adding individual applications.</p></li>
1.207 leot 9742: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.184 rillig 9743: complete installation of the GNOME platform and desktop as defined
9744: by the GNOME project; this is based on the components distributed in
9745: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9746: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9747: official FTP server. Developer-only tools found in those
9748: directories are not installed unless required by some other
9749: component to work properly. Similarly, packages from the bindings
9750: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9751: in unless required as a dependency for an end-user component. This
1.207 leot 9752: 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>
9753: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.184 rillig 9754: Installs all the tools required to build a GNOME component when
9755: fetched from the CVS repository. These are required to let the
9756: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9757: </ul></div>
9758: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9759: sorted in a way that eases updates: a package may depend on other
9760: packages listed before it but not on any listed after it. It is very
9761: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9762: change it to alphabetical sorting!</em></span></p>
9763: </div>
9764: <div class="sect1">
9765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9766: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9767: <p>Almost all GNOME applications are written in C and use a common
9768: set of tools as their build system. Things get different with the new
9769: bindings to other languages (such as Python), but the following will
9770: give you a general idea on the minimum required tools:</p>
9771: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9772: <li class="listitem">
9773: <p>Almost all GNOME applications use the GNU Autotools as their
9774: build system. As a general rule you will need to tell this to your
9775: package:</p>
9776: <pre class="programlisting">
1.223 nia 9777: GNU_CONFIGURE= yes
9778: USE_LIBTOOL= yes
9779: USE_TOOLS+= gmake
1.184 rillig 9780: </pre>
9781: </li>
9782: <li class="listitem">
9783: <p>If the package uses pkg-config to detect dependencies, add this
9784: tool to the list of required utilities:</p>
9785: <pre class="programlisting">
1.223 nia 9786: USE_TOOLS+= pkg-config
1.184 rillig 9787: </pre>
1.207 leot 9788: <p>Also use <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/index.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.184 rillig 9789: the end of the build process to ensure that you did not miss to
9790: specify any dependency in your package and that the version
9791: requirements are all correct.</p>
9792: </li>
9793: <li class="listitem"><p>If the package uses intltool, be sure to add
9794: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9795: to handle dependencies and to force the package to use the latest
9796: available version.</p></li>
9797: <li class="listitem">
9798: <p>If the package uses gtk-doc (a documentation generation
9799: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9800: tool is rather big and the distfile should come with pregenerated
9801: documentation anyway; if it does not, it is a bug that you ought to
9802: report. For such packages you should disable gtk-doc (unless it is
9803: the default):</p>
9804: <pre class="programlisting">
1.223 nia 9805: CONFIGURE_ARGS+= --disable-gtk-doc
1.184 rillig 9806: </pre>
9807: <p>The default location of installed HTML files
9808: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9809: and should not be changed unless the package insists on installing
9810: them somewhere else. Otherwise programs as
9811: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9812: do that with an entry similar to:</p>
9813: <pre class="programlisting">
1.223 nia 9814: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.184 rillig 9815: </pre>
9816: </li>
9817: </ul></div>
9818: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9819: files under the installation prefix to maintain databases. In this
9820: context, shared means that those exact same directories and files are
9821: used among several different packages, leading to conflicts in the
9822: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9823: handle the most common cases, so you have to forget about using
9824: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9825: omitting shared files from them. If you find yourself doing those,
9826: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9827: <p>The following table lists the common situations that result in
9828: using shared directories or files. For each of them, the appropriate
9829: solution is given. After applying the solution be sure to
9830: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9831: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9832: <div class="table">
9833: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9834: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9835: <colgroup>
9836: <col>
9837: <col>
9838: </colgroup>
9839: <thead><tr>
9840: <th>If the package...</th>
9841: <th>Then...</th>
9842: </tr></thead>
9843: <tbody>
9844: <tr>
9845: <td>Installs icons under the
9846: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9847: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.254 wiz 9848: <td>See <a class="xref" href="#hicolor-theme" title="21.6.17. Packages installing hicolor icons">Section 21.6.17, “Packages installing hicolor icons”</a>.</td>
1.184 rillig 9849: </tr>
9850: <tr>
9851: <td>Installs files under
9852: <code class="filename">share/mime/packages</code>.</td>
1.254 wiz 9853: <td>See <a class="xref" href="#mime-database" title="21.6.12. Packages installing extensions to the MIME database">Section 21.6.12, “Packages installing extensions to the MIME database”</a>.</td>
1.184 rillig 9854: </tr>
9855: <tr>
9856: <td>Installs <code class="filename">.desktop</code> files under
9857: <code class="filename">share/applications</code> and these include MIME
9858: information.</td>
1.254 wiz 9859: <td>See <a class="xref" href="#desktop-files" title="21.6.18. Packages installing desktop files">Section 21.6.18, “Packages installing desktop files”</a>.</td>
1.184 rillig 9860: </tr>
9861: </tbody>
9862: </table></div>
1.1 dsieger 9863: </div>
1.184 rillig 9864: <br class="table-break">
1.1 dsieger 9865: </div>
1.41 asau 9866: <div class="sect1">
1.1 dsieger 9867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 9868: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9869: <p>When seeing GNOME as a whole, there are two kinds of
9870: updates:</p>
9871: <div class="variablelist"><dl class="variablelist">
9872: <dt><span class="term">Major update</span></dt>
9873: <dd>
9874: <p>Given that there is still a very long way for GNOME 3 (if it
9875: ever appears), we consider a major update one that goes from a
9876: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9877: where <code class="literal">Y</code> is even and greater than
9878: <code class="literal">X</code>. These are hard to achieve because they
9879: introduce lots of changes in the components' code and almost all
9880: GNOME distfiles are updated to newer versions. Some of them can
9881: even break API and ABI compatibility with the previous major
9882: version series. As a result, the update needs to be done all at
9883: once to minimize breakage.</p>
9884: <p>A major update typically consists of around 80 package
9885: updates and the addition of some new ones.</p>
9886: </dd>
9887: <dt><span class="term">Minor update</span></dt>
9888: <dd>
9889: <p>We consider a minor update one that goes from a
9890: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9891: one where <code class="literal">Y</code> is greater than
9892: <code class="literal">X</code>. These are easy to achieve because they do
9893: not update all GNOME components, can be done in an incremental way
9894: and do not break API nor ABI compatibility.</p>
9895: <p>A minor update typically consists of around 50 package
9896: updates, although the numbers here may vary a lot.</p>
9897: </dd>
9898: </dl></div>
9899: <p>In order to update the GNOME components in pkgsrc to a new stable
9900: release (either major or minor), the following steps should be
9901: followed:</p>
9902: <div class="orderedlist"><ol class="orderedlist" type="1">
1.23 wiz 9903: <li class="listitem">
1.184 rillig 9904: <p>Get a list of all the tarballs that form the new release by
9905: using the following commands. These will leave the full list of the
9906: components' distfiles into the <code class="filename">list.txt</code>
9907: file:</p>
9908: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9909: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9910: awk '{ print $9 }' >list.txt</code></strong>
9911: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9912: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9913: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.1 dsieger 9914: </li>
1.184 rillig 9915: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9916: bump their version to the release you are updating them to. The
9917: three meta packages should be always consistent with versioning.
9918: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9919: in them.</p></li>
1.23 wiz 9920: <li class="listitem">
1.184 rillig 9921: <p>For each meta package, update all its
9922: <code class="varname">DEPENDS</code> lines to match the latest versions as
9923: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9924: newer version (even if found in the FTP) because the meta packages
9925: are supposed to list the exact versions that form a specific GNOME
9926: release. Exceptions are permitted here if a newer version solves a
9927: serious issue in the overall desktop experience; these typically
9928: come in the form of a revision bump in pkgsrc, not in newer versions
9929: from the developers.</p>
9930: <p>Packages not listed in the <code class="filename">list.txt</code> file
9931: should be updated to the latest version available (if found in
9932: pkgsrc). This is the case, for example, of the dependencies on the
1.207 leot 9933: GNU Autotools in the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.1 dsieger 9934: </li>
1.23 wiz 9935: <li class="listitem">
1.184 rillig 9936: <p>Generate a patch from the modified meta packages and extract the
9937: list of "new" lines. This will provide you an outline on what
9938: packages need to be updated in pkgsrc and in what order:</p>
9939: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
1.1 dsieger 9940: </li>
1.184 rillig 9941: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9942: installed packages and start over from scratch at this point.</p></li>
9943: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9944: of <code class="filename">todo.txt</code> and update the packages listed in
9945: it in order. For major desktop updates none of these should be
9946: committed until the entire set is completed because there are chances
9947: of breaking not-yet-updated packages.</p></li>
9948: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9949: the tree one by one with appropriate log messages. At the end,
9950: commit the three meta package updates and all the corresponding
9951: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9952: <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>
9953: </ol></div>
9954: </div>
9955: <div class="sect1">
9956: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9957: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9958: <p>GNOME is a very big component in pkgsrc which approaches 100
9959: packages. Please, it is very important that you always, always,
9960: <span class="strong"><strong>always</strong></span> feed back any portability
9961: 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
9962: their attention on portability issues and to ensure that future versions
9963: can be built out-of-the box on NetBSD. The less custom patches in
9964: pkgsrc, the easier further updates are. Those developers in charge of
9965: issuing major GNOME updates will be grateful if you do that.</p>
1.200 cirnatda 9966: <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
9967: GitLab</a>. Not all components use these to track bugs, but most
1.184 rillig 9968: of them do. Do not be short on your reports: always provide detailed
9969: explanations of the current failure, how it can be improved to achieve
1.200 cirnatda 9970: maximum portability and, if at all possible, provide a patch against the
9971: main Git branch. The more verbose you are, the higher chances of your
9972: patch being accepted.</p>
1.184 rillig 9973: <p>Also, please avoid using preprocessor magic to fix portability
9974: issues. While the FreeBSD GNOME people are doing a great job in porting
9975: GNOME to their operating system, the official GNOME sources are now
9976: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9977: and similar macros. This hurts portability. Please see our patching
9978: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9979: details.</p>
9980: </div>
1.1 dsieger 9981: </div>
1.41 asau 9982: <div class="chapter">
1.1 dsieger 9983: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9984: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9985: <div class="toc">
9986: <p><b>Table of Contents</b></p>
1.100 leot 9987: <dl class="toc">
1.154 rillig 9988: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9989: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9990: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9991: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9992: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9993: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9994: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9995: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9996: </dl>
9997: </div>
1.41 asau 9998: <div class="sect1">
1.1 dsieger 9999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10000: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 10001: <p>Our policy is that we accept binaries only from pkgsrc
10002: developers to guarantee that the packages don't contain any
10003: trojan horses etc. This is not to annoy anyone but rather to
10004: protect our users! You're still free to put up your home-made
10005: binary packages and tell the world where to get them. NetBSD
10006: developers doing bulk builds and wanting to upload them please
1.154 rillig 10007: see <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.66 asau 10008: builds)</i></a>.</p>
1.1 dsieger 10009: </div>
1.41 asau 10010: <div class="sect1">
1.1 dsieger 10011: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10012: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.218 nia 10013: <p>Firstly, you can import new packages into
10014: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
10015: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
10016: for details.</p>
10017: <p>Next, check that your package is complete, compiles and
1.184 rillig 10018: runs well; see <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> and the rest of this
1.218 nia 10019: 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>
10020: tool and fix any errors that appear.</p>
10021: <p>Finally, send a report to the pkgsrc bug tracking system,
1.259 leot 10022: 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.1 dsieger 10023: that, go to the web page
1.174 leot 10024: <a class="ulink" href="https://www.NetBSD.org/support/send-pr.html" target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
1.21 snj 10025: which contains some instructions and a link to a form where you
10026: can submit packages. The
1.207 leot 10027: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/index.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.21 snj 10028: also available as a substitute for either of the above two tools.
10029: </p>
1.1 dsieger 10030: <p>In the form of the problem report, the category should be
1.23 wiz 10031: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 10032: and version number, and the description field should contain a
10033: short description of your package (contents of the COMMENT
1.218 nia 10034: variable or DESCR file are OK).</p>
1.1 dsieger 10035: </div>
1.41 asau 10036: <div class="sect1">
1.1 dsieger 10037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10038: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 10039: <p>Please note all package additions, updates, moves, and
10040: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
10041: important to keep this file up to date and conforming to the
10042: existing format, because it will be used by scripts to
1.174 leot 10043: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 10044: sites. Additionally, check the
10045: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
10046: for the package you updated or removed, in case it was mentioned
10047: there.</p>
10048: <p>When the <code class="varname">PKGREVISION</code> of a package is
10049: bumped, the change should appear in
10050: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
10051: related or otherwise relevant. Mass bumps that result from a
10052: dependency being updated should not be mentioned. In all other
10053: cases it's the developer's decision.</p>
10054: <p>There is a make target that helps in creating proper
1.10 hubertf 10055: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 10056: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
10057: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
10058: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
10059: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 10060: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
10061: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 10062: For new packages, or package moves or removals, set the
10063: <code class="varname">CTYPE</code> variable on the command line to "Added",
10064: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 10065: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 10066: not the same as your NetBSD login name. The target also automatically
10067: removes possibly existing entries for the package in the
10068: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 10069: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 10070: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
10071: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
10072: makes the cvs commands use the main repository.
10073: </p>
1.1 dsieger 10074: </div>
1.41 asau 10075: <div class="sect1">
1.1 dsieger 10076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10077: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 10078: <p>For several years, there have been mirrors of pkgsrc in
1.257 jkoshy 10079: fossil, git, and hg. Standard practice when using these tools is to
1.130 wiz 10080: make the first line of a commit message function as a summary that
10081: can be read without the rest, such as is commonly done with "git log
10082: --oneline". For this reason, we have the following guidelines for
10083: pkgsrc commit messages:</p>
10084: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10085: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 10086: big picture in 65 characters or less. When a commit is for one
1.130 wiz 10087: package, include the name of the package. For updates, include the
10088: version to which it is updated.</p></li>
10089: <li class="listitem"><p>Leave the next line empty.</p></li>
10090: <li class="listitem"><p>Then come the details for the commit (changes in that
10091: package, reason for a change) and any relevant PRs. Wrap this
10092: section.</p></li>
10093: </ul></div>
10094: <p>Here is an example:
1.238 wiz 10095: </p>
1.130 wiz 10096: <pre class="programlisting">
1.238 wiz 10097: libxslt: update to 1.0.30
1.130 wiz 10098:
1.238 wiz 10099: Changes since 1.0.29:
10100: ...
10101: </pre>
1.130 wiz 10102: <p>
10103: </p>
10104: <p>Here is another example:
1.238 wiz 10105: </p>
1.130 wiz 10106: <pre class="programlisting">
1.238 wiz 10107: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.130 wiz 10108:
1.238 wiz 10109: (rationale)
10110: </pre>
1.130 wiz 10111: <p>
10112: </p>
10113: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
10114: allowed on the pkgsrc repository to change commit messages.</p>
10115: </div>
10116: <div class="sect1">
10117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10118: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 10119: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 10120: access to the pkgsrc repository.</p>
10121: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
10122: Start by adding the directory and then files in the directory. Don't
10123: forget to add the new package to the category's
10124: <code class="filename">Makefile</code>. Make sure you don't forget any files;
10125: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
10126: <pre class="programlisting">
10127: <code class="prompt">$</code> cd .../pkgsrc/category
10128: <code class="prompt">$</code> cvs add pkgname
10129: <code class="prompt">$</code> cd pkgname
10130: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
10131: <code class="prompt">$</code> cvs add patches/p*
10132: <code class="prompt">$</code> cvs status | less
1.34 wiz 10133: <code class="prompt">$</code> cvs commit
1.33 wiz 10134: <code class="prompt">$</code> cd ..
1.236 gutterid 10135: <code class="prompt">$</code> vi Makefile # add SUBDIR+=pkgname line
1.34 wiz 10136: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 10137: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 10138: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 10139: </pre>
1.1 dsieger 10140: <p>The commit message of the initial import should include part of the
10141: <code class="filename">DESCR</code> file, so people reading the mailing lists know
10142: what the package is/does.</p>
1.33 wiz 10143: <p>Also mention the new package in
10144: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
10145: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
10146: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 10147: </div>
1.41 asau 10148: <div class="sect1">
1.1 dsieger 10149: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10150: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 10151: <p>Please always put a concise, appropriate and relevant summary of the
10152: changes between old and new versions into the commit log when updating
10153: a package. There are various reasons for this:</p>
1.41 asau 10154: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10155: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 10156: or its information may be overwritten by newer information.</p></li>
1.23 wiz 10157: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 10158: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 10159: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 10160: repository is very useful for people who read the pkgsrc-changes mailing
10161: list, so that they can make tactical decisions about when to upgrade
10162: the package.</p></li>
10163: </ul></div>
10164: <p>Please also recognize that, just because a new version of a package
10165: has been released, it should not automatically be upgraded in the CVS
10166: repository. We prefer to be conservative in the packages that are
10167: included in pkgsrc - development or beta packages are not really the
10168: best thing for most places in which pkgsrc is used. Please use your
10169: judgement about what should go into pkgsrc, and bear in mind that
10170: stability is to be preferred above new and possibly untested features.</p>
10171: </div>
1.41 asau 10172: <div class="sect1">
1.1 dsieger 10173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10174: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 10175: <p>Renaming packages is not recommended.</p>
1.175 gutterid 10176: <p>When renaming packages, be sure to fix any references to the old name
1.20 snj 10177: in other Makefiles, options, buildlink files, etc.</p>
1.167 leot 10178: <p>
1.175 gutterid 10179: Also, when renaming a package, please add
1.167 leot 10180: the package name and version pattern(s) of the previous package
10181: to <code class="varname">SUPERSEDES</code>.
1.20 snj 10182: This may be repeated for multiple renames.
10183: The new package would be an exact replacement.
1.167 leot 10184: Example:
1.20 snj 10185: </p>
1.167 leot 10186: <pre class="programlisting">
10187: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
10188: SUPERSEDES+= optcomp-[0-9]*
10189: </pre>
1.23 wiz 10190: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 10191: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
10192: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
10193: not be an exact replacement but is a suggestion for the replaced
10194: functionality.</p>
10195: </div>
1.41 asau 10196: <div class="sect1">
1.20 snj 10197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10198: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 10199: <p>It is preferred that packages are not renamed or moved, but if needed
10200: please follow these steps.
10201: </p>
1.23 wiz 10202: <div class="orderedlist"><ol class="orderedlist" type="1">
10203: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
10204: <li class="listitem">
1.1 dsieger 10205: <p>Remove all CVS dirs.</p>
10206: <p>Alternatively to the first two steps you can also do:</p>
10207: <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>
10208: <p>and use that for further work.</p>
10209: </li>
1.23 wiz 10210: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
10211: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
10212: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
10213: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 10214: <code class="varname">PREV_PKGPATH</code> to the previous category/package
10215: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
10216: for doing an update using pkgsrc building; for example, it can
1.259 leot 10217: 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.20 snj 10218: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
10219: new <code class="varname">PKGPATH</code> for that moved package. Note that
10220: it may have multiple matches, so the tool should also check on the
10221: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
10222: probably has no value unless <code class="varname">SUPERSEDES</code> is not
10223: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.237 gutterid 10224: <li class="listitem"><p><span class="command"><strong>cvs add</strong></span> the modified package in the new
1.1 dsieger 10225: place.</p></li>
1.23 wiz 10226: <li class="listitem">
1.1 dsieger 10227: <p>Check if any package depends on it:
10228: </p>
10229: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
10230: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
10231: </li>
1.23 wiz 10232: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
10233: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
10234: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
10235: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
10236: <li class="listitem">
1.1 dsieger 10237: <p>Commit the changed and removed files:</p>
10238: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
10239: <p>(and any packages from step 5, of course).</p>
10240: </li>
10241: </ol></div>
10242: </div>
10243: </div>
1.41 asau 10244: <div class="chapter">
1.1 dsieger 10245: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 10246: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 10247: <p>This section contains the answers to questions that may
10248: arise when you are writing a package. If you don't find your
10249: question answered here, first have a look in the other chapters,
10250: and if you still don't have the answer, ask on the
10251: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 10252: <div class="qandaset">
1.174 leot 10253: <a name="devfaq.qandaset"></a><dl>
1.154 rillig 10254: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 10255: MAKEFLAGS, .MAKEFLAGS and
10256: MAKE_FLAGS?</a>
10257: </dt>
1.154 rillig 10258: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 10259: MAKE, GMAKE and
10260: MAKE_PROGRAM?</a>
10261: </dt>
1.154 rillig 10262: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 10263: CC, PKG_CC and
10264: PKGSRC_COMPILER?</a>
10265: </dt>
1.223 nia 10266: <dt>24.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 10267: VARNAME=BUILDLINK_PREFIX.foo
10268: say it's empty?</a>
10269: </dt>
1.223 nia 10270: <dt>24.5. <a href="#devfaq.master_sites">What does
1.1 dsieger 10271: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
10272: don't understand the := inside
10273: it.</a>
10274: </dt>
1.223 nia 10275: <dt>24.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 10276: developers?</a>
10277: </dt>
1.223 nia 10278: <dt>24.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 10279: documentation?</a>
10280: </dt>
1.223 nia 10281: <dt>24.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.174 leot 10282: What shall I do?</a>
1.1 dsieger 10283: </dt>
10284: </dl>
1.41 asau 10285: <table border="0" style="width: 100%;">
10286: <colgroup>
1.1 dsieger 10287: <col align="left" width="1%">
1.23 wiz 10288: <col>
1.41 asau 10289: </colgroup>
1.1 dsieger 10290: <tbody>
1.41 asau 10291: <tr class="question">
1.1 dsieger 10292: <td align="left" valign="top">
1.174 leot 10293: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.1 dsieger 10294: </td>
10295: <td align="left" valign="top"><p>What is the difference between
10296: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10297: <code class="varname">MAKE_FLAGS</code>?</p></td>
10298: </tr>
10299: <tr class="answer">
10300: <td align="left" valign="top"></td>
1.223 nia 10301: <td align="left" valign="top">
10302: <p><code class="varname">MAKEFLAGS</code> are the flags passed
1.259 leot 10303: 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.223 nia 10304: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
10305: passed to the <code class="varname">MAKE_PROGRAM</code> when building the
10306: package.</p>
10307: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
10308: <span class="command"><strong>bmake</strong></span> and should not be used by
10309: packages.</p>
10310: </td>
1.1 dsieger 10311: </tr>
1.41 asau 10312: <tr class="question">
1.1 dsieger 10313: <td align="left" valign="top">
1.174 leot 10314: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.1 dsieger 10315: </td>
10316: <td align="left" valign="top"><p>What is the difference between
10317: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10318: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10319: </tr>
10320: <tr class="answer">
10321: <td align="left" valign="top"></td>
1.223 nia 10322: <td align="left" valign="top">
10323: <p><code class="varname">MAKE</code> is the path to the
1.259 leot 10324: <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.223 nia 10325: infrastructure.</p>
10326: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
10327: need to say <code class="varname">USE_TOOLS+=gmake</code> to use
10328: that.</p>
10329: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
10330: program that is used for building the package.</p>
10331: </td>
1.1 dsieger 10332: </tr>
1.41 asau 10333: <tr class="question">
1.1 dsieger 10334: <td align="left" valign="top">
1.174 leot 10335: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.1 dsieger 10336: </td>
10337: <td align="left" valign="top"><p>What is the difference between
10338: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10339: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10340: </tr>
10341: <tr class="answer">
10342: <td align="left" valign="top"></td>
10343: <td align="left" valign="top">
1.223 nia 10344: <p><code class="varname">CC</code> is the path to the real C
10345: compiler, which can be configured by the pkgsrc user.</p>
10346: <p><code class="varname">PKG_CC</code> is the path to the compiler
10347: wrapper.</p>
10348: <p><code class="varname">PKGSRC_COMPILER</code> is
10349: <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
10350: compiler that should be used. See
10351: <code class="filename">mk/compiler.mk</code> for more information about
10352: the latter variable.</p>
1.1 dsieger 10353: </td>
10354: </tr>
1.41 asau 10355: <tr class="question">
1.1 dsieger 10356: <td align="left" valign="top">
1.223 nia 10357: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.4.</b></p>
1.1 dsieger 10358: </td>
1.10 hubertf 10359: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 10360: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10361: say it's empty?</p></td>
10362: </tr>
10363: <tr class="answer">
10364: <td align="left" valign="top"></td>
10365: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 10366: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10367: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 10368: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 10369: command.</p></td>
10370: </tr>
1.41 asau 10371: <tr class="question">
1.1 dsieger 10372: <td align="left" valign="top">
1.223 nia 10373: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.5.</b></p>
1.1 dsieger 10374: </td>
10375: <td align="left" valign="top"><p>What does
1.108 rillig 10376: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10377: don't understand the <code class="code">:=</code> inside
1.1 dsieger 10378: it.</p></td>
10379: </tr>
10380: <tr class="answer">
10381: <td align="left" valign="top"></td>
1.223 nia 10382: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
10383: assignment operator, even though it may look like one.
1.1 dsieger 10384: Instead, it is a degenerate form of
1.108 rillig 10385: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.259 leot 10386: 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.108 rillig 10387: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 10388: case of <code class="varname">MASTER_SITE_*</code>,
10389: <em class="replaceable"><code>old_string</code></em> is the empty string and
10390: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 10391: <code class="code">package/</code>. That's where the
10392: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 10393: together.</p></td>
10394: </tr>
1.41 asau 10395: <tr class="question">
1.1 dsieger 10396: <td align="left" valign="top">
1.223 nia 10397: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.6.</b></p>
1.1 dsieger 10398: </td>
10399: <td align="left" valign="top"><p>Which mailing lists are there for package
10400: developers?</p></td>
10401: </tr>
10402: <tr class="answer">
10403: <td align="left" valign="top"></td>
1.41 asau 10404: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.174 leot 10405: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1 dsieger 10406: <dd><p>This is a list for technical discussions related
10407: to pkgsrc development, e.g. soliciting feedback for changes to
10408: pkgsrc infrastructure, proposed new features, questions related
10409: to porting pkgsrc to a new platform, advice for maintaining a
10410: package, patches that affect many packages, help requests moved
10411: from pkgsrc-users when an infrastructure bug is found,
10412: etc.</p></dd>
1.174 leot 10413: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1 dsieger 10414: <dd><p>All bug reports in category "pkg" sent with
1.259 leot 10415: <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.1 dsieger 10416: directly; use one of the other mailing
10417: lists.</p></dd>
10418: </dl></div></td>
10419: </tr>
1.41 asau 10420: <tr class="question">
1.1 dsieger 10421: <td align="left" valign="top">
1.223 nia 10422: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.7.</b></p>
1.1 dsieger 10423: </td>
10424: <td align="left" valign="top"><p>Where is the pkgsrc
10425: documentation?</p></td>
10426: </tr>
10427: <tr class="answer">
10428: <td align="left" valign="top"></td>
10429: <td align="left" valign="top">
10430: <p>There are many places where you can find
10431: documentation about pkgsrc:</p>
1.41 asau 10432: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10433: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 10434: of chapters that explain large parts of pkgsrc, but some
10435: chapters tend to be outdated. Which ones they are is hard to
10436: say.</p></li>
1.174 leot 10437: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>), you can find discussions
1.1 dsieger 10438: about certain features, announcements of new parts of the pkgsrc
10439: infrastructure and sometimes even announcements that a certain
10440: feature has been marked as obsolete. The benefit here is that
10441: each message has a date appended to it.</p></li>
1.23 wiz 10442: <li class="listitem"><p>Many of the files in the
1.1 dsieger 10443: <code class="filename">mk/</code> directory start with a comment that
10444: describes the purpose of the file and how it can be used by the
10445: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 10446: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 10447: help</strong></span>.</p></li>
1.23 wiz 10448: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 10449: information, but they tend to be highly abbreviated, especially
10450: for actions that occur often. Some contain a detailed
10451: description of what has changed, but they are geared towards the
10452: other pkgsrc developers, not towards an average pkgsrc user.
10453: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10454: don't know what has been before, these messages may not be worth
10455: too much to you.</p></li>
1.23 wiz 10456: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10457: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 10458: mind of the developer who wrote the code. To get this
1.10 hubertf 10459: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 10460: to see who has written it and ask on the
10461: <code class="literal">tech-pkg</code> mailing list, so that others can
10462: find your questions later (see above). To be sure that the
10463: developer in charge reads the mail, you may CC him or
10464: her.</p></li>
10465: </ul></div>
1.184 rillig 10466: </td>
10467: </tr>
10468: <tr class="question">
10469: <td align="left" valign="top">
1.223 nia 10470: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.8.</b></p>
1.184 rillig 10471: </td>
1.223 nia 10472: <td align="left" valign="top"><p>I have a little time to kill.
1.184 rillig 10473: What shall I do?</p></td>
10474: </tr>
10475: <tr class="answer">
10476: <td align="left" valign="top"></td>
10477: <td align="left" valign="top">
10478: <p>This is not really an FAQ yet, but here's the answer
10479: anyway.</p>
1.41 asau 10480: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 10481: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.207 leot 10482: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.184 rillig 10483: will tell you about newer versions of installed packages that are
10484: available, but not yet updated in pkgsrc.</p></li>
10485: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10486: — it contains a list of suggested new packages and a list of
10487: cleanups and enhancements for pkgsrc that would be nice to
10488: have.</p></li>
10489: <li class="listitem"><p>Review packages for which review was requested on
10490: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10491: mailing list.</p></li>
1.1 dsieger 10492: </ul></div>
1.184 rillig 10493: </td>
1.1 dsieger 10494: </tr>
10495: </tbody>
1.184 rillig 10496: </table>
1.1 dsieger 10497: </div>
10498: </div>
10499: </div>
1.41 asau 10500: <div class="part">
1.1 dsieger 10501: <div class="titlepage"><div><div><h1 class="title">
10502: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10503: <div class="partintro">
1.1 dsieger 10504: <div></div>
10505: <p>This part of the guide deals with everything
10506: from the infrastructure that is behind the interfaces described
10507: in the developer's guide. A casual package maintainer should not
10508: need anything from this part.</p>
10509: <div class="toc">
10510: <p><b>Table of Contents</b></p>
1.100 leot 10511: <dl class="toc">
1.184 rillig 10512: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10513: <dd><dl>
1.184 rillig 10514: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10515: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10516: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10517: <dd><dl>
1.184 rillig 10518: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10519: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10520: </dl></dd>
1.184 rillig 10521: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10522: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10523: <dd><dl>
1.184 rillig 10524: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10525: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10526: </dl></dd>
1.184 rillig 10527: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10528: <dd><dl>
1.184 rillig 10529: <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>
10530: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10531: </dl></dd>
10532: </dl></dd>
1.184 rillig 10533: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 10534: <dd><dl>
1.184 rillig 10535: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10536: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10537: <dd><dl>
1.184 rillig 10538: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10539: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10540: </dl></dd>
10541: </dl></dd>
1.184 rillig 10542: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10543: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 10544: </dl>
10545: </div>
10546: </div>
1.41 asau 10547: <div class="chapter">
1.1 dsieger 10548: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10549: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10550: <div class="toc">
10551: <p><b>Table of Contents</b></p>
1.100 leot 10552: <dl class="toc">
1.184 rillig 10553: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10554: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10555: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10556: <dd><dl>
1.184 rillig 10557: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10558: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10559: </dl></dd>
1.184 rillig 10560: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10561: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10562: <dd><dl>
1.184 rillig 10563: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10564: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10565: </dl></dd>
1.184 rillig 10566: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10567: <dd><dl>
1.184 rillig 10568: <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>
10569: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10570: </dl></dd>
10571: </dl>
10572: </div>
10573: <p>The pkgsrc infrastructure consists of many small Makefile
10574: fragments. Each such fragment needs a properly specified
10575: interface. This chapter explains how such an interface looks
10576: like.</p>
1.41 asau 10577: <div class="sect1">
1.1 dsieger 10578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10579: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10580: <p>Whenever a variable is defined in the pkgsrc
10581: infrastructure, the location and the way of definition provide
10582: much information about the intended use of that variable.
10583: Additionally, more documentation may be found in a header
10584: comment or in this pkgsrc guide.</p>
10585: <p>A special file is
10586: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10587: variables that are intended to be user-defined. They are either
10588: defined using the <code class="literal">?=</code> operator or they are
10589: left undefined because defining them to anything would
1.23 wiz 10590: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10591: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10592: file.</p>
10593: <p>Outside this file, the following conventions apply:
10594: Variables that are defined using the <code class="literal">?=</code>
10595: operator may be overridden by a package.</p>
10596: <p>Variables that are defined using the <code class="literal">=</code>
10597: operator may be used read-only at run-time.</p>
10598: <p>Variables whose name starts with an underscore must not be
10599: accessed outside the pkgsrc infrastructure at all. They may
10600: change without further notice.</p>
1.41 asau 10601: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10602: <h3 class="title">Note</h3>
10603: <p>These conventions are currently not applied
10604: consistently to the complete pkgsrc
10605: infrastructure.</p>
10606: </div>
10607: </div>
1.41 asau 10608: <div class="sect1">
1.1 dsieger 10609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10610: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10611: <p>All variables that contain lists of things should default
10612: to being empty. Two examples that do not follow this rule are
10613: <code class="varname">USE_LANGUAGES</code> and
10614: <code class="varname">DISTFILES</code>. These variables cannot simply be
10615: modified using the <code class="literal">+=</code> operator in package
10616: <code class="filename">Makefile</code>s (or other files included by
10617: them), since there is no guarantee whether the variable is
10618: already set or not, and what its value is. In the case of
1.23 wiz 10619: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10620: the default value and just define it as in the following
10621: example.</p>
10622: <pre class="programlisting">
10623: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10624: </pre>
10625: <p>Because of the selection of this default value, the same
10626: value appears in many package Makefiles. Similarly for
10627: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10628: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10629: doesn't stand out. Nevertheless it is mentioned in many
10630: files.</p>
10631: </div>
1.41 asau 10632: <div class="sect1">
1.1 dsieger 10633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10634: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.41 asau 10635: <div class="sect2">
1.1 dsieger 10636: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10637: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.1 dsieger 10638: <p>Variable evaluation takes place either at load time or at
10639: runtime, depending on the context in which they occur. The
10640: contexts where variables are evaluated at load time are:</p>
1.41 asau 10641: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10642: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10643: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10644: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10645: <code class="literal">.for</code>,</p></li>
1.23 wiz 10646: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10647: </ul></div>
10648: <p>A special exception are references to the iteration
10649: variables of <code class="literal">.for</code> loops, which are expanded
10650: inline, no matter in which context they appear.</p>
10651: <p>As the values of variables may change during load time,
10652: care must be taken not to evaluate them by accident. Typical
10653: examples for variables that should not be evaluated at load time
10654: are <code class="varname">DEPENDS</code> and
10655: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10656: clear, here is an example:</p>
10657: <pre class="programlisting">
10658: CONFIGURE_ARGS= # none
10659: CFLAGS= -O
10660: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10661:
10662: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10663:
10664: CFLAGS+= -Wall
1.111 sevan 10665: </pre>
1.1 dsieger 10666: <p>This code shows how the use of the <code class="literal">:=</code>
10667: operator can quickly lead to unexpected results. The first
10668: paragraph is fairly common code. The second paragraph evaluates
10669: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10670: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10671: <code class="literal">-Wall</code> is appended to the
10672: <code class="varname">CFLAGS</code>, but this addition will not appear in
10673: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10674: paragraphs from above typically occur in completely unrelated
10675: files.</p>
10676: </div>
1.41 asau 10677: <div class="sect2">
1.1 dsieger 10678: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10679: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10680: <p>After all the files have been loaded, the values of the
10681: variables cannot be changed anymore. Variables that are used in
10682: the shell commands are expanded at this point.</p>
10683: </div>
10684: </div>
1.41 asau 10685: <div class="sect1">
1.1 dsieger 10686: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10687: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10688: <p>There are many ways in which the definition and use of a
1.108 rillig 10689: variable can be restricted in order to detect bugs and violations
10690: of the (mostly unwritten) policies. A package can be checked with
10691: <code class="literal">pkglint -Wall</code> to see whether it meets these
10692: rules.</p>
1.1 dsieger 10693: </div>
1.41 asau 10694: <div class="sect1">
1.1 dsieger 10695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10696: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10697: <p>Most of the <code class="filename">.mk</code> files fall into one
10698: of the following classes. Cases where a file falls into more
10699: than one class should be avoided as it often leads to subtle
10700: bugs.</p>
1.41 asau 10701: <div class="sect2">
1.1 dsieger 10702: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10703: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10704: <p>In a traditional imperative programming language some of
10705: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10706: procedures. They take some input parameters and—after
10707: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10708: variables in <code class="filename">Makefile</code>s have global scope
10709: care must be taken not to use parameter names that have already
10710: another meaning. For example, <code class="varname">PKGNAME</code> is a
10711: bad choice for a parameter name.</p>
10712: <p>Procedures are completely evaluated at preprocessing time.
10713: That is, when calling a procedure all input parameters must be
10714: completely resolvable. For example,
10715: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10716: parameter since it is very likely that further text will be
10717: added after calling the procedure, which would effectively apply
10718: the procedure to only a part of the variable. Also, references
1.108 rillig 10719: to other variables will be modified after calling the
1.1 dsieger 10720: procedure.</p>
10721: <p>A procedure can declare its output parameters either as
10722: suitable for use in preprocessing directives or as only
10723: available at runtime. The latter alternative is for variables
10724: that contain references to other runtime variables.</p>
10725: <p>Procedures shall be written such that it is possible to
10726: call the procedure more than once. That is, the file must not
10727: contain multiple-inclusion guards.</p>
10728: <p>Examples for procedures are
10729: <code class="filename">mk/bsd.options.mk</code> and
10730: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10731: that the parameters are evaluated at load time, they should be
10732: assigned using the <code class="literal">:=</code> operator, which should
10733: be used only for this purpose.</p>
10734: </div>
1.41 asau 10735: <div class="sect2">
1.1 dsieger 10736: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10737: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10738: <p>Action files take some input parameters and may define
10739: runtime variables. They shall not define loadtime variables.
10740: There are action files that are included implicitly by the
10741: pkgsrc infrastructure, while other must be included
10742: explicitly.</p>
10743: <p>An example for action files is
10744: <code class="filename">mk/subst.mk</code>.</p>
10745: </div>
10746: </div>
1.41 asau 10747: <div class="sect1">
1.1 dsieger 10748: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10749: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10750: <p>Package <code class="filename">Makefile</code>s usually consist of
10751: a set of variable definitions, and include the file
10752: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10753: Before that, they may also include various other
10754: <code class="filename">*.mk</code> files if they need to query the
10755: availability of certain features like the type of compiler or
10756: the X11 implementation. Due to the heavy use of preprocessor
10757: directives like <code class="literal">.if</code> and
10758: <code class="literal">.for</code>, the order in which the files are loaded
10759: matters.</p>
10760: <p>This section describes at which point the various files
10761: are loaded and gives reasons for that order.</p>
1.41 asau 10762: <div class="sect2">
1.1 dsieger 10763: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10764: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10765: </h3></div></div></div>
10766: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10767: is to define some essential variables like
10768: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10769: <code class="varname">MACHINE_ARCH</code>.</p>
10770: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10771: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4 rillig 10772: After that, those variables
1.1 dsieger 10773: that have not been overridden by the user are loaded from
10774: <code class="filename">mk/defaults/mk.conf</code>.</p>
10775: <p>After the user settings, the system settings and platform
10776: settings are loaded, which may override the user
10777: settings.</p>
10778: <p>Then, the tool definitions are loaded. The tool wrappers
10779: are not yet in effect. This only happens when building a
10780: package, so the proper variables must be used instead of the
10781: direct tool names.</p>
10782: <p>As the last steps, some essential variables from the
10783: wrapper and the package system flavor are loaded, as well as the
10784: variables that have been cached in earlier phases of a package
10785: build.</p>
10786: </div>
1.41 asau 10787: <div class="sect2">
1.1 dsieger 10788: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10789: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10790: </h3></div></div></div>
10791: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10792: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10793: loaded, which fill default values for those variables that have
10794: not been defined by the package. These variables may later
10795: be used even in unrelated files.</p>
10796: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10797: provides the target <code class="literal">error-check</code> that is added
10798: as a special dependency to all other targets that use
10799: <code class="varname">DELAYED_ERROR_MSG</code> or
10800: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10801: <p>Then, the package-specific hacks from
10802: <code class="filename">hacks.mk</code> are included.</p>
10803: <p>Then, various other files follow. Most of them don't have
10804: any dependencies on what they need to have included before or
10805: after them, though some do.</p>
10806: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10807: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10808: restricts the use of these variables to all the files that have
10809: been included before. Appearances in later files will be
10810: silently ignored.</p>
10811: <p>Then, the files for the main targets are included, in the
10812: order of later execution, though the actual order should not
10813: matter.</p>
10814: <p>At last, some more files are included that don't set any
10815: interesting variables but rather just define make targets to be
10816: executed.</p>
10817: </div>
10818: </div>
10819: </div>
1.41 asau 10820: <div class="chapter">
1.1 dsieger 10821: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10822: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.1 dsieger 10823: <div class="toc">
10824: <p><b>Table of Contents</b></p>
1.100 leot 10825: <dl class="toc">
1.184 rillig 10826: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10827: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10828: <dd><dl>
1.184 rillig 10829: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10830: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10831: </dl></dd>
10832: </dl>
10833: </div>
10834: <p>The pkgsrc infrastructure consists of a large codebase,
10835: and there are many corners where every little bit of a file is
10836: well thought out, making pkgsrc likely to fail as soon as
10837: anything is changed near those parts. To prevent most changes
10838: from breaking anything, a suite of regression tests should go
10839: along with every important part of the pkgsrc infrastructure.
10840: This chapter describes how regression tests work in pkgsrc and
10841: how you can add new tests.</p>
1.41 asau 10842: <div class="sect1">
1.1 dsieger 10843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10844: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.207 leot 10845: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/index.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.10 hubertf 10846: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10847: can simply run that command, which will run all tests in the
1.168 rillig 10848: <code class="filename">regress/</code> directory.</p>
1.1 dsieger 10849: </div>
1.41 asau 10850: <div class="sect1">
1.1 dsieger 10851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10852: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.168 rillig 10853: <p>Every directory in the <code class="filename">regress/</code>
10854: directory that contains a file called <code class="filename">spec</code>
1.1 dsieger 10855: is considered a regression test. This file is a shell program
1.10 hubertf 10856: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10857: The following functions can be overridden to suit your
10858: needs.</p>
1.41 asau 10859: <div class="sect2">
1.1 dsieger 10860: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10861: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 10862: <p>These functions do not take any parameters. Although they
10863: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.174 leot 10864: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108 rillig 10865: question</a> for details.</p>
1.41 asau 10866: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10867: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 10868: <dd><p>This function prepares the environment for the
10869: test. By default it does nothing.</p></dd>
1.108 rillig 10870: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10871: <dd>
10872: <p>This function runs the actual test. By default,
1.1 dsieger 10873: it calls <code class="varname">TEST_MAKE</code> with the arguments
10874: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10875: error messages into the file
1.108 rillig 10876: <code class="varname">TEST_OUTFILE</code>.</p>
10877: <p>When defining this function, make sure that all output that
10878: needs to be checked is written to the correct output file.
10879: Example:</p>
10880: <pre class="programlisting">
10881: do_test() {
1.112 rillig 10882: echo "Example output"
1.108 rillig 10883: } 1>$TEST_OUTFILE 2>&1
10884: </pre>
10885: </dd>
10886: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10887: <dd>
10888: <p>This function is run after the test and is
1.1 dsieger 10889: typically used to compare the actual output from the one that is
10890: expected. It can make use of the various helper functions from
1.108 rillig 10891: the next section. Example:</p>
10892: <pre class="programlisting">
10893: check_result() {
1.112 rillig 10894: exit_status 0
10895: output_require "Example"
10896: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10897: output_prohibit "no such file or directory"
1.168 rillig 10898: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 10899: }
10900: </pre>
10901: </dd>
10902: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 10903: <dd><p>This function cleans everything up after the
10904: test has been run. By default it does nothing.</p></dd>
10905: </dl></div>
10906: </div>
1.41 asau 10907: <div class="sect2">
1.1 dsieger 10908: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10909: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.41 asau 10910: <div class="variablelist"><dl class="variablelist">
1.168 rillig 10911: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10912: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108 rillig 10913: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 10914: <dd><p>This function compares the exitcode of the
1.108 rillig 10915: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 10916: If they differ, the test will fail.</p></dd>
1.108 rillig 10917: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10918: <dd>
10919: <p>This function checks for each of its parameters
10920: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 10921: extended regular expression. If it does not, the test will
1.108 rillig 10922: fail. Example:</p>
10923: <pre class="programlisting">
10924: output_require "looks fine"
10925: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10926: </pre>
10927: </dd>
1.177 leot 10928: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.1 dsieger 10929: <dd><p>This function checks for each of its parameters
1.10 hubertf 10930: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10931: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10932: If any of the regular expressions matches, the test will
10933: fail.</p></dd>
10934: </dl></div>
10935: </div>
10936: </div>
10937: </div>
1.41 asau 10938: <div class="chapter">
1.1 dsieger 10939: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10940: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10941: <div class="toc">
10942: <p><b>Table of Contents</b></p>
1.184 rillig 10943: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.1 dsieger 10944: </div>
10945: <p>The pkgsrc system has already been ported to many
10946: operating systems, hardware architectures and compilers. This
10947: chapter explains the necessary steps to make pkgsrc even more
10948: portable.</p>
1.41 asau 10949: <div class="sect1">
1.1 dsieger 10950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10951: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10952: <p>To port pkgsrc to a new operating system (called
10953: <code class="literal">MyOS</code> in this example), you need to touch the
10954: following files:</p>
1.41 asau 10955: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10956: <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>
10957: <dd><p>This file contains some basic definitions, for
10958: example the name of the C
10959: compiler.</p></dd>
10960: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10961: <dd><p>Insert code that defines the variables
10962: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.212 wiz 10963: <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.1 dsieger 10964: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10965: <code class="varname">APPEND_ELF</code>, and the other variables that
10966: appear in this file.</p></dd>
10967: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10968: <dd><p>This file contains the platform-specific
10969: definitions that are used by pkgsrc. Start by copying one of the
10970: other files and edit it to your
10971: needs.</p></dd>
10972: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10973: <dd><p>This file defines the paths to all the tools
10974: that are needed by one or the other package in pkgsrc, as well
10975: as by pkgsrc itself. Find out where these tools are on your
10976: platform and add them.</p></dd>
10977: </dl></div>
10978: <p>Now, you should be able to build some basic packages, like
1.207 leot 10979: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/index.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/index.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.1 dsieger 10980: </div>
10981: </div>
10982: </div>
1.41 asau 10983: <div class="appendix">
10984: <div class="titlepage"><div><div><h1 class="title">
10985: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10986: <div class="toc">
10987: <p><b>Table of Contents</b></p>
1.100 leot 10988: <dl class="toc">
1.1 dsieger 10989: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10990: <dd><dl>
10991: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10992: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10993: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 10994: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 10995: </dl></dd>
10996: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10997: </dl>
10998: </div>
10999: <p>We checked to find a piece of software that wasn't in the packages
11000: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 11001: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 11002: present in the tree is beyond us, but it's useful for the purposes of
11003: this exercise.</p>
1.41 asau 11004: <div class="sect1">
1.1 dsieger 11005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11006: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 11007: <div class="sect2">
1.1 dsieger 11008: <div class="titlepage"><div><div><h3 class="title">
11009: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
11010: <pre class="programlisting">
11011: # $NetBSD$
11012: #
11013:
11014: DISTNAME= bison-1.25
11015: CATEGORIES= devel
1.171 rillig 11016: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 11017:
1.29 dholland 11018: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 11019: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 11020: COMMENT= GNU yacc clone
11021:
11022: GNU_CONFIGURE= yes
1.46 wiz 11023: INFO_FILES= yes
1.1 dsieger 11024:
11025: .include "../../mk/bsd.pkg.mk"
11026: </pre>
11027: </div>
1.41 asau 11028: <div class="sect2">
1.1 dsieger 11029: <div class="titlepage"><div><div><h3 class="title">
11030: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
11031: <pre class="programlisting">
11032: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.259 leot 11033: 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.1 dsieger 11034: of the NetBSD source tree is beyond me.
11035: </pre>
11036: </div>
1.41 asau 11037: <div class="sect2">
1.1 dsieger 11038: <div class="titlepage"><div><div><h3 class="title">
11039: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
11040: <pre class="programlisting">
11041: @comment $NetBSD$
11042: bin/bison
11043: man/man1/bison.1.gz
11044: share/bison.simple
11045: share/bison.hairy
11046: </pre>
11047: </div>
1.41 asau 11048: <div class="sect2">
1.1 dsieger 11049: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 11050: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1 dsieger 11051: <p>The NetBSD package system comes with
1.207 leot 11052: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1 dsieger 11053: which helps to check the contents of these
11054: files. After installation it is quite easy to use, just change to the
1.171 rillig 11055: directory of the package you wish to examine and run
1.10 hubertf 11056: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 11057: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171 rillig 11058: ERROR: Makefile: Each package must define its LICENSE.
11059: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
11060: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
11061: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
11062: 1 error, 2 warnings and 1 note found.
11063: (Run "pkglint -e" to show explanations.)
11064: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 11065: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1 dsieger 11066: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170 rillig 11067: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1 dsieger 11068: -Wall</strong></span> for a very thorough check.</p>
11069: </div>
11070: </div>
1.41 asau 11071: <div class="sect1">
1.1 dsieger 11072: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11073: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
11074: <p>Create the directory where the package lives,
11075: plus any auxiliary directories:</p>
11076: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
11077: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
11078: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
11079: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
11080: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.184 rillig 11081: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 12. Package components - files, directories and contents">Chapter 12, <i>Package components - files, directories and contents</i></a>)
1.1 dsieger 11082: then continue with fetching the distfile:</p>
11083: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
11084: >> bison-1.25.tar.gz doesn't seem to exist on this system.
11085: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
11086: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11087: ftp: Error retrieving file: 500 Internal error
11088:
11089: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
11090: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11091: ftp: Error retrieving file: 500 Internal error
11092:
11093: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
11094: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11095: Successfully retrieved file.</pre>
11096: <p>Generate the checksum of the distfile into
11097: <code class="filename">distinfo</code>:</p>
11098: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
11099: <p>Now compile:</p>
11100: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11101: >> Checksum OK for bison-1.25.tar.gz.
11102: ===> Extracting for bison-1.25
11103: ===> Patching for bison-1.25
11104: ===> Ignoring empty patch directory
11105: ===> Configuring for bison-1.25
11106: creating cache ./config.cache
11107: checking for gcc... cc
11108: checking whether we are using GNU C... yes
11109: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
11110: checking how to run the C preprocessor... cc -E
11111: checking for minix/config.h... no
11112: checking for POSIXized ISC... no
11113: checking whether cross-compiling... no
11114: checking for ANSI C header files... yes
11115: checking for string.h... yes
11116: checking for stdlib.h... yes
11117: checking for memory.h... yes
11118: checking for working const... yes
11119: checking for working alloca.h... no
11120: checking for alloca... yes
11121: checking for strerror... yes
11122: updating cache ./config.cache
11123: creating ./config.status
11124: creating Makefile
11125: ===> Building for bison-1.25
11126: 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
11127: 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
11128: 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
11129: 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
11130: 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
11131: 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
11132: 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
11133: 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
11134: 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
11135: 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
11136: 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
11137: 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
11138: 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
11139: 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
11140: 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
11141: 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
11142: 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
11143: 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
11144: 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
11145: 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
11146: 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
11147: 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
11148: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
11149: rm -f bison.s1
11150: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
11151: <p>Everything seems OK, so install the files:</p>
11152: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11153: >> Checksum OK for bison-1.25.tar.gz.
11154: ===> Installing for bison-1.25
11155: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
11156: rm -f /usr/pkg/bin/bison
11157: cd /usr/pkg/share; rm -f bison.simple bison.hairy
11158: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
11159: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
11160: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
11161: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
11162: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
11163: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
11164: ===> Registering installation for bison-1.25</pre>
11165: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 11166: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 11167: binary package, do this now:</p>
11168: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11169: >> Checksum OK for bison-1.25.tar.gz.
11170: ===> Building package for bison-1.25
11171: Creating package bison-1.25.tgz
11172: Registering depends:.
11173: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
11174: <p>Now that you don't need the source and object files
11175: any more, clean up:</p>
11176: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
11177: ===> Cleaning for bison-1.25</pre>
11178: </div>
11179: </div>
1.41 asau 11180: <div class="appendix">
11181: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 11182: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.1 dsieger 11183: <div class="toc">
11184: <p><b>Table of Contents</b></p>
1.100 leot 11185: <dl class="toc">
1.207 leot 11186: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
11187: <dd><dl>
11188: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
11189: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
11190: </dl></dd>
11191: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
11192: <dd><dl>
11193: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
11194: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
11195: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
11196: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
11197: </dl></dd>
11198: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
11199: <dd><dl>
11200: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
11201: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
11202: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
11203: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
11204: </dl></dd>
1.1 dsieger 11205: </dl>
11206: </div>
1.207 leot 11207: <p>
11208: A number of mechanisms are available in pkgsrc to improve the security of the
11209: resulting system. This page describes the mechanisms, and gives hints
11210: about detecting and fixing problems.
11211: </p>
11212: <p>
11213: Mechanisms can be enabled individually in
11214: <code class="filename">mk.conf</code>, and are
11215: individually described below.
11216: </p>
11217: <p>
11218: Typically, a feature will cause some programs to fail to build or work
11219: when first enabled. This can be due to latent problems in the
11220: program, and can be due to other reasons. After enough testing to
11221: have confidence that user problems will be quite rare, individual
11222: mechanisms will be enabled by default.
11223: </p>
11224: <p>
11225: For each mechanism, see the Caveats section below for an explanation
11226: of what might go wrong at compile time and at run time, and how to
11227: notice and address these problems.
11228: </p>
1.41 asau 11229: <div class="sect1">
1.1 dsieger 11230: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11231: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
11232: <div class="sect2">
11233: <div class="titlepage"><div><div><h3 class="title">
11234: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
11235: <div class="sect3">
11236: <div class="titlepage"><div><div><h4 class="title">
11237: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
11238: <p>
11239: This allows substitute wrappers to be used for some commonly used
11240: library functions that do not have built-in bounds checking - but
11241: could in some cases.
11242: </p>
11243: <p>
11244: Two mitigation levels are available:
11245: </p>
11246: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11247: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
11248: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
11249: </ul></div>
11250: <p>
11251: "strong" has been enabled by default since pkgsrc-2017Q3.
11252: </p>
11253: </div>
11254: <div class="sect3">
11255: <div class="titlepage"><div><div><h4 class="title">
11256: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
11257: <p>
11258: This enables a stack-smashing protection mitigation. It is done by adding a
11259: guard variable to functions with vulnerable objects. The guards are initialized
11260: when a function is entered and then checked when the function exits. The guard
11261: check will fail and the program forcibly exited if the variable was modified in
11262: the meantime. This can happen in case of buffer overflows or memory corruption,
11263: and therefore exposing these bugs.
11264: </p>
11265: <p>
11266: Different mitigation levels are available:
11267: </p>
11268: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11269: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
11270: by the compiler;</p></li>
11271: <li class="listitem"><p>"all", which will protect every function;</p></li>
11272: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
11273: two settings above.</p></li>
11274: </ul></div>
11275: <p>
11276: This mitigation is supported by both GCC and clang. It may be supported in
11277: additional compilers, possibly under a different name. It is particularly useful
11278: for unsafe programming languages, such as C/C++.
11279: </p>
11280: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11281: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
11282: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
11283: </ul></div>
11284: <p>More details can be found here:</p>
11285: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11286: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
11287: </p></li></ul></div>
11288: </div>
11289: <div class="sect3">
11290: <div class="titlepage"><div><div><h4 class="title">
11291: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
11292: <p>
11293: This requests the creation of PIE (Position Independent Executables) for all
11294: executables. The PIE mechanism is normally used for shared libraries, so that
11295: they can be loaded at differing addresses at runtime. PIE itself does not have
11296: useful security properties; however, it is necessary to fully leverage some,
11297: such as ASLR. Some operating systems support Address Space Layout Randomization
11298: (ASLR), which causes different addresses to be used each time a program is run.
11299: This makes it more difficult for an attacker to guess addresses and thus makes
11300: exploits harder to construct. With PIE, ASLR can really be applied to the entire
11301: program, instead of the stack and heap only.
11302: </p>
11303: <p>
11304: PIE executables will only be built for toolchains that are known to support PIE.
11305: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
11306: </p>
11307: <p>
11308: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
11309: </p>
1.1 dsieger 11310: </div>
1.210 gutterid 11311: <div class="sect3">
11312: <div class="titlepage"><div><div><h4 class="title">
1.219 nia 11313: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.207 leot 11314: <p>
11315: This also makes the exploitation of some security vulnerabilities more
11316: difficult in some cases.
11317: </p>
11318: <p>Two different mitigation levels are available:</p>
11319: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11320: <li class="listitem"><p>
1.219 nia 11321: partial (the default): the ELF sections are reordered so that internal data sections
1.207 leot 11322: precede the program's own data sections, and non-PLT GOT is read-only;
11323: </p></li>
11324: <li class="listitem"><p>
11325: full: in addition to partial RELRO, every relocation is performed immediately
1.218 nia 11326: when starting the program, allowing the entire GOT to be read-only. This
11327: can greatly slow down startup of large programs.
1.207 leot 11328: </p></li>
11329: </ul></div>
11330: <p>
11331: This is currently supported by GCC. Many software distributions now enable this
1.220 nia 11332: feature by default, at the "partial" level.
1.207 leot 11333: </p>
11334: <p>
11335: More details can be found here:
11336: </p>
11337: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11338: <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>
11339: </p></li></ul></div>
1.1 dsieger 11340: </div>
1.219 nia 11341: </div>
11342: <div class="sect2">
11343: <div class="titlepage"><div><div><h3 class="title">
11344: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
11345: <div class="sect3">
11346: <div class="titlepage"><div><div><h4 class="title">
11347: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
11348: <p>
11349: With this option, pkgsrc will try to build packages reproducibly. This allows
11350: packages built from the same tree and with the same options, to produce
11351: identical results bit by bit. This option should be combined with ASLR and
11352: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
11353: attackers attempting to exploit security vulnerabilities.
11354: </p>
11355: <p>
11356: More details can be found here:
11357: </p>
11358: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11359: <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>
11360: </p></li></ul></div>
11361: <p>
11362: More work likely needs to be done before pkgsrc is fully reproducible.
11363: </p>
11364: </div>
1.207 leot 11365: <div class="sect3">
11366: <div class="titlepage"><div><div><h4 class="title">
1.219 nia 11367: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.207 leot 11368: <p>
11369: This uses <code class="literal">-fstack-check</code> with GCC for
11370: another stack protection mitigation.
11371: </p>
11372: <p>
11373: It asks the compiler to generate code verifying that it does not corrupt the
11374: stack. According to GCC's manual page, this is really only useful for
11375: multi-threaded programs.
11376: </p>
1.1 dsieger 11377: </div>
11378: </div>
11379: </div>
1.41 asau 11380: <div class="sect1">
1.1 dsieger 11381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11382: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
11383: <div class="sect2">
11384: <div class="titlepage"><div><div><h3 class="title">
11385: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
11386: <div class="sect3">
11387: <div class="titlepage"><div><div><h4 class="title">
11388: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
11389: <p>
11390: A number of packages may fail to build with this option enabled. The
11391: failures are often related to the absence of the <code class="literal">-fPIC</code>
11392: compilation flag when building libraries or executables (or ideally
11393: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
11394: <code class="varname">CFLAGS</code> already, but requires the package to
11395: actually support it.
11396: </p>
11397: <div class="sect4">
11398: <div class="titlepage"><div><div><h5 class="title">
11399: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
11400: <p>
11401: These instructions are meant as a reference only; they likely need to be adapted
11402: for many packages individually.
11403: </p>
11404: <p>
11405: For packages using <code class="filename">Makefiles</code>:
11406: </p>
11407: <pre class="programlisting">
11408: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
11409: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
11410: </pre>
11411: <p>
11412: For packages using <code class="filename">Imakefiles</code>:
11413: </p>
11414: <pre class="programlisting">
11415: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
11416: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
11417: </pre>
11418: </div>
11419: </div>
11420: <div class="sect3">
11421: <div class="titlepage"><div><div><h4 class="title">
11422: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
11423: <p>
11424: Some programs may fail to run, or crash at random times once built as PIE. Two
11425: scenarios are essentially possible. This is nearly always due to a bug in
11426: the program being exposed due to ASLR.
11427: </p>
11428: </div>
11429: <div class="sect3">
11430: <div class="titlepage"><div><div><h4 class="title">
11431: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
11432: <p>
11433: Ideally, packages should be fixed for compatibility with MKPIE.
11434: However, in some cases this is very difficult, due to complex build systems,
11435: packages using non-standard toolchains, or programming languages with odd
11436: bootstrapping mechanisms.
11437: </p>
11438: <p>
11439: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
11440: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
11441: <code class="filename">bsd.prefs.mk</code> is included.
11442: </p>
11443: </div>
11444: </div>
11445: <div class="sect2">
11446: <div class="titlepage"><div><div><h3 class="title">
11447: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
11448: <div class="sect3">
11449: <div class="titlepage"><div><div><h4 class="title">
11450: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
11451: <p>
11452: This feature makes use of pre-processing directives to look for hardened,
11453: alternative implementations of essential library calls. Some programs may fail
11454: to build as a result; this usually happens for those trying too hard to be
11455: portable, or otherwise abusing definitions in the standard library.
11456: </p>
11457: </div>
11458: <div class="sect3">
11459: <div class="titlepage"><div><div><h4 class="title">
11460: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
11461: <p>
11462: This feature may cause some programs to crash, usually indicating an
11463: actual bug in the program. The fix will typically involve patching the
11464: original program's source code.
11465: </p>
11466: </div>
11467: <div class="sect3">
11468: <div class="titlepage"><div><div><h4 class="title">
11469: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
11470: <p>
11471: At least in the case of GCC, FORTIFY will only be applied if optimization is
11472: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
11473: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
11474: optimization level. This cannot easily be applied globally, as some packages
11475: may require specific optimization levels.
11476: </p>
11477: </div>
11478: <div class="sect3">
11479: <div class="titlepage"><div><div><h4 class="title">
11480: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
11481: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11482: <h3 class="title">Note</h3>
11483: <p>FORTIFY should not be disabled to work around runtime crashes in
11484: the program! This is a very bad idea and will expose you to security
11485: vulnerabilities.
11486: </p>
11487: </div>
11488: <p>
11489: To disable FORTIFY on a per-package basis, set the following
11490: in the package's <code class="filename">Makefile</code>
11491: before <code class="filename">bsd.prefs.mk</code> is included:
11492: </p>
11493: <pre class="programlisting">
11494: FORTIFY_SUPPORTED= no
11495: </pre>
11496: </div>
11497: </div>
11498: <div class="sect2">
11499: <div class="titlepage"><div><div><h3 class="title">
11500: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
11501: <div class="sect3">
11502: <div class="titlepage"><div><div><h4 class="title">
11503: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
11504: <p>
11505: For better protection, full RELRO requires every symbol to be resolved when the
11506: program starts, rather than simply when required at run-time. This will have
11507: more impact on programs using a lot of symbols, or linked to libraries exposing
11508: a lot of symbols. Therefore, daemons or programs otherwise running in
11509: background are affected only when started. Programs loading plug-ins at
11510: run-time are affected when loading the plug-ins.
11511: </p>
11512: <p>
11513: The impact is not expected to be noticeable on modern hardware, except in some
11514: cases for big programs.
11515: </p>
11516: </div>
11517: <div class="sect3">
11518: <div class="titlepage"><div><div><h4 class="title">
11519: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
11520: <p>
11521: Some programs handle plug-ins and dependencies in a way that conflicts with
11522: RELRO: for instance, with an initialization routine listing any other plug-in
11523: required. With full RELRO, the missing symbols are resolved before the
11524: initialization routine can run, and the dynamic loader will not be able to find
11525: them directly and abort as a result. Unfortunately, this is how Xorg loads its
11526: drivers. Partial RELRO can be applied instead in this case.
11527: </p>
11528: </div>
11529: <div class="sect3">
11530: <div class="titlepage"><div><div><h4 class="title">
11531: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
11532: <p>
11533: To disable RELRO on a per-package basis, set the following
11534: in the package's <code class="filename">Makefile</code>
11535: before <code class="filename">bsd.prefs.mk</code> is included:
11536: </p>
11537: <pre class="programlisting">
11538: RELRO_SUPPORTED= no
11539: </pre>
1.209 nia 11540: <p>
11541: It is also possible to at most enable partial RELRO, by
11542: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
11543: </p>
1.207 leot 11544: </div>
11545: </div>
11546: <div class="sect2">
11547: <div class="titlepage"><div><div><h3 class="title">
11548: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
11549: <div class="sect3">
11550: <div class="titlepage"><div><div><h4 class="title">
11551: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
11552: <p>
11553: The stack-smashing protection provided by this option does not work for some
11554: programs. The most common situation in which this happens is when the program
11555: allocates variables on the stack, with the size determined at run-time.
11556: </p>
11557: </div>
11558: <div class="sect3">
11559: <div class="titlepage"><div><div><h4 class="title">
11560: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
11561: <p>
11562: Again, this feature may cause some programs to crash via a
11563: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
11564: </p>
11565: <p>
11566: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
11567: messages are sent and - by default -
11568: appended to <code class="filename">/var/log/messages</code>, e.g.:
11569: </p>
11570: <pre class="programlisting">
11571: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
11572: </pre>
11573: <p>
11574: (where <code class="literal">hostname</code> is the hostname(1) and
11575: <code class="literal">program</code> is the basename(1) of the program crashed).
11576: </p>
11577: <p>
11578: Patching the original program is then required.
11579: </p>
11580: <p>
11581: Rebuilding the package via:
11582: </p>
11583: <pre class="programlisting">
11584: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
11585: </pre>
11586: <p>
11587: and inspecting the backtrace of the coredump via the debugger
11588: should point out the problematic call by inspecting the frame
11589: calling the _chk() (SSP) function.
11590: </p>
11591: </div>
11592: <div class="sect3">
11593: <div class="titlepage"><div><div><h4 class="title">
11594: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
11595: <p>
11596: The compiler emits extra code when using this feature: a check for buffer
11597: overflows is performed when entering and exiting functions, requiring an extra
11598: variable on the stack. The level of protection can otherwise be adjusted to
11599: affect only those functions considered more sensitive by the compiler (with
11600: -fstack-protector instead of -fstack-protector-all).
11601: </p>
11602: <p>
11603: The impact is not expected to be noticeable on modern hardware. However,
11604: programs with a hard requirement to run at the fastest possible speed should
11605: avoid using this feature, or using libraries built with this feature.
11606: </p>
11607: </div>
11608: <div class="sect3">
11609: <div class="titlepage"><div><div><h4 class="title">
11610: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
11611: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11612: <h3 class="title">Note</h3>
11613: <p>SSP should not be disabled to work around runtime crashes in
11614: the program! This is a very bad idea and will expose you to security
11615: vulnerabilities.</p>
11616: </div>
11617: <p>
11618: To disable SSP on a per-package basis, set the following
11619: in the package's <code class="filename">Makefile</code>
11620: before <code class="filename">bsd.prefs.mk</code> is included:
11621: </p>
11622: <pre class="programlisting">
11623: SSP_SUPPORTED= no
11624: </pre>
11625: </div>
11626: </div>
11627: </div>
11628: <div class="sect1">
11629: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11630: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
11631: <p>
11632: The illusion of security is worse than having no security at all. This section
11633: lists a number of ways to ensure the security features requested are actually
11634: effective.
11635: </p>
11636: <p>
11637: These instructions were obtained and tested on a system derived from NetBSD 7
11638: (amd64). YMMV.
11639: </p>
11640: <div class="sect2">
11641: <div class="titlepage"><div><div><h3 class="title">
11642: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
11643: <p>
11644: The ELF executable type in use changes for binaries built as PIE; without:
11645: </p>
11646: <pre class="programlisting">
11647: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
11648: /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
11649: </pre>
11650: <p>as opposed to the following binary, built as PIE:</p>
11651: <pre class="programlisting">
11652: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
11653: /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
11654: </pre>
11655: <p>
11656: The latter result is then what is expected.
11657: </p>
11658: </div>
11659: <div class="sect2">
11660: <div class="titlepage"><div><div><h3 class="title">
11661: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
11662: <p>
11663: The following command should list a section called RELRO:
11664: </p>
11665: <pre class="programlisting">
11666: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
11667:
11668: /path/to/bin/ary: file format elf64-x86-64
11669:
11670: Program Header:
11671: [...]
11672: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
11673: </pre>
11674: <p>
11675: This check is now performed automatically if
11676: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
11677: </p>
11678: </div>
11679: <div class="sect2">
11680: <div class="titlepage"><div><div><h3 class="title">
11681: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
11682: <p>
11683: The dynamic loader will apply RELRO immediately when detecting the presence of
11684: the <code class="varname">BIND_NOW</code> flag:
11685: </p>
11686: <pre class="programlisting">
11687: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
11688:
11689: /path/to/bin/ary: file format elf64-x86-64
11690:
11691: Dynamic Section:
11692: [...]
11693: BIND_NOW 0x0000000000000000
11694: </pre>
11695: <p>
11696: This has to be combined with partial RELRO (see above) to be fully efficient.
11697: </p>
11698: <p>
11699: This check is now performed automatically (where supported) if
11700: <code class="varname">PKG_DEVELOPER</code> is set.
11701: </p>
11702: </div>
11703: <div class="sect2">
11704: <div class="titlepage"><div><div><h3 class="title">
11705: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.208 nia 11706: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11707: <h3 class="title">Note</h3>
11708: <p>
11709: Checking for SSP using this method only works where the operating system
11710: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
11711: on recent NetBSD/FreeBSD/Linux versions.
11712: </p>
11713: </div>
1.207 leot 11714: <p>
11715: Building objects, binaries and libraries with SSP will affect the presence of
11716: additional symbols in the resulting file:
11717: </p>
11718: <pre class="programlisting">
11719: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
11720: [...]
11721: U __stack_chk_fail
11722: 0000000000600ea0 B __stack_chk_guard
11723: </pre>
11724: <p>
11725: This is an indicator that the program was indeed built with support for SSP.
11726: </p>
11727: <p>
11728: This check is now performed automatically (where supported) if
11729: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
11730: </p>
11731: </div>
11732: </div>
11733: </div>
11734: <div class="appendix">
11735: <div class="titlepage"><div><div><h1 class="title">
11736: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
11737: <div class="toc">
11738: <p><b>Table of Contents</b></p>
11739: <dl class="toc">
11740: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
11741: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
11742: </dl>
11743: </div>
11744: <div class="sect1">
11745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11746: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
11747: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11748: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11749: => figlet221.tar.gz doesn't seem to exist on this system.
11750: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11751: => [172219 bytes]
11752: Connected to ftp.plig.net.
11753: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11754: 331 Guest login ok, send your complete e-mail address as password.
11755: 230-You are user #5 of 500 simultaneous users allowed.
11756: 230-
11757: 230- ___ _ _ _
11758: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11759: 230- | _| _| . |_| . | | | . |_| . | _| . |
11760: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11761: 230- |_| |_| |___| |___|
11762: 230-
11763: 230-** Welcome to ftp.plig.org **
11764: 230-
11765: 230-Please note that all transfers from this FTP site are logged. If you
11766: 230-do not like this, please disconnect now.
11767: 230-
11768: 230-This archive is available via
11769: 230-
11770: 230-HTTP: http://ftp.plig.org/
11771: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11772: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11773: 230-
11774: 230-Please email comments, bug reports and requests for packages to be
11775: 230-mirrored to ftp-admin@plig.org.
11776: 230-
11777: 230-
11778: 230 Logged in anonymously.
11779: Remote system type is UNIX.
11780: Using binary mode to transfer files.
11781: 200 Type okay.
11782: 250 "/pub" is new cwd.
11783: 250-"/pub/figlet" is new cwd.
11784: 250-
11785: 250-Welcome to the figlet archive at ftp.figlet.org
11786: 250-
11787: 250- ftp://ftp.figlet.org/pub/figlet/
11788: 250-
11789: 250-The official FIGlet web page is:
11790: 250- http://www.figlet.org/
11791: 250-
11792: 250-If you have questions, please mailto:info@figlet.org. If you want to
11793: 250-contribute a font or something else, you can email us.
11794: 250
11795: 250 "/pub/figlet/program" is new cwd.
11796: 250 "/pub/figlet/program/unix" is new cwd.
11797: local: figlet221.tar.gz remote: figlet221.tar.gz
11798: 502 Unimplemented command.
11799: 227 Entering Passive Mode (195,40,6,41,246,104)
11800: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11801: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11802: 226 Transfer completed.
11803: 172219 bytes received in 00:02 (75.99 KB/s)
11804: 221 Goodbye.
11805: => Checksum OK for figlet221.tar.gz.
11806: ===> Extracting for figlet-2.2.1nb2
11807: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11808: ===> Patching for figlet-2.2.1nb2
11809: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11810: ===> Overriding tools for figlet-2.2.1nb2
11811: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11812: ===> Configuring for figlet-2.2.1nb2
11813: ===> Building for figlet-2.2.1nb2
11814: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11815: chmod a+x figlet
11816: gcc -O2 -o chkfont chkfont.c
11817: => Unwrapping files-to-be-installed.
11818: <code class="prompt">#</code>
11819: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11820: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11821: ===> Installing for figlet-2.2.1nb2
11822: install -d -o root -g wheel -m 755 /usr/pkg/bin
11823: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11824: mkdir -p /usr/pkg/share/figlet
11825: cp figlet /usr/pkg/bin
11826: cp chkfont /usr/pkg/bin
11827: chmod 555 figlist showfigfonts
11828: cp figlist /usr/pkg/bin
11829: cp showfigfonts /usr/pkg/bin
11830: cp fonts/*.flf /usr/pkg/share/figlet
11831: cp fonts/*.flc /usr/pkg/share/figlet
11832: cp figlet.6 /usr/pkg/man/man6
11833: ===> Registering installation for figlet-2.2.1nb2
11834: <code class="prompt">#</code></pre>
11835: </div>
11836: <div class="sect1">
11837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11838: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
11839: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11840: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11841: ===> Packaging figlet-2.2.1nb2
11842: ===> Building binary package for figlet-2.2.1nb2
11843: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11844: Using SrcDir value of /usr/pkg
11845: Registering depends:.
11846: <code class="prompt">#</code></pre>
11847: </div>
11848: </div>
11849: <div class="appendix">
11850: <div class="titlepage"><div><div><h1 class="title">
11851: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
11852: <div class="toc">
11853: <p><b>Table of Contents</b></p>
11854: <dl class="toc">
11855: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11856: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11857: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11858: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11859: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
11860: <code class="filename">stable</code>,
11861: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11862: source packages</a></span></dt>
11863: </dl>
11864: </div>
11865: <p>As in other big projects, the directory layout of pkgsrc
11866: is quite complex for newbies. This chapter explains where you
11867: find things on the FTP server. The base directory on
11868: <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>.
11869: On other servers it may be different, but inside this directory,
11870: everything should look the same, no matter on which server you
11871: are. This directory contains some subdirectories, which are
11872: explained below.</p>
11873: <div class="sect1">
11874: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11875: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
11876: <p>The directory <code class="filename">distfiles</code> contains lots
11877: of archive files from all pkgsrc packages, which are mirrored
11878: here. The subdirectories are called after their package names
11879: and are used when the distributed files have names that don't
11880: explicitly contain a version number or are otherwise too generic
11881: (for example <code class="filename">release.tar.gz</code>).</p>
11882: </div>
11883: <div class="sect1">
11884: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11885: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
11886: <p>This directory contains things that individual pkgsrc
11887: developers find worth publishing.</p>
11888: </div>
11889: <div class="sect1">
11890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11891: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
11892: <p>This directory contains binary packages for the various
11893: platforms that are supported by pkgsrc.
11894: 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>
11895: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11896: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
11897: operating system for which the packages have been built. The
11898: name is taken from the output of the <span class="command"><strong>uname</strong></span>
11899: command, so it may differ from the one you are used to
11900: hear.</p></li>
11901: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
11902: architecture of the platform for which the packages have been
11903: built. It also includes the <code class="varname">ABI</code> (Application
11904: Binary Interface) for platforms that have several of
11905: them.</p></li>
11906: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.255 wiz 11907: the operating system. Typically it is the version defining an
11908: ABI, e.g. 9.0.</p></li>
1.207 leot 11909: <li class="listitem"><p><code class="varname">TAG</code> is either
1.255 wiz 11910: <code class="literal">20<em class="replaceable"><code>YY</code></em>Q<em class="replaceable"><code>N</code></em></code>
11911: for a stable branch, or <code class="literal">current</code> for packages
1.207 leot 11912: built from the HEAD branch. The latter should only be used when
1.255 wiz 11913: the packages are updated on a regular basis.</p></li>
1.207 leot 11914: </ul></div>
1.255 wiz 11915: <p>The rationale for this scheme is that users can first
11916: search by OPSYS and ARCH, since these are more or less
11917: unchangeable. After that, there is a management set of
11918: directories with OSVERSION and TAG.</p>
11919: <p>See also <code class="filename">README.md</code> in
11920: <code class="filename">packages</code> for more details, including
11921: about symlinks.</p>
1.207 leot 11922: <p>In each of these directories, there is a
11923: whole binary packages collection for a specific platform. It has a directory called
11924: <code class="filename">All</code> which contains all binary packages.
1.255 wiz 11925: </p>
1.207 leot 11926: </div>
11927: <div class="sect1">
11928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11929: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 11930: <p>Here are the reports from bulk builds, for those who want
11931: to fix packages that didn't build on some of the platforms. The
1.207 leot 11932: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="D.3. packages: Binary packages">Section D.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.8 rillig 11933: </div>
1.41 asau 11934: <div class="sect1">
1.8 rillig 11935: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11936: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.148 leot 11937: <code class="filename">stable</code>,
1.22 jakllsch 11938: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 11939: source packages</h2></div></div></div>
1.23 wiz 11940: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 11941: that is the files that define how to create binary packages from
11942: source archives.</p>
1.149 leot 11943: <p>Each of the <code class="filename">current</code>,
11944: <code class="filename">stable</code> and
11945: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11946: directories share the same structure. They each contain a
11947: <code class="filename">pkgsrc</code> directory and
11948: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 11949: <p>The directory <code class="filename">pkgsrc</code> contains a
11950: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 11951: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11952: as the directory, ready to be downloaded as a whole.</p>
11953: <p>The <code class="filename">current</code> directory contains files
11954: related to the HEAD branch of the CVS repository.
11955: In this directory there is an additional file called
11956: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11957: all pkgsrc <code class="filename">README</code>s with information about
11958: categories and packages.
11959: </p>
11960: <p>The <code class="filename">stable</code> directory is a symlink to
11961: the latest
11962: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11963: </p>
11964: <p>The
11965: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11966: directories contain files related to the
11967: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11968: stable branch of the CVS repository. In these directories there is
11969: an additional file called
11970: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.{bz,gz,xz}</code>,
1.1 dsieger 11971: which contains the state of pkgsrc when it was branched.</p>
11972: </div>
11973: </div>
1.41 asau 11974: <div class="appendix">
11975: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 11976: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.154 rillig 11977: <p>
11978: The following list contains all help topics that are available
11979: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11980: </p>
1.156 leot 11981: <table border="0" summary="Simple list" class="simplelist">
11982: <tr>
11983: <td>#!</td>
11984: <td>-lintl</td>
11985: </tr>
11986: <tr>
1.205 wiz 11987: <td>32bit</td>
1.156 leot 11988: <td>64bit</td>
1.205 wiz 11989: </tr>
11990: <tr>
1.156 leot 11991: <td>ABI</td>
1.205 wiz 11992: <td>ACCEPTABLE_LICENSES</td>
1.156 leot 11993: </tr>
11994: <tr>
11995: <td>ACROREAD_FONTPATH</td>
1.205 wiz 11996: <td>ADDITIONAL</td>
1.156 leot 11997: </tr>
11998: <tr>
11999: <td>AFAIK</td>
1.205 wiz 12000: <td>AIX</td>
1.156 leot 12001: </tr>
12002: <tr>
1.255 wiz 12003: <td>ALLOW_NETWORK_ACCESS</td>
1.243 gutterid 12004: <td>ALLOW_NEWER_COMPILER</td>
1.156 leot 12005: </tr>
12006: <tr>
1.255 wiz 12007: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.243 gutterid 12008: <td>ALL_ENV</td>
1.254 wiz 12009: </tr>
12010: <tr>
1.258 wiz 12011: <td>ALSA_PC</td>
1.249 gutterid 12012: <td>ALTERNATIVES_SRC</td>
1.258 wiz 12013: </tr>
12014: <tr>
1.257 jkoshy 12015: <td>AMANDA_TMP</td>
1.258 wiz 12016: <td>AMANDA_USER</td>
1.246 leot 12017: </tr>
12018: <tr>
1.257 jkoshy 12019: <td>AMANDA_VAR</td>
1.258 wiz 12020: <td>APACHE_GROUP</td>
1.241 rillig 12021: </tr>
12022: <tr>
1.257 jkoshy 12023: <td>APACHE_MODULE_NAME</td>
1.258 wiz 12024: <td>APACHE_MODULE_SRC</td>
1.238 wiz 12025: </tr>
12026: <tr>
1.257 jkoshy 12027: <td>APACHE_MODULE_SRCDIR</td>
1.258 wiz 12028: <td>APACHE_PKG_PREFIX</td>
1.233 wiz 12029: </tr>
12030: <tr>
1.257 jkoshy 12031: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.258 wiz 12032: <td>APACHE_SUEXEC_DOCROOT</td>
1.227 wiz 12033: </tr>
12034: <tr>
1.257 jkoshy 12035: <td>APACHE_USER</td>
1.258 wiz 12036: <td>ARGMAX_REQ</td>
1.223 nia 12037: </tr>
12038: <tr>
1.258 wiz 12039: <td>ARG_MAX</td>
1.255 wiz 12040: <td>ARLA_CACHE</td>
1.258 wiz 12041: </tr>
12042: <tr>
1.257 jkoshy 12043: <td>AUDIT_PACKAGES_FLAGS</td>
1.258 wiz 12044: <td>AUTOCONF_REQD</td>
1.217 rillig 12045: </tr>
12046: <tr>
1.257 jkoshy 12047: <td>AUTOMAKE_OVERRIDE</td>
1.258 wiz 12048: <td>AUTOMAKE_REQD</td>
1.214 leot 12049: </tr>
12050: <tr>
1.257 jkoshy 12051: <td>AUTO_MKDIRS</td>
1.258 wiz 12052: <td>AUX</td>
1.212 wiz 12053: </tr>
12054: <tr>
1.257 jkoshy 12055: <td>BDB185_DEFAULT</td>
1.258 wiz 12056: <td>BDBBASE</td>
1.197 leot 12057: </tr>
12058: <tr>
1.257 jkoshy 12059: <td>BDB_ACCEPTED</td>
1.258 wiz 12060: <td>BDB_DEFAULT</td>
1.177 leot 12061: </tr>
12062: <tr>
1.257 jkoshy 12063: <td>BDB_LIBS</td>
1.258 wiz 12064: <td>BDB_TYPE</td>
1.161 leot 12065: </tr>
12066: <tr>
1.257 jkoshy 12067: <td>BINCIMAP_GROUP</td>
1.258 wiz 12068: <td>BINCIMAP_LOG_USER</td>
1.159 rillig 12069: </tr>
12070: <tr>
1.257 jkoshy 12071: <td>BINCIMAP_USER</td>
1.258 wiz 12072: <td>BIND_DIR</td>
1.156 leot 12073: </tr>
12074: <tr>
1.257 jkoshy 12075: <td>BIND_GROUP</td>
1.258 wiz 12076: <td>BIND_USER</td>
1.254 wiz 12077: </tr>
12078: <tr>
1.257 jkoshy 12079: <td>BINOWN</td>
1.258 wiz 12080: <td>BINPKG_SITES</td>
1.156 leot 12081: </tr>
12082: <tr>
1.257 jkoshy 12083: <td>BIN_INSTALL_FLAGS</td>
1.258 wiz 12084: <td>BISON_PKGDATADIR</td>
1.156 leot 12085: </tr>
12086: <tr>
1.257 jkoshy 12087: <td>BLAS</td>
1.258 wiz 12088: <td>BLAS_ACCEPTED</td>
1.156 leot 12089: </tr>
12090: <tr>
1.257 jkoshy 12091: <td>BLAS_C_INTERFACE</td>
1.258 wiz 12092: <td>BLAS_INCLUDES</td>
1.156 leot 12093: </tr>
12094: <tr>
1.257 jkoshy 12095: <td>BLAS_INDEX64</td>
1.258 wiz 12096: <td>BLAS_LIBS</td>
1.156 leot 12097: </tr>
12098: <tr>
1.257 jkoshy 12099: <td>BLAS_PC</td>
1.258 wiz 12100: <td>BLAS_TYPE</td>
1.156 leot 12101: </tr>
12102: <tr>
1.257 jkoshy 12103: <td>BOOTSTRAP_DEPENDS</td>
1.258 wiz 12104: <td>BROKEN</td>
1.156 leot 12105: </tr>
12106: <tr>
1.257 jkoshy 12107: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.258 wiz 12108: <td>BROKEN_ON_PLATFORM</td>
1.156 leot 12109: </tr>
12110: <tr>
1.257 jkoshy 12111: <td>BSDSRCDIR</td>
1.258 wiz 12112: <td>BSDXSRCDIR</td>
1.156 leot 12113: </tr>
12114: <tr>
1.257 jkoshy 12115: <td>BSD_MAKE_ENV</td>
1.258 wiz 12116: <td>BUILDLINK_AUTO_DIRS</td>
1.198 leot 12117: </tr>
12118: <tr>
1.257 jkoshy 12119: <td>BUILDLINK_AUTO_VARS</td>
1.258 wiz 12120: <td>BUILDLINK_CFLAGS</td>
1.229 gutterid 12121: </tr>
12122: <tr>
1.257 jkoshy 12123: <td>BUILDLINK_CONTENTS_FILTER</td>
1.258 wiz 12124: <td>BUILDLINK_CPPFLAGS</td>
1.156 leot 12125: </tr>
12126: <tr>
1.258 wiz 12127: <td>BUILDLINK_DEPMETHOD</td>
1.255 wiz 12128: <td>BUILDLINK_FILES</td>
1.156 leot 12129: </tr>
12130: <tr>
1.216 gutterid 12131: <td>BUILDLINK_FILES_CMD</td>
1.255 wiz 12132: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.205 wiz 12133: </tr>
12134: <tr>
1.216 gutterid 12135: <td>BUILDLINK_LDFLAGS</td>
1.255 wiz 12136: <td>BUILDLINK_LIBS</td>
1.156 leot 12137: </tr>
12138: <tr>
1.216 gutterid 12139: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.255 wiz 12140: <td>BUILDLINK_PKGNAME</td>
1.156 leot 12141: </tr>
12142: <tr>
1.216 gutterid 12143: <td>BUILDLINK_PREFIX</td>
1.255 wiz 12144: <td>BUILDLINK_RPATHDIRS</td>
1.156 leot 12145: </tr>
12146: <tr>
1.216 gutterid 12147: <td>BUILDLINK_TREE</td>
1.255 wiz 12148: <td>BUILD_DEFS</td>
1.156 leot 12149: </tr>
12150: <tr>
1.216 gutterid 12151: <td>BUILD_DEFS_EFFECTS</td>
1.255 wiz 12152: <td>BUILD_DEPENDS</td>
1.156 leot 12153: </tr>
12154: <tr>
1.216 gutterid 12155: <td>BUILD_DIRS</td>
1.255 wiz 12156: <td>BUILD_ENV_SHELL</td>
1.156 leot 12157: </tr>
12158: <tr>
1.216 gutterid 12159: <td>BUILD_MAKE_CMD</td>
1.255 wiz 12160: <td>BUILD_MAKE_FLAGS</td>
1.156 leot 12161: </tr>
12162: <tr>
1.216 gutterid 12163: <td>BUILD_TARGET</td>
1.255 wiz 12164: <td>BUILTIN_FIND_FILES</td>
1.156 leot 12165: </tr>
12166: <tr>
1.216 gutterid 12167: <td>BUILTIN_FIND_FILES_VAR</td>
1.255 wiz 12168: <td>BUILTIN_FIND_GREP</td>
1.156 leot 12169: </tr>
12170: <tr>
1.216 gutterid 12171: <td>BUILTIN_FIND_HEADERS</td>
1.255 wiz 12172: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.156 leot 12173: </tr>
12174: <tr>
1.216 gutterid 12175: <td>BUILTIN_FIND_PKGCONFIG</td>
1.255 wiz 12176: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.156 leot 12177: </tr>
12178: <tr>
1.216 gutterid 12179: <td>BUILTIN_PKG</td>
1.255 wiz 12180: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.195 gutterid 12181: </tr>
12182: <tr>
1.216 gutterid 12183: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.255 wiz 12184: <td>BUILTIN_VERSION_SCRIPT</td>
1.156 leot 12185: </tr>
12186: <tr>
1.216 gutterid 12187: <td>BUILTIN_X11_TYPE</td>
1.255 wiz 12188: <td>BUILTIN_X11_VERSION</td>
1.156 leot 12189: </tr>
12190: <tr>
1.216 gutterid 12191: <td>CACTI_GROUP</td>
1.255 wiz 12192: <td>CACTI_USER</td>
1.156 leot 12193: </tr>
12194: <tr>
1.216 gutterid 12195: <td>CANNA_GROUP</td>
1.255 wiz 12196: <td>CANNA_USER</td>
1.156 leot 12197: </tr>
12198: <tr>
1.216 gutterid 12199: <td>CAT</td>
1.255 wiz 12200: <td>CBLAS_LIBS</td>
1.156 leot 12201: </tr>
12202: <tr>
1.229 gutterid 12203: <td>CBLAS_PC</td>
1.255 wiz 12204: <td>CCACHE_BASE</td>
1.156 leot 12205: </tr>
12206: <tr>
1.189 bacon 12207: <td>CCACHE_DIR</td>
1.255 wiz 12208: <td>CCACHE_LOGFILE</td>
1.156 leot 12209: </tr>
12210: <tr>
1.256 wiz 12211: <td>CCACHE_RECACHE</td>
1.189 bacon 12212: <td>CC_VERSION</td>
1.156 leot 12213: </tr>
12214: <tr>
1.256 wiz 12215: <td>CC_VERSION_STRING</td>
1.189 bacon 12216: <td>CDRECORD_CONF</td>
1.156 leot 12217: </tr>
12218: <tr>
1.256 wiz 12219: <td>CDROM_PKG_URL_DIR</td>
1.189 bacon 12220: <td>CDROM_PKG_URL_HOST</td>
1.223 nia 12221: </tr>
12222: <tr>
1.256 wiz 12223: <td>CHANGES</td>
1.258 wiz 12224: <td>CHECKOUT_DATE</td>
12225: </tr>
12226: <tr>
1.257 jkoshy 12227: <td>CHECK_COMPILER</td>
1.258 wiz 12228: <td>CHECK_FAKEHOME</td>
1.254 wiz 12229: </tr>
12230: <tr>
1.257 jkoshy 12231: <td>CHECK_FILES</td>
1.258 wiz 12232: <td>CHECK_FILES_ONLY_PREFIX</td>
1.246 leot 12233: </tr>
12234: <tr>
1.257 jkoshy 12235: <td>CHECK_FILES_SKIP</td>
1.258 wiz 12236: <td>CHECK_FILES_STRICT</td>
1.241 rillig 12237: </tr>
12238: <tr>
1.257 jkoshy 12239: <td>CHECK_HEADERS</td>
1.258 wiz 12240: <td>CHECK_HEADERS_SKIP</td>
1.238 wiz 12241: </tr>
12242: <tr>
1.257 jkoshy 12243: <td>CHECK_INTERPRETER</td>
1.258 wiz 12244: <td>CHECK_INTERPRETER_SKIP</td>
1.233 wiz 12245: </tr>
12246: <tr>
1.257 jkoshy 12247: <td>CHECK_PERMS</td>
1.258 wiz 12248: <td>CHECK_PERMS_AUTOFIX</td>
1.227 wiz 12249: </tr>
12250: <tr>
1.257 jkoshy 12251: <td>CHECK_PERMS_SKIP</td>
1.258 wiz 12252: <td>CHECK_PIE</td>
1.217 rillig 12253: </tr>
12254: <tr>
1.257 jkoshy 12255: <td>CHECK_PIE_SKIP</td>
1.258 wiz 12256: <td>CHECK_PIE_SUPPORTED</td>
1.214 leot 12257: </tr>
12258: <tr>
1.257 jkoshy 12259: <td>CHECK_PORTABILITY</td>
1.258 wiz 12260: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.212 wiz 12261: </tr>
12262: <tr>
1.257 jkoshy 12263: <td>CHECK_PORTABILITY_SKIP</td>
1.258 wiz 12264: <td>CHECK_RELRO</td>
1.205 wiz 12265: </tr>
12266: <tr>
1.257 jkoshy 12267: <td>CHECK_RELRO_SKIP</td>
1.258 wiz 12268: <td>CHECK_RELRO_SUPPORTED</td>
1.197 leot 12269: </tr>
12270: <tr>
1.257 jkoshy 12271: <td>CHECK_SHLIBS</td>
1.258 wiz 12272: <td>CHECK_SHLIBS_SKIP</td>
1.177 leot 12273: </tr>
12274: <tr>
1.257 jkoshy 12275: <td>CHECK_SHLIBS_SUPPORTED</td>
1.258 wiz 12276: <td>CHECK_SHLIBS_TOXIC</td>
1.161 leot 12277: </tr>
12278: <tr>
1.257 jkoshy 12279: <td>CHECK_SSP</td>
1.258 wiz 12280: <td>CHECK_SSP_SKIP</td>
1.216 gutterid 12281: </tr>
12282: <tr>
1.257 jkoshy 12283: <td>CHECK_SSP_SUPPORTED</td>
1.258 wiz 12284: <td>CHECK_STRIPPED</td>
1.159 rillig 12285: </tr>
12286: <tr>
1.257 jkoshy 12287: <td>CHECK_STRIPPED_SKIP</td>
1.258 wiz 12288: <td>CHECK_WRKREF</td>
1.156 leot 12289: </tr>
12290: <tr>
1.257 jkoshy 12291: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.258 wiz 12292: <td>CHECK_WRKREF_SKIP</td>
1.156 leot 12293: </tr>
12294: <tr>
1.257 jkoshy 12295: <td>CLAMAV_DBDIR</td>
1.258 wiz 12296: <td>CLAMAV_GROUP</td>
1.156 leot 12297: </tr>
12298: <tr>
1.257 jkoshy 12299: <td>CLAMAV_USER</td>
1.258 wiz 12300: <td>CLANGBASE</td>
1.156 leot 12301: </tr>
12302: <tr>
1.257 jkoshy 12303: <td>CLEANDEPENDS</td>
1.258 wiz 12304: <td>CLT</td>
1.156 leot 12305: </tr>
12306: <tr>
1.257 jkoshy 12307: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.258 wiz 12308: <td>CMAKE_INSTALL_NAME_DIR</td>
1.254 wiz 12309: </tr>
12310: <tr>
1.257 jkoshy 12311: <td>CMAKE_INSTALL_PREFIX</td>
1.258 wiz 12312: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.156 leot 12313: </tr>
12314: <tr>
1.257 jkoshy 12315: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.258 wiz 12316: <td>CMAKE_PREFIX_PATH</td>
1.156 leot 12317: </tr>
12318: <tr>
1.256 wiz 12319: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.258 wiz 12320: <td>COMMON_LISP_DOCFILES</td>
12321: </tr>
12322: <tr>
12323: <td>COMMON_LISP_EXAMPLES</td>
12324: <td>COMMON_LISP_EXTRAFILES</td>
12325: </tr>
12326: <tr>
12327: <td>COMMON_LISP_PACKAGES</td>
12328: <td>COMMON_LISP_SYSTEM</td>
1.156 leot 12329: </tr>
12330: <tr>
1.256 wiz 12331: <td>COMPILER_RPATH_FLAG</td>
1.226 gutterid 12332: <td>COMPILER_USE_SYMLINKS</td>
1.156 leot 12333: </tr>
12334: <tr>
1.256 wiz 12335: <td>CONFIGURE_ARGS</td>
1.226 gutterid 12336: <td>CONFIGURE_DIRS</td>
1.156 leot 12337: </tr>
12338: <tr>
1.256 wiz 12339: <td>CONFIGURE_ENV</td>
1.226 gutterid 12340: <td>CONFIGURE_ENV_SHELL</td>
1.156 leot 12341: </tr>
12342: <tr>
1.256 wiz 12343: <td>CONFIGURE_HAS_INFODIR</td>
1.226 gutterid 12344: <td>CONFIGURE_HAS_MANDIR</td>
1.156 leot 12345: </tr>
12346: <tr>
1.256 wiz 12347: <td>CONFIGURE_SCRIPT</td>
1.226 gutterid 12348: <td>CONFIG_SHELL</td>
1.156 leot 12349: </tr>
12350: <tr>
1.256 wiz 12351: <td>CONFIG_SHELL_FLAGS</td>
1.226 gutterid 12352: <td>CONF_FILES</td>
1.156 leot 12353: </tr>
12354: <tr>
1.256 wiz 12355: <td>CONF_FILES_MODE</td>
1.226 gutterid 12356: <td>CONF_FILES_PERMS</td>
1.156 leot 12357: </tr>
12358: <tr>
1.256 wiz 12359: <td>CONSERVER_DEFAULTHOST</td>
1.226 gutterid 12360: <td>CONSERVER_DEFAULTPORT</td>
1.156 leot 12361: </tr>
12362: <tr>
1.256 wiz 12363: <td>CP</td>
1.232 gutterid 12364: <td>CPE</td>
12365: </tr>
12366: <tr>
1.256 wiz 12367: <td>CPE_EDITION</td>
1.232 gutterid 12368: <td>CPE_LANG</td>
12369: </tr>
12370: <tr>
1.256 wiz 12371: <td>CPE_OTHER</td>
1.232 gutterid 12372: <td>CPE_PART</td>
12373: </tr>
12374: <tr>
1.256 wiz 12375: <td>CPE_PRODUCT</td>
1.232 gutterid 12376: <td>CPE_SW_EDITION</td>
12377: </tr>
12378: <tr>
1.256 wiz 12379: <td>CPE_TARGET_HW</td>
1.232 gutterid 12380: <td>CPE_TARGET_SW</td>
12381: </tr>
12382: <tr>
1.256 wiz 12383: <td>CPE_UPDATE</td>
1.232 gutterid 12384: <td>CPE_URI</td>
12385: </tr>
12386: <tr>
1.256 wiz 12387: <td>CPE_VENDOR</td>
1.232 gutterid 12388: <td>CPE_VERSION</td>
1.156 leot 12389: </tr>
12390: <tr>
1.256 wiz 12391: <td>CPP</td>
1.232 gutterid 12392: <td>CPP_PRECOMP_FLAGS</td>
1.156 leot 12393: </tr>
12394: <tr>
1.256 wiz 12395: <td>CREATE_WRKDIR_SYMLINK</td>
1.232 gutterid 12396: <td>CROSSBASE</td>
1.156 leot 12397: </tr>
12398: <tr>
1.256 wiz 12399: <td>CTFCONVERT</td>
1.232 gutterid 12400: <td>CTF_FILES_SKIP</td>
1.156 leot 12401: </tr>
12402: <tr>
1.256 wiz 12403: <td>CTF_SUPPORTED</td>
1.232 gutterid 12404: <td>CTYPE</td>
1.156 leot 12405: </tr>
12406: <tr>
1.256 wiz 12407: <td>CUPS_GROUP</td>
1.232 gutterid 12408: <td>CUPS_SYSTEM_GROUPS</td>
1.177 leot 12409: </tr>
12410: <tr>
1.256 wiz 12411: <td>CUPS_USER</td>
1.232 gutterid 12412: <td>CURSES_DEFAULT</td>
1.227 wiz 12413: </tr>
12414: <tr>
1.256 wiz 12415: <td>CURSES_TYPE</td>
1.258 wiz 12416: <td>CVS_EXTRACTDIR</td>
12417: </tr>
12418: <tr>
12419: <td>CVS_MODULE</td>
12420: <td>CVS_PROJECT</td>
12421: </tr>
12422: <tr>
12423: <td>CVS_REPOSITORIES</td>
12424: <td>CVS_ROOT</td>
12425: </tr>
12426: <tr>
12427: <td>CVS_ROOT_GNU</td>
12428: <td>CVS_ROOT_NONGNU</td>
12429: </tr>
12430: <tr>
12431: <td>CVS_ROOT_SOURCEFORGE</td>
12432: <td>CVS_TAG</td>
12433: </tr>
12434: <tr>
1.257 jkoshy 12435: <td>CXX</td>
1.258 wiz 12436: <td>CYRUS_GROUP</td>
1.254 wiz 12437: </tr>
12438: <tr>
1.257 jkoshy 12439: <td>CYRUS_IDLE</td>
1.258 wiz 12440: <td>CYRUS_USER</td>
1.246 leot 12441: </tr>
12442: <tr>
1.257 jkoshy 12443: <td>DAEMONTOOLS_GROUP</td>
1.258 wiz 12444: <td>DAEMONTOOLS_LOG_USER</td>
1.238 wiz 12445: </tr>
12446: <tr>
1.257 jkoshy 12447: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.258 wiz 12448: <td>DARWIN_REQUIRES_FILTER</td>
1.233 wiz 12449: </tr>
12450: <tr>
1.257 jkoshy 12451: <td>DBUS_GROUP</td>
1.258 wiz 12452: <td>DBUS_USER</td>
1.217 rillig 12453: </tr>
12454: <tr>
1.257 jkoshy 12455: <td>DEFANG_GROUP</td>
1.258 wiz 12456: <td>DEFANG_USER</td>
1.214 leot 12457: </tr>
12458: <tr>
1.257 jkoshy 12459: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.258 wiz 12460: <td>DEFAULT_DISTFILES</td>
1.212 wiz 12461: </tr>
12462: <tr>
1.257 jkoshy 12463: <td>DEFAULT_IRC_SERVER</td>
1.258 wiz 12464: <td>DEFAULT_SERIAL_DEVICE</td>
1.205 wiz 12465: </tr>
12466: <tr>
1.257 jkoshy 12467: <td>DEF_UMASK</td>
1.258 wiz 12468: <td>DEINSTALLDEPENDS</td>
1.197 leot 12469: </tr>
12470: <tr>
1.257 jkoshy 12471: <td>DEINSTALL_SRC</td>
1.258 wiz 12472: <td>DEINSTALL_TEMPLATES</td>
1.159 rillig 12473: </tr>
12474: <tr>
1.257 jkoshy 12475: <td>DELAYED_ERROR_MSG</td>
1.258 wiz 12476: <td>DELAYED_WARNING_MSG</td>
1.156 leot 12477: </tr>
12478: <tr>
1.257 jkoshy 12479: <td>DEPENDS</td>
1.258 wiz 12480: <td>DEPENDS_TARGET</td>
1.156 leot 12481: </tr>
12482: <tr>
1.257 jkoshy 12483: <td>DEPENDS_TYPE</td>
1.258 wiz 12484: <td>DESTDIR</td>
1.195 gutterid 12485: </tr>
12486: <tr>
1.257 jkoshy 12487: <td>DESTDIR_VARNAME</td>
1.258 wiz 12488: <td>DIALER_GROUP</td>
1.156 leot 12489: </tr>
12490: <tr>
1.257 jkoshy 12491: <td>DIGEST_REQD</td>
1.258 wiz 12492: <td>DISTDIR</td>
1.156 leot 12493: </tr>
12494: <tr>
1.257 jkoshy 12495: <td>DISTFILES</td>
1.258 wiz 12496: <td>DISTINFO_FILE</td>
1.156 leot 12497: </tr>
12498: <tr>
1.257 jkoshy 12499: <td>DISTNAME</td>
1.258 wiz 12500: <td>DIST_PATH</td>
1.156 leot 12501: </tr>
12502: <tr>
1.257 jkoshy 12503: <td>DIST_SUBDIR</td>
1.258 wiz 12504: <td>DJBDNS_AXFR_USER</td>
1.156 leot 12505: </tr>
12506: <tr>
1.257 jkoshy 12507: <td>DJBDNS_CACHE_USER</td>
1.258 wiz 12508: <td>DJBDNS_DJBDNS_GROUP</td>
1.156 leot 12509: </tr>
12510: <tr>
1.257 jkoshy 12511: <td>DJBDNS_LOG_USER</td>
1.258 wiz 12512: <td>DJBDNS_RBL_USER</td>
1.156 leot 12513: </tr>
12514: <tr>
1.257 jkoshy 12515: <td>DJBDNS_TINY_USER</td>
1.258 wiz 12516: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.156 leot 12517: </tr>
12518: <tr>
1.257 jkoshy 12519: <td>DL_AUTO_VARS</td>
1.258 wiz 12520: <td>DL_CFLAGS</td>
1.156 leot 12521: </tr>
12522: <tr>
1.257 jkoshy 12523: <td>DL_LDFLAGS</td>
1.258 wiz 12524: <td>DL_LIBS</td>
1.156 leot 12525: </tr>
12526: <tr>
1.257 jkoshy 12527: <td>DNS</td>
1.258 wiz 12528: <td>DOCOWN</td>
1.156 leot 12529: </tr>
12530: <tr>
1.257 jkoshy 12531: <td>DOWNLOADED_DISTFILE</td>
1.258 wiz 12532: <td>DQCACHE_GROUP</td>
1.156 leot 12533: </tr>
12534: <tr>
1.257 jkoshy 12535: <td>DQCACHE_USER</td>
1.258 wiz 12536: <td>DT_LAYOUT</td>
1.156 leot 12537: </tr>
12538: <tr>
1.257 jkoshy 12539: <td>DYNAMIC_SITES_CMD</td>
1.258 wiz 12540: <td>DYNAMIC_SITES_SCRIPT</td>
1.156 leot 12541: </tr>
12542: <tr>
1.257 jkoshy 12543: <td>ECHO</td>
1.258 wiz 12544: <td>ECHO_N</td>
1.156 leot 12545: </tr>
12546: <tr>
1.257 jkoshy 12547: <td>ELK_GUI</td>
1.258 wiz 12548: <td>EMACS_TYPE</td>
1.156 leot 12549: </tr>
12550: <tr>
1.257 jkoshy 12551: <td>EMULDIR</td>
1.258 wiz 12552: <td>EMULSUBDIR</td>
1.243 gutterid 12553: </tr>
12554: <tr>
1.257 jkoshy 12555: <td>EMULSUBDIRSLASH</td>
1.258 wiz 12556: <td>EMUL_ARCH</td>
1.218 nia 12557: </tr>
12558: <tr>
1.257 jkoshy 12559: <td>EMUL_DISTRO</td>
1.258 wiz 12560: <td>EMUL_EXEC_FMT</td>
1.156 leot 12561: </tr>
12562: <tr>
1.257 jkoshy 12563: <td>EMUL_IS_NATIVE</td>
1.258 wiz 12564: <td>EMUL_MODULES</td>
1.156 leot 12565: </tr>
12566: <tr>
1.257 jkoshy 12567: <td>EMUL_OPSYS</td>
1.258 wiz 12568: <td>EMUL_PKG_FMT</td>
1.156 leot 12569: </tr>
12570: <tr>
1.257 jkoshy 12571: <td>EMUL_PLATFORM</td>
1.258 wiz 12572: <td>EMUL_PLATFORMS</td>
1.156 leot 12573: </tr>
12574: <tr>
1.257 jkoshy 12575: <td>EMUL_PREFER</td>
1.258 wiz 12576: <td>EMUL_REQD</td>
1.156 leot 12577: </tr>
12578: <tr>
1.257 jkoshy 12579: <td>EMUL_TYPE</td>
1.258 wiz 12580: <td>ERROR_MSG</td>
1.156 leot 12581: </tr>
12582: <tr>
1.257 jkoshy 12583: <td>EXIM_GROUP</td>
1.258 wiz 12584: <td>EXIM_USER</td>
1.156 leot 12585: </tr>
12586: <tr>
1.257 jkoshy 12587: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.258 wiz 12588: <td>EXTRACTOR</td>
1.156 leot 12589: </tr>
12590: <tr>
1.257 jkoshy 12591: <td>EXTRACT_CMD</td>
1.258 wiz 12592: <td>EXTRACT_CMD_DEFAULT</td>
1.156 leot 12593: </tr>
12594: <tr>
1.257 jkoshy 12595: <td>EXTRACT_DIR</td>
1.258 wiz 12596: <td>EXTRACT_ELEMENTS</td>
1.156 leot 12597: </tr>
12598: <tr>
1.257 jkoshy 12599: <td>EXTRACT_ENV</td>
1.258 wiz 12600: <td>EXTRACT_ONLY</td>
1.156 leot 12601: </tr>
12602: <tr>
1.257 jkoshy 12603: <td>EXTRACT_OPTS</td>
1.258 wiz 12604: <td>EXTRACT_SUFX</td>
1.156 leot 12605: </tr>
12606: <tr>
1.257 jkoshy 12607: <td>EXTRACT_USING</td>
1.258 wiz 12608: <td>FAIL</td>
1.156 leot 12609: </tr>
12610: <tr>
1.257 jkoshy 12611: <td>FAILOVER_FETCH</td>
1.258 wiz 12612: <td>FAIL_MSG</td>
1.223 nia 12613: </tr>
12614: <tr>
1.257 jkoshy 12615: <td>FAKE_NCURSES</td>
1.258 wiz 12616: <td>FAM</td>
1.156 leot 12617: </tr>
12618: <tr>
1.257 jkoshy 12619: <td>FAM_ACCEPTED</td>
1.258 wiz 12620: <td>FAM_DEFAULT</td>
1.156 leot 12621: </tr>
12622: <tr>
1.257 jkoshy 12623: <td>FAM_SERVER</td>
1.258 wiz 12624: <td>FCPATH</td>
1.156 leot 12625: </tr>
12626: <tr>
1.258 wiz 12627: <td>FETCH_AFTER_ARGS</td>
1.260 wiz 12628: <td>FETCH_BEFORE_ARGS</td>
1.156 leot 12629: </tr>
12630: <tr>
1.258 wiz 12631: <td>FETCH_CMD</td>
1.260 wiz 12632: <td>FETCH_INSECURE</td>
1.156 leot 12633: </tr>
12634: <tr>
1.257 jkoshy 12635: <td>FETCH_OUTPUT_ARGS</td>
1.260 wiz 12636: <td>FETCH_PROXY</td>
1.259 leot 12637: </tr>
12638: <tr>
12639: <td>FETCH_RESUME_ARGS</td>
1.260 wiz 12640: <td>FETCH_TIMEOUT</td>
1.156 leot 12641: </tr>
12642: <tr>
1.259 leot 12643: <td>FETCH_USE_IPV4_ONLY</td>
1.260 wiz 12644: <td>FETCH_USING</td>
1.156 leot 12645: </tr>
12646: <tr>
1.259 leot 12647: <td>FILES_SUBST</td>
1.260 wiz 12648: <td>FILES_SUBST_SED</td>
1.156 leot 12649: </tr>
12650: <tr>
1.259 leot 12651: <td>FIX_SYSTEM_HEADERS</td>
1.260 wiz 12652: <td>FONTDIR</td>
1.177 leot 12653: </tr>
12654: <tr>
1.259 leot 12655: <td>FONTS_DIRS</td>
1.260 wiz 12656: <td>FONTS_VERBOSE</td>
1.156 leot 12657: </tr>
12658: <tr>
1.259 leot 12659: <td>FOO_HACKS_MK</td>
1.260 wiz 12660: <td>FORCE_CXX_STD</td>
1.177 leot 12661: </tr>
12662: <tr>
1.259 leot 12663: <td>FORCE_C_STD</td>
1.260 wiz 12664: <td>FOSSIL_EXTRACTDIR</td>
1.244 gutterid 12665: </tr>
12666: <tr>
1.259 leot 12667: <td>FOSSIL_REPO</td>
1.260 wiz 12668: <td>FOSSIL_REPOSITORIES</td>
1.258 wiz 12669: </tr>
12670: <tr>
1.259 leot 12671: <td>FOSSIL_VERSION</td>
1.260 wiz 12672: <td>FOX_USE_XUNICODE</td>
1.258 wiz 12673: </tr>
12674: <tr>
1.259 leot 12675: <td>FREEWNN_GROUP</td>
1.260 wiz 12676: <td>FREEWNN_USER</td>
1.156 leot 12677: </tr>
12678: <tr>
1.259 leot 12679: <td>FTP_PKG_URL_DIR</td>
1.260 wiz 12680: <td>FTP_PKG_URL_HOST</td>
1.156 leot 12681: </tr>
12682: <tr>
1.259 leot 12683: <td>GAMEDATAMODE</td>
1.260 wiz 12684: <td>GAMEDATA_PERMS</td>
1.156 leot 12685: </tr>
12686: <tr>
1.259 leot 12687: <td>GAMEDIRMODE</td>
1.260 wiz 12688: <td>GAMEDIR_PERMS</td>
1.156 leot 12689: </tr>
12690: <tr>
1.259 leot 12691: <td>GAMEGRP</td>
1.260 wiz 12692: <td>GAMEMODE</td>
1.156 leot 12693: </tr>
12694: <tr>
1.259 leot 12695: <td>GAMEOWN</td>
1.260 wiz 12696: <td>GAMES_GROUP</td>
1.156 leot 12697: </tr>
12698: <tr>
1.259 leot 12699: <td>GAMES_USER</td>
1.260 wiz 12700: <td>GCC</td>
1.156 leot 12701: </tr>
12702: <tr>
1.259 leot 12703: <td>GCCBASE</td>
1.260 wiz 12704: <td>GCC_REQD</td>
1.156 leot 12705: </tr>
12706: <tr>
1.259 leot 12707: <td>GCC_VERSION_SUFFIX</td>
1.260 wiz 12708: <td>GEM_BUILD</td>
1.156 leot 12709: </tr>
12710: <tr>
1.259 leot 12711: <td>GEM_CLEANBUILD</td>
1.260 wiz 12712: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.156 leot 12713: </tr>
12714: <tr>
1.259 leot 12715: <td>GEM_DOCDIR</td>
1.260 wiz 12716: <td>GEM_EXTSDIR</td>
1.156 leot 12717: </tr>
12718: <tr>
1.259 leot 12719: <td>GEM_HOME</td>
1.260 wiz 12720: <td>GEM_KEEPBUILD</td>
1.256 wiz 12721: </tr>
12722: <tr>
1.259 leot 12723: <td>GEM_LIBDIR</td>
1.260 wiz 12724: <td>GEM_NAME</td>
1.177 leot 12725: </tr>
12726: <tr>
1.259 leot 12727: <td>GEM_PATH</td>
1.260 wiz 12728: <td>GEM_PLUGINSDIR</td>
1.156 leot 12729: </tr>
12730: <tr>
1.259 leot 12731: <td>GEM_SPECFILE</td>
1.260 wiz 12732: <td>GENERATE_PLIST</td>
1.156 leot 12733: </tr>
12734: <tr>
1.259 leot 12735: <td>GHC</td>
1.260 wiz 12736: <td>GHOSTSCRIPT_REQD</td>
1.198 leot 12737: </tr>
12738: <tr>
1.259 leot 12739: <td>GITHUB_PROJECT</td>
1.260 wiz 12740: <td>GITHUB_RELEASE</td>
1.156 leot 12741: </tr>
12742: <tr>
1.259 leot 12743: <td>GITHUB_SUBMODULES</td>
1.260 wiz 12744: <td>GITHUB_TAG</td>
1.156 leot 12745: </tr>
12746: <tr>
1.259 leot 12747: <td>GITHUB_TYPE</td>
1.260 wiz 12748: <td>GITLAB_PROJECT</td>
1.177 leot 12749: </tr>
12750: <tr>
1.259 leot 12751: <td>GITLAB_RELEASE</td>
1.260 wiz 12752: <td>GITLAB_SUBMODULES</td>
1.159 rillig 12753: </tr>
12754: <tr>
1.259 leot 12755: <td>GITLAB_TAG</td>
1.260 wiz 12756: <td>GITLAB_TYPE</td>
1.223 nia 12757: </tr>
12758: <tr>
1.259 leot 12759: <td>GIT_BRANCH</td>
1.260 wiz 12760: <td>GIT_ENV</td>
1.223 nia 12761: </tr>
12762: <tr>
1.259 leot 12763: <td>GIT_EXTRACTDIR</td>
1.260 wiz 12764: <td>GIT_REPO</td>
1.258 wiz 12765: </tr>
12766: <tr>
1.259 leot 12767: <td>GIT_REPOSITORIES</td>
1.260 wiz 12768: <td>GIT_REVISION</td>
1.258 wiz 12769: </tr>
12770: <tr>
1.259 leot 12771: <td>GIT_TAG</td>
1.260 wiz 12772: <td>GNU</td>
1.258 wiz 12773: </tr>
12774: <tr>
1.259 leot 12775: <td>GNU_CONFIGURE</td>
1.260 wiz 12776: <td>GNU_CONFIGURE_ICONV</td>
1.258 wiz 12777: </tr>
12778: <tr>
1.259 leot 12779: <td>GNU_CONFIGURE_INFODIR</td>
1.260 wiz 12780: <td>GNU_CONFIGURE_MANDIR</td>
1.254 wiz 12781: </tr>
12782: <tr>
1.259 leot 12783: <td>GNU_CONFIGURE_QUIET</td>
1.260 wiz 12784: <td>GNU_CONFIGURE_STRICT</td>
1.254 wiz 12785: </tr>
12786: <tr>
1.259 leot 12787: <td>GODEP_REDIRECTS</td>
1.260 wiz 12788: <td>GO_BUILD_PATTERN</td>
1.246 leot 12789: </tr>
12790: <tr>
1.259 leot 12791: <td>GO_DEPS</td>
1.260 wiz 12792: <td>GO_DIST_BASE</td>
1.241 rillig 12793: </tr>
12794: <tr>
1.259 leot 12795: <td>GO_EXTRA_MOD_DIRS</td>
1.260 wiz 12796: <td>GO_MODULE_EXTRACT</td>
1.233 wiz 12797: </tr>
12798: <tr>
1.259 leot 12799: <td>GO_MODULE_FILES</td>
1.260 wiz 12800: <td>GO_SRCPATH</td>
1.156 leot 12801: </tr>
12802: <tr>
1.259 leot 12803: <td>GROUP_SPECIFIC_PKGS</td>
1.260 wiz 12804: <td>GRUB_NETWORK_CARDS</td>
1.156 leot 12805: </tr>
12806: <tr>
1.259 leot 12807: <td>GRUB_PRESET_COMMAND</td>
1.260 wiz 12808: <td>GRUB_SCAN_ARGS</td>
1.156 leot 12809: </tr>
12810: <tr>
1.259 leot 12811: <td>GZIP</td>
1.260 wiz 12812: <td>HASKELL_COMPILER</td>
1.238 wiz 12813: </tr>
12814: <tr>
1.259 leot 12815: <td>HASKELL_DISABLE_EXECUTABLES</td>
1.260 wiz 12816: <td>HASKELL_DISABLE_LIBRARIES</td>
1.156 leot 12817: </tr>
12818: <tr>
1.259 leot 12819: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.260 wiz 12820: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.156 leot 12821: </tr>
12822: <tr>
1.259 leot 12823: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.260 wiz 12824: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.217 rillig 12825: </tr>
12826: <tr>
1.259 leot 12827: <td>HASKELL_ENABLE_TESTS</td>
1.260 wiz 12828: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.226 gutterid 12829: </tr>
12830: <tr>
1.259 leot 12831: <td>HASKELL_PKG_NAME</td>
1.260 wiz 12832: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
1.220 nia 12833: </tr>
12834: <tr>
1.259 leot 12835: <td>HEADER_TEMPLATES</td>
1.260 wiz 12836: <td>HG_REPO</td>
1.229 gutterid 12837: </tr>
12838: <tr>
1.259 leot 12839: <td>HG_REPOSITORIES</td>
1.260 wiz 12840: <td>HG_TAG</td>
1.258 wiz 12841: </tr>
12842: <tr>
1.259 leot 12843: <td>HOMEPAGE</td>
1.260 wiz 12844: <td>HOST_PKGTOOLS_ARGS</td>
1.258 wiz 12845: </tr>
12846: <tr>
1.259 leot 12847: <td>HOST_SPECIFIC_PKGS</td>
1.260 wiz 12848: <td>HOWL_GROUP</td>
1.246 leot 12849: </tr>
12850: <tr>
1.259 leot 12851: <td>HOWL_USER</td>
1.260 wiz 12852: <td>ICCBASE</td>
1.241 rillig 12853: </tr>
12854: <tr>
1.259 leot 12855: <td>ICECAST_CHROOTDIR</td>
1.260 wiz 12856: <td>ICON_THEMES</td>
1.233 wiz 12857: </tr>
12858: <tr>
1.259 leot 12859: <td>IDOBASE</td>
1.260 wiz 12860: <td>IGNORE_CCACHE</td>
1.227 wiz 12861: </tr>
12862: <tr>
1.259 leot 12863: <td>IGNORE_INFO_DIRS</td>
1.260 wiz 12864: <td>IGNORE_INTERACTIVE_FETCH</td>
1.223 nia 12865: </tr>
12866: <tr>
1.259 leot 12867: <td>IMAKE</td>
1.260 wiz 12868: <td>IMAKEOPTS</td>
1.156 leot 12869: </tr>
12870: <tr>
1.259 leot 12871: <td>IMAKE_MAKE</td>
1.260 wiz 12872: <td>IMAKE_MANINSTALL</td>
1.156 leot 12873: </tr>
12874: <tr>
1.259 leot 12875: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.260 wiz 12876: <td>IMDICTDIR</td>
1.191 bacon 12877: </tr>
12878: <tr>
1.259 leot 12879: <td>INCOMPAT_CURSES</td>
1.260 wiz 12880: <td>INFO_DIR</td>
1.156 leot 12881: </tr>
12882: <tr>
1.259 leot 12883: <td>INFO_FILES</td>
1.260 wiz 12884: <td>INFO_MSG</td>
1.156 leot 12885: </tr>
12886: <tr>
1.259 leot 12887: <td>INIT_SYSTEM</td>
1.260 wiz 12888: <td>INN_DATA_DIR</td>
1.156 leot 12889: </tr>
12890: <tr>
1.259 leot 12891: <td>INN_GROUP</td>
1.260 wiz 12892: <td>INN_USER</td>
1.156 leot 12893: </tr>
12894: <tr>
1.259 leot 12895: <td>INSTALLATION_DIRS</td>
1.260 wiz 12896: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.156 leot 12897: </tr>
12898: <tr>
1.259 leot 12899: <td>INSTALL_ENV</td>
1.260 wiz 12900: <td>INSTALL_ENV_SHELL</td>
1.156 leot 12901: </tr>
12902: <tr>
1.258 wiz 12903: <td>INSTALL_SH_OVERRIDE</td>
1.259 leot 12904: <td>INSTALL_SRC</td>
1.156 leot 12905: </tr>
12906: <tr>
1.258 wiz 12907: <td>INSTALL_TEMPLATES</td>
1.259 leot 12908: <td>INSTALL_UNSTRIPPED</td>
1.156 leot 12909: </tr>
12910: <tr>
1.258 wiz 12911: <td>IRCD_HYBRID_IRC_GROUP</td>
1.259 leot 12912: <td>IRCD_HYBRID_IRC_USER</td>
1.254 wiz 12913: </tr>
12914: <tr>
1.258 wiz 12915: <td>IRCD_HYBRID_MAXCONN</td>
1.259 leot 12916: <td>IRCD_HYBRID_NICLEN</td>
1.172 rillig 12917: </tr>
12918: <tr>
1.258 wiz 12919: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.259 leot 12920: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.156 leot 12921: </tr>
12922: <tr>
1.258 wiz 12923: <td>IRCD_HYBRID_TOPICLEN</td>
1.259 leot 12924: <td>IRIX</td>
1.156 leot 12925: </tr>
12926: <tr>
1.258 wiz 12927: <td>IRRD_USE_PGP</td>
1.259 leot 12928: <td>JABBERD_GROUP</td>
1.156 leot 12929: </tr>
12930: <tr>
1.258 wiz 12931: <td>JABBERD_LOGDIR</td>
1.259 leot 12932: <td>JABBERD_PIDDIR</td>
1.156 leot 12933: </tr>
12934: <tr>
1.258 wiz 12935: <td>JABBERD_SPOOLDIR</td>
1.259 leot 12936: <td>JABBERD_USER</td>
1.156 leot 12937: </tr>
12938: <tr>
1.258 wiz 12939: <td>JAVA_APP_PATH</td>
1.259 leot 12940: <td>JAVA_APP_TARGETS</td>
1.156 leot 12941: </tr>
12942: <tr>
1.255 wiz 12943: <td>JAVA_BINPREFIX</td>
1.259 leot 12944: <td>JAVA_CLASSPATH</td>
1.258 wiz 12945: </tr>
12946: <tr>
12947: <td>JAVA_HOME</td>
1.259 leot 12948: <td>JAVA_LD_LIBRARY_PATH</td>
1.246 leot 12949: </tr>
12950: <tr>
1.258 wiz 12951: <td>JAVA_NAME</td>
1.259 leot 12952: <td>JAVA_UNLIMIT</td>
1.156 leot 12953: </tr>
12954: <tr>
1.258 wiz 12955: <td>JAVA_WRAPPERS</td>
1.259 leot 12956: <td>JPEG_ACCEPTED</td>
1.233 wiz 12957: </tr>
12958: <tr>
1.258 wiz 12959: <td>JPEG_DEFAULT</td>
1.259 leot 12960: <td>KERBEROS</td>
1.156 leot 12961: </tr>
12962: <tr>
1.258 wiz 12963: <td>KERMIT_SUID_UUCP</td>
1.259 leot 12964: <td>KJS_USE_PCRE</td>
1.227 wiz 12965: </tr>
12966: <tr>
1.258 wiz 12967: <td>KNEWS_DOMAIN_FILE</td>
1.259 leot 12968: <td>KNEWS_DOMAIN_NAME</td>
1.177 leot 12969: </tr>
12970: <tr>
1.258 wiz 12971: <td>KRB5_ACCEPTED</td>
1.259 leot 12972: <td>KRB5_DEFAULT</td>
1.156 leot 12973: </tr>
12974: <tr>
1.258 wiz 12975: <td>LANGUAGES</td>
1.259 leot 12976: <td>LAPACKE_LIBS</td>
1.217 rillig 12977: </tr>
12978: <tr>
1.258 wiz 12979: <td>LAPACKE_PC</td>
1.259 leot 12980: <td>LAPACK_LIBS</td>
1.156 leot 12981: </tr>
12982: <tr>
1.258 wiz 12983: <td>LAPACK_PC</td>
1.259 leot 12984: <td>LATEX2HTML_ICONPATH</td>
1.156 leot 12985: </tr>
12986: <tr>
1.258 wiz 12987: <td>LDCONFIG_ADD_CMD</td>
1.259 leot 12988: <td>LDCONFIG_REMOVE_CMD</td>
1.156 leot 12989: </tr>
12990: <tr>
1.258 wiz 12991: <td>LDD</td>
1.259 leot 12992: <td>LEAFNODE_DATA_DIR</td>
1.156 leot 12993: </tr>
12994: <tr>
1.258 wiz 12995: <td>LEAFNODE_GROUP</td>
1.259 leot 12996: <td>LEAFNODE_USER</td>
1.156 leot 12997: </tr>
12998: <tr>
1.258 wiz 12999: <td>LIBDVDCSS_HOMEPAGE</td>
1.259 leot 13000: <td>LIBDVDCSS_MASTER_SITES</td>
1.177 leot 13001: </tr>
13002: <tr>
1.258 wiz 13003: <td>LIBIMAGEQUANT_TYPE</td>
1.259 leot 13004: <td>LIBRSVG_TYPE</td>
1.156 leot 13005: </tr>
13006: <tr>
1.258 wiz 13007: <td>LIBTOOL</td>
1.259 leot 13008: <td>LIBTOOLIZE_PLIST</td>
1.156 leot 13009: </tr>
13010: <tr>
1.258 wiz 13011: <td>LIBTOOL_M4_OVERRIDE</td>
1.259 leot 13012: <td>LIBUSB_TYPE</td>
1.156 leot 13013: </tr>
13014: <tr>
1.258 wiz 13015: <td>LICENSE</td>
1.259 leot 13016: <td>LINKER_RPATH_FLAG</td>
1.156 leot 13017: </tr>
13018: <tr>
1.258 wiz 13019: <td>LINK_RPATH_FLAG</td>
1.259 leot 13020: <td>LINUX_BASE_NODEPS</td>
1.254 wiz 13021: </tr>
13022: <tr>
1.258 wiz 13023: <td>LINUX_BASE_PREFERRED</td>
1.259 leot 13024: <td>LINUX_BASE_REQUIRED</td>
1.258 wiz 13025: </tr>
13026: <tr>
1.257 jkoshy 13027: <td>LINUX_LOCALES</td>
1.259 leot 13028: <td>LOCALBASE</td>
1.241 rillig 13029: </tr>
13030: <tr>
1.257 jkoshy 13031: <td>LOCALBASE_LOCKTYPE</td>
1.259 leot 13032: <td>LOCALPATCHES</td>
1.156 leot 13033: </tr>
13034: <tr>
1.257 jkoshy 13035: <td>LOVE_DATA</td>
1.259 leot 13036: <td>LOVE_GAME</td>
1.255 wiz 13037: </tr>
13038: <tr>
1.257 jkoshy 13039: <td>LOVE_VERSION</td>
1.259 leot 13040: <td>LOWER_OPSYS</td>
1.238 wiz 13041: </tr>
13042: <tr>
1.257 jkoshy 13043: <td>LOWER_OPSYS_VERSUFFIX</td>
1.259 leot 13044: <td>LOWER_VARIANT_VERSION</td>
1.255 wiz 13045: </tr>
13046: <tr>
1.257 jkoshy 13047: <td>LOWER_VENDOR</td>
1.259 leot 13048: <td>LP32PLATFORMS</td>
1.223 nia 13049: </tr>
13050: <tr>
1.257 jkoshy 13051: <td>LP64PLATFORMS</td>
1.259 leot 13052: <td>LUA_BUSTED_ARGS</td>
1.177 leot 13053: </tr>
13054: <tr>
1.257 jkoshy 13055: <td>LUA_CDIR</td>
1.259 leot 13056: <td>LUA_COMPILER</td>
1.214 leot 13057: </tr>
13058: <tr>
1.257 jkoshy 13059: <td>LUA_DOCDIR</td>
1.259 leot 13060: <td>LUA_EXAMPLESDIR</td>
1.197 leot 13061: </tr>
13062: <tr>
1.257 jkoshy 13063: <td>LUA_INCDIR</td>
1.259 leot 13064: <td>LUA_INTERPRETER</td>
1.156 leot 13065: </tr>
13066: <tr>
1.257 jkoshy 13067: <td>LUA_LDIR</td>
1.259 leot 13068: <td>LUA_LINKER_MAGIC</td>
1.156 leot 13069: </tr>
13070: <tr>
1.257 jkoshy 13071: <td>LUA_PKGPREFIX</td>
1.259 leot 13072: <td>LUA_SELF_CONFLICT</td>
1.221 nia 13073: </tr>
13074: <tr>
1.257 jkoshy 13075: <td>LUA_USE_BUSTED</td>
1.259 leot 13076: <td>LUA_VERSIONS_ACCEPTED</td>
1.218 nia 13077: </tr>
13078: <tr>
1.257 jkoshy 13079: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.259 leot 13080: <td>LUA_VERSION_DEFAULT</td>
1.218 nia 13081: </tr>
13082: <tr>
1.257 jkoshy 13083: <td>LUA_VERSION_REQD</td>
1.259 leot 13084: <td>Lua</td>
1.218 nia 13085: </tr>
13086: <tr>
1.257 jkoshy 13087: <td>MACHINE_PLATFORM</td>
1.259 leot 13088: <td>MAILAGENT_DOMAIN</td>
1.218 nia 13089: </tr>
13090: <tr>
1.257 jkoshy 13091: <td>MAILAGENT_EMAIL</td>
1.259 leot 13092: <td>MAILAGENT_FQDN</td>
1.218 nia 13093: </tr>
13094: <tr>
1.257 jkoshy 13095: <td>MAILAGENT_ORGANIZATION</td>
1.259 leot 13096: <td>MAJORDOMO_HOMEDIR</td>
1.218 nia 13097: </tr>
13098: <tr>
1.258 wiz 13099: <td>MAJOR_OS_VERSION</td>
1.259 leot 13100: <td>MAKEINFO_ARGS</td>
1.258 wiz 13101: </tr>
13102: <tr>
13103: <td>MAKE_DIRS</td>
1.259 leot 13104: <td>MAKE_DIRS_PERMS</td>
1.246 leot 13105: </tr>
13106: <tr>
1.258 wiz 13107: <td>MAKE_ENV</td>
1.259 leot 13108: <td>MAKE_FILE</td>
1.205 wiz 13109: </tr>
13110: <tr>
1.258 wiz 13111: <td>MAKE_FLAGS</td>
1.259 leot 13112: <td>MAKE_JOBS</td>
1.233 wiz 13113: </tr>
13114: <tr>
1.258 wiz 13115: <td>MAKE_JOBS_SAFE</td>
1.259 leot 13116: <td>MAKE_PROGRAM</td>
1.227 wiz 13117: </tr>
13118: <tr>
1.258 wiz 13119: <td>MANCOMPRESSED_IF_MANZ</td>
1.259 leot 13120: <td>MANINSTALL</td>
1.156 leot 13121: </tr>
13122: <tr>
1.258 wiz 13123: <td>MANZ</td>
1.259 leot 13124: <td>MARIADB_VERSIONS_ALL</td>
1.212 wiz 13125: </tr>
13126: <tr>
1.258 wiz 13127: <td>MASTER_SITES</td>
1.259 leot 13128: <td>MASTER_SITE_BACKUP</td>
1.156 leot 13129: </tr>
13130: <tr>
1.258 wiz 13131: <td>MASTER_SITE_LOCAL</td>
1.259 leot 13132: <td>MASTER_SITE_MOZILLA</td>
1.156 leot 13133: </tr>
13134: <tr>
1.258 wiz 13135: <td>MASTER_SITE_OVERRIDE</td>
1.259 leot 13136: <td>MASTER_SITE_PERL_CPAN</td>
1.156 leot 13137: </tr>
13138: <tr>
1.258 wiz 13139: <td>MASTER_SORT</td>
1.259 leot 13140: <td>MASTER_SORT_RANDOM</td>
1.156 leot 13141: </tr>
13142: <tr>
1.258 wiz 13143: <td>MASTER_SORT_REGEX</td>
1.259 leot 13144: <td>MECAB_CHARSET</td>
1.189 bacon 13145: </tr>
13146: <tr>
1.258 wiz 13147: <td>MEDIATOMB_GROUP</td>
1.259 leot 13148: <td>MEDIATOMB_USER</td>
1.156 leot 13149: </tr>
13150: <tr>
1.258 wiz 13151: <td>MIPSPROBASE</td>
1.259 leot 13152: <td>MIREDO_GROUP</td>
1.156 leot 13153: </tr>
13154: <tr>
1.258 wiz 13155: <td>MIREDO_USER</td>
1.259 leot 13156: <td>MISSING_FEATURES</td>
1.156 leot 13157: </tr>
13158: <tr>
1.258 wiz 13159: <td>MKDIR</td>
1.259 leot 13160: <td>MKPIE_SUPPORTED</td>
1.156 leot 13161: </tr>
13162: <tr>
1.258 wiz 13163: <td>MLDONKEY_GROUP</td>
1.259 leot 13164: <td>MLDONKEY_HOME</td>
1.156 leot 13165: </tr>
13166: <tr>
1.258 wiz 13167: <td>MLDONKEY_USER</td>
1.259 leot 13168: <td>MONOTONE_GROUP</td>
1.156 leot 13169: </tr>
13170: <tr>
1.258 wiz 13171: <td>MONOTONE_USER</td>
1.259 leot 13172: <td>MOTIFBASE</td>
1.156 leot 13173: </tr>
13174: <tr>
1.258 wiz 13175: <td>MOTIF_TYPE</td>
1.259 leot 13176: <td>MOTIF_TYPE_DEFAULT</td>
1.156 leot 13177: </tr>
13178: <tr>
1.258 wiz 13179: <td>MPI_TYPE</td>
1.259 leot 13180: <td>MSGFMT_STRIP_MSGCTXT</td>
1.156 leot 13181: </tr>
13182: <tr>
1.258 wiz 13183: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.259 leot 13184: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.207 leot 13185: </tr>
13186: <tr>
1.258 wiz 13187: <td>MUST</td>
1.259 leot 13188: <td>MV</td>
1.241 rillig 13189: </tr>
13190: <tr>
1.257 jkoshy 13191: <td>MYSQL_CHARSET</td>
1.259 leot 13192: <td>MYSQL_DATADIR</td>
1.156 leot 13193: </tr>
13194: <tr>
1.257 jkoshy 13195: <td>MYSQL_EXTRA_CHARSET</td>
1.259 leot 13196: <td>MYSQL_GROUP</td>
1.238 wiz 13197: </tr>
13198: <tr>
1.257 jkoshy 13199: <td>MYSQL_USER</td>
1.259 leot 13200: <td>MYSQL_VERSION</td>
1.223 nia 13201: </tr>
13202: <tr>
1.257 jkoshy 13203: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.259 leot 13204: <td>MYSQL_VERSION_DEFAULT</td>
1.214 leot 13205: </tr>
13206: <tr>
1.257 jkoshy 13207: <td>NAGIOSCMD_GROUP</td>
1.259 leot 13208: <td>NAGIOSDIR</td>
1.197 leot 13209: </tr>
13210: <tr>
1.257 jkoshy 13211: <td>NAGIOS_GROUP</td>
1.259 leot 13212: <td>NAGIOS_USER</td>
1.205 wiz 13213: </tr>
13214: <tr>
1.257 jkoshy 13215: <td>NATIVE_EXEC_FMT</td>
1.259 leot 13216: <td>NATIVE_LOWER_OPSYS</td>
1.156 leot 13217: </tr>
13218: <tr>
1.257 jkoshy 13219: <td>NATIVE_LOWER_VENDOR</td>
1.259 leot 13220: <td>NATIVE_MACHINE_PLATFORM</td>
1.156 leot 13221: </tr>
13222: <tr>
1.257 jkoshy 13223: <td>NATIVE_OBJECT_FMT</td>
1.259 leot 13224: <td>NATIVE_OPSYS_VERSION</td>
1.156 leot 13225: </tr>
13226: <tr>
1.257 jkoshy 13227: <td>NATIVE_OS_VARIANT</td>
1.259 leot 13228: <td>NATIVE_OS_VERSION</td>
1.255 wiz 13229: </tr>
13230: <tr>
1.257 jkoshy 13231: <td>NBPAX_PROGRAM_PREFIX</td>
1.259 leot 13232: <td>NETBSD_LOGIN_NAME</td>
1.255 wiz 13233: </tr>
13234: <tr>
1.257 jkoshy 13235: <td>NMH_EDITOR</td>
1.259 leot 13236: <td>NMH_MTA</td>
1.156 leot 13237: </tr>
13238: <tr>
1.257 jkoshy 13239: <td>NMH_PAGER</td>
1.259 leot 13240: <td>NODE_VERSIONS_ACCEPTED</td>
1.195 gutterid 13241: </tr>
13242: <tr>
1.257 jkoshy 13243: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.259 leot 13244: <td>NODE_VERSION_DEFAULT</td>
1.156 leot 13245: </tr>
13246: <tr>
1.257 jkoshy 13247: <td>NODE_VERSION_REQD</td>
1.259 leot 13248: <td>NOLOGIN</td>
1.156 leot 13249: </tr>
13250: <tr>
1.257 jkoshy 13251: <td>NOTE</td>
1.259 leot 13252: <td>NOT_FOR_PLATFORM</td>
1.156 leot 13253: </tr>
13254: <tr>
1.257 jkoshy 13255: <td>NOT_PAX_ASLR_SAFE</td>
1.259 leot 13256: <td>NOT_PAX_MPROTECT_SAFE</td>
1.156 leot 13257: </tr>
13258: <tr>
1.257 jkoshy 13259: <td>NO_BUILD</td>
1.259 leot 13260: <td>NO_CHECKSUM</td>
1.156 leot 13261: </tr>
13262: <tr>
1.257 jkoshy 13263: <td>NO_CONFIGURE</td>
1.259 leot 13264: <td>NO_SKIP</td>
1.229 gutterid 13265: </tr>
13266: <tr>
1.260 wiz 13267: <td>NSD_GROUP</td>
13268: <td>NSD_LOG_FACILITY</td>
13269: </tr>
13270: <tr>
13271: <td>NSD_USER</td>
1.257 jkoshy 13272: <td>NS_PREFERRED</td>
1.218 nia 13273: </tr>
13274: <tr>
1.260 wiz 13275: <td>NULLMAILER_GROUP</td>
1.257 jkoshy 13276: <td>NULLMAILER_USER</td>
1.218 nia 13277: </tr>
13278: <tr>
1.260 wiz 13279: <td>OBJECT_FMT</td>
1.257 jkoshy 13280: <td>OBJHOSTNAME</td>
1.156 leot 13281: </tr>
13282: <tr>
1.260 wiz 13283: <td>OBJMACHINE</td>
1.257 jkoshy 13284: <td>OCAML_FINDLIB_DIRS</td>
1.178 rillig 13285: </tr>
13286: <tr>
1.260 wiz 13287: <td>OCAML_FINDLIB_REGISTER</td>
1.257 jkoshy 13288: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.156 leot 13289: </tr>
13290: <tr>
1.260 wiz 13291: <td>OCAML_SITELIBDIR</td>
1.257 jkoshy 13292: <td>OMF</td>
1.156 leot 13293: </tr>
13294: <tr>
1.260 wiz 13295: <td>ONLY_FOR_COMPILER</td>
1.257 jkoshy 13296: <td>ONLY_FOR_PLATFORM</td>
1.156 leot 13297: </tr>
13298: <tr>
1.260 wiz 13299: <td>OPENSSH_CHROOT</td>
1.257 jkoshy 13300: <td>OPENSSH_GROUP</td>
1.156 leot 13301: </tr>
13302: <tr>
1.260 wiz 13303: <td>OPENSSH_USER</td>
1.257 jkoshy 13304: <td>OPSYS</td>
1.156 leot 13305: </tr>
13306: <tr>
1.260 wiz 13307: <td>OPSYS_EMULDIR</td>
1.257 jkoshy 13308: <td>OPSYS_VERSION</td>
1.156 leot 13309: </tr>
13310: <tr>
1.260 wiz 13311: <td>OS</td>
1.257 jkoshy 13312: <td>OSS_TYPE</td>
1.156 leot 13313: </tr>
13314: <tr>
1.260 wiz 13315: <td>OSX</td>
1.257 jkoshy 13316: <td>OSX_PATH_TO_M4</td>
1.254 wiz 13317: </tr>
13318: <tr>
1.260 wiz 13319: <td>OSX_PATH_TO_YACC</td>
1.258 wiz 13320: <td>OS_HAVE_ALSA</td>
13321: </tr>
13322: <tr>
1.260 wiz 13323: <td>OS_HAVE_RCD</td>
1.257 jkoshy 13324: <td>OS_VARIANT</td>
1.254 wiz 13325: </tr>
13326: <tr>
1.260 wiz 13327: <td>OS_VERSION</td>
1.257 jkoshy 13328: <td>OTF_FONTS_DIR</td>
1.238 wiz 13329: </tr>
13330: <tr>
1.260 wiz 13331: <td>OVERRIDE_DIRDEPTH</td>
1.257 jkoshy 13332: <td>OVERRIDE_GEMSPEC</td>
1.156 leot 13333: </tr>
13334: <tr>
1.260 wiz 13335: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.258 wiz 13336: <td>OVERRIDE_ROCKSPEC</td>
13337: </tr>
13338: <tr>
1.260 wiz 13339: <td>OWN_DIRS</td>
1.258 wiz 13340: <td>OWN_DIRS_PERMS</td>
1.246 leot 13341: </tr>
13342: <tr>
1.260 wiz 13343: <td>P4GROUP</td>
1.258 wiz 13344: <td>P4PORT</td>
1.233 wiz 13345: </tr>
13346: <tr>
1.260 wiz 13347: <td>P4ROOT</td>
1.258 wiz 13348: <td>P4USER</td>
1.214 leot 13349: </tr>
13350: <tr>
1.260 wiz 13351: <td>PACKAGES</td>
1.258 wiz 13352: <td>PALMOS_DEFAULT_SDK</td>
1.227 wiz 13353: </tr>
13354: <tr>
1.260 wiz 13355: <td>PAMBASE</td>
1.258 wiz 13356: <td>PAM_DEFAULT</td>
1.205 wiz 13357: </tr>
13358: <tr>
1.260 wiz 13359: <td>PAPERSIZE</td>
1.258 wiz 13360: <td>PASSIVE_FETCH</td>
1.161 leot 13361: </tr>
13362: <tr>
1.260 wiz 13363: <td>PATCHDIR</td>
1.258 wiz 13364: <td>PATCHFILES</td>
1.156 leot 13365: </tr>
13366: <tr>
1.260 wiz 13367: <td>PATCH_ARGS</td>
1.258 wiz 13368: <td>PATCH_DEBUG</td>
1.156 leot 13369: </tr>
13370: <tr>
1.260 wiz 13371: <td>PATCH_DIST_ARGS</td>
1.258 wiz 13372: <td>PATCH_DIST_CAT</td>
1.156 leot 13373: </tr>
13374: <tr>
1.260 wiz 13375: <td>PATCH_DIST_STRIP</td>
1.258 wiz 13376: <td>PATCH_FUZZ_FACTOR</td>
1.156 leot 13377: </tr>
13378: <tr>
1.260 wiz 13379: <td>PATCH_STRIP</td>
1.258 wiz 13380: <td>PATH</td>
1.156 leot 13381: </tr>
13382: <tr>
1.260 wiz 13383: <td>PCCBASE</td>
1.258 wiz 13384: <td>PEAR</td>
1.254 wiz 13385: </tr>
13386: <tr>
1.260 wiz 13387: <td>PEAR_CHANNEL</td>
1.258 wiz 13388: <td>PEAR_CHANNEL_ALIAS</td>
13389: </tr>
13390: <tr>
1.260 wiz 13391: <td>PEAR_CHANNEL_VERSION</td>
1.256 wiz 13392: <td>PEAR_CMD</td>
1.258 wiz 13393: </tr>
13394: <tr>
1.260 wiz 13395: <td>PEAR_LIB</td>
1.258 wiz 13396: <td>PEAR_PACKAGE_XML</td>
1.227 wiz 13397: </tr>
13398: <tr>
1.260 wiz 13399: <td>PEP-518</td>
1.249 gutterid 13400: <td>PERL5</td>
1.156 leot 13401: </tr>
13402: <tr>
1.260 wiz 13403: <td>PERL5_CONFIGURE</td>
1.249 gutterid 13404: <td>PERL5_CONFIGURE_DIRS</td>
1.217 rillig 13405: </tr>
13406: <tr>
1.260 wiz 13407: <td>PERL5_LDFLAGS</td>
1.249 gutterid 13408: <td>PERL5_LICENSE</td>
1.205 wiz 13409: </tr>
13410: <tr>
1.260 wiz 13411: <td>PERL5_MODULE_TYPE</td>
1.249 gutterid 13412: <td>PERL5_PACKLIST</td>
1.177 leot 13413: </tr>
13414: <tr>
1.260 wiz 13415: <td>PERL5_PACKLIST_DIR</td>
1.249 gutterid 13416: <td>PERL5_PERLBASE</td>
1.161 leot 13417: </tr>
13418: <tr>
1.260 wiz 13419: <td>PERL5_SITEBASE</td>
1.249 gutterid 13420: <td>PERL5_USE_PACKLIST</td>
1.161 leot 13421: </tr>
13422: <tr>
1.260 wiz 13423: <td>PERL5_VENDORBASE</td>
1.249 gutterid 13424: <td>PFCTL</td>
1.156 leot 13425: </tr>
13426: <tr>
1.260 wiz 13427: <td>PFVAR_H</td>
1.249 gutterid 13428: <td>PF_VERSION</td>
1.156 leot 13429: </tr>
13430: <tr>
1.260 wiz 13431: <td>PGGROUP</td>
1.249 gutterid 13432: <td>PGHOME</td>
1.156 leot 13433: </tr>
13434: <tr>
1.260 wiz 13435: <td>PGPKGSRCDIR</td>
1.249 gutterid 13436: <td>PGSQL_TYPE</td>
1.156 leot 13437: </tr>
13438: <tr>
1.260 wiz 13439: <td>PGSQL_VERSION</td>
1.249 gutterid 13440: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.156 leot 13441: </tr>
13442: <tr>
1.260 wiz 13443: <td>PGSQL_VERSION_DEFAULT</td>
1.249 gutterid 13444: <td>PGUSER</td>
1.156 leot 13445: </tr>
13446: <tr>
1.260 wiz 13447: <td>PG_LIB_EXT</td>
1.249 gutterid 13448: <td>PHP</td>
1.260 wiz 13449: </tr>
13450: <tr>
1.258 wiz 13451: <td>PHPCOMMON_MK</td>
1.260 wiz 13452: <td>PHPPKGSRCDIR</td>
1.156 leot 13453: </tr>
13454: <tr>
1.258 wiz 13455: <td>PHP_BASE_VERS</td>
1.260 wiz 13456: <td>PHP_EGDIR</td>
1.156 leot 13457: </tr>
13458: <tr>
1.258 wiz 13459: <td>PHP_EXTENSION_DIR</td>
1.260 wiz 13460: <td>PHP_INCDIR</td>
13461: </tr>
13462: <tr>
13463: <td>PHP_LIBDIR</td>
13464: <td>PHP_MAJOR_VERS</td>
13465: </tr>
13466: <tr>
13467: <td>PHP_MINIMUM_TEENY</td>
13468: <td>PHP_MINOR_VERS</td>
1.156 leot 13469: </tr>
13470: <tr>
1.258 wiz 13471: <td>PHP_PKG_PREFIX</td>
1.260 wiz 13472: <td>PHP_SHAREDIR</td>
1.156 leot 13473: </tr>
13474: <tr>
1.260 wiz 13475: <td>PHP_VER</td>
1.249 gutterid 13476: <td>PHP_VERSION</td>
1.156 leot 13477: </tr>
13478: <tr>
1.260 wiz 13479: <td>PHP_VERSIONS_ACCEPTED</td>
1.249 gutterid 13480: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.156 leot 13481: </tr>
13482: <tr>
1.260 wiz 13483: <td>PHP_VERSION_DEFAULT</td>
1.249 gutterid 13484: <td>PHP_VERSION_REQD</td>
1.156 leot 13485: </tr>
13486: <tr>
1.260 wiz 13487: <td>PILRC_USE_GTK</td>
1.249 gutterid 13488: <td>PKGCONFIG_BASE</td>
1.156 leot 13489: </tr>
13490: <tr>
1.260 wiz 13491: <td>PKGCONFIG_FILE</td>
1.249 gutterid 13492: <td>PKGCONFIG_OVERRIDE</td>
1.156 leot 13493: </tr>
13494: <tr>
1.260 wiz 13495: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.249 gutterid 13496: <td>PKGDIR</td>
1.156 leot 13497: </tr>
13498: <tr>
1.260 wiz 13499: <td>PKGGNUDIR</td>
1.249 gutterid 13500: <td>PKGINFODIR</td>
1.156 leot 13501: </tr>
13502: <tr>
1.260 wiz 13503: <td>PKGLOCALEDIR</td>
1.249 gutterid 13504: <td>PKGMANDIR</td>
1.156 leot 13505: </tr>
13506: <tr>
1.260 wiz 13507: <td>PKGNAME</td>
1.249 gutterid 13508: <td>PKGNAME_REQD</td>
1.156 leot 13509: </tr>
13510: <tr>
1.260 wiz 13511: <td>PKGPATH</td>
1.249 gutterid 13512: <td>PKGREVISION</td>
1.156 leot 13513: </tr>
13514: <tr>
1.260 wiz 13515: <td>PKGSRC_BLAS_TYPES</td>
1.249 gutterid 13516: <td>PKGSRC_CHANGES</td>
1.156 leot 13517: </tr>
13518: <tr>
1.260 wiz 13519: <td>PKGSRC_COMPILER</td>
1.249 gutterid 13520: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.156 leot 13521: </tr>
13522: <tr>
1.260 wiz 13523: <td>PKGSRC_LOCKTYPE</td>
1.249 gutterid 13524: <td>PKGSRC_MAKE_ENV</td>
1.156 leot 13525: </tr>
13526: <tr>
1.260 wiz 13527: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.249 gutterid 13528: <td>PKGSRC_MKPIE</td>
1.156 leot 13529: </tr>
13530: <tr>
1.260 wiz 13531: <td>PKGSRC_MKREPRO</td>
1.249 gutterid 13532: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.177 leot 13533: </tr>
13534: <tr>
1.260 wiz 13535: <td>PKGSRC_RUN_TEST</td>
1.249 gutterid 13536: <td>PKGSRC_SETENV</td>
1.156 leot 13537: </tr>
13538: <tr>
1.260 wiz 13539: <td>PKGSRC_SLEEPSECS</td>
1.249 gutterid 13540: <td>PKGSRC_TODO</td>
1.159 rillig 13541: </tr>
13542: <tr>
1.260 wiz 13543: <td>PKGSRC_USE_CTF</td>
1.249 gutterid 13544: <td>PKGSRC_USE_FORTIFY</td>
1.156 leot 13545: </tr>
13546: <tr>
1.260 wiz 13547: <td>PKGSRC_USE_MKTOOLS</td>
1.249 gutterid 13548: <td>PKGSRC_USE_RELRO</td>
1.156 leot 13549: </tr>
13550: <tr>
1.260 wiz 13551: <td>PKGSRC_USE_SSP</td>
1.249 gutterid 13552: <td>PKGSRC_USE_STACK_CHECK</td>
1.156 leot 13553: </tr>
13554: <tr>
1.260 wiz 13555: <td>PKGTASKS_DATAFILE</td>
1.249 gutterid 13556: <td>PKGTOOLS_ARGS</td>
1.156 leot 13557: </tr>
13558: <tr>
1.260 wiz 13559: <td>PKGTOOLS_ENV</td>
1.249 gutterid 13560: <td>PKG_ALTERNATIVES</td>
1.156 leot 13561: </tr>
13562: <tr>
1.260 wiz 13563: <td>PKG_APACHE</td>
1.249 gutterid 13564: <td>PKG_APACHE_ACCEPTED</td>
1.156 leot 13565: </tr>
13566: <tr>
1.260 wiz 13567: <td>PKG_APACHE_DEFAULT</td>
1.249 gutterid 13568: <td>PKG_BEST_EXISTS</td>
1.156 leot 13569: </tr>
13570: <tr>
1.260 wiz 13571: <td>PKG_BUILD_OPTIONS</td>
1.249 gutterid 13572: <td>PKG_COMPRESSION</td>
1.156 leot 13573: </tr>
13574: <tr>
1.260 wiz 13575: <td>PKG_CONFIG</td>
1.249 gutterid 13576: <td>PKG_CONFIG_PERMS</td>
1.156 leot 13577: </tr>
13578: <tr>
1.260 wiz 13579: <td>PKG_CREATE_USERGROUP</td>
1.255 wiz 13580: <td>PKG_DBDIR</td>
1.156 leot 13581: </tr>
13582: <tr>
1.260 wiz 13583: <td>PKG_DB_TMPDIR</td>
1.255 wiz 13584: <td>PKG_DEBUG_LEVEL</td>
1.156 leot 13585: </tr>
13586: <tr>
1.260 wiz 13587: <td>PKG_DEFAULT_OPTIONS</td>
1.255 wiz 13588: <td>PKG_DESTDIR_SUPPORT</td>
1.156 leot 13589: </tr>
13590: <tr>
1.260 wiz 13591: <td>PKG_DEVELOPER</td>
1.255 wiz 13592: <td>PKG_DISABLED_OPTIONS</td>
1.233 wiz 13593: </tr>
13594: <tr>
1.260 wiz 13595: <td>PKG_FATAL_ERRORS</td>
1.255 wiz 13596: <td>PKG_FC</td>
1.246 leot 13597: </tr>
13598: <tr>
1.260 wiz 13599: <td>PKG_FILELIST_CMD</td>
1.255 wiz 13600: <td>PKG_GECOS</td>
1.156 leot 13601: </tr>
13602: <tr>
1.260 wiz 13603: <td>PKG_GID</td>
1.255 wiz 13604: <td>PKG_GROUPS</td>
1.156 leot 13605: </tr>
13606: <tr>
1.260 wiz 13607: <td>PKG_GROUPS_VARS</td>
1.255 wiz 13608: <td>PKG_HOME</td>
1.156 leot 13609: </tr>
13610: <tr>
1.260 wiz 13611: <td>PKG_INIT_SCRIPTS</td>
1.255 wiz 13612: <td>PKG_JAVA_HOME</td>
1.156 leot 13613: </tr>
13614: <tr>
1.260 wiz 13615: <td>PKG_JVM</td>
1.255 wiz 13616: <td>PKG_JVMS_ACCEPTED</td>
1.156 leot 13617: </tr>
13618: <tr>
1.260 wiz 13619: <td>PKG_JVM_DEFAULT</td>
1.255 wiz 13620: <td>PKG_LEGACY_OPTIONS</td>
1.156 leot 13621: </tr>
13622: <tr>
1.260 wiz 13623: <td>PKG_LIBTOOL</td>
1.255 wiz 13624: <td>PKG_MKSYMLINKS</td>
1.156 leot 13625: </tr>
13626: <tr>
1.260 wiz 13627: <td>PKG_OPTIONS</td>
1.255 wiz 13628: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.156 leot 13629: </tr>
13630: <tr>
1.260 wiz 13631: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.255 wiz 13632: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.156 leot 13633: </tr>
13634: <tr>
1.260 wiz 13635: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.255 wiz 13636: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.226 gutterid 13637: </tr>
13638: <tr>
1.260 wiz 13639: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.255 wiz 13640: <td>PKG_OPTIONS_VAR</td>
1.156 leot 13641: </tr>
13642: <tr>
1.255 wiz 13643: <td>PKG_RCD_SCRIPTS</td>
1.258 wiz 13644: <td>PKG_REFCOUNT_DBDIR</td>
1.156 leot 13645: </tr>
13646: <tr>
1.255 wiz 13647: <td>PKG_REGISTER_SHELLS</td>
1.258 wiz 13648: <td>PKG_RESUME_TRANSFERS</td>
1.156 leot 13649: </tr>
13650: <tr>
1.255 wiz 13651: <td>PKG_SHELL</td>
1.258 wiz 13652: <td>PKG_SUGGESTED_OPTIONS</td>
1.156 leot 13653: </tr>
13654: <tr>
1.255 wiz 13655: <td>PKG_SUPPORTED_OPTIONS</td>
1.258 wiz 13656: <td>PKG_SYSCONFBASE</td>
1.156 leot 13657: </tr>
13658: <tr>
1.255 wiz 13659: <td>PKG_SYSCONFBASEDIR</td>
1.258 wiz 13660: <td>PKG_SYSCONFDIR</td>
1.156 leot 13661: </tr>
13662: <tr>
1.255 wiz 13663: <td>PKG_SYSCONFDIR_PERMS</td>
1.258 wiz 13664: <td>PKG_SYSCONFSUBDIR</td>
1.156 leot 13665: </tr>
13666: <tr>
1.255 wiz 13667: <td>PKG_SYSCONFVAR</td>
1.258 wiz 13668: <td>PKG_TOOLS_BIN</td>
1.156 leot 13669: </tr>
13670: <tr>
1.255 wiz 13671: <td>PKG_UID</td>
1.258 wiz 13672: <td>PKG_UPDATE_FONTS_DB</td>
1.156 leot 13673: </tr>
13674: <tr>
1.255 wiz 13675: <td>PKG_USERS</td>
1.258 wiz 13676: <td>PKG_USERS_VARS</td>
1.156 leot 13677: </tr>
13678: <tr>
1.255 wiz 13679: <td>PKG_VERBOSE</td>
1.258 wiz 13680: <td>PLEASE</td>
1.156 leot 13681: </tr>
13682: <tr>
1.255 wiz 13683: <td>PLIST</td>
1.258 wiz 13684: <td>PLIST_AWK</td>
1.156 leot 13685: </tr>
13686: <tr>
1.255 wiz 13687: <td>PLIST_AWK_ENV</td>
1.258 wiz 13688: <td>PLIST_SRC</td>
1.156 leot 13689: </tr>
13690: <tr>
1.255 wiz 13691: <td>PLIST_SUBST</td>
1.258 wiz 13692: <td>PLIST_TYPE</td>
1.156 leot 13693: </tr>
13694: <tr>
1.255 wiz 13695: <td>PLIST_VARS</td>
1.258 wiz 13696: <td>POPTOP_USE_MPPE</td>
1.156 leot 13697: </tr>
13698: <tr>
1.255 wiz 13699: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.258 wiz 13700: <td>POST_FETCH_HOOK</td>
1.156 leot 13701: </tr>
13702: <tr>
1.255 wiz 13703: <td>PREFER</td>
1.258 wiz 13704: <td>PREFER_NATIVE</td>
1.156 leot 13705: </tr>
13706: <tr>
1.255 wiz 13707: <td>PREFER_NATIVE_PTHREADS</td>
1.258 wiz 13708: <td>PREFER_PKGSRC</td>
1.156 leot 13709: </tr>
13710: <tr>
1.255 wiz 13711: <td>PREFIX</td>
1.258 wiz 13712: <td>PREPEND_PATH</td>
1.156 leot 13713: </tr>
13714: <tr>
1.255 wiz 13715: <td>PRE_ROOT_CMD</td>
1.258 wiz 13716: <td>PRIVILEGED_STAGES</td>
1.156 leot 13717: </tr>
13718: <tr>
1.255 wiz 13719: <td>PS</td>
1.258 wiz 13720: <td>PTHREAD_AUTO_VARS</td>
1.156 leot 13721: </tr>
13722: <tr>
1.255 wiz 13723: <td>PTHREAD_CFLAGS</td>
1.258 wiz 13724: <td>PTHREAD_LDFLAGS</td>
1.156 leot 13725: </tr>
13726: <tr>
1.255 wiz 13727: <td>PTHREAD_LIBS</td>
1.258 wiz 13728: <td>PTHREAD_OPTS</td>
1.156 leot 13729: </tr>
13730: <tr>
1.255 wiz 13731: <td>PTHREAD_TYPE</td>
1.258 wiz 13732: <td>PVM_SSH</td>
1.156 leot 13733: </tr>
13734: <tr>
1.255 wiz 13735: <td>PYPKGPREFIX</td>
1.258 wiz 13736: <td>PYTHON_FOR_BUILD_ONLY</td>
1.156 leot 13737: </tr>
13738: <tr>
1.255 wiz 13739: <td>PYTHON_SELF_CONFLICT</td>
1.258 wiz 13740: <td>PYTHON_VERSION</td>
1.156 leot 13741: </tr>
13742: <tr>
1.255 wiz 13743: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.258 wiz 13744: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.156 leot 13745: </tr>
13746: <tr>
1.255 wiz 13747: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.258 wiz 13748: <td>PYTHON_VERSION_DEFAULT</td>
1.156 leot 13749: </tr>
13750: <tr>
1.255 wiz 13751: <td>PYTHON_VERSION_REQD</td>
1.258 wiz 13752: <td>PYVERSSUFFIX</td>
1.156 leot 13753: </tr>
13754: <tr>
1.255 wiz 13755: <td>QMAILDIR</td>
1.258 wiz 13756: <td>QMAIL_ALIAS_USER</td>
1.156 leot 13757: </tr>
13758: <tr>
1.255 wiz 13759: <td>QMAIL_DAEMON_USER</td>
1.258 wiz 13760: <td>QMAIL_LOG_USER</td>
1.156 leot 13761: </tr>
13762: <tr>
1.255 wiz 13763: <td>QMAIL_NOFILES_GROUP</td>
1.258 wiz 13764: <td>QMAIL_PASSWD_USER</td>
1.156 leot 13765: </tr>
13766: <tr>
1.255 wiz 13767: <td>QMAIL_QMAIL_GROUP</td>
1.258 wiz 13768: <td>QMAIL_QUEUE_DIR</td>
1.156 leot 13769: </tr>
13770: <tr>
1.255 wiz 13771: <td>QMAIL_QUEUE_EXTRA</td>
1.258 wiz 13772: <td>QMAIL_QUEUE_USER</td>
1.156 leot 13773: </tr>
13774: <tr>
1.255 wiz 13775: <td>QMAIL_REMOTE_USER</td>
1.258 wiz 13776: <td>QMAIL_ROOT_USER</td>
1.156 leot 13777: </tr>
13778: <tr>
1.255 wiz 13779: <td>QMAIL_SEND_USER</td>
1.258 wiz 13780: <td>QORE_LATEST_MODULE_API</td>
1.156 leot 13781: </tr>
13782: <tr>
1.255 wiz 13783: <td>QORE_MODULE_API</td>
1.258 wiz 13784: <td>QORE_MODULE_DIR</td>
1.156 leot 13785: </tr>
13786: <tr>
1.255 wiz 13787: <td>QORE_USER_MODULE_DIR</td>
1.258 wiz 13788: <td>QORE_VERSION</td>
1.156 leot 13789: </tr>
13790: <tr>
1.255 wiz 13791: <td>QPOPPER_FAC</td>
1.258 wiz 13792: <td>QPOPPER_SPOOL_DIR</td>
1.156 leot 13793: </tr>
13794: <tr>
1.255 wiz 13795: <td>QPOPPER_USER</td>
1.258 wiz 13796: <td>RAKE_NAME</td>
1.254 wiz 13797: </tr>
13798: <tr>
1.255 wiz 13799: <td>RASMOL_DEPTH</td>
1.258 wiz 13800: <td>RCD_DIR</td>
1.156 leot 13801: </tr>
13802: <tr>
1.258 wiz 13803: <td>RCD_ORDER</td>
1.256 wiz 13804: <td>RCD_SCRIPTS</td>
1.258 wiz 13805: </tr>
13806: <tr>
1.255 wiz 13807: <td>RCD_SCRIPTS_DIR</td>
1.258 wiz 13808: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.218 nia 13809: </tr>
13810: <tr>
1.255 wiz 13811: <td>RCD_SCRIPTS_MODE</td>
1.258 wiz 13812: <td>RCD_SCRIPTS_SHELL</td>
1.227 wiz 13813: </tr>
13814: <tr>
1.255 wiz 13815: <td>RCD_SCRIPT_SRC</td>
1.258 wiz 13816: <td>RCD_SUBR</td>
1.241 rillig 13817: </tr>
13818: <tr>
1.255 wiz 13819: <td>RDOC</td>
1.257 jkoshy 13820: <td>READLINE_DEFAULT</td>
1.214 leot 13821: </tr>
13822: <tr>
1.255 wiz 13823: <td>READLINE_TYPE</td>
1.257 jkoshy 13824: <td>REAL_ROOT_GROUP</td>
1.205 wiz 13825: </tr>
13826: <tr>
1.255 wiz 13827: <td>REAL_ROOT_USER</td>
1.257 jkoshy 13828: <td>RECURSIVE_MAKE</td>
1.223 nia 13829: </tr>
13830: <tr>
1.255 wiz 13831: <td>RELAY_CTRL_DIR</td>
1.257 jkoshy 13832: <td>RELRO_SUPPORTED</td>
1.177 leot 13833: </tr>
13834: <tr>
1.255 wiz 13835: <td>REPLACE_AWK</td>
1.257 jkoshy 13836: <td>REPLACE_BASH</td>
1.214 leot 13837: </tr>
13838: <tr>
1.255 wiz 13839: <td>REPLACE_CSH</td>
1.257 jkoshy 13840: <td>REPLACE_KSH</td>
1.212 wiz 13841: </tr>
13842: <tr>
1.255 wiz 13843: <td>REPLACE_LUA</td>
1.257 jkoshy 13844: <td>REPLACE_NODEJS</td>
1.156 leot 13845: </tr>
13846: <tr>
1.255 wiz 13847: <td>REPLACE_OCTAVE</td>
1.257 jkoshy 13848: <td>REPLACE_PERL</td>
1.205 wiz 13849: </tr>
13850: <tr>
1.255 wiz 13851: <td>REPLACE_PERL6</td>
1.257 jkoshy 13852: <td>REPLACE_PHP</td>
1.197 leot 13853: </tr>
13854: <tr>
1.255 wiz 13855: <td>REPLACE_PYTHON</td>
1.257 jkoshy 13856: <td>REPLACE_QORE</td>
1.156 leot 13857: </tr>
13858: <tr>
1.255 wiz 13859: <td>REPLACE_R</td>
1.257 jkoshy 13860: <td>REPLACE_RUBY</td>
1.218 nia 13861: </tr>
13862: <tr>
1.255 wiz 13863: <td>REPLACE_RUBY_DIRS</td>
1.257 jkoshy 13864: <td>REPLACE_RUBY_PAT</td>
1.161 leot 13865: </tr>
13866: <tr>
1.255 wiz 13867: <td>REPLACE_SH</td>
1.257 jkoshy 13868: <td>REPLACE_TEXLUA</td>
1.254 wiz 13869: </tr>
13870: <tr>
1.255 wiz 13871: <td>REPLACE_TOOL_PYTHON</td>
1.257 jkoshy 13872: <td>REPLACE_WISH</td>
1.216 gutterid 13873: </tr>
13874: <tr>
1.255 wiz 13875: <td>REQD_DIRS</td>
1.257 jkoshy 13876: <td>REQD_DIRS_PERMS</td>
1.156 leot 13877: </tr>
13878: <tr>
1.255 wiz 13879: <td>REQD_FILES</td>
1.257 jkoshy 13880: <td>REQD_FILES_MODE</td>
1.218 nia 13881: </tr>
13882: <tr>
1.255 wiz 13883: <td>REQD_FILES_PERMS</td>
1.257 jkoshy 13884: <td>RESOLV_AUTO_VARS</td>
1.156 leot 13885: </tr>
13886: <tr>
1.255 wiz 13887: <td>RESOLV_LDFLAGS</td>
1.257 jkoshy 13888: <td>RESOLV_LIBS</td>
1.254 wiz 13889: </tr>
13890: <tr>
1.255 wiz 13891: <td>RM</td>
1.258 wiz 13892: <td>ROCKSPEC_NAME</td>
13893: </tr>
13894: <tr>
13895: <td>ROCKSPEC_SPECFILE</td>
1.257 jkoshy 13896: <td>ROOT_CMD</td>
1.238 wiz 13897: </tr>
13898: <tr>
1.255 wiz 13899: <td>ROOT_GROUP</td>
1.257 jkoshy 13900: <td>ROOT_USER</td>
1.156 leot 13901: </tr>
13902: <tr>
1.255 wiz 13903: <td>RPCGEN</td>
1.257 jkoshy 13904: <td>RPM</td>
1.156 leot 13905: </tr>
13906: <tr>
1.255 wiz 13907: <td>RPM2PKG_PLIST</td>
1.257 jkoshy 13908: <td>RPM2PKG_PREFIX</td>
1.205 wiz 13909: </tr>
13910: <tr>
1.255 wiz 13911: <td>RPM2PKG_STAGE</td>
1.257 jkoshy 13912: <td>RPM2PKG_STRIP</td>
1.217 rillig 13913: </tr>
13914: <tr>
1.255 wiz 13915: <td>RPM2PKG_SUBPREFIX</td>
1.257 jkoshy 13916: <td>RPMFILES</td>
1.214 leot 13917: </tr>
13918: <tr>
1.255 wiz 13919: <td>RPMIGNOREPATH</td>
1.257 jkoshy 13920: <td>RPM_DB_PREFIX</td>
1.212 wiz 13921: </tr>
13922: <tr>
1.255 wiz 13923: <td>RSSH_CVS_PATH</td>
1.257 jkoshy 13924: <td>RSSH_RDIST_PATH</td>
1.156 leot 13925: </tr>
13926: <tr>
1.255 wiz 13927: <td>RSSH_RSYNC_PATH</td>
1.257 jkoshy 13928: <td>RSSH_SCP_PATH</td>
1.197 leot 13929: </tr>
13930: <tr>
1.255 wiz 13931: <td>RSSH_SFTP_SERVER_PATH</td>
1.257 jkoshy 13932: <td>RUBY</td>
1.156 leot 13933: </tr>
13934: <tr>
1.255 wiz 13935: <td>RUBYGEM</td>
1.257 jkoshy 13936: <td>RUBYGEM_MANPAGES</td>
1.156 leot 13937: </tr>
13938: <tr>
1.255 wiz 13939: <td>RUBYGEM_NAME</td>
1.257 jkoshy 13940: <td>RUBYGEM_OPTIONS</td>
1.156 leot 13941: </tr>
13942: <tr>
1.255 wiz 13943: <td>RUBYGEM_USE_MANPAGES</td>
1.257 jkoshy 13944: <td>RUBYGEM_VERBOSE</td>
1.231 jnemeth 13945: </tr>
13946: <tr>
1.255 wiz 13947: <td>RUBY_ABI_VERSION</td>
1.257 jkoshy 13948: <td>RUBY_ARCH</td>
1.156 leot 13949: </tr>
13950: <tr>
1.255 wiz 13951: <td>RUBY_ARCHINC</td>
1.257 jkoshy 13952: <td>RUBY_ARCHLIB</td>
1.156 leot 13953: </tr>
13954: <tr>
1.255 wiz 13955: <td>RUBY_BASE</td>
1.257 jkoshy 13956: <td>RUBY_BASERIDIR</td>
1.156 leot 13957: </tr>
13958: <tr>
1.255 wiz 13959: <td>RUBY_BUILD_DOCUMENT</td>
1.257 jkoshy 13960: <td>RUBY_DLEXT</td>
1.156 leot 13961: </tr>
13962: <tr>
1.255 wiz 13963: <td>RUBY_DOC</td>
1.257 jkoshy 13964: <td>RUBY_DYNAMIC_DIRS</td>
1.156 leot 13965: </tr>
13966: <tr>
1.255 wiz 13967: <td>RUBY_EG</td>
1.257 jkoshy 13968: <td>RUBY_ENCODING_ARG</td>
1.156 leot 13969: </tr>
13970: <tr>
1.255 wiz 13971: <td>RUBY_EXTCONF</td>
1.257 jkoshy 13972: <td>RUBY_EXTCONF_CHECK</td>
1.156 leot 13973: </tr>
13974: <tr>
1.255 wiz 13975: <td>RUBY_EXTCONF_DEBUG</td>
1.257 jkoshy 13976: <td>RUBY_EXTCONF_MAKEFILE</td>
1.198 leot 13977: </tr>
13978: <tr>
1.255 wiz 13979: <td>RUBY_GEM_ARCH</td>
1.257 jkoshy 13980: <td>RUBY_GEM_BASE</td>
1.156 leot 13981: </tr>
13982: <tr>
1.255 wiz 13983: <td>RUBY_INC</td>
1.257 jkoshy 13984: <td>RUBY_LIB</td>
1.156 leot 13985: </tr>
13986: <tr>
1.255 wiz 13987: <td>RUBY_LIB_BASE</td>
1.257 jkoshy 13988: <td>RUBY_NAME</td>
1.156 leot 13989: </tr>
13990: <tr>
1.255 wiz 13991: <td>RUBY_NOVERSION</td>
1.257 jkoshy 13992: <td>RUBY_PKGPREFIX</td>
1.156 leot 13993: </tr>
13994: <tr>
1.255 wiz 13995: <td>RUBY_RAILS</td>
1.257 jkoshy 13996: <td>RUBY_RAILS61_VERSION</td>
1.223 nia 13997: </tr>
13998: <tr>
1.255 wiz 13999: <td>RUBY_RAILS70_VERSION</td>
1.257 jkoshy 14000: <td>RUBY_RAILS71_VERSION</td>
1.156 leot 14001: </tr>
14002: <tr>
1.259 leot 14003: <td>RUBY_RAILS72_VERSION</td>
14004: <td>RUBY_RAILS80_VERSION</td>
14005: </tr>
14006: <tr>
1.255 wiz 14007: <td>RUBY_RAILS_ACCEPTED</td>
1.257 jkoshy 14008: <td>RUBY_RAILS_DEFAULT</td>
1.156 leot 14009: </tr>
14010: <tr>
1.255 wiz 14011: <td>RUBY_RAILS_REQD</td>
1.257 jkoshy 14012: <td>RUBY_RAILS_STRICT_DEP</td>
1.156 leot 14013: </tr>
14014: <tr>
1.255 wiz 14015: <td>RUBY_RIDIR</td>
1.257 jkoshy 14016: <td>RUBY_SETUP</td>
1.156 leot 14017: </tr>
14018: <tr>
1.255 wiz 14019: <td>RUBY_SHLIB</td>
1.257 jkoshy 14020: <td>RUBY_SHLIBALIAS</td>
1.156 leot 14021: </tr>
14022: <tr>
1.255 wiz 14023: <td>RUBY_SHLIBVER</td>
1.257 jkoshy 14024: <td>RUBY_SIMPLE_INSTALL</td>
1.156 leot 14025: </tr>
14026: <tr>
1.255 wiz 14027: <td>RUBY_SITEARCHLIB</td>
1.257 jkoshy 14028: <td>RUBY_SITELIB</td>
1.156 leot 14029: </tr>
14030: <tr>
1.255 wiz 14031: <td>RUBY_SITELIB_BASE</td>
1.257 jkoshy 14032: <td>RUBY_SITERIDIR</td>
1.156 leot 14033: </tr>
14034: <tr>
1.255 wiz 14035: <td>RUBY_SLEXT</td>
1.257 jkoshy 14036: <td>RUBY_SRCDIR</td>
1.156 leot 14037: </tr>
14038: <tr>
1.255 wiz 14039: <td>RUBY_STATICLIB</td>
1.257 jkoshy 14040: <td>RUBY_SUFFIX</td>
1.174 leot 14041: </tr>
14042: <tr>
1.255 wiz 14043: <td>RUBY_SYSRIDIR</td>
1.257 jkoshy 14044: <td>RUBY_USE_PTHREAD</td>
1.156 leot 14045: </tr>
14046: <tr>
1.255 wiz 14047: <td>RUBY_VENDORARCHLIB</td>
1.257 jkoshy 14048: <td>RUBY_VENDORLIB</td>
1.156 leot 14049: </tr>
14050: <tr>
1.255 wiz 14051: <td>RUBY_VENDORLIB_BASE</td>
1.257 jkoshy 14052: <td>RUBY_VER</td>
1.156 leot 14053: </tr>
14054: <tr>
1.255 wiz 14055: <td>RUBY_VERSION</td>
1.257 jkoshy 14056: <td>RUBY_VERSIONS_ACCEPTED</td>
1.156 leot 14057: </tr>
14058: <tr>
1.255 wiz 14059: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.257 jkoshy 14060: <td>RUBY_VERSION_DEFAULT</td>
1.156 leot 14061: </tr>
14062: <tr>
1.255 wiz 14063: <td>RUBY_VERSION_REQD</td>
1.257 jkoshy 14064: <td>RUBY_VER_DIR</td>
1.156 leot 14065: </tr>
14066: <tr>
1.255 wiz 14067: <td>RUN</td>
1.257 jkoshy 14068: <td>RUN_LDCONFIG</td>
1.156 leot 14069: </tr>
14070: <tr>
1.255 wiz 14071: <td>RUST_TYPE</td>
1.257 jkoshy 14072: <td>SCO</td>
1.156 leot 14073: </tr>
14074: <tr>
1.255 wiz 14075: <td>SCREWS_GROUP</td>
1.257 jkoshy 14076: <td>SCREWS_USER</td>
1.156 leot 14077: </tr>
14078: <tr>
1.255 wiz 14079: <td>SCRIPTS_ENV</td>
1.257 jkoshy 14080: <td>SCROLLKEEPER_DATADIR</td>
1.156 leot 14081: </tr>
14082: <tr>
1.255 wiz 14083: <td>SCROLLKEEPER_REBUILDDB</td>
1.257 jkoshy 14084: <td>SCROLLKEEPER_UPDATEDB</td>
1.156 leot 14085: </tr>
14086: <tr>
1.255 wiz 14087: <td>SDIST_PAWD</td>
1.257 jkoshy 14088: <td>SDL12_TYPE</td>
1.156 leot 14089: </tr>
14090: <tr>
1.255 wiz 14091: <td>SERIAL_DEVICES</td>
1.257 jkoshy 14092: <td>SETGIDGAME</td>
1.156 leot 14093: </tr>
14094: <tr>
1.255 wiz 14095: <td>SETGID_GAMES_PERMS</td>
1.257 jkoshy 14096: <td>SETUID_ROOT_PERMS</td>
1.156 leot 14097: </tr>
14098: <tr>
1.255 wiz 14099: <td>SH</td>
1.256 wiz 14100: <td>SHLIB</td>
1.233 wiz 14101: </tr>
14102: <tr>
1.258 wiz 14103: <td>SHORTNAME</td>
1.256 wiz 14104: <td>SIGN_PACKAGES</td>
1.258 wiz 14105: </tr>
14106: <tr>
1.255 wiz 14107: <td>SILC_CLIENT_WITH_PERL</td>
1.258 wiz 14108: <td>SITE_SPECIFIC_PKGS</td>
1.156 leot 14109: </tr>
14110: <tr>
1.255 wiz 14111: <td>SKIP_DEPENDS</td>
1.258 wiz 14112: <td>SMF_INSTANCES</td>
1.227 wiz 14113: </tr>
14114: <tr>
1.255 wiz 14115: <td>SMF_MANIFEST</td>
1.258 wiz 14116: <td>SMF_METHODS</td>
1.156 leot 14117: </tr>
14118: <tr>
1.255 wiz 14119: <td>SMF_METHOD_SHELL</td>
1.258 wiz 14120: <td>SMF_METHOD_SRC</td>
1.156 leot 14121: </tr>
14122: <tr>
1.255 wiz 14123: <td>SMF_NAME</td>
1.258 wiz 14124: <td>SMF_PREFIX</td>
1.177 leot 14125: </tr>
14126: <tr>
1.255 wiz 14127: <td>SMF_SRCDIR</td>
1.258 wiz 14128: <td>SNIPROXY_GROUP</td>
1.156 leot 14129: </tr>
14130: <tr>
1.255 wiz 14131: <td>SNIPROXY_USER</td>
1.258 wiz 14132: <td>SOURCE_BUFFSIZE</td>
1.217 rillig 14133: </tr>
14134: <tr>
1.255 wiz 14135: <td>SPECIAL_PERMS</td>
1.258 wiz 14136: <td>SPECIFIC_PKGS</td>
1.156 leot 14137: </tr>
14138: <tr>
1.255 wiz 14139: <td>SSH_SUID</td>
1.259 leot 14140: <td>SSLCERTBUNDLE</td>
14141: </tr>
14142: <tr>
14143: <td>SSLCERTS</td>
14144: <td>SSLDIR</td>
14145: </tr>
14146: <tr>
14147: <td>SSLKEYS</td>
1.258 wiz 14148: <td>SSP_SUPPORTED</td>
1.159 rillig 14149: </tr>
14150: <tr>
1.255 wiz 14151: <td>SSYNC_PAWD</td>
1.258 wiz 14152: <td>STEP_MSG</td>
1.156 leot 14153: </tr>
14154: <tr>
1.255 wiz 14155: <td>STRIP</td>
1.258 wiz 14156: <td>STRIP_DBG</td>
1.156 leot 14157: </tr>
14158: <tr>
1.255 wiz 14159: <td>STRIP_DEBUG</td>
1.258 wiz 14160: <td>STRIP_DEBUG_SUPPORTED</td>
1.156 leot 14161: </tr>
14162: <tr>
1.255 wiz 14163: <td>STRIP_FILES_SKIP</td>
1.258 wiz 14164: <td>SU</td>
1.156 leot 14165: </tr>
14166: <tr>
1.255 wiz 14167: <td>SUBDIR</td>
1.258 wiz 14168: <td>SUBST</td>
1.156 leot 14169: </tr>
14170: <tr>
1.255 wiz 14171: <td>SUBST_CLASSES</td>
1.258 wiz 14172: <td>SUBST_FILES</td>
1.156 leot 14173: </tr>
14174: <tr>
1.255 wiz 14175: <td>SUBST_FILTER_CMD</td>
1.258 wiz 14176: <td>SUBST_MESSAGE</td>
1.156 leot 14177: </tr>
14178: <tr>
1.255 wiz 14179: <td>SUBST_NOOP_OK</td>
1.258 wiz 14180: <td>SUBST_SED</td>
1.156 leot 14181: </tr>
14182: <tr>
1.255 wiz 14183: <td>SUBST_SHOW_DIFF</td>
1.258 wiz 14184: <td>SUBST_SKIP_TEXT_CHECK</td>
1.156 leot 14185: </tr>
14186: <tr>
1.255 wiz 14187: <td>SUBST_STAGE</td>
1.258 wiz 14188: <td>SUBST_VARS</td>
1.156 leot 14189: </tr>
14190: <tr>
1.255 wiz 14191: <td>SUNWSPROBASE</td>
1.258 wiz 14192: <td>SUSE_PREFER</td>
1.246 leot 14193: </tr>
14194: <tr>
1.255 wiz 14195: <td>SU_CMD</td>
1.258 wiz 14196: <td>SVN_EXTRACTDIR</td>
1.254 wiz 14197: </tr>
14198: <tr>
1.258 wiz 14199: <td>SVN_REPO</td>
14200: <td>SVN_REPOSITORIES</td>
14201: </tr>
14202: <tr>
14203: <td>SVN_REVISION</td>
1.256 wiz 14204: <td>SYSCONFBASE</td>
1.258 wiz 14205: </tr>
14206: <tr>
1.255 wiz 14207: <td>TARGET_MACHINE_ARCH</td>
1.258 wiz 14208: <td>TBL</td>
1.255 wiz 14209: </tr>
14210: <tr>
1.246 leot 14211: <td>TERMCAP_TYPE</td>
1.258 wiz 14212: <td>TERMINFO_DEFAULT</td>
1.156 leot 14213: </tr>
14214: <tr>
1.246 leot 14215: <td>TERMINFO_TYPE</td>
1.258 wiz 14216: <td>TEST</td>
1.227 wiz 14217: </tr>
14218: <tr>
1.246 leot 14219: <td>TEST_DEPENDS</td>
1.258 wiz 14220: <td>TEST_DIRS</td>
1.156 leot 14221: </tr>
14222: <tr>
1.246 leot 14223: <td>TEST_ENV</td>
1.258 wiz 14224: <td>TEST_ENV_SHELL</td>
1.217 rillig 14225: </tr>
14226: <tr>
1.246 leot 14227: <td>TEST_MAKE_CMD</td>
1.258 wiz 14228: <td>TEST_MAKE_FLAGS</td>
1.212 wiz 14229: </tr>
14230: <tr>
1.246 leot 14231: <td>TEST_TARGET</td>
1.258 wiz 14232: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.217 rillig 14233: </tr>
14234: <tr>
1.246 leot 14235: <td>TEXLIVE_REV</td>
1.258 wiz 14236: <td>TEXLIVE_UNVERSIONED</td>
1.205 wiz 14237: </tr>
14238: <tr>
1.246 leot 14239: <td>TEXMFSITE</td>
1.258 wiz 14240: <td>TEX_FORMATS</td>
1.189 bacon 14241: </tr>
14242: <tr>
1.246 leot 14243: <td>TEX_HYPHEN_DAT</td>
1.258 wiz 14244: <td>TEX_HYPHEN_DEF</td>
1.161 leot 14245: </tr>
14246: <tr>
1.246 leot 14247: <td>TEX_TEXMF_DIRS</td>
1.258 wiz 14248: <td>THTTPD_LOG_FACILITY</td>
1.159 rillig 14249: </tr>
14250: <tr>
1.246 leot 14251: <td>TINYDYN_USER</td>
1.259 leot 14252: <td>TLS</td>
14253: </tr>
14254: <tr>
1.258 wiz 14255: <td>TLSWRAPPER_CHROOT</td>
1.259 leot 14256: <td>TO</td>
1.156 leot 14257: </tr>
14258: <tr>
1.258 wiz 14259: <td>TOOLDIR</td>
1.259 leot 14260: <td>TOOLS_ALIASES</td>
1.156 leot 14261: </tr>
14262: <tr>
1.258 wiz 14263: <td>TOOLS_ALWAYS_WRAP</td>
1.259 leot 14264: <td>TOOLS_ARGS</td>
1.156 leot 14265: </tr>
14266: <tr>
1.258 wiz 14267: <td>TOOLS_BROKEN</td>
1.259 leot 14268: <td>TOOLS_CMD</td>
1.156 leot 14269: </tr>
14270: <tr>
1.258 wiz 14271: <td>TOOLS_CMDLINE_SED</td>
1.259 leot 14272: <td>TOOLS_CREATE</td>
1.156 leot 14273: </tr>
14274: <tr>
1.258 wiz 14275: <td>TOOLS_CROSS_DESTDIR</td>
1.259 leot 14276: <td>TOOLS_DIR</td>
1.156 leot 14277: </tr>
14278: <tr>
1.258 wiz 14279: <td>TOOLS_FAIL</td>
1.259 leot 14280: <td>TOOLS_GNU_MISSING</td>
1.156 leot 14281: </tr>
14282: <tr>
1.258 wiz 14283: <td>TOOLS_LDCONFIG</td>
1.259 leot 14284: <td>TOOLS_NOOP</td>
1.156 leot 14285: </tr>
14286: <tr>
1.258 wiz 14287: <td>TOOLS_PATH</td>
1.259 leot 14288: <td>TOOLS_SCRIPT</td>
1.156 leot 14289: </tr>
14290: <tr>
1.258 wiz 14291: <td>TOOLS_USE_CROSS_COMPILE</td>
1.259 leot 14292: <td>TOOL_DEPENDS</td>
1.156 leot 14293: </tr>
14294: <tr>
1.258 wiz 14295: <td>TTF_FONTDIR</td>
1.259 leot 14296: <td>TTF_FONTS_DIR</td>
1.254 wiz 14297: </tr>
14298: <tr>
1.257 jkoshy 14299: <td>TYPE</td>
1.259 leot 14300: <td>UAC_REQD_EXECS</td>
1.241 rillig 14301: </tr>
14302: <tr>
1.257 jkoshy 14303: <td>UCSPI_SSL_GROUP</td>
1.259 leot 14304: <td>UCSPI_SSL_USER</td>
1.238 wiz 14305: </tr>
14306: <tr>
1.260 wiz 14307: <td>UNBOUND_GROUP</td>
14308: <td>UNBOUND_LOG_FACILITY</td>
14309: </tr>
14310: <tr>
14311: <td>UNBOUND_USER</td>
1.257 jkoshy 14312: <td>UNLIMIT_RESOURCES</td>
1.260 wiz 14313: </tr>
14314: <tr>
1.259 leot 14315: <td>UNPRIVILEGED</td>
1.260 wiz 14316: <td>UNPRIVILEGED_GROUP</td>
1.156 leot 14317: </tr>
14318: <tr>
1.259 leot 14319: <td>UNPRIVILEGED_GROUPS</td>
1.260 wiz 14320: <td>UNPRIVILEGED_USER</td>
1.223 nia 14321: </tr>
14322: <tr>
1.259 leot 14323: <td>UNWRAP_FILES</td>
1.260 wiz 14324: <td>UNWRAP_PATTERNS</td>
1.156 leot 14325: </tr>
14326: <tr>
1.259 leot 14327: <td>UPDATE_GEMSPEC</td>
1.260 wiz 14328: <td>UPDATE_TARGET</td>
1.212 wiz 14329: </tr>
14330: <tr>
1.259 leot 14331: <td>URI</td>
1.260 wiz 14332: <td>USERGROUP_PHASE</td>
1.156 leot 14333: </tr>
14334: <tr>
1.259 leot 14335: <td>USERPPP_GROUP</td>
1.260 wiz 14336: <td>USER_SPECIFIC_PKGS</td>
1.156 leot 14337: </tr>
14338: <tr>
1.259 leot 14339: <td>USE_ABI_DEPENDS</td>
1.260 wiz 14340: <td>USE_APR</td>
1.156 leot 14341: </tr>
14342: <tr>
1.259 leot 14343: <td>USE_BSD_MAKEFILE</td>
1.260 wiz 14344: <td>USE_BUILTIN</td>
1.156 leot 14345: </tr>
14346: <tr>
1.259 leot 14347: <td>USE_CC_FEATURES</td>
1.260 wiz 14348: <td>USE_CROSS_COMPILE</td>
1.156 leot 14349: </tr>
14350: <tr>
1.259 leot 14351: <td>USE_CURSES</td>
1.260 wiz 14352: <td>USE_CWRAPPERS</td>
1.243 gutterid 14353: </tr>
14354: <tr>
1.259 leot 14355: <td>USE_CXX_FEATURES</td>
1.260 wiz 14356: <td>USE_DB185</td>
1.156 leot 14357: </tr>
14358: <tr>
1.259 leot 14359: <td>USE_FEATURES</td>
1.260 wiz 14360: <td>USE_GAMESGROUP</td>
1.156 leot 14361: </tr>
14362: <tr>
1.259 leot 14363: <td>USE_GCC_RUNTIME</td>
1.260 wiz 14364: <td>USE_IMAKE</td>
1.156 leot 14365: </tr>
14366: <tr>
1.259 leot 14367: <td>USE_INDIRECT_DEPENDS</td>
1.260 wiz 14368: <td>USE_JAVA</td>
1.156 leot 14369: </tr>
14370: <tr>
1.259 leot 14371: <td>USE_JAVA2</td>
1.260 wiz 14372: <td>USE_LANGUAGES</td>
1.205 wiz 14373: </tr>
14374: <tr>
1.259 leot 14375: <td>USE_LIBTOOL</td>
1.260 wiz 14376: <td>USE_NATIVE_GCC</td>
1.156 leot 14377: </tr>
14378: <tr>
1.259 leot 14379: <td>USE_NETBSD_REPO</td>
1.260 wiz 14380: <td>USE_PKGSRC_GCC</td>
1.156 leot 14381: </tr>
14382: <tr>
1.259 leot 14383: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.260 wiz 14384: <td>USE_PKGTASKS</td>
1.156 leot 14385: </tr>
14386: <tr>
1.259 leot 14387: <td>USE_PKG_ADMIN_DIGEST</td>
1.260 wiz 14388: <td>USE_RUBY_EXTCONF</td>
1.156 leot 14389: </tr>
14390: <tr>
1.259 leot 14391: <td>USE_RUBY_INSTALL</td>
1.260 wiz 14392: <td>USE_RUBY_SETUP</td>
1.156 leot 14393: </tr>
14394: <tr>
1.259 leot 14395: <td>USE_RUBY_SETUP_PKG</td>
1.260 wiz 14396: <td>USE_TMPFILES</td>
1.156 leot 14397: </tr>
14398: <tr>
1.259 leot 14399: <td>USE_TOOLS</td>
1.260 wiz 14400: <td>UUCP_GROUP</td>
1.258 wiz 14401: </tr>
14402: <tr>
1.259 leot 14403: <td>UUCP_USER</td>
1.260 wiz 14404: <td>VARBASE</td>
1.156 leot 14405: </tr>
14406: <tr>
1.259 leot 14407: <td>VARNAME</td>
1.260 wiz 14408: <td>VIM_EXTRA_OPTS</td>
1.156 leot 14409: </tr>
14410: <tr>
1.259 leot 14411: <td>WARNING_MSG</td>
1.260 wiz 14412: <td>WCALC_CGIDIR</td>
1.156 leot 14413: </tr>
14414: <tr>
1.259 leot 14415: <td>WCALC_CGIPATH</td>
1.260 wiz 14416: <td>WCALC_HTMLDIR</td>
1.156 leot 14417: </tr>
14418: <tr>
1.259 leot 14419: <td>WCALC_HTMLPATH</td>
1.260 wiz 14420: <td>WDM_MANAGERS</td>
1.156 leot 14421: </tr>
14422: <tr>
1.259 leot 14423: <td>WRAPPER_CC</td>
1.260 wiz 14424: <td>WRAPPER_REORDER_CMDS</td>
1.156 leot 14425: </tr>
14426: <tr>
1.259 leot 14427: <td>WRKDIR</td>
1.260 wiz 14428: <td>WRKDIR_BASENAME</td>
1.156 leot 14429: </tr>
14430: <tr>
1.259 leot 14431: <td>WRKDIR_LOCKTYPE</td>
1.260 wiz 14432: <td>WRKLOG</td>
1.156 leot 14433: </tr>
14434: <tr>
1.259 leot 14435: <td>WRKOBJDIR</td>
1.260 wiz 14436: <td>WRKSRC</td>
1.156 leot 14437: </tr>
14438: <tr>
1.259 leot 14439: <td>X10_PORT</td>
1.260 wiz 14440: <td>X11</td>
1.156 leot 14441: </tr>
14442: <tr>
1.259 leot 14443: <td>X11BASE</td>
1.260 wiz 14444: <td>X11_PKGSRCDIR</td>
1.156 leot 14445: </tr>
14446: <tr>
1.259 leot 14447: <td>X11_TYPE</td>
1.260 wiz 14448: <td>X509_CERTIFICATE</td>
1.156 leot 14449: </tr>
14450: <tr>
1.259 leot 14451: <td>X509_KEY</td>
1.260 wiz 14452: <td>XAW_TYPE</td>
1.156 leot 14453: </tr>
14454: <tr>
1.259 leot 14455: <td>XLOCK_DEFAULT_MODE</td>
1.260 wiz 14456: <td>XMKMF</td>
1.189 bacon 14457: </tr>
14458: <tr>
1.259 leot 14459: <td>XMKMF_FLAGS</td>
1.260 wiz 14460: <td>XXX</td>
1.156 leot 14461: </tr>
14462: <tr>
1.259 leot 14463: <td>XXXX</td>
1.260 wiz 14464: <td>YES</td>
1.156 leot 14465: </tr>
14466: <tr>
1.259 leot 14467: <td>ZSH_STATIC</td>
1.260 wiz 14468: <td>__stdc__</td>
1.246 leot 14469: </tr>
14470: <tr>
1.259 leot 14471: <td>_vargroups</td>
1.260 wiz 14472: <td>accept</td>
1.233 wiz 14473: </tr>
14474: <tr>
1.259 leot 14475: <td>acquire-localbase-lock</td>
1.260 wiz 14476: <td>acquire-lock</td>
1.156 leot 14477: </tr>
14478: <tr>
1.259 leot 14479: <td>add</td>
1.260 wiz 14480: <td>added</td>
1.227 wiz 14481: </tr>
14482: <tr>
1.259 leot 14483: <td>administrator</td>
1.260 wiz 14484: <td>alloca</td>
1.156 leot 14485: </tr>
14486: <tr>
1.259 leot 14487: <td>alternatives</td>
1.260 wiz 14488: <td>aslr</td>
1.159 rillig 14489: </tr>
14490: <tr>
1.259 leot 14491: <td>asprintf</td>
1.260 wiz 14492: <td>atlas</td>
1.217 rillig 14493: </tr>
14494: <tr>
1.259 leot 14495: <td>autoconf</td>
1.260 wiz 14496: <td>automake</td>
1.156 leot 14497: </tr>
14498: <tr>
1.259 leot 14499: <td>autoreconf</td>
1.260 wiz 14500: <td>awk</td>
1.201 cirnatda 14501: </tr>
14502: <tr>
1.259 leot 14503: <td>bash</td>
1.260 wiz 14504: <td>big-endian</td>
1.174 leot 14505: </tr>
14506: <tr>
1.259 leot 14507: <td>bin-install</td>
1.260 wiz 14508: <td>bind</td>
1.156 leot 14509: </tr>
14510: <tr>
1.259 leot 14511: <td>binpkg-list</td>
1.260 wiz 14512: <td>blas</td>
1.156 leot 14513: </tr>
14514: <tr>
1.259 leot 14515: <td>bootstrap-depends</td>
1.260 wiz 14516: <td>broken</td>
1.174 leot 14517: </tr>
14518: <tr>
1.259 leot 14519: <td>broken_on_platform</td>
1.260 wiz 14520: <td>bsd</td>
1.156 leot 14521: </tr>
14522: <tr>
1.259 leot 14523: <td>bsd.prog.mk</td>
1.260 wiz 14524: <td>build</td>
1.161 leot 14525: </tr>
14526: <tr>
1.259 leot 14527: <td>build-env</td>
1.260 wiz 14528: <td>buildlink-directories</td>
1.156 leot 14529: </tr>
14530: <tr>
1.259 leot 14531: <td>buildlink-oss-soundcard-h</td>
1.260 wiz 14532: <td>built-in</td>
1.156 leot 14533: </tr>
14534: <tr>
1.259 leot 14535: <td>builtin</td>
1.260 wiz 14536: <td>c</td>
1.156 leot 14537: </tr>
14538: <tr>
1.259 leot 14539: <td>c++</td>
1.260 wiz 14540: <td>ccache</td>
1.242 gutterid 14541: </tr>
14542: <tr>
1.259 leot 14543: <td>cce</td>
1.260 wiz 14544: <td>cdefs</td>
1.177 leot 14545: </tr>
14546: <tr>
1.259 leot 14547: <td>ceil</td>
1.260 wiz 14548: <td>changes</td>
1.159 rillig 14549: </tr>
14550: <tr>
1.259 leot 14551: <td>changes-entry</td>
1.260 wiz 14552: <td>changes-entry-noupdate</td>
1.156 leot 14553: </tr>
14554: <tr>
1.259 leot 14555: <td>check</td>
1.260 wiz 14556: <td>check-clean</td>
1.174 leot 14557: </tr>
14558: <tr>
1.259 leot 14559: <td>check-files</td>
1.260 wiz 14560: <td>check-files-clean</td>
1.156 leot 14561: </tr>
14562: <tr>
1.259 leot 14563: <td>check-hackage</td>
1.260 wiz 14564: <td>check-vulnerable</td>
1.156 leot 14565: </tr>
14566: <tr>
1.259 leot 14567: <td>checksum</td>
1.260 wiz 14568: <td>checksum-phase</td>
1.255 wiz 14569: </tr>
14570: <tr>
1.259 leot 14571: <td>clean</td>
1.260 wiz 14572: <td>clean-depends</td>
1.156 leot 14573: </tr>
14574: <tr>
1.259 leot 14575: <td>cleandir</td>
1.260 wiz 14576: <td>commit</td>
1.156 leot 14577: </tr>
14578: <tr>
1.259 leot 14579: <td>commit-changes-entry</td>
1.260 wiz 14580: <td>compact</td>
1.174 leot 14581: </tr>
14582: <tr>
1.259 leot 14583: <td>compiler</td>
1.260 wiz 14584: <td>conf</td>
1.156 leot 14585: </tr>
14586: <tr>
1.259 leot 14587: <td>config.guess</td>
1.260 wiz 14588: <td>config.sub</td>
1.156 leot 14589: </tr>
14590: <tr>
1.259 leot 14591: <td>configuration</td>
1.260 wiz 14592: <td>configure</td>
1.156 leot 14593: </tr>
14594: <tr>
1.259 leot 14595: <td>configure-env</td>
1.260 wiz 14596: <td>configure-help</td>
1.156 leot 14597: </tr>
14598: <tr>
1.259 leot 14599: <td>configure_args</td>
1.260 wiz 14600: <td>connect</td>
1.156 leot 14601: </tr>
14602: <tr>
1.259 leot 14603: <td>cos</td>
1.260 wiz 14604: <td>cpe</td>
1.156 leot 14605: </tr>
14606: <tr>
1.259 leot 14607: <td>cputime</td>
1.260 wiz 14608: <td>create-usergroup</td>
1.156 leot 14609: </tr>
14610: <tr>
1.259 leot 14611: <td>csh</td>
1.260 wiz 14612: <td>ctf</td>
1.156 leot 14613: </tr>
14614: <tr>
1.259 leot 14615: <td>cvs</td>
1.260 wiz 14616: <td>debug</td>
1.254 wiz 14617: </tr>
14618: <tr>
1.259 leot 14619: <td>declaration</td>
1.260 wiz 14620: <td>declare</td>
1.258 wiz 14621: </tr>
14622: <tr>
1.259 leot 14623: <td>defined</td>
1.260 wiz 14624: <td>depend</td>
1.241 rillig 14625: </tr>
14626: <tr>
1.259 leot 14627: <td>dependencies</td>
1.260 wiz 14628: <td>depends</td>
1.238 wiz 14629: </tr>
14630: <tr>
1.259 leot 14631: <td>depends-checksum</td>
1.260 wiz 14632: <td>depends-fetch</td>
1.223 nia 14633: </tr>
14634: <tr>
1.259 leot 14635: <td>deps</td>
1.260 wiz 14636: <td>describe</td>
1.174 leot 14637: </tr>
14638: <tr>
1.259 leot 14639: <td>destdir</td>
1.260 wiz 14640: <td>disable</td>
1.214 leot 14641: </tr>
14642: <tr>
1.259 leot 14643: <td>distclean</td>
1.260 wiz 14644: <td>distfiles</td>
1.205 wiz 14645: </tr>
14646: <tr>
1.258 wiz 14647: <td>distinfo</td>
1.259 leot 14648: <td>dl</td>
1.161 leot 14649: </tr>
14650: <tr>
1.258 wiz 14651: <td>dlopen</td>
1.259 leot 14652: <td>do-buildlink</td>
1.197 leot 14653: </tr>
14654: <tr>
1.258 wiz 14655: <td>do-clean</td>
1.259 leot 14656: <td>do-configure</td>
1.156 leot 14657: </tr>
14658: <tr>
1.258 wiz 14659: <td>do-configure-post-hook</td>
1.259 leot 14660: <td>do-extract</td>
1.156 leot 14661: </tr>
14662: <tr>
1.258 wiz 14663: <td>do-fetch</td>
1.259 leot 14664: <td>do-install</td>
1.156 leot 14665: </tr>
14666: <tr>
1.257 jkoshy 14667: <td>download</td>
1.259 leot 14668: <td>emul</td>
1.156 leot 14669: </tr>
14670: <tr>
1.257 jkoshy 14671: <td>emul-distinfo</td>
1.259 leot 14672: <td>emul-fetch</td>
1.156 leot 14673: </tr>
14674: <tr>
1.257 jkoshy 14675: <td>emulation</td>
1.259 leot 14676: <td>emulator</td>
1.162 rillig 14677: </tr>
14678: <tr>
1.257 jkoshy 14679: <td>enable</td>
1.259 leot 14680: <td>endian</td>
1.156 leot 14681: </tr>
14682: <tr>
1.258 wiz 14683: <td>endif</td>
1.259 leot 14684: <td>enomem</td>
1.258 wiz 14685: </tr>
14686: <tr>
14687: <td>ensurepip</td>
1.259 leot 14688: <td>err</td>
1.233 wiz 14689: </tr>
14690: <tr>
1.258 wiz 14691: <td>errx</td>
1.259 leot 14692: <td>etc</td>
1.156 leot 14693: </tr>
14694: <tr>
1.258 wiz 14695: <td>exp</td>
1.259 leot 14696: <td>extract-rpm</td>
1.227 wiz 14697: </tr>
14698: <tr>
1.258 wiz 14699: <td>fabs</td>
1.259 leot 14700: <td>feature</td>
1.214 leot 14701: </tr>
14702: <tr>
1.258 wiz 14703: <td>features</td>
1.259 leot 14704: <td>fetch</td>
1.156 leot 14705: </tr>
14706: <tr>
1.258 wiz 14707: <td>fetch-list</td>
1.259 leot 14708: <td>follows</td>
1.205 wiz 14709: </tr>
14710: <tr>
1.258 wiz 14711: <td>forbids</td>
1.259 leot 14712: <td>form</td>
1.197 leot 14713: </tr>
14714: <tr>
1.258 wiz 14715: <td>format</td>
1.259 leot 14716: <td>fortify</td>
1.156 leot 14717: </tr>
14718: <tr>
1.258 wiz 14719: <td>fortify_source</td>
1.259 leot 14720: <td>fossil</td>
1.238 wiz 14721: </tr>
14722: <tr>
1.257 jkoshy 14723: <td>friend</td>
1.259 leot 14724: <td>fts</td>
1.254 wiz 14725: </tr>
14726: <tr>
1.257 jkoshy 14727: <td>fts_close</td>
1.259 leot 14728: <td>fts_open</td>
1.241 rillig 14729: </tr>
14730: <tr>
1.257 jkoshy 14731: <td>fts_read</td>
1.259 leot 14732: <td>fts_set</td>
1.217 rillig 14733: </tr>
14734: <tr>
1.257 jkoshy 14735: <td>gcc</td>
1.259 leot 14736: <td>gethostbyaddr</td>
1.223 nia 14737: </tr>
14738: <tr>
1.257 jkoshy 14739: <td>gethostbyname</td>
1.259 leot 14740: <td>gethostbyname2</td>
1.156 leot 14741: </tr>
14742: <tr>
1.257 jkoshy 14743: <td>getopt_long</td>
1.259 leot 14744: <td>getprogname</td>
1.156 leot 14745: </tr>
14746: <tr>
1.257 jkoshy 14747: <td>getservbyname</td>
1.259 leot 14748: <td>getservbyport</td>
1.156 leot 14749: </tr>
14750: <tr>
1.257 jkoshy 14751: <td>getservent</td>
1.259 leot 14752: <td>gettext</td>
1.156 leot 14753: </tr>
14754: <tr>
1.258 wiz 14755: <td>git</td>
1.259 leot 14756: <td>github</td>
1.258 wiz 14757: </tr>
14758: <tr>
14759: <td>gitlab</td>
1.259 leot 14760: <td>glob</td>
1.233 wiz 14761: </tr>
14762: <tr>
1.258 wiz 14763: <td>gnu</td>
1.259 leot 14764: <td>gnu_configure_strict</td>
1.174 leot 14765: </tr>
14766: <tr>
1.258 wiz 14767: <td>go</td>
1.259 leot 14768: <td>go-deps</td>
1.227 wiz 14769: </tr>
14770: <tr>
1.258 wiz 14771: <td>golang</td>
1.259 leot 14772: <td>guess-license</td>
1.223 nia 14773: </tr>
14774: <tr>
1.258 wiz 14775: <td>hashbang</td>
1.259 leot 14776: <td>heimdal</td>
1.217 rillig 14777: </tr>
14778: <tr>
1.258 wiz 14779: <td>help</td>
1.259 leot 14780: <td>hg</td>
1.238 wiz 14781: </tr>
14782: <tr>
1.257 jkoshy 14783: <td>imake</td>
1.259 leot 14784: <td>in-tree</td>
1.254 wiz 14785: </tr>
14786: <tr>
1.257 jkoshy 14787: <td>increment</td>
1.259 leot 14788: <td>indirect</td>
1.241 rillig 14789: </tr>
14790: <tr>
1.257 jkoshy 14791: <td>inet_aton</td>
1.260 wiz 14792: <td>install</td>
14793: </tr>
14794: <tr>
14795: <td>install-env</td>
1.259 leot 14796: <td>interp</td>
1.156 leot 14797: </tr>
14798: <tr>
1.257 jkoshy 14799: <td>interpreter</td>
1.259 leot 14800: <td>intl</td>
1.214 leot 14801: </tr>
14802: <tr>
1.257 jkoshy 14803: <td>ip4</td>
1.259 leot 14804: <td>ip6</td>
1.156 leot 14805: </tr>
14806: <tr>
1.257 jkoshy 14807: <td>ipv4</td>
1.259 leot 14808: <td>ipv6</td>
1.205 wiz 14809: </tr>
14810: <tr>
1.257 jkoshy 14811: <td>iso</td>
1.259 leot 14812: <td>kerberos</td>
1.197 leot 14813: </tr>
14814: <tr>
1.257 jkoshy 14815: <td>krb</td>
1.259 leot 14816: <td>krb5</td>
1.161 leot 14817: </tr>
14818: <tr>
1.257 jkoshy 14819: <td>ksh</td>
1.259 leot 14820: <td>lapack</td>
1.156 leot 14821: </tr>
14822: <tr>
1.257 jkoshy 14823: <td>latex</td>
1.259 leot 14824: <td>libiconv</td>
1.156 leot 14825: </tr>
14826: <tr>
1.241 rillig 14827: <td>libintl_bindtextdomain</td>
1.259 leot 14828: <td>libintl_gettext</td>
1.156 leot 14829: </tr>
14830: <tr>
1.241 rillig 14831: <td>libintl_textdomain</td>
1.259 leot 14832: <td>libnbcompat</td>
1.189 bacon 14833: </tr>
14834: <tr>
1.241 rillig 14835: <td>libs</td>
1.259 leot 14836: <td>libtool</td>
1.189 bacon 14837: </tr>
14838: <tr>
1.241 rillig 14839: <td>licence</td>
1.259 leot 14840: <td>license</td>
1.156 leot 14841: </tr>
14842: <tr>
1.241 rillig 14843: <td>lintl</td>
1.259 leot 14844: <td>little-endian</td>
1.177 leot 14845: </tr>
14846: <tr>
1.241 rillig 14847: <td>lock</td>
1.259 leot 14848: <td>locking</td>
1.156 leot 14849: </tr>
14850: <tr>
1.241 rillig 14851: <td>lua</td>
1.259 leot 14852: <td>lvalue</td>
1.174 leot 14853: </tr>
14854: <tr>
1.260 wiz 14855: <td>machine_endian</td>
1.241 rillig 14856: <td>make</td>
1.159 rillig 14857: </tr>
14858: <tr>
1.260 wiz 14859: <td>makedistinfo</td>
1.259 leot 14860: <td>makepatchsum</td>
14861: </tr>
14862: <tr>
1.260 wiz 14863: <td>makesum</td>
1.259 leot 14864: <td>mdi</td>
1.246 leot 14865: </tr>
14866: <tr>
1.260 wiz 14867: <td>memory</td>
1.258 wiz 14868: <td>mercurial</td>
14869: </tr>
14870: <tr>
1.260 wiz 14871: <td>meta</td>
1.257 jkoshy 14872: <td>meta-package</td>
1.156 leot 14873: </tr>
14874: <tr>
1.260 wiz 14875: <td>meta_package</td>
1.257 jkoshy 14876: <td>mit-krb5</td>
1.233 wiz 14877: </tr>
14878: <tr>
1.260 wiz 14879: <td>mk.conf</td>
1.257 jkoshy 14880: <td>mkl</td>
1.227 wiz 14881: </tr>
14882: <tr>
1.260 wiz 14883: <td>mount</td>
1.257 jkoshy 14884: <td>move</td>
1.156 leot 14885: </tr>
14886: <tr>
1.260 wiz 14887: <td>moved</td>
1.257 jkoshy 14888: <td>mprotect</td>
1.259 leot 14889: </tr>
14890: <tr>
1.260 wiz 14891: <td>mps</td>
1.258 wiz 14892: <td>mremap</td>
1.156 leot 14893: </tr>
14894: <tr>
1.260 wiz 14895: <td>native</td>
1.258 wiz 14896: <td>nb</td>
1.177 leot 14897: </tr>
14898: <tr>
1.260 wiz 14899: <td>nbcompat</td>
1.258 wiz 14900: <td>netlib</td>
1.159 rillig 14901: </tr>
14902: <tr>
1.260 wiz 14903: <td>network</td>
1.258 wiz 14904: <td>node</td>
1.255 wiz 14905: </tr>
14906: <tr>
1.260 wiz 14907: <td>node.js</td>
1.258 wiz 14908: <td>nodejs</td>
1.226 gutterid 14909: </tr>
14910: <tr>
1.260 wiz 14911: <td>obstack</td>
1.258 wiz 14912: <td>obstack_ptr_grow</td>
1.156 leot 14913: </tr>
14914: <tr>
1.260 wiz 14915: <td>occurs</td>
1.258 wiz 14916: <td>only</td>
1.156 leot 14917: </tr>
14918: <tr>
1.260 wiz 14919: <td>openblas</td>
1.258 wiz 14920: <td>options</td>
1.218 nia 14921: </tr>
14922: <tr>
1.260 wiz 14923: <td>options.mk</td>
1.258 wiz 14924: <td>order</td>
1.218 nia 14925: </tr>
14926: <tr>
1.260 wiz 14927: <td>override</td>
1.258 wiz 14928: <td>override-intltool</td>
1.205 wiz 14929: </tr>
14930: <tr>
1.260 wiz 14931: <td>override-message-intltool</td>
1.258 wiz 14932: <td>package</td>
1.156 leot 14933: </tr>
14934: <tr>
1.260 wiz 14935: <td>parallel</td>
1.258 wiz 14936: <td>path</td>
1.161 leot 14937: </tr>
14938: <tr>
1.260 wiz 14939: <td>pax</td>
1.258 wiz 14940: <td>paxctl</td>
1.156 leot 14941: </tr>
14942: <tr>
1.260 wiz 14943: <td>pbulk-index</td>
1.258 wiz 14944: <td>pc</td>
1.156 leot 14945: </tr>
14946: <tr>
1.260 wiz 14947: <td>perl</td>
1.258 wiz 14948: <td>perl5</td>
1.156 leot 14949: </tr>
14950: <tr>
1.260 wiz 14951: <td>perms</td>
1.258 wiz 14952: <td>php</td>
1.156 leot 14953: </tr>
14954: <tr>
1.260 wiz 14955: <td>pkg-build-options</td>
1.258 wiz 14956: <td>pkg-config</td>
1.156 leot 14957: </tr>
14958: <tr>
1.260 wiz 14959: <td>pkg_build_options</td>
1.258 wiz 14960: <td>pkgsrc</td>
1.156 leot 14961: </tr>
14962: <tr>
1.260 wiz 14963: <td>platform</td>
1.258 wiz 14964: <td>plist</td>
1.156 leot 14965: </tr>
14966: <tr>
1.260 wiz 14967: <td>post-extract</td>
1.258 wiz 14968: <td>post-fetch</td>
1.156 leot 14969: </tr>
14970: <tr>
1.260 wiz 14971: <td>post-wrapper</td>
1.258 wiz 14972: <td>pre-build-checks-hook</td>
1.156 leot 14973: </tr>
14974: <tr>
1.260 wiz 14975: <td>pre-configure-checks-hook</td>
1.258 wiz 14976: <td>pre-extract</td>
1.156 leot 14977: </tr>
14978: <tr>
1.260 wiz 14979: <td>pre-fetch</td>
1.258 wiz 14980: <td>print-go-deps</td>
1.156 leot 14981: </tr>
14982: <tr>
1.260 wiz 14983: <td>print-plist</td>
1.258 wiz 14984: <td>print-summary-data</td>
1.156 leot 14985: </tr>
14986: <tr>
1.260 wiz 14987: <td>privileged-install-hook</td>
1.258 wiz 14988: <td>pypi</td>
1.156 leot 14989: </tr>
14990: <tr>
1.260 wiz 14991: <td>python</td>
1.258 wiz 14992: <td>r</td>
1.174 leot 14993: </tr>
14994: <tr>
1.260 wiz 14995: <td>readme-all</td>
1.258 wiz 14996: <td>recursive</td>
1.156 leot 14997: </tr>
14998: <tr>
1.260 wiz 14999: <td>recv</td>
1.258 wiz 15000: <td>recvfrom</td>
1.156 leot 15001: </tr>
15002: <tr>
1.260 wiz 15003: <td>regcomp</td>
1.258 wiz 15004: <td>release-localbase-lock</td>
1.156 leot 15005: </tr>
15006: <tr>
1.260 wiz 15007: <td>release-lock</td>
1.258 wiz 15008: <td>relro</td>
1.156 leot 15009: </tr>
15010: <tr>
1.260 wiz 15011: <td>remove</td>
1.258 wiz 15012: <td>removed</td>
1.156 leot 15013: </tr>
15014: <tr>
1.260 wiz 15015: <td>rename</td>
1.258 wiz 15016: <td>renamed</td>
1.174 leot 15017: </tr>
15018: <tr>
1.260 wiz 15019: <td>reorder</td>
1.258 wiz 15020: <td>replace</td>
1.174 leot 15021: </tr>
15022: <tr>
1.260 wiz 15023: <td>replace_interpreter</td>
1.258 wiz 15024: <td>reproducible</td>
1.156 leot 15025: </tr>
15026: <tr>
1.260 wiz 15027: <td>resolv</td>
1.258 wiz 15028: <td>root</td>
1.226 gutterid 15029: </tr>
15030: <tr>
1.260 wiz 15031: <td>ruby</td>
1.258 wiz 15032: <td>send</td>
1.226 gutterid 15033: </tr>
15034: <tr>
1.260 wiz 15035: <td>sendfile</td>
1.258 wiz 15036: <td>sendto</td>
1.156 leot 15037: </tr>
15038: <tr>
1.260 wiz 15039: <td>setenv</td>
1.258 wiz 15040: <td>setgid</td>
1.156 leot 15041: </tr>
15042: <tr>
1.260 wiz 15043: <td>setprogname</td>
1.258 wiz 15044: <td>setuid</td>
1.156 leot 15045: </tr>
15046: <tr>
1.260 wiz 15047: <td>sh</td>
1.258 wiz 15048: <td>shebang</td>
1.174 leot 15049: </tr>
15050: <tr>
1.260 wiz 15051: <td>show</td>
1.258 wiz 15052: <td>show-all</td>
1.156 leot 15053: </tr>
15054: <tr>
1.260 wiz 15055: <td>show-build-defs</td>
1.258 wiz 15056: <td>show-depends</td>
1.156 leot 15057: </tr>
15058: <tr>
1.260 wiz 15059: <td>show-depends-dirs</td>
1.258 wiz 15060: <td>show-depends-pkgpaths</td>
1.156 leot 15061: </tr>
15062: <tr>
1.260 wiz 15063: <td>show-depends-recursive</td>
1.258 wiz 15064: <td>show-deps</td>
1.156 leot 15065: </tr>
15066: <tr>
1.260 wiz 15067: <td>show-distfiles</td>
1.258 wiz 15068: <td>show-downlevel</td>
1.181 rillig 15069: </tr>
15070: <tr>
1.260 wiz 15071: <td>show-subdir-var</td>
1.258 wiz 15072: <td>show-tools</td>
1.156 leot 15073: </tr>
15074: <tr>
1.260 wiz 15075: <td>show-var</td>
1.258 wiz 15076: <td>show-vars</td>
1.222 gutterid 15077: </tr>
15078: <tr>
1.260 wiz 15079: <td>snprintf</td>
1.258 wiz 15080: <td>socket</td>
1.223 nia 15081: </tr>
15082: <tr>
1.260 wiz 15083: <td>ssp</td>
1.258 wiz 15084: <td>st_mode</td>
1.156 leot 15085: </tr>
15086: <tr>
1.260 wiz 15087: <td>stage-install</td>
1.258 wiz 15088: <td>strcasestr</td>
1.156 leot 15089: </tr>
15090: <tr>
1.260 wiz 15091: <td>strict</td>
1.258 wiz 15092: <td>strip</td>
1.156 leot 15093: </tr>
15094: <tr>
1.260 wiz 15095: <td>strndup</td>
1.258 wiz 15096: <td>strnlen</td>
1.156 leot 15097: </tr>
15098: <tr>
1.260 wiz 15099: <td>strsep</td>
1.258 wiz 15100: <td>subst</td>
1.174 leot 15101: </tr>
15102: <tr>
1.260 wiz 15103: <td>substitutions</td>
1.258 wiz 15104: <td>subversion</td>
1.254 wiz 15105: </tr>
15106: <tr>
1.260 wiz 15107: <td>sun</td>
1.254 wiz 15108: <td>sunpro</td>
1.241 rillig 15109: </tr>
15110: <tr>
1.260 wiz 15111: <td>sunwspro</td>
1.258 wiz 15112: <td>svn</td>
1.214 leot 15113: </tr>
15114: <tr>
1.260 wiz 15115: <td>symlink</td>
1.242 gutterid 15116: <td>test</td>
1.212 wiz 15117: </tr>
15118: <tr>
1.260 wiz 15119: <td>test-env</td>
1.242 gutterid 15120: <td>tex</td>
1.227 wiz 15121: </tr>
15122: <tr>
1.260 wiz 15123: <td>texlive</td>
1.242 gutterid 15124: <td>tmp</td>
1.223 nia 15125: </tr>
15126: <tr>
1.260 wiz 15127: <td>todo</td>
1.242 gutterid 15128: <td>tool</td>
1.161 leot 15129: </tr>
15130: <tr>
1.260 wiz 15131: <td>tools</td>
1.242 gutterid 15132: <td>tools-libtool-m4-override</td>
1.156 leot 15133: </tr>
15134: <tr>
1.260 wiz 15135: <td>transitive</td>
1.242 gutterid 15136: <td>type</td>
1.156 leot 15137: </tr>
15138: <tr>
1.260 wiz 15139: <td>ulimit</td>
1.242 gutterid 15140: <td>undefined</td>
1.156 leot 15141: </tr>
15142: <tr>
1.260 wiz 15143: <td>undo-replace</td>
1.242 gutterid 15144: <td>unlimit</td>
1.156 leot 15145: </tr>
15146: <tr>
1.260 wiz 15147: <td>unprivileged</td>
1.242 gutterid 15148: <td>unprivileged-install-hook</td>
1.156 leot 15149: </tr>
15150: <tr>
1.260 wiz 15151: <td>unstripped</td>
1.242 gutterid 15152: <td>update</td>
1.156 leot 15153: </tr>
15154: <tr>
1.260 wiz 15155: <td>updated</td>
1.242 gutterid 15156: <td>upload</td>
1.156 leot 15157: </tr>
15158: <tr>
1.260 wiz 15159: <td>upload-distfiles</td>
1.242 gutterid 15160: <td>use_tools</td>
1.156 leot 15161: </tr>
15162: <tr>
1.260 wiz 15163: <td>user</td>
1.242 gutterid 15164: <td>utimes</td>
1.156 leot 15165: </tr>
15166: <tr>
1.260 wiz 15167: <td>vasprintf</td>
1.242 gutterid 15168: <td>verbose</td>
1.156 leot 15169: </tr>
15170: <tr>
1.260 wiz 15171: <td>vsnprintf</td>
1.242 gutterid 15172: <td>warn</td>
1.156 leot 15173: </tr>
15174: <tr>
1.260 wiz 15175: <td>warning</td>
1.242 gutterid 15176: <td>warnings</td>
1.156 leot 15177: </tr>
15178: <tr>
1.260 wiz 15179: <td>warnx</td>
1.242 gutterid 15180: <td>wattr_off</td>
1.156 leot 15181: </tr>
15182: <tr>
1.260 wiz 15183: <td>wattr_on</td>
1.242 gutterid 15184: <td>work</td>
1.156 leot 15185: </tr>
15186: <tr>
1.260 wiz 15187: <td>wrapper</td>
1.174 leot 15188: <td>wrkdir</td>
1.156 leot 15189: </tr>
15190: </table>
1.154 rillig 15191: </div>
15192: <div class="appendix">
15193: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 15194: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 15195: <div class="toc">
15196: <p><b>Table of Contents</b></p>
1.100 leot 15197: <dl class="toc">
1.207 leot 15198: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
15199: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 15200: </dl>
15201: </div>
15202: <p>This section contains information on editing the pkgsrc
15203: guide itself.</p>
1.41 asau 15204: <div class="sect1">
1.1 dsieger 15205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 15206: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.1 dsieger 15207: <p>The pkgsrc guide's source code is stored in
15208: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
15209: are created from it:</p>
1.41 asau 15210: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 15211: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
15212: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.174 leot 15213: <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>
15214: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1 dsieger 15215: The PDF version of the pkgsrc guide.</p></li>
1.174 leot 15216: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1 dsieger 15217: PostScript version of the pkgsrc guide.</p></li>
15218: </ul></div>
15219: </div>
1.41 asau 15220: <div class="sect1">
1.1 dsieger 15221: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 15222: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.1 dsieger 15223: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 15224: <div class="procedure"><ol class="procedure" type="1">
1.190 bacon 15225: <li class="step"><p>Make sure you have checked out the htdocs repository
15226: into a sibling directory of your pkgsrc directory. You will need
15227: the ability to commit from both pkgsrc and htdocs.</p></li>
1.41 asau 15228: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 15229: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 15230: documentation) installed. These are automatically installed when
1.207 leot 15231: you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/index.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.41 asau 15232: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 15233: right directory. All further steps will take place
15234: here.</p></li>
1.41 asau 15235: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 15236: <code class="filename">files/</code>.</p></li>
1.41 asau 15237: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 15238: guide for valid XML and to build the final output files. If you
15239: get any errors at this stage, you can just edit the files, as
15240: there are only symbolic links in the working directory, pointing
15241: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 15242: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 15243: commit)</strong></span></p></li>
1.41 asau 15244: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 15245: regenerate the output files with the proper RCS
15246: Ids.</p></li>
1.41 asau 15247: <li class="step">
1.10 hubertf 15248: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 15249: commit the files in both <code class="filename">pkgsrc/doc</code> and
15250: <code class="filename">htdocs</code>.</p>
1.41 asau 15251: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 15252: <h3 class="title">Note</h3>
15253: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 15254: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
15255: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 15256: directory.</p>
15257: </div>
15258: </li>
15259: </ol></div>
15260: </div>
15261: </div>
15262: </div></body>
15263: </html>
CVSweb <webmaster@jp.NetBSD.org>