Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.275
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
1.274 wiz 4: <meta charset="utf-8">
1.1 dsieger 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.269 wiz 33: <div><p class="copyright">Copyright © 1994-2026 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.46 2026/01/01 08:41:23 wiz 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>
1.272 wiz 128: <dt><span class="sect1"><a href="#bulk.scan">8.3. Speeding up bulk build scans</a></span></dt>
129: <dt><span class="sect1"><a href="#bulk.req">8.4. Requirements of a full bulk build</a></span></dt>
130: <dt><span class="sect1"><a href="#bulk.var">8.5. Bulk build variants</a></span></dt>
131: <dd><dl>
132: <dt><span class="sect2"><a href="#bulk.var.confopt">8.5.1. Detect unknown configure options</a></span></dt>
133: <dt><span class="sect2"><a href="#bulk.var.comperr">8.5.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
134: <dt><span class="sect2"><a href="#bulk.var.builderr">8.5.3. Force compiler options only in the build phase</a></span></dt>
135: <dt><span class="sect2"><a href="#bulk.var.dirs">8.5.4. Use custom directories</a></span></dt>
136: <dt><span class="sect2"><a href="#bulk.var.warn">8.5.5. Turn warnings into errors</a></span></dt>
137: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.5.6. Reject packages for which pkglint reports errors</a></span></dt>
138: <dt><span class="sect2"><a href="#bulk.var.strings">8.5.7. Reject packages that contain forbidden strings</a></span></dt>
139: <dt><span class="sect2"><a href="#bulk.var.test">8.5.8. Reject packages whose self-test fails</a></span></dt>
140: <dt><span class="sect2"><a href="#bulk.var.shvar">8.5.9. Reject packages that use undefined shell variables</a></span></dt>
141: <dt><span class="sect2"><a href="#bulk.var.quiet">8.5.10. Turn off verbose logging</a></span></dt>
1.178 rillig 142: </dl></dd>
1.272 wiz 143: <dt><span class="sect1"><a href="#creating-cdroms">8.6. Creating a multiple CD-ROM packages collection</a></span></dt>
144: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.6.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 145: </dl></dd>
146: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
147: <dd><dl>
148: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
149: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
150: </dl></dd>
151: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
152: <dd><dl>
153: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
154: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
155: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
156: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
157: <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>
158: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
159: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
160: <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>
161: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
1.266 martin 162: <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
163: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
164: <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 165: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 166: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
167: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
168: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
169: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
1.266 martin 170: <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 171: </dl></dd>
172: </dl></dd>
173: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
174: <dd><dl>
1.154 rillig 175: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 176: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 177: <dd><dl>
1.184 rillig 178: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
179: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
180: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 181: <dd><dl>
1.184 rillig 182: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
183: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
184: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
185: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
186: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 187: </dl></dd>
1.184 rillig 188: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
189: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
190: <dd><dl>
191: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
192: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
193: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
194: </dl></dd>
195: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
196: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 197: </dl></dd>
1.184 rillig 198: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 199: <dd><dl>
1.184 rillig 200: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
201: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
202: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
203: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
204: <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 205: <dd><dl>
1.184 rillig 206: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
207: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 208: </dl></dd>
1.184 rillig 209: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
210: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
211: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
212: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
213: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
214: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
215: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
216: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
217: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
218: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
219: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
220: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
221: </dl></dd>
222: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
223: <dd><dl>
224: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 225: <dd><dl>
1.219 nia 226: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
227: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
228: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.6 rillig 229: </dl></dd>
1.184 rillig 230: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
231: <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 232: </dl></dd>
1.184 rillig 233: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 234: <dd><dl>
1.184 rillig 235: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
236: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
237: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
238: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 239: <dd><dl>
1.184 rillig 240: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
241: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
242: <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>
243: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 244: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.6 rillig 245: </dl></dd>
246: </dl></dd>
1.184 rillig 247: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 248: <dd><dl>
1.184 rillig 249: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
250: <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>
251: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
252: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 253: </dl></dd>
1.184 rillig 254: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 255: <dd><dl>
1.184 rillig 256: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
257: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
258: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
259: </dl></dd>
260: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
261: <dd><dl>
262: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
263: <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 264: <dd><dl>
1.184 rillig 265: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
266: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 267: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
268: and
269: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
270: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 271: </dl></dd>
1.184 rillig 272: <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 273: <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 274: </dl></dd>
275: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 276: <dd><dl>
1.184 rillig 277: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
278: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
279: <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>
280: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
281: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
282: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
283: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
284: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
285: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 286: </dl></dd>
1.184 rillig 287: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
288: <dd><dl>
289: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
290: <dd><dl>
291: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
292: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 293: </dl></dd>
1.184 rillig 294: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 295: <dd><dl>
1.184 rillig 296: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
297: <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 298: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
299: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
300: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 301: </dl></dd>
302: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
303: <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>
304: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
305: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
306: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
307: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
308: <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 309: </dl></dd>
310: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
311: <dd><dl>
312: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
313: <dd><dl>
314: <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>
315: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
316: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
317: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
318: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
319: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
320: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
321: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
322: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
323: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
324: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
325: </dl></dd>
326: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
327: <dd><dl>
328: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
329: <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>
330: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
331: </dl></dd>
332: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
333: <dd><dl>
334: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
336: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 337: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.260 wiz 338: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.154 rillig 339: </dl></dd>
340: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
341: <dd><dl>
342: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
343: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 344: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 345: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
346: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
347: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
348: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 349: </dl></dd>
350: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
351: <dd><dl>
352: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
353: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 354: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
1.266 martin 355: <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>
1.172 rillig 356: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 357: </dl></dd>
358: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
359: <dd><dl>
360: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
361: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
362: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
363: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
364: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 365: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.254 wiz 366: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
367: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
368: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
369: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
370: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
371: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
372: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
373: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
374: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
375: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.1 dsieger 376: emulation</a></span></dt>
1.254 wiz 377: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
378: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.1 dsieger 379: </dl></dd>
1.154 rillig 380: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 381: </dl></dd>
1.184 rillig 382: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
383: <dd><dl>
384: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
385: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
386: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
387: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
388: </dl></dd>
1.154 rillig 389: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 390: <dd><dl>
1.154 rillig 391: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
392: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
393: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
394: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
395: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
396: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
397: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
398: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
399: </dl></dd>
1.263 wiz 400: <dt><span class="chapter"><a href="#policies">24. pkgsrc Policies</a></span></dt>
401: <dd><dl>
402: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
403: <dd><dl>
404: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
405: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
406: </dl></dd>
407: </dl></dd>
408: <dt><span class="chapter"><a href="#devfaq">25. Frequently Asked Questions</a></span></dt>
1.1 dsieger 409: </dl></dd>
410: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
411: <dd><dl>
1.263 wiz 412: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 413: <dd><dl>
1.263 wiz 414: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
415: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
416: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 417: <dd><dl>
1.263 wiz 418: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
419: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 420: </dl></dd>
1.263 wiz 421: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
422: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 423: <dd><dl>
1.263 wiz 424: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
425: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 426: </dl></dd>
1.263 wiz 427: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 428: <dd><dl>
1.263 wiz 429: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
430: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 431: </dl></dd>
432: </dl></dd>
1.263 wiz 433: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1 dsieger 434: <dd><dl>
1.263 wiz 435: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
436: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 437: <dd><dl>
1.263 wiz 438: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
439: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 440: </dl></dd>
441: </dl></dd>
1.263 wiz 442: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
443: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 444: </dl></dd>
445: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
446: <dd><dl>
447: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
448: <dd><dl>
449: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
450: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
451: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 452: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 453: </dl></dd>
454: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
455: </dl></dd>
1.207 leot 456: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.1 dsieger 457: <dd><dl>
1.207 leot 458: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
459: <dd><dl>
460: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
461: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
462: </dl></dd>
463: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
464: <dd><dl>
465: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
466: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
467: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
468: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
469: </dl></dd>
470: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
471: <dd><dl>
472: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
473: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
474: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
475: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
476: </dl></dd>
477: </dl></dd>
478: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
479: <dd><dl>
480: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
481: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.1 dsieger 482: </dl></dd>
1.207 leot 483: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.1 dsieger 484: <dd><dl>
1.207 leot 485: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
486: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
487: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
488: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
489: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.148 leot 490: <code class="filename">stable</code>,
1.23 wiz 491: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 492: source packages</a></span></dt>
493: </dl></dd>
1.207 leot 494: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
495: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1 dsieger 496: <dd><dl>
1.207 leot 497: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
498: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 499: </dl></dd>
500: </dl>
501: </div>
502: <div class="list-of-tables">
503: <p><b>List of Tables</b></p>
504: <dl>
505: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
506: </dt>
1.184 rillig 507: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 508: </dt>
1.184 rillig 509: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 510: </dt>
511: </dl>
512: </div>
1.41 asau 513: <div class="chapter">
514: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 515: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 516: <div class="toc">
517: <p><b>Table of Contents</b></p>
1.100 leot 518: <dl class="toc">
1.1 dsieger 519: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
520: <dd><dl>
521: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
522: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
523: </dl></dd>
524: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
525: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
526: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
527: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
528: </dl>
529: </div>
1.41 asau 530: <div class="sect1">
1.1 dsieger 531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 532: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.1 dsieger 533: <p>There is a lot of software freely available for Unix-based
534: systems, which is usually available in form of the source code. Before
535: such software can be used, it needs to be configured to the local
536: system, compiled and installed, and this is exactly what The NetBSD
537: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
538: to handle binary packages, so that not every user has to build the
539: packages for himself, which is a time-costly task.</p>
540: <p>pkgsrc currently contains several thousand packages,
541: including:</p>
1.41 asau 542: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 543: <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 544: web server</p></li>
1.207 leot 545: <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 546: web browser</p></li>
1.207 leot 547: <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 548: Desktop Environment</p></li>
1.207 leot 549: <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 550: Desktop Environment</p></li>
551: </ul></div>
1.266 martin 552: <p>… just to name a few.</p>
1.1 dsieger 553: <p>pkgsrc has built-in support for handling varying dependencies,
554: such as pthreads and X11, and extended features such as IPv6 support on
555: a range of platforms.</p>
1.41 asau 556: <div class="sect2">
1.1 dsieger 557: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 558: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
1.1 dsieger 559: <p>
560: pkgsrc provides the following key features:
561: </p>
1.41 asau 562: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 563: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 564: and installation of binary packages. The source and latest
565: patches are retrieved from a master or mirror download site, checksum
566: verified, then built on your system. Support for binary-only
567: distributions is available for both native platforms and NetBSD
568: emulated platforms.</p></li>
1.23 wiz 569: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 570: including binaries, libraries, man pages and other
571: documentation.</p></li>
1.104 sevan 572: <li class="listitem"><p>Tracking of package dependencies automatically, including when
573: performing updates, to ensure required packages are installed. The
574: configuration files of various packages are handled automatically during
575: updates, so local changes are preserved.</p></li>
1.23 wiz 576: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 577: consists of highly portable code. This allows the greatest speed of
1.25 spz 578: development when porting to a new platform. This portability also
1.1 dsieger 579: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
580: platforms</em></span>.</p></li>
1.23 wiz 581: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 582: international encryption requirements and build-time options for a
583: large number of packages are all set in a simple, central
584: configuration file.</p></li>
1.23 wiz 585: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 586: freely available under a BSD license, so you may extend and adapt
587: pkgsrc to your needs. Support for local packages and patches is
588: available right out of the box, so you can configure it specifically
589: for your environment.</p></li>
590: </ul></div>
591: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 592: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.266 martin 593: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 594: — That means, if a package contains bugs, it's better to find
1.1 dsieger 595: them and to complain about them rather than to just install the package
596: and hope that it works. There are numerous checks in pkgsrc that try to
1.207 leot 597: 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 598: of shell scripts), and post-installation checks (installed files,
599: references to shared libraries, script interpreters).</p></li>
1.266 martin 600: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 601: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 602: pkgsrc has been ported to many operating systems. Care is taken that
603: packages behave the same on all platforms.</p></li>
604: </ul></div>
605: </div>
1.41 asau 606: <div class="sect2">
1.1 dsieger 607: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 608: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
1.1 dsieger 609: <p>pkgsrc consists of both a source distribution and a binary
610: distribution for these operating systems. After retrieving the required
611: source or binaries, you can be up and running with pkgsrc in just
612: minutes!</p>
613: <p>pkgsrc was derived from FreeBSD's ports system, and
614: initially developed for NetBSD only. Since then, pkgsrc has
615: grown a lot, and now supports the following platforms:</p>
616: <div class="table">
1.266 martin 617: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 618: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 619: <colgroup>
620: <col>
621: <col>
1.92 sevan 622: <col>
1.1 dsieger 623: </colgroup>
624: <thead><tr>
625: <th>Platform</th>
626: <th>Date Support Added</th>
1.92 sevan 627: <th>Notes</th>
1.1 dsieger 628: </tr></thead>
629: <tbody>
630: <tr>
1.174 leot 631: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 632: <td align="center">Aug 1997</td>
1.266 martin 633: <td class="auto-generated"> </td>
1.1 dsieger 634: </tr>
635: <tr>
1.10 hubertf 636: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 637: <td align="center">Mar 1999</td>
1.151 sevan 638: <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 639: </tr>
640: <tr>
1.174 leot 641: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 642: <td align="center">Jun 1999</td>
1.151 sevan 643: <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 644: </tr>
645: <tr>
646: <td>
1.118 sevan 647: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 648: </td>
649: <td align="center">Oct 2001</td>
1.191 bacon 650: <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 651: </tr>
652: <tr>
1.174 leot 653: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 654: <td align="center">Nov 2002</td>
1.151 sevan 655: <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 656: </tr>
657: <tr>
1.174 leot 658: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 659: <td align="center">Nov 2002</td>
1.151 sevan 660: <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 661: </tr>
662: <tr>
1.174 leot 663: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 664: <td align="center">Dec 2002</td>
1.92 sevan 665: <td>
1.151 sevan 666: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.92 sevan 667: </td>
1.1 dsieger 668: </tr>
669: <tr>
670: <td>BSD/OS</td>
671: <td align="center">Dec 2003</td>
1.262 dholland 672: <td align="center">Removed from pkgsrc Mar 2025</td>
1.1 dsieger 673: </tr>
674: <tr>
1.174 leot 675: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 676: <td align="center">Dec 2003</td>
1.151 sevan 677: <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 678: </tr>
679: <tr>
680: <td>
1.174 leot 681: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 682: (Microsoft Windows Services for Unix)
683: </td>
684: <td align="center">Mar 2004</td>
1.264 wiz 685: <td align="center">Removed from pkgsrc Apr 2025</td>
1.1 dsieger 686: </tr>
687: <tr>
1.174 leot 688: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 689: <td align="center">Oct 2004</td>
1.266 martin 690: <td class="auto-generated"> </td>
1.1 dsieger 691: </tr>
692: <tr>
1.10 hubertf 693: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 694: <td align="center">Nov 2004</td>
1.151 sevan 695: <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 696: </tr>
697: <tr>
1.174 leot 698: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 699: <td align="center">Apr 2007</td>
1.151 sevan 700: <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 701: </tr>
1.23 wiz 702: <tr>
1.174 leot 703: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.23 wiz 704: <td align="center">Sep 2010</td>
1.151 sevan 705: <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 706: </tr>
1.45 obache 707: <tr>
1.174 leot 708: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 709: <td align="center">Jan 2011</td>
1.262 dholland 710: <td align="center">Removed from pkgsrc Mar 2025</td>
1.45 obache 711: </tr>
712: <tr>
1.174 leot 713: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.45 obache 714: <td align="center">Nov 2011</td>
1.151 sevan 715: <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 716: </tr>
717: <tr>
1.174 leot 718: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.45 obache 719: <td align="center">Mar 2013</td>
1.151 sevan 720: <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 721: </tr>
1.58 ryoon 722: <tr>
1.174 leot 723: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.58 ryoon 724: <td align="center">Jul 2013</td>
1.261 maya 725: <td>Removed from pkgsrc Mar 2025</td>
1.58 ryoon 726: </tr>
1.104 sevan 727: <tr>
1.174 leot 728: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.104 sevan 729: <td align="center">Jun 2014</td>
1.229 gutterid 730: <td>Removed from pkgsrc Sep 2022</td>
1.104 sevan 731: </tr>
1.1 dsieger 732: </tbody>
733: </table></div>
734: </div>
735: <br class="table-break">
736: </div>
737: </div>
1.41 asau 738: <div class="sect1">
1.1 dsieger 739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 740: <a name="overview"></a>1.2. Overview</h2></div></div></div>
1.1 dsieger 741: <p>This document is divided into three parts. The first,
1.266 martin 742: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 743: describes how one can use one of the packages in the Package
744: Collection, either by installing a precompiled binary package,
745: or by building one's own copy using the NetBSD package system.
1.266 martin 746: 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 747: package so it can be easily built by other NetBSD users without
748: knowing about the package's building details. The third part,
1.266 martin 749: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 750: is intended for those who want to understand how pkgsrc is
751: implemented.</p>
752: <p>This document is available in various formats:
1.10 hubertf 753: <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 754: </div>
1.41 asau 755: <div class="sect1">
1.1 dsieger 756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 757: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
758: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
759: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 760: terminology used within this document.</p>
1.41 asau 761: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 762: <dt><span class="term">Package</span></dt>
763: <dd><p>A set of files and building instructions
764: that describe what's necessary
765: to build a certain piece of software using
766: pkgsrc. Packages are traditionally stored under
1.123 wiz 767: <code class="filename">/usr/pkgsrc</code>,
768: but may be stored in any location,
769: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1 dsieger 770: <dt><span class="term">The NetBSD package system</span></dt>
1.266 martin 771: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 772: is part of the NetBSD operating system and can be bootstrapped
773: to run on non-NetBSD operating systems as well. It handles
774: building (compiling), installing, and removing of
775: packages.</p></dd>
776: <dt><span class="term">Distfile</span></dt>
777: <dd><p>This term describes the file or files that are
778: provided by the author of the piece of software to
779: distribute his work. All the changes necessary to build on
780: NetBSD are reflected in the corresponding package. Usually
781: the distfile is in the form of a compressed tar-archive,
782: but other types are possible, too. Distfiles are usually
783: stored below
784: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
785: <dt><span class="term">Port</span></dt>
786: <dd><p>This is the term used by FreeBSD and OpenBSD people
787: for what we call a package.
1.266 martin 788: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 789: architecture.</p></dd>
790: <dt><span class="term">Precompiled/binary package</span></dt>
791: <dd>
792: <p>A set of binaries built with pkgsrc from a distfile
793: and stuffed together in a single <code class="filename">.tgz</code>
794: file so it can be installed on machines of the same
795: machine architecture without the need to
796: recompile. Packages are usually generated in
797: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 798: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.266 martin 799: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 800: especially in the context of precompiled packages.</p>
801: </dd>
802: <dt><span class="term">Program</span></dt>
803: <dd><p>The piece of software to be installed which will be
804: constructed from all the files in the distfile by the
805: actions defined in the corresponding package.</p></dd>
806: </dl></div>
1.41 asau 807: <div class="sect2">
1.1 dsieger 808: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 809: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 810: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 811: <dt><span class="term">pkgsrc users</span></dt>
812: <dd>
813: <p>The
814: pkgsrc users are people who use the packages provided by pkgsrc.
815: Typically they are system administrators. The people using the
1.266 martin 816: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
817: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 818: <p>There are two kinds of pkgsrc users: Some only want to
819: install pre-built binary packages. Others build the pkgsrc
820: packages from source, either for installing them directly or for
1.266 martin 821: 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 822: documentation.</p>
823: </dd>
824: <dt><span class="term">package maintainers</span></dt>
825: <dd><p>A
1.266 martin 826: 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 827: <dt><span class="term">infrastructure developers</span></dt>
828: <dd><p>These people are involved in all those files
829: that live in the <code class="filename">mk/</code> directory and below.
1.266 martin 830: 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 831: too.</p></dd>
832: </dl></div>
833: </div>
834: </div>
1.41 asau 835: <div class="sect1">
1.1 dsieger 836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 837: <a name="typography"></a>1.4. Typography</h2></div></div></div>
1.1 dsieger 838: <p>When giving examples for commands, shell prompts are used to
839: show if the command should/can be issued as root, or if
1.266 martin 840: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 841: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
842: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.229 gutterid 843: Bourne shell and derivatives.</p>
1.1 dsieger 844: </div>
845: </div>
1.41 asau 846: <div class="part">
1.1 dsieger 847: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 848: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
1.1 dsieger 849: <div class="toc">
850: <p><b>Table of Contents</b></p>
1.100 leot 851: <dl class="toc">
1.154 rillig 852: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
853: <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 854: <dd><dl>
1.154 rillig 855: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 856: <dd><dl>
1.154 rillig 857: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
858: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 859: </dl></dd>
1.154 rillig 860: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 861: <dd><dl>
1.154 rillig 862: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
863: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 864: </dl></dd>
865: </dl></dd>
1.154 rillig 866: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 867: <dd><dl>
1.154 rillig 868: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
869: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 870: </dl></dd>
1.154 rillig 871: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 872: <dd><dl>
1.154 rillig 873: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 874: <dd><dl>
1.154 rillig 875: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
876: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 877: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
878: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
879: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
880: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
881: <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>
882: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1 dsieger 883: </dl></dd>
1.154 rillig 884: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 885: <dd><dl>
1.154 rillig 886: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
887: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
888: <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 889: </dl></dd>
890: </dl></dd>
1.154 rillig 891: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 892: <dd><dl>
1.154 rillig 893: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
894: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 895: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
896: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
897: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
898: <dd><dl>
899: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
900: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
901: <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 902: </dl></dd>
1.241 rillig 903: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
904: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 905: </dl></dd>
1.154 rillig 906: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 907: <dd><dl>
1.154 rillig 908: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
909: <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 910: </dl></dd>
1.154 rillig 911: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 912: builds)</a></span></dt>
1.1 dsieger 913: <dd><dl>
1.154 rillig 914: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 915: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 916: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
1.272 wiz 917: <dt><span class="sect1"><a href="#bulk.scan">8.3. Speeding up bulk build scans</a></span></dt>
918: <dt><span class="sect1"><a href="#bulk.req">8.4. Requirements of a full bulk build</a></span></dt>
919: <dt><span class="sect1"><a href="#bulk.var">8.5. Bulk build variants</a></span></dt>
920: <dd><dl>
921: <dt><span class="sect2"><a href="#bulk.var.confopt">8.5.1. Detect unknown configure options</a></span></dt>
922: <dt><span class="sect2"><a href="#bulk.var.comperr">8.5.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
923: <dt><span class="sect2"><a href="#bulk.var.builderr">8.5.3. Force compiler options only in the build phase</a></span></dt>
924: <dt><span class="sect2"><a href="#bulk.var.dirs">8.5.4. Use custom directories</a></span></dt>
925: <dt><span class="sect2"><a href="#bulk.var.warn">8.5.5. Turn warnings into errors</a></span></dt>
926: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.5.6. Reject packages for which pkglint reports errors</a></span></dt>
927: <dt><span class="sect2"><a href="#bulk.var.strings">8.5.7. Reject packages that contain forbidden strings</a></span></dt>
928: <dt><span class="sect2"><a href="#bulk.var.test">8.5.8. Reject packages whose self-test fails</a></span></dt>
929: <dt><span class="sect2"><a href="#bulk.var.shvar">8.5.9. Reject packages that use undefined shell variables</a></span></dt>
930: <dt><span class="sect2"><a href="#bulk.var.quiet">8.5.10. Turn off verbose logging</a></span></dt>
1.178 rillig 931: </dl></dd>
1.272 wiz 932: <dt><span class="sect1"><a href="#creating-cdroms">8.6. Creating a multiple CD-ROM packages collection</a></span></dt>
933: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.6.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 934: </dl></dd>
935: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
936: <dd><dl>
937: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
938: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
939: </dl></dd>
940: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
941: <dd><dl>
942: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
943: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
944: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
945: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
946: <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>
947: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
948: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
949: <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>
950: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
1.266 martin 951: <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
952: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
953: <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 954: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 955: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
956: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
957: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
958: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
1.266 martin 959: <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 960: </dl></dd>
961: </dl>
962: </div>
1.41 asau 963: <div class="chapter">
1.1 dsieger 964: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 965: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
1.154 rillig 966: <p>
967: To get help when using pkgsrc, the definitive source is this
968: document, the pkgsrc guide. If you don't find anything here,
969: there are alternatives:
970: </p>
971: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
972: <li class="listitem">
973: <p>
974: The built-in pkgsrc help, which is available after bootstrapping
1.266 martin 975: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
1.154 rillig 976: help for any topic, such as a variable name like
977: <code class="varname">BUILD_DEFS</code>, a make target like
978: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
979: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.266 martin 980: <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 981: </li>
982: <li class="listitem"><p>
1.163 rillig 983: To see the value of a single variable, run <span class="command"><strong>bmake
984: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
985: </p></li>
986: <li class="listitem"><p>
987: To see the values of the most common variables, run
988: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
989: topic. To see the variables for a single topic, run
990: <span class="command"><strong>bmake
991: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
992: <span class="command"><strong>bmake show-all-fetch</strong></span>.
993: </p></li>
994: <li class="listitem"><p>
1.154 rillig 995: The pkgsrc-users mailing list, to which
996: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
997: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
998: questions</a>.</p></li>
999: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
1.262 dholland 1000: <a class="ulink" href="https://web.libera.chat/" target="_top">via a web browser</a>
1.154 rillig 1001: or by using a specialized chat program such as
1002: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
1003: Pick any user name and join the channel #pkgsrc.</p></li>
1004: </ul></div>
1005: </div>
1006: <div class="chapter">
1007: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 1008: <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 1009: <div class="toc">
1010: <p><b>Table of Contents</b></p>
1.100 leot 1011: <dl class="toc">
1.154 rillig 1012: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 1013: <dd><dl>
1.154 rillig 1014: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
1015: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 1016: </dl></dd>
1.154 rillig 1017: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 1018: <dd><dl>
1.154 rillig 1019: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
1020: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 1021: </dl></dd>
1022: </dl>
1023: </div>
1024: <p>Before you download and extract the files, you need to decide
1025: where you want to extract them. When using pkgsrc as root user, pkgsrc
1026: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
1027: free to install the sources and binary packages wherever you want in
1028: your filesystem, provided that the pathname does not contain white-space
1029: or other characters that are interpreted specially by the shell and some
1030: other programs. A safe bet is to use only letters, digits, underscores
1031: and dashes.</p>
1.41 asau 1032: <div class="sect1">
1.1 dsieger 1033: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1034: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 1035: <p>Before you download any pkgsrc files, you should decide
1036: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1037: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1038: quarterly basis from the current branch and only gets modified
1039: for security updates. The names of the stable branches are built
1040: from the year and the quarter, for example
1.267 leot 1041: <code class="literal">2025Q4</code>.</p>
1.1 dsieger 1042: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 1043: want to download pkgsrc. You can get it as a tar file or via CVS.
1044: Both ways are described here.</p>
1.51 asau 1045: <p>Note that tar archive contains CVS working copy.
1046: Thus you can switch to using CVS at any later time.</p>
1.41 asau 1047: <div class="sect2">
1.1 dsieger 1048: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1049: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 1050: <p>The primary download location for all pkgsrc files is
1.151 sevan 1051: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 1052: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1053: (it points to the same location).
1054: There are a number of subdirectories for different purposes,
1.266 martin 1055: 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 1056: <p>The tar archive for the current branch is in the directory
1.151 sevan 1057: <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 1058: It is autogenerated weekly.</p>
1.51 asau 1059: <p>To save download time we provide bzip2- and
1060: xz-compressed archives which are published at
1.151 sevan 1061: <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 1062: and
1.151 sevan 1063: <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 1064: respectively.
1065: </p>
1066: <p>You can fetch the same files using FTP.</p>
1.267 leot 1067: <p>The tar file for the stable branch 2025Q4 is in the
1068: directory <code class="filename">pkgsrc-2025Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2025Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136 leot 1069: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 1070: <pre class="screen">
1.267 leot 1071: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2025Q4/pkgsrc.tar.gz</code></strong></pre>
1.78 snj 1072: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1073: or your web browser.</p>
1.12 weinem 1074: <p>Then, extract it with:</p>
1.78 snj 1075: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1076: <p>This will create the directory <code class="filename">pkgsrc/</code>
1077: in <code class="filename">/usr/</code> and all the package source will be
1078: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1079: <p>To download pkgsrc-current, run:</p>
1080: <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 1081: </div>
1.41 asau 1082: <div class="sect2">
1.1 dsieger 1083: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1084: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1085: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.267 leot 1086: <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-2025Q4 -P pkgsrc</code></strong>
1.23 wiz 1087: </pre>
1088: <p>This will create the directory <code class="filename">pkgsrc/</code>
1089: in your <code class="filename">/usr/</code> directory and all the package source
1090: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1091: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1092: <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 1093: </pre>
1.174 leot 1094: <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 1095: <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 1096: <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 1097: </pre>
1098: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1099: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1100: or better globally in <code class="filename">/etc/profile</code>:</p>
1101: <pre class="programlisting">
1102: # set CVS remote shell command
1103: CVS_RSH=ssh
1104: export CVS_RSH
1105: </pre>
1106: <p>By default, CVS doesn't do things like most people would expect it to do.
1107: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1108: in your home directory and saving the following lines to it.
1109: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1110: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1111: <pre class="programlisting">
1112: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1113: cvs -q
1.2 rillig 1114: checkout -P
1.4 rillig 1115: update -dP
1116: diff -upN
1.2 rillig 1117: rdiff -u
1.23 wiz 1118: release -d
1.2 rillig 1119: </pre>
1.1 dsieger 1120: </div>
1121: </div>
1.41 asau 1122: <div class="sect1">
1.1 dsieger 1123: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1124: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1125: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1126: (which also works if you have first installed it via a tar
1127: file). It saves bandwidth and hard disk activity, compared to
1128: downloading the tar file again.</p>
1.41 asau 1129: <div class="sect2">
1.1 dsieger 1130: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1131: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1132: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1133: <h3 class="title">Warning</h3>
1134: <p>When updating from a tar file, you first need to
1135: completely remove the old pkgsrc directory. Otherwise those
1136: files that have been removed from pkgsrc in the mean time will
1137: not be removed on your local disk, resulting in inconsistencies.
1138: When removing the old files, any changes that you have done to
1139: the pkgsrc files will be lost after updating. Therefore updating
1140: via CVS is strongly recommended.</p>
1141: </div>
1142: <p>Note that by default the distfiles and the binary packages
1143: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1144: before updating. You can also configure pkgsrc to store distfiles
1145: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1146: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.266 martin 1147: 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 1148: <p>To update pkgsrc from a tar file, download the tar file as
1149: explained above. Then, make sure that you have not made any
1150: changes to the files in the pkgsrc directory. Remove the pkgsrc
1151: directory and extract the new tar file. Done.</p>
1152: </div>
1.41 asau 1153: <div class="sect2">
1.1 dsieger 1154: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1155: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1156: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1157: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1158: </pre>
1159: <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>
1160: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1161: </pre>
1.41 asau 1162: <div class="sect3">
1.1 dsieger 1163: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 1164: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1165: <p>When updating pkgsrc, the CVS program keeps track of the
1166: branch you selected. But if you, for whatever reason, want to
1167: switch from the stable branch to the current one, you can do it
1.266 martin 1168: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1169: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1170: back to the stable branch, add the
1.267 leot 1171: <span class="quote">“<span class="quote">-rpkgsrc-2025Q4</span>”</span> option.</p>
1.1 dsieger 1172: </div>
1.41 asau 1173: <div class="sect3">
1.1 dsieger 1174: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 1175: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1176: <p>When you update pkgsrc, the CVS program will only touch
1177: those files that are registered in the CVS repository. That
1178: means that any packages that you created on your own will stay
1179: unmodified. If you change files that are managed by CVS, later
1180: updates will try to merge your changes with those that have been
1181: done by others. See the CVS manual, chapter
1.266 martin 1182: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1183: </div>
1184: </div>
1185: </div>
1186: </div>
1.41 asau 1187: <div class="chapter">
1.1 dsieger 1188: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 1189: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1190: <div class="toc">
1191: <p><b>Table of Contents</b></p>
1.100 leot 1192: <dl class="toc">
1.154 rillig 1193: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1194: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1195: </dl>
1196: </div>
1.41 asau 1197: <div class="sect1">
1.1 dsieger 1198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1199: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1200: <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 1201: </div>
1.41 asau 1202: <div class="sect1">
1.1 dsieger 1203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1204: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1205: <p>pkgsrc can be bootstrapped for use in two different modes:
1206: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1207: to privileged one all programs are installed under one particular user
1.43 asau 1208: and cannot utilise privileged operations (packages don't create
1209: special users and all special file permissions like setuid are ignored).
1210: </p>
1.1 dsieger 1211: <p>Installing the bootstrap kit from source should be as simple as:</p>
1212: <pre class="screen">
1.60 asau 1213: <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 1214: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1215: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1216: </pre>
1.266 martin 1217: <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>
1.43 asau 1218: <p>By default, in privileged mode pkgsrc uses
1219: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1220: where programs will be installed in,
1.118 sevan 1221: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1222: directory where pkgsrc will do its internal bookkeeping,
1223: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1224: where packages install their persistent data.
1225: In unprivileged mode pkgsrc uses
1226: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1227: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1228: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1229: </p>
1230: <p>You can change default layout using command-line arguments.
1.266 martin 1231: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1.43 asau 1232: </p>
1.41 asau 1233: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1234: <h3 class="title">Note</h3>
1.10 hubertf 1235: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1236: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1237: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.266 martin 1238: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1239: </div>
1.43 asau 1240: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1241: <h3 class="title">Note</h3>
1242: <p>It is possible to bootstrap multiple instances of pkgsrc
1243: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1244: corresponding to the installation you're working with to build
1245: and install packages.
1246: </p>
1247: </div>
1.1 dsieger 1248: </div>
1249: </div>
1.41 asau 1250: <div class="chapter">
1.1 dsieger 1251: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 1252: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1253: <div class="toc">
1254: <p><b>Table of Contents</b></p>
1.100 leot 1255: <dl class="toc">
1.154 rillig 1256: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1257: <dd><dl>
1.154 rillig 1258: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1259: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 1260: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1261: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1262: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1263: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1264: <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>
1265: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.154 rillig 1266: </dl></dd>
1267: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1268: <dd><dl>
1269: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1270: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1271: <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 1272: </dl></dd>
1273: </dl>
1274: </div>
1275: <p>Basically, there are two ways of using pkgsrc. The first
1276: is to only install the package tools and to use binary packages
1.266 martin 1277: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1278: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1279: of pkgsrc, too. Then you are able to build your own packages,
1280: and you can still use binary packages from someone else.</p>
1.41 asau 1281: <div class="sect1">
1.1 dsieger 1282: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1283: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.202 nia 1284: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.151 sevan 1285: site and mirrors, there are collections of binary packages,
1.9 rillig 1286: ready to be installed. These binary packages have been built using the
1287: default settings for the directories, that is:</p>
1.41 asau 1288: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1289: <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>
1290: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1291: <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 1292: </ul></div>
1293: <p>If you cannot use these directories for whatever reasons (maybe
1294: because you're not root), you cannot use these binary packages, but
1.266 martin 1295: 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 1296: <div class="sect2">
1.1 dsieger 1297: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1298: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1299: <p>To install binary packages, you first need to know from where
1300: to get them. The first place where you should look is on the main
1.202 nia 1301: 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 1302: <p>This directory contains binary packages for multiple
1.226 gutterid 1303: platforms. First, select your operating system. Then, select your
1304: hardware architecture, and in the third step, the OS version and
1.266 martin 1305: the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.226 gutterid 1306: <p>In this directory, you may find a file called
1.9 rillig 1307: <code class="filename">bootstrap.tar.gz</code> which contains the package
1308: management tools. If the file is missing, it is likely that your
1309: operating system already provides those tools. Download the file and
1310: extract it in the <code class="filename">/</code> directory. It will create
1311: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1312: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1313: </div>
1.41 asau 1314: <div class="sect2">
1.1 dsieger 1315: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1316: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1317: <p>In the directory from the last section, there is a
1.85 wiz 1318: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1319: binary packages that are available for the platform, excluding those
1.202 nia 1320: that may not be distributed via HTTP or FTP.</p>
1.9 rillig 1321: <p>To install packages directly from an FTP or HTTP server, run
1322: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1323: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1324: <pre class="screen">
1.202 nia 1325: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1326: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.169 rillig 1327: <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 1328: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.202 nia 1329: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.9 rillig 1330: </pre>
1331: <p>Instead of URLs, you can also use local paths, for example if
1332: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1333: repository. If you want to install packages from multiple sources,
1334: you can separate them by a semicolon in
1335: <code class="varname">PKG_PATH</code>.</p>
1336: <p>After these preparations, installing a package is very
1337: easy:</p>
1338: <pre class="screen">
1.202 nia 1339: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1340: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1341: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1342: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1343: </pre>
1344: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1345: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1346: <p>Any prerequisite packages needed to run the
1.1 dsieger 1347: package in question will be installed, too, assuming they are
1.202 nia 1348: present in the repository.</p>
1.1 dsieger 1349: <p>After you've installed packages, be sure to have
1350: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1351: <code class="varname">PATH</code> so you can actually start the just
1352: installed program.</p>
1353: </div>
1.41 asau 1354: <div class="sect2">
1.1 dsieger 1355: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1356: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1.202 nia 1357: <p>To update binary packages, it is recommended that you use
1358: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1359: package repository to your locally installed packages and safely
1360: replace any older packages.</p>
1361: <p>Note that pkgsrc is released as quarterly branches.
1362: If you are updating to a newer quarterly branch of pkgsrc, you may
1363: need to adjust the repository in
1364: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1365: </div>
1366: <div class="sect2">
1367: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1368: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1369: <p>To deinstall a package, it does not matter whether it was
1.202 nia 1370: installed from source code or from a binary package. Neither the
1371: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1372: command need to know.</p>
1373: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.1 dsieger 1374: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.202 nia 1375: name can be given with or without version number.</p>
1.1 dsieger 1376: </div>
1.41 asau 1377: <div class="sect2">
1.1 dsieger 1378: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1379: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1380: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.202 nia 1381: installed packages or binary package files.
1382: As with other management tools, it works with packages installed
1383: from source or binaries.</p>
1.1 dsieger 1384: </div>
1.41 asau 1385: <div class="sect2">
1.1 dsieger 1386: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1387: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1388: <p>
1.164 leot 1389: The pkgsrc Security Team and Packages Groups maintain a list of
1.202 nia 1390: known vulnerabilities to packages which are (or have been)
1.1 dsieger 1391: included in pkgsrc. The list is available from the NetBSD
1.202 nia 1392: 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>.
1393: </p>
1394: <p>
1395: Please note that not every "vulnerability" with a CVE assignment is
1396: exploitable in every configuration.
1397: Some bugs are marked as active simply because an fix was not
1398: marked as such.
1399: Operating system specific hardening and mitigation features may also
1400: reduce the impact of bugs.
1.1 dsieger 1401: </p>
1402: <p>
1.22 jakllsch 1403: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1404: this list can be downloaded
1405: automatically, and a security audit of all packages installed on a system
1406: can take place.
1407: </p>
1408: <p>
1.22 jakllsch 1409: There are two components to auditing. The first
1410: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1411: is for downloading
1.1 dsieger 1412: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1413: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1414: installed packages are vulnerable. If a package is vulnerable, you
1415: will see output similar to the following:
1416: </p>
1417: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1418: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.1 dsieger 1419: <p>
1.22 jakllsch 1420: You may wish to have the
1.202 nia 1421: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1422: file downloaded daily so that
1423: it remains current. This may be done by adding an appropriate entry
1.259 leot 1424: 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 1425: </p>
1426: <pre class="screen">
1.121 sevan 1427: # Download vulnerabilities file
1.118 sevan 1428: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1429: # Audit the installed packages and email results to root
1430: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1431: root >/dev/null 2>&1
1.22 jakllsch 1432: </pre>
1433: <p>
1.118 sevan 1434: will update the vulnerability list every day at 3AM, followed by an audit
1435: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1436:
1.118 sevan 1437: On NetBSD this may be accomplished instead by adding the following
1438: line to <code class="filename">/etc/daily.conf</code>:
1439: </p>
1440: <pre class="screen">
1441: fetch_pkg_vulnerabilities=YES
1442: </pre>
1443: <p>
1444: to fetch the vulnerability list from the daily security script. The system
1445: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1446: desired (not required), by adding the following line to
1.118 sevan 1447: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1448: </p>
1449: <pre class="screen">
1.118 sevan 1450: check_pkg_vulnerabilities=YES
1.22 jakllsch 1451: </pre>
1452: <p>
1.259 leot 1453: 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 1454: </p>
1455: </div>
1.41 asau 1456: <div class="sect2">
1.1 dsieger 1457: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1458: <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 1459: <p>
1.207 leot 1460: 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.266 martin 1461: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.202 nia 1462: argument to check if any packages are stale, e.g.
1.1 dsieger 1463: </p>
1464: <pre class="screen">
1465: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1466: ...
1467: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1468: </pre>
1469: </div>
1.41 asau 1470: <div class="sect2">
1.1 dsieger 1471: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1472: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.10 hubertf 1473: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1474: administrative functions on the package system.</p>
1475: </div>
1476: </div>
1.41 asau 1477: <div class="sect1">
1.1 dsieger 1478: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1479: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1 dsieger 1480: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1481: directory now contains a set of packages, organized into
1482: categories. You can browse the online index of packages, or run
1.10 hubertf 1483: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1484: directory to build local <code class="filename">README.html</code> files for
1.207 leot 1485: 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 1486: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1487: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1488: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1489: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1490: different <code class="varname">LOCALBASE</code> definitions on the same
1491: system (inside a chroot is an exception). </p>
1492: <p>The rest of this chapter assumes that the package is already
1.266 martin 1493: 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 1494: instructions how to create your own packages.</p>
1.41 asau 1495: <div class="sect2">
1.1 dsieger 1496: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1497: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1 dsieger 1498: <p>To build packages from source, you need a working C
1499: compiler. On NetBSD, you need to install the
1.266 martin 1500: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1501: sets. If you want to build X11-related packages, the
1.266 martin 1502: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1503: sets are required, too.</p>
1504: </div>
1.41 asau 1505: <div class="sect2">
1.1 dsieger 1506: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1507: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1 dsieger 1508: <p>The first step for building a package is downloading the
1509: distfiles (i.e. the unmodified source). If they have not yet been
1510: downloaded, pkgsrc will fetch them automatically.</p>
1511: <p>If you have all files that you need in the
1512: <code class="filename">distfiles</code> directory,
1513: you don't need to connect. If the distfiles are on CD-ROM, you can
1514: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1515: </p>
1516: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1517: <p>
1.10 hubertf 1518: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1519: <p>By default a list of distribution sites will be randomly
1520: intermixed to prevent huge load on servers which holding popular
1521: packages (for example, SourceForge.net mirrors). Thus, every
1522: time when you need to fetch yet another distfile all the mirrors
1523: will be tried in new (random) order. You can turn this feature
1524: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1525: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1526: <p>You can overwrite some of the major distribution sites to
1527: fit to sites that are close to your own. By setting one or two
1528: variables you can modify the order in which the master sites are
1529: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1530: delimited list of domain suffixes.
1531: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1532: contains a whitespace delimited list of regular expressions. It
1533: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1534: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1535: some examples. This may save some of your bandwidth and
1536: time.</p>
1537: <p>You can change these settings either in your shell's environment, or,
1538: if you want to keep the settings, by editing the
1.10 hubertf 1539: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1540: and adding the definitions there.</p>
1541: <p>
1542: If a package depends on many other packages (such as
1.207 leot 1543: <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 1544: alternate between periods of
1545: downloading source, and compiling. To ensure you have all the source
1546: downloaded initially you can run the command:
1547: </p>
1548: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1549: <p>
1550: which will output and run a set of shell commands to fetch the
1551: necessary files into the <code class="filename">distfiles</code> directory. You can
1552: also choose to download the files manually.
1553: </p>
1554: </div>
1.41 asau 1555: <div class="sect2">
1.1 dsieger 1556: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1557: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1 dsieger 1558: <p>
1559: Once the software has downloaded, any patches will be applied, then it
1560: will be compiled for you. This may take some time depending on your
1561: computer, and how many other packages the software depends on and their
1562: compile time.
1563: </p>
1.41 asau 1564: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1565: <h3 class="title">Note</h3>
1566: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1567: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.266 martin 1568: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1569: </div>
1570: <p>For example, type</p>
1571: <pre class="screen">
1572: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1573: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1574: </pre>
1575: <p>at the shell prompt to build the various components of the
1576: package.</p>
1577: <p>The next stage is to actually install the newly compiled
1578: program onto your system. Do this by entering:
1579:
1580: </p>
1581: <pre class="screen">
1582: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1583: </pre>
1584: <p>
1585:
1586: while you are still in the directory for whatever package you
1587: are installing.</p>
1588: <p>Installing the package on your system may require you to
1589: be root. However, pkgsrc has a
1590: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1591: to only become root for the actual installation step.</p>
1592: <p>That's it, the software should now be installed and setup for use.
1593: You can now enter:
1594:
1595: </p>
1596: <pre class="screen">
1597: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1598: </pre>
1599: <p>
1600:
1601: to remove the compiled files in the work directory, as you shouldn't need
1602: them any more. If other packages were also added to your system
1603: (dependencies) to allow your program to compile, you can tidy these up
1604: also with the command:</p>
1605: <pre class="screen">
1606: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1607: </pre>
1608: <p>Taking the figlet utility as an example, we can install it on our
1.266 martin 1609: 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 1610: <p>The program is installed under the default root of the
1611: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1612: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1613: variable in your environment, and it will use that value as the
1614: root of your packages tree. So, to use
1615: <code class="filename">/usr/local</code>, set
1616: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1617: Please note that you should use a directory which is dedicated to
1618: packages and not shared with other programs (i.e., do not try and
1619: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1620: to add any of your own files or directories (such as
1621: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1622: <code class="filename">pkgsrc/</code>) below the
1623: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1624: conflicts between programs and other files installed by the
1625: package system and whatever else may have been installed
1626: there.</p>
1.10 hubertf 1627: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1628: alter some configuration options at build time. Have a look at
1629: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1630: of what will be set there by default. Environment variables such
1631: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1632: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1633: set them each time you want to use pkgsrc.</p>
1.266 martin 1634: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1635: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1636: or being installed. This may be for debugging purposes, or out of
1637: simple curiosity. A number of utility values have been added to
1638: help with this.</p>
1.23 wiz 1639: <div class="orderedlist"><ol class="orderedlist" type="1">
1640: <li class="listitem">
1.259 leot 1641: <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 1642: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1643: information will be displayed. For example,</p>
1644: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1645: <p>will show all the commands that are invoked, up to and
1.266 martin 1646: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1647: </li>
1.23 wiz 1648: <li class="listitem">
1.259 leot 1649: <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 1650: definition, then the <code class="varname">VARNAME</code> definition
1651: should be used, in conjunction with the show-var
1.259 leot 1652: 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 1653: variable <code class="varname">LOCALBASE</code>:</p>
1654: <pre class="screen">
1655: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1656: /usr/pkg
1657: <code class="prompt">%</code>
1658: </pre>
1659: </li>
1660: </ol></div>
1661: <p>If you want to install a binary package that you've either
1662: created yourself (see next section), that you put into
1663: pkgsrc/packages manually or that is located on a remote FTP
1664: server, you can use the "bin-install" target. This target will
1.259 leot 1665: 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 1666: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1667: sites searched is kept in the variable
1668: <code class="varname">BINPKG_SITES</code>, which defaults to
1.259 leot 1669: 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 1670: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1671: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1672: details.</p>
1673: <p>A final word of warning: If you set up a system that has a
1674: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1675: set that before any packages are installed, as you cannot use
1676: several directories for the same purpose. Doing so will result in
1677: pkgsrc not being able to properly detect your installed packages,
1678: and fail miserably. Note also that precompiled binary packages are
1679: usually built with the default <code class="varname">LOCALBASE</code> of
1680: <code class="filename">/usr/pkg</code>, and that you should
1681: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1682: <code class="varname">LOCALBASE</code>.</p>
1683: </div>
1684: </div>
1685: </div>
1.41 asau 1686: <div class="chapter">
1.1 dsieger 1687: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 1688: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1 dsieger 1689: <div class="toc">
1690: <p><b>Table of Contents</b></p>
1.100 leot 1691: <dl class="toc">
1.154 rillig 1692: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1693: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 1694: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
1695: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
1696: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
1697: <dd><dl>
1698: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
1699: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1700: <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 1701: </dl></dd>
1.241 rillig 1702: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
1703: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 1704: </dl>
1705: </div>
1.4 rillig 1706: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1707: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1708: that file depends on the installation. On NetBSD, when you use
1.259 leot 1709: <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 1710: <code class="filename">/etc/</code>. In all other cases the default location is
1711: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1712: bootstrap program to install the binary packages.</p>
1713: <p>The format of the configuration file is that of the usual
1714: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1715: is done by setting variables in this file. Note that you can define all
1716: kinds of variables, and no special error checking (for example for
1.112 rillig 1717: spelling mistakes) takes place.</p>
1.41 asau 1718: <div class="sect1">
1.1 dsieger 1719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1720: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112 rillig 1721: <p>The following variables apply to all
1.1 dsieger 1722: pkgsrc packages. A complete list of the variables that can be
1723: configured by the user is available in
1724: <code class="filename">mk/defaults/mk.conf</code>, together with some
1725: comments that describe each variable's intent.</p>
1.41 asau 1726: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1727: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1728: packages will be installed. The default is
1729: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1730: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1731: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1.266 martin 1732: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1733: installed. The default is
1734: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1735: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1736: X11 is installed on the system. The default is
1.84 wiz 1737: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1738: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1739: downloaded copies of the original source distributions used
1740: for building pkgsrc packages. The default is
1741: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1742: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1743: database about installed packages is stored. The default is
1.118 sevan 1744: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1745: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1746: If set, override the packages'
1747: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1748: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1749: Backup location(s) for distribution files and patch files
1750: if not found locally or in
1751: <code class="filename">${MASTER_SITES}</code> or
1752: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1753: The defaults is
1754: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1755: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1756: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1757: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.266 martin 1758: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1759: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1.23 wiz 1760: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1761: List of acceptable licenses. License names are case-sensitive.
1762: Whenever you try to build a package whose license is not in this
1763: list, you will get an error message. If the license condition is
1764: simple enough, the error message will include specific
1765: instructions on how to change this variable.</p></li>
1.1 dsieger 1766: </ul></div>
1767: </div>
1.41 asau 1768: <div class="sect1">
1.1 dsieger 1769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1770: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1771: <p>
1.1 dsieger 1772: </p>
1.41 asau 1773: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1774: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1775: directory for the binary packages. The default is
1776: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1777: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1778: The top level directory where, if defined, the separate
1779: working directories will get created, and symbolically
1780: linked to from <code class="filename">${WRKDIR}</code> (see below).
1781: This is useful for building packages on several
1782: architectures, then <code class="filename">${PKGSRCDIR}</code>
1783: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1784: is local to every architecture. (It should be noted that
1785: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1786: — it is an internal definition which refers to the
1.1 dsieger 1787: root of the pkgsrc tree. It is possible to have many
1788: pkgsrc tree instances.)</p></li>
1.23 wiz 1789: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1790: Directory for local patches that aren't part of pkgsrc.
1.266 martin 1791: 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 1792: information.</p></li>
1.23 wiz 1793: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1794: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1795: BSD-style Makefile. If this is not set,
1796: <code class="varname">MAKECONF</code> is set to
1797: <code class="filename">/dev/null</code> to avoid picking up
1798: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1799: </ul></div>
1800: </div>
1.41 asau 1801: <div class="sect1">
1.1 dsieger 1802: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1803: <a name="native-or-pkgsrc-preference"></a>6.3. Preferences for native or pkgsrc software</h2></div></div></div>
1.241 rillig 1804: <p>Whenever a package depends on a package that has a
1805: <code class="filename">builtin.mk</code> file, the dependent package can
1806: either use the built-in (native) version from the base system or the
1807: pkgsrc-provided version. This only affects dependencies, so it is
1808: 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
1809: on the native pcre++ version instead.</p>
1810: <p>To force using the pkgsrc-provided version for a particular
1.266 martin 1811: package, define <span class="quote">“<span class="quote"><code class="varname">PREFER_PKGSRC</code> =
1812: <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
1.241 rillig 1813: using the native package, define
1.266 martin 1814: <span class="quote">“<span class="quote"><code class="varname">PREFER_NATIVE</code> =
1815: <em class="replaceable"><code>package-ID</code></em></span>”</span>. In both cases, the
1.241 rillig 1816: <em class="replaceable"><code>package-ID</code></em> is the one from the
1817: <code class="filename">buildlink3.mk</code> of the package. In most cases,
1818: this ID is the same as the directory name of the package, but for
1819: example, <code class="filename">devel/pcre++</code> has the
1.266 martin 1820: package ID <span class="quote">“<span class="quote">pcrexx</span>”</span>.</p>
1.241 rillig 1821: <p>For the packages that are not listed by their package ID,
1822: pkgsrc uses the pkgsrc-provided version if
1823: <code class="varname">PREFER_PKGSRC</code> contains the word
1.266 martin 1824: <span class="quote">“<span class="quote">yes</span>”</span>. Otherwise, if <code class="varname">PREFER_NATIVE</code>
1825: contains the word <span class="quote">“<span class="quote">yes</span>”</span>, pkgsrc uses the native
1.241 rillig 1826: version. For example, to require using the pkgsrc-provided versions
1827: for all but the most basic bits on a NetBSD system, you can
1828: set:</p>
1829: <pre class="programlisting">
1830: PREFER_PKGSRC= yes
1831: PREFER_NATIVE= getopt skey tcp_wrappers
1832: </pre>
1833: <p>A package <span class="emphasis"><em>must</em></span> have a
1834: <code class="filename">builtin.mk</code> file to be listed in
1835: <code class="varname">PREFER_NATIVE</code>, otherwise it is simply ignored in
1836: that list.</p>
1837: <p><code class="varname">PREFER_PKGSRC</code> and
1838: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap to
1839: ensure that the bootstrap process does not use inapropriate native
1840: tools as dependencies for core packages.</p>
1841: <pre class="screen">
1842: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
1843: </pre>
1844: <p>Switching between settings globally at a later date can
1845: introduce complications with dependency resolution. This is caused
1846: by packages built with the opposite preference being installed
1847: alongside each other. Hence, when changing any of these variables
1848: after bootstrap, you need to rebuild all packages depending on those
1849: whose preference has been changed. This is not trivial and should
1850: be avoided.</p>
1851: <p>When using pkgsrc on Linux systems, there is high risk of
1.266 martin 1852: <span class="quote">“<span class="quote">leakage</span>”</span>, where programs installed by pkgsrc may
1.241 rillig 1853: inadvertently use a command or library not installed by pkgsrc, e.g.
1854: those installed by yum or apt. Such foreign dependencies may be
1855: installed, removed, or upgraded to a version incompatible with the
1856: pkgsrc package at any time, causing pkgsrc packages to subsequently
1857: malfunction. Pkgsrc cannot prevent this, as it has no control over
1858: other package managers. Another potential problem is that under
1859: Redhat Enterprise and related Linux systems, yum packages are only
1860: patched and never upgraded, so eventually they may become too
1861: outdated for use by pkgsrc. Even intentionally using foreign
1862: dependencies, not considered leakage, can lead to these problems, so
1863: it is generally discouraged. In order to minimize such problems,
1.266 martin 1864: PREFER_PKGSRC defaults to <span class="quote">“<span class="quote">yes</span>”</span> on Linux systems. This ensures that
1.241 rillig 1865: pkgsrc is aware of any changes to dependency packages and can
1866: rebuild or upgrade the entire dependency tree as needed. This
1867: default can be overridden by setting --prefer-pkgsrc to a
1.266 martin 1868: list of packages and --prefer-native to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.241 rillig 1869: </div>
1870: <div class="sect1">
1871: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1872: <a name="variables-affecting-installation"></a>6.4. Variables affecting the installation process</h2></div></div></div>
1.198 leot 1873: <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 1874: By default, binary packages of built packages are
1.150 leot 1875: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143 maya 1876: this variable to "no" prevents this.</p></li></ul></div>
1.107 jnemeth 1877: <p>Packages have to support installation into a
1.4 rillig 1878: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1879: to be built, before the actual filesystem is touched. DESTDIR
1880: support exists in two variations:</p>
1.41 asau 1881: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1882: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1883: installation and packaging is still run as root.</p></li>
1884: <li class="listitem"><p>Full DESTDIR support can run the complete
1885: build, installation and packaging as normal user. Root
1886: privileges are only needed to add packages.</p></li>
1887: </ul></div>
1.4 rillig 1888: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1889: clean</code></strong> needs to be run as root.</p>
1.17 imil 1890: <p>Considering the <code class="filename">foo/bar</code> package,
1891: DESTDIR full support can be tested using the following commands
1892:
1893: </p>
1894: <pre class="programlisting">
1895: <code class="prompt">$</code> id
1896: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1897: <code class="prompt">$</code> mkdir $HOME/packages
1898: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1899: </pre>
1900: <p>
1901:
1902: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1903: should be needed
1904:
1905: </p>
1906: <pre class="programlisting">
1.66 asau 1907: <code class="prompt">$</code> make stage-install
1.17 imil 1908: </pre>
1909: <p>
1910:
1911: Create a package without root privileges
1912:
1913: </p>
1914: <pre class="programlisting">
1.66 asau 1915: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1916: </pre>
1917: <p>
1918:
1919: For the following command, you must be able to gain root
1.259 leot 1920: 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 1921:
1922: </p>
1923: <pre class="programlisting">
1.66 asau 1924: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1925: </pre>
1926: <p>
1927:
1928: Then, as a simple user
1929:
1930: </p>
1931: <pre class="programlisting">
1932: <code class="prompt">$</code> make clean
1933: </pre>
1934: <p>
1935:
1936: </p>
1.4 rillig 1937: </div>
1.41 asau 1938: <div class="sect1">
1.4 rillig 1939: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1940: <a name="conf.compiler"></a>6.5. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1941: <div class="sect2">
1.1 dsieger 1942: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1943: <a name="selecting-the-compiler"></a>6.5.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1944: <p>By default, pkgsrc will use GCC to build packages. This may be
1945: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1946: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1947: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1948: <dd>
1949: <p>This is a list of values specifying the chain of
1950: compilers to invoke when building packages. Valid values
1951: are:</p>
1.41 asau 1952: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1953: <li class="listitem"><p><code class="varname">ccc</code>:
1954: Compaq C Compilers (Tru64)</p></li>
1955: <li class="listitem"><p><code class="varname">ccache</code>:
1956: compiler cache (chainable)</p></li>
1957: <li class="listitem"><p><code class="varname">clang</code>:
1958: Clang C and Objective-C compiler</p></li>
1.23 wiz 1959: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1960: distributed C/C++ (chainable)</p></li>
1.66 asau 1961: <li class="listitem"><p><code class="varname">f2c</code>:
1962: Fortran 77 to C compiler (chainable)</p></li>
1963: <li class="listitem"><p><code class="varname">icc</code>:
1964: Intel C++ Compiler (Linux)</p></li>
1965: <li class="listitem"><p><code class="varname">ido</code>:
1966: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1967: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1968: GNU C/C++ Compiler</p></li>
1.66 asau 1969: <li class="listitem"><p><code class="varname">hp</code>:
1970: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1971: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1972: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1973: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1974: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1975: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1976: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1977: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1978: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1979: </ul></div>
1980: <p>The default is
1.266 martin 1981: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1982: <code class="varname">ccache</code> and/or
1983: <code class="varname">distcc</code> with an appropriate
1984: <code class="varname">PKGSRC_COMPILER</code> setting,
1.266 martin 1985: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1986: variable should always be terminated with a value for
1987: a real compiler. Note that only one real compiler
1.266 martin 1988: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1989: is not allowed).</p>
1990: </dd>
1991: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1992: <dd><p>This specifies the minimum version of GCC to use
1993: when building packages. If the system GCC doesn't
1994: satisfy this requirement, then pkgsrc will build and
1995: install one of the GCC packages to use instead.</p></dd>
1.153 leot 1996: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114 maya 1997: <dd><p>Specifies which version of python to use when several
1998: options are available.</p></dd>
1999: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.176 gutterid 2000: <dd><p>Specifies the Fortran compiler to use.
2001: The default is <code class="varname">gfortran</code>.</p></dd>
1.114 maya 2002: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
2003: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
2004: <code class="varname">gfortran</code> is used, this option specifies which
2005: version to use.</p></dd>
1.1 dsieger 2006: </dl></div>
2007: </div>
1.41 asau 2008: <div class="sect2">
1.1 dsieger 2009: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 2010: <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 2011: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2012: please make sure to use the <code class="literal">+=</code> operator
2013: instead of the <code class="literal">=</code> operator:</p>
2014: <pre class="programlisting">
2015: CFLAGS+= -your -flags
2016: </pre>
2017: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.266 martin 2018: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 2019: need to add their own flags. You may want to take a look
1.207 leot 2020: 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 2021: package if you're interested in optimization specifically
2022: for the current CPU. </p>
1.1 dsieger 2023: </div>
1.41 asau 2024: <div class="sect2">
1.1 dsieger 2025: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 2026: <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 2027: <p>If you want to pass flags to the linker, both in the configure
2028: step and the build step, you can do this in two ways. Either set
2029: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2030: between the two is that <code class="varname">LIBS</code> will be appended to
2031: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2032: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2033: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2034: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2035: <code class="varname">CFLAGS</code>, if you do not wish to override these
2036: settings, use the <code class="literal">+=</code> operator:</p>
2037: <pre class="programlisting">
2038: LDFLAGS+= -your -linkerflags
2039: </pre>
2040: </div>
2041: </div>
1.41 asau 2042: <div class="sect1">
1.1 dsieger 2043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2044: <a name="developer-advanced-settings"></a>6.6. Developer/advanced settings</h2></div></div></div>
1.84 wiz 2045: <p>
1.1 dsieger 2046: </p>
1.41 asau 2047: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2048: <li class="listitem">
1.1 dsieger 2049: <p><code class="varname">PKG_DEVELOPER</code>:
1.232 gutterid 2050: Run some sanity checks that package developers want:
2051: </p>
1.41 asau 2052: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2053: <li class="listitem"><p>make sure patches apply with zero
1.232 gutterid 2054: fuzz</p></li>
1.23 wiz 2055: <li class="listitem"><p>run check-shlibs to see that all
1.232 gutterid 2056: binaries will find their shared libs.</p></li>
1.1 dsieger 2057: </ul></div>
2058: </li>
1.232 gutterid 2059: <li class="listitem"><p><code class="varname">CHECK_FILES_STRICT</code>:
2060: Also check <code class="varname">VARBASE</code> and <code class="varname">PKG_SYSCONFDIR
2061: </code> values in PLIST entries.
2062: </p></li>
1.23 wiz 2063: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.232 gutterid 2064: of debugging output which is displayed whilst making and
2065: installing the package. The default value for this is 0,
2066: which will not display the commands as they are executed
2067: (normal, default, quiet operation); the value 1 will display
2068: all shell commands before their invocation, and the value 2
2069: will display both the shell commands before their invocation,
2070: as well as their actual execution progress with <span class="command"><strong>set
2071: -x</strong></span>.</p></li>
1.1 dsieger 2072: </ul></div>
2073: <p>
2074: </p>
2075: </div>
1.41 asau 2076: <div class="sect1">
1.1 dsieger 2077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2078: <a name="selecting-build-options"></a>6.7. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2079: <p>Some packages have build time options, usually to select
2080: between different dependencies, enable optional support for big
2081: dependencies or enable experimental features.</p>
2082: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2083: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2084: show-options</strong></span>, for example:</p>
2085: <pre class="programlisting">
2086: The following options are supported by this package:
2087: ssl Enable SSL support.
2088: Exactly one of the following gecko options is required:
2089: firefox Use firefox as gecko rendering engine.
2090: mozilla Use mozilla as gecko rendering engine.
2091: At most one of the following database options may be selected:
2092: mysql Enable support for MySQL database.
2093: pgsql Enable support for PostgreSQL database.
2094:
2095: These options are enabled by default: firefox
2096: These options are currently enabled: mozilla ssl
2097: </pre>
2098: <p>The following variables can be defined in
1.10 hubertf 2099: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2100: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2101: which can be used to select or disable options for all packages
2102: that support them, and
2103: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2104: which can be used to select or disable options specifically for
2105: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.266 martin 2106: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2107: are disabled. A few examples:</p>
2108: <pre class="screen">
1.10 hubertf 2109: <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 2110: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2111: PKG_OPTIONS.kdebase= debug -sasl
2112: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2113: <p>It is important to note that options that were specifically
1.18 snj 2114: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2115: you do not wish to include the option. If you are unsure you can view
2116: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2117: <p>The following settings are consulted in the order given, and
2118: the last setting that selects or disables an option is
2119: used:</p>
1.23 wiz 2120: <div class="orderedlist"><ol class="orderedlist" type="1">
2121: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2122: maintainer</p></li>
1.23 wiz 2123: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2124: variables (see below)</p></li>
1.23 wiz 2125: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2126: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2127: </ol></div>
2128: <p>For groups of mutually exclusive options, the last option
2129: selected is used, all others are automatically disabled. If an
2130: option of the group is explicitly disabled, the previously
2131: selected option, if any, is used. It is an error if no option
2132: from a required group of options is selected, and building the
2133: package will fail.</p>
2134: <p>Before the options framework was introduced, build options
2135: were selected by setting a variable (often named
2136: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2137: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2138: transition to the options framework for the user, these legacy
2139: variables are converted to the appropriate options setting
2140: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2141: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2142: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2143: directly. Support for the legacy variables will be removed
2144: eventually.</p>
2145: </div>
2146: </div>
1.41 asau 2147: <div class="chapter">
1.1 dsieger 2148: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 2149: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1 dsieger 2150: <div class="toc">
2151: <p><b>Table of Contents</b></p>
1.100 leot 2152: <dl class="toc">
1.154 rillig 2153: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2154: <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 2155: </dl>
2156: </div>
1.41 asau 2157: <div class="sect1">
1.1 dsieger 2158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2159: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1 dsieger 2160: <p>Once you have built and installed a package, you can create
2161: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.259 leot 2162: 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 2163: the same package on a group of hosts and wasting CPU time. It also
2164: provides a simple means for others to install your package, should
2165: you distribute it.</p>
2166: <p>To create a binary package, change into the appropriate
1.10 hubertf 2167: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2168: package</strong></span>:</p>
2169: <pre class="screen">
1.112 rillig 2170: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2171: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2172: </pre>
1.242 gutterid 2173: <p>This will build your package (if not already done) and package
2174: it into a binary package. You can then use the
2175: <span class="command"><strong>pkg_*</strong></span> tools to manipulate it. Binary packages are
2176: created in <code class="varname">PACKAGES</code>, which defaults to
2177: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a compressed
1.266 martin 2178: tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a continuation of
1.242 gutterid 2179: 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>
2180: example.</p>
1.266 martin 2181: <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 2182: such a binary package.</p>
2183: </div>
1.41 asau 2184: <div class="sect1">
1.1 dsieger 2185: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2186: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
2187: <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 2188: </div>
2189: </div>
1.41 asau 2190: <div class="chapter">
1.6 rillig 2191: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 2192: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 2193: builds)</h2></div></div></div>
2194: <div class="toc">
2195: <p><b>Table of Contents</b></p>
1.100 leot 2196: <dl class="toc">
1.154 rillig 2197: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 2198: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 2199: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
1.272 wiz 2200: <dt><span class="sect1"><a href="#bulk.scan">8.3. Speeding up bulk build scans</a></span></dt>
2201: <dt><span class="sect1"><a href="#bulk.req">8.4. Requirements of a full bulk build</a></span></dt>
2202: <dt><span class="sect1"><a href="#bulk.var">8.5. Bulk build variants</a></span></dt>
2203: <dd><dl>
2204: <dt><span class="sect2"><a href="#bulk.var.confopt">8.5.1. Detect unknown configure options</a></span></dt>
2205: <dt><span class="sect2"><a href="#bulk.var.comperr">8.5.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
2206: <dt><span class="sect2"><a href="#bulk.var.builderr">8.5.3. Force compiler options only in the build phase</a></span></dt>
2207: <dt><span class="sect2"><a href="#bulk.var.dirs">8.5.4. Use custom directories</a></span></dt>
2208: <dt><span class="sect2"><a href="#bulk.var.warn">8.5.5. Turn warnings into errors</a></span></dt>
2209: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.5.6. Reject packages for which pkglint reports errors</a></span></dt>
2210: <dt><span class="sect2"><a href="#bulk.var.strings">8.5.7. Reject packages that contain forbidden strings</a></span></dt>
2211: <dt><span class="sect2"><a href="#bulk.var.test">8.5.8. Reject packages whose self-test fails</a></span></dt>
2212: <dt><span class="sect2"><a href="#bulk.var.shvar">8.5.9. Reject packages that use undefined shell variables</a></span></dt>
2213: <dt><span class="sect2"><a href="#bulk.var.quiet">8.5.10. Turn off verbose logging</a></span></dt>
1.178 rillig 2214: </dl></dd>
1.272 wiz 2215: <dt><span class="sect1"><a href="#creating-cdroms">8.6. Creating a multiple CD-ROM packages collection</a></span></dt>
2216: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.6.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2217: </dl>
2218: </div>
1.175 gutterid 2219: <p>For a number of reasons, you may want to build binary packages
2220: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.71 wiz 2221: For instance, when you have multiple machines that should run the same software,
2222: it is wasted time if they all build their packages themselves from source.
2223: Or you may want to build a list of packages you want and check them before
1.175 gutterid 2224: deploying onto production systems.
1.71 wiz 2225: There is a way of getting a set of binary packages:
1.175 gutterid 2226: the bulk build system, or pbulk ("p" stands for "parallel").
1.112 rillig 2227: This chapter describes how to set it up.</p>
1.41 asau 2228: <div class="sect1">
1.6 rillig 2229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2230: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71 wiz 2231: <p>First of all, you have to decide whether you build all packages
2232: or a limited set of them. Full bulk builds usually consume a lot more resources,
2233: both space and time, than builds for some practical sets of packages.
1.175 gutterid 2234: A number of particularly heavy packages exist that are not actually
2235: interesting to a wide audience. (The approximate resource consumption for a
1.272 wiz 2236: full bulk build is given in section <a class="xref" href="#bulk.req" title="8.4. Requirements of a full bulk build">Section 8.4, “Requirements of a full bulk build”</a>.)
1.175 gutterid 2237: For limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2238: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2239: </p>
2240: <p>During bulk builds various packages are installed and deinstalled
2241: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2242: so make sure that you don't need any package during the builds.
1.112 rillig 2243: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2244: or something even more restrictive, depending on what the operating system provides,
2245: or dedicate the whole physical machine.
2246: As a useful side effect this makes sure that bulk builds cannot
2247: break anything in your system. There have been numerous cases where
1.6 rillig 2248: certain packages tried to install files outside the
2249: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2250: <code class="filename">/etc</code>.
2251: </p>
1.6 rillig 2252: </div>
1.41 asau 2253: <div class="sect1">
1.6 rillig 2254: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2255: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
1.180 rillig 2256: <p>Running a bulk build works roughly as follows:</p>
1.41 asau 2257: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2258: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2259: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2260: </ul></div>
1.41 asau 2261: <div class="sect2">
1.15 rillig 2262: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 2263: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112 rillig 2264: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2265: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2266: Configure network access to fetch distribution files.
1.112 rillig 2267: Create a user with name "pbulk".</p>
1.68 asau 2268: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2269: <pre class="screen">
1.151 sevan 2270: <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>
2271: <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 2272: <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 2273: </pre>
2274: <p>Or any other way that fits (e.g., curl, wget).</p>
2275: <p>Deploy and configure pbulk tools, e.g.:</p>
2276: <pre class="screen">
1.118 sevan 2277: <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 2278: <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>
2279: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2280: </pre>
2281: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2282: <h3 class="title">Note</h3>
2283: <p><code class="filename">mk.conf.frag</code> is a fragment of
2284: <code class="filename">mk.conf</code> that contains settings you want to
2285: apply to packages you build. For instance,</p>
2286: <pre class="programlisting">
1.112 rillig 2287: PKG_DEVELOPER= yes # perform more checks
2288: X11_TYPE= modular # use pkgsrc X11
2289: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2290: # when building all packages)
1.68 asau 2291: </pre>
2292: </div>
2293: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2294: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2295: <pre class="programlisting">
2296: www/firefox
2297: mail/thunderbird
2298: misc/libreoffice4
2299: </pre>
1.69 asau 2300: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2301: and make final amendments, if wanted.</p>
1.68 asau 2302: <p>Start it:</p>
2303: <pre class="screen">
2304: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2305: </pre>
2306: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2307: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2308: </p>
2309: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2310: <h3 class="title">Note</h3>
2311: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2312: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2313: The script is kept small enough for better understanding.</p>
2314: </div>
2315: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2316: <h3 class="title">Note</h3>
2317: <p>The <code class="filename">pbulk.sh</code> script supports running
1.205 wiz 2318: unprivileged bulk build and helps configuring distributed bulk builds.
2319: Distributed bulk builds support either building in worker chroots
2320: (each node is a path to a different chroot)
2321: that replicate the target system, including the pbulk prefix,
2322: or remote machines (each node is
2323: an IP address that must be accessible over SSH without a password).</p>
1.68 asau 2324: </div>
1.6 rillig 2325: </div>
2326: </div>
1.41 asau 2327: <div class="sect1">
1.6 rillig 2328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.272 wiz 2329: <a name="bulk.scan"></a>8.3. Speeding up bulk build scans</h2></div></div></div>
2330: <p>At the start of a bulk build. pkgsrc is scanned for details
2331: about the packages to build. This is needed e.g. to build a
2332: dependency graph for building the packages in the correct
2333: order.</p>
2334: <p>Basically, this calls <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> once for each package. To
2335: speed this up, some variables can be pre-computed and others can be
2336: cached. This will greatly reduce the time needed for the scan part
2337: of a bulk build.</p>
2338: <p>The fake <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/varcache/index.html" target="_top"><code class="filename">pkgtools/varcache</code></a>
2339: package provides a Makefile target to precompute some often-used
2340: variables for the build system that shouldn't change during one
2341: build. Redirect its output to a file and include it from
2342: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>; for example:</p>
2343: <pre class="screen">
2344: <code class="prompt">$</code> <strong class="userinput"><code>cd pkgtools/varcache</code></strong>
2345: <code class="prompt">$</code> <strong class="userinput"><code>make show-varcache > /etc/varcache.mk</code></strong>
2346: <code class="prompt">$</code> <strong class="userinput"><code>echo .include "varcache.mk" >> /etc/mk.conf</code></strong>
2347: </pre>
2348: <p>Some system information is needed quite early in the build
2349: and can not be cached this way. It must be set in the environment
2350: for the next speed-up:</p>
2351: <pre class="screen">
2352: <code class="prompt">$</code> <strong class="userinput"><code>export HOST_MACHINE_ARCH=`uname -m`</code></strong>
2353: <code class="prompt">$</code> <strong class="userinput"><code>export NATIVE_OPSYS=`uname -s`</code></strong>
2354: <code class="prompt">$</code> <strong class="userinput"><code>export NATIVE_OPSYS_VERSION=`uname -r | awk -F. '{major=int($1); minor=int($2); if (minor>=100) minor=99; patch=int($3); if (patch>=100) patch=99; printf "%02d%02d%02d", major, minor, patch}'`</code></strong>
2355: <code class="prompt">$</code> <strong class="userinput"><code>export NATIVE_OS_VERSION=`uname -r`</code></strong>
2356: </pre>
2357: <p>Some settings that also affect the scan time strongly can be set in
2358: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
2359: <pre class="programlisting">
2360: NATIVE_PKG_TOOLS_BIN=/usr/sbin # location on NetBSD
2361: NO_PKGTOOLS_REQD_CHECK=yes # assume pkg tools are up-to-date
2362: SKIP_LICENSE_CHECK=yes # do not check license validity
2363: _SRC_TOP_= # bulk build is not running from inside /usr/src
2364: UNPRIVILEGED_USER=pbulk # use the appropriate user for your system
2365: UNPRIVILEGED_GROUP=builder # use the appropriate group for your system
2366: UNPRIVILEGED_GROUPS=builder # use the appropriate groups for your system
2367: </pre>
2368: <p>Finally, some packages require information about build options
2369: of other packages. This information can be cached by setting
2370: <code class="varname">PBULK_CACHE_DIRECTORY</code>.</p>
2371: <pre class="programlisting">
2372: PBULK_CACHE_DIRECTORY=/tmp/pbulk_cache
2373: </pre>
2374: <p>For all of these: please make sure they are kept up-to-date for
2375: changes in your environment. The safest method is to re-create the
2376: varcache before each build, make sure the environment variables are
2377: still up-to-date, and to delete the
2378: <code class="varname">PBULK_CACHE_DIRECTORY</code> before builds.</p>
2379: </div>
2380: <div class="sect1">
2381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2382: <a name="bulk.req"></a>8.4. Requirements of a full bulk build</h2></div></div></div>
1.71 wiz 2383: <p>A complete bulk build requires lots of disk space. Some of the
2384: disk space can be read-only, some other must be writable. Some can be on
2385: remote filesystems (such as NFS) and some should be local. Some can be
2386: temporary filesystems, others must survive a sudden reboot.</p>
2387: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.205 wiz 2388: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2389: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.71 wiz 2390: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2391: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2392: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2393: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2394: </ul></div>
2395: </div>
2396: <div class="sect1">
2397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.272 wiz 2398: <a name="bulk.var"></a>8.5. Bulk build variants</h2></div></div></div>
1.178 rillig 2399: <p>To ensure that pkgsrc packages work in different configurations, it
2400: makes sense to run non-default bulk builds from time to time. This
2401: section lists some ideas for bulk builds that intentionally let packages
2402: fail if they don't follow the pkgsrc style.</p>
2403: <div class="sect2">
2404: <div class="titlepage"><div><div><h3 class="title">
1.272 wiz 2405: <a name="bulk.var.confopt"></a>8.5.1. Detect unknown configure options</h3></div></div></div>
1.178 rillig 2406: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2407: <pre class="programlisting">
2408: GNU_CONFIGURE_STRICT= yes
2409: </pre>
2410: <p>When a package fails this additional check, the most common cause
2411: is that the configure option was valid for an older version of the
2412: package but does not apply anymore. In that case, just remove it.</p>
2413: </div>
2414: <div class="sect2">
2415: <div class="titlepage"><div><div><h3 class="title">
1.272 wiz 2416: <a name="bulk.var.comperr"></a>8.5.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.178 rillig 2417: <p>The job of a compiler is not restricted to producing executable
1.179 rillig 2418: code, most compilers also detect typical programming mistakes. The pkgsrc
2419: compiler wrappers make it easy to force compiler options when the package
2420: is built. This can be used to find typical bugs across all packages that
2421: are in pkgsrc. By reporting these bugs upstream, the packages will be
2422: more reliable with the next updates.</p>
2423: <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 2424: <pre class="programlisting">
2425: CFLAGS+= -Werror=char-subscripts
1.179 rillig 2426: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 2427: </pre>
1.179 rillig 2428: <p>When a package fails to build using these stricter compiler
2429: options, document the circumstances in which the compiler produced the
2430: error message. This includes:</p>
1.178 rillig 2431: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2432: <li class="listitem"><p>The platform
2433: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2434: <li class="listitem"><p>The source file</p></li>
2435: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2436: part of the diagnostic.</p></li>
1.179 rillig 2437: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.178 rillig 2438: </ul></div>
2439: <p>If a package produces these error messages, but the package is
1.179 rillig 2440: 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
2441: in the next builds:</p>
1.178 rillig 2442: <pre class="programlisting">
1.179 rillig 2443: .if ${PKGPATH} == category/package
1.178 rillig 2444: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2445: # error message
2446: # code
1.179 rillig 2447: # Reason why the code does not need to be fixed.
1.178 rillig 2448: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 2449: .endif
1.178 rillig 2450: </pre>
2451: <p>If the error messages from the compiler are valid and the code
1.179 rillig 2452: needs to be fixed, prepare a local patch (see
2453: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2454: authors of the package, providing them with the information you collected
2455: above.</p>
2456: <p>Patches that are not essential for the package to work should only
2457: be reported upstream but not committed to pkgsrc, to make future updates
2458: easier.</p>
1.178 rillig 2459: </div>
2460: <div class="sect2">
2461: <div class="titlepage"><div><div><h3 class="title">
1.272 wiz 2462: <a name="bulk.var.builderr"></a>8.5.3. Force compiler options only in the build phase</h3></div></div></div>
1.181 rillig 2463: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2464: these apply to all phases of the package build process. Especially in the
2465: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2466: decisions. The GNU configure scripts feed many small test programs to the
2467: C compiler to see whether certain headers are available, functions are
2468: defined in a library and programs can be run. In many cases these
2469: programs would not survive a strict compiler run with <code class="literal">-Wall
2470: -Wextra -Werror</code>.</p>
2471: <p>The pkgsrc infrastructure is flexible enough to support compiler
2472: options being added between the <code class="literal">configure</code> and
2473: <code class="literal">build</code> phases. It's a little more complicated than the
2474: other examples in this section but still easy enough.</p>
2475: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2476: desired compiler options. The compiler wrapper's original task is to hide
2477: unwanted directories of include files and to normalize compiler options.
2478: It does this by wrapping the compiler command and rewriting the command
2479: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2480: package directory and examine the
2481: <code class="filename">work/.cwrappers/config</code> directory. It contains
2482: individual configurations for the C compiler and the related tools. The
2483: plan is to find a hook between the configure and build phases, and to
2484: modify these configuration files at that point.</p>
2485: <p>To find this hook, have a look at
2486: <code class="filename">mk/build/build.mk</code>, which contains among others the
2487: <code class="literal">pre-build-checks-hook</code>. The word
2488: <code class="literal">checks</code> doesn't quite fit, but the
2489: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2490: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2491: <pre class="programlisting">
2492: # Just a few example options.
2493: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2494:
2495: .if ${BUILD_ONLY_CFLAGS:U:M*}
2496: pre-build-checks-hook: add-build-only-cflags
2497:
2498: add-build-only-cflags: .PHONY
2499: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2500: ${TEST} ! -f ${.TARGET} || exit 0; \
2501: for flag in ${BUILD_ONLY_CFLAGS}; do \
2502: ${ECHO} "append=$$flag" >> cc; \
2503: done; \
2504: > ${.TARGET}
2505: .endif
2506: </pre>
2507: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2508: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2509: not with spaces.)</p>
2510: <p>The condition in the <code class="literal">.if</code> statement contains the
2511: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2512: should be undefined, possibly because it is only defined for a subset of
2513: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2514: at least one compiler option, to prevent a syntax error in the shell
2515: parser.</p>
2516: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2517: that the additional compiler options are only appended once, even if
2518: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2519: creates a marker file.</p>
2520: <p>To verify that this setup works, run <span class="command"><strong>bmake
2521: configure</strong></span> in a package directory. Up to now, everything works
2522: as usual. Examine the directory
2523: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2524: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2525: the file <code class="filename">cc</code>. Examine the tail of the
2526: <code class="filename">work/.work.log</code> file to see that the normal compiler
2527: options are used.</p>
2528: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2529: options to the file <code class="filename">cc</code> and will create the marker
2530: file in the same directory. After that, the build starts as usual, but
2531: with the added compiler options. Examine the tail of the file
2532: <code class="filename">work/.work.log</code> to see that the lines starting with
2533: <code class="literal">[*]</code> don't contain the compiler options, but the
2534: corresponding lines starting with <code class="literal"><.></code> do end
2535: with these options.</p>
2536: <p>Building packages using this setup variant and fixing the resulting
1.272 wiz 2537: bugs is the same as in <a class="xref" href="#bulk.var.comperr" title="8.5.2. Detect classes of bugs by forcing compiler warnings">Section 8.5.2, “Detect classes of bugs by forcing compiler warnings”</a>.</p>
1.181 rillig 2538: </div>
2539: <div class="sect2">
2540: <div class="titlepage"><div><div><h3 class="title">
1.272 wiz 2541: <a name="bulk.var.dirs"></a>8.5.4. Use custom directories</h3></div></div></div>
1.178 rillig 2542: <p>Some directories like <code class="varname">PREFIX</code>,
2543: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2544: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2545: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2546: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2547: <pre class="programlisting">
2548: PREFIX= /a-random-uuid
2549: PKG_SYSCONFDIR= /a-random-uuid
2550: VARBASE= /a-random-uuid
2551: PKGMANDIR= a-random-uuid
2552: PKG_INFODIR= a-random-uuid
2553: </pre>
2554: </div>
2555: <div class="sect2">
2556: <div class="titlepage"><div><div><h3 class="title">
1.272 wiz 2557: <a name="bulk.var.warn"></a>8.5.5. Turn warnings into errors</h3></div></div></div>
1.178 rillig 2558: <p>When building a package, warnings are typically ignored since they
2559: just flow by and do not cause the build to fail immediately. To find
2560: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2561: <pre class="programlisting">
2562: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2563: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2564: </pre>
2565: <p>(There are many more classes of warnings in pkgsrc, and most of
2566: them can be redefined with a simple definition like above.</p>
1.179 rillig 2567: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.178 rillig 2568: the package Makefile, research whether the package actually needs Perl.
2569: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2570: Makefile, and if it doesn't, add
2571: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2572: </div>
2573: <div class="sect2">
2574: <div class="titlepage"><div><div><h3 class="title">
1.272 wiz 2575: <a name="bulk.var.pkglint"></a>8.5.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.178 rillig 2576: <p>Using pkglint as part of the regular build process is mostly a
2577: waste of time. If you want to fix some of the warnings, just run pkglint
2578: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2579: 10), which is much faster than a complete bulk build.</p>
2580: </div>
2581: <div class="sect2">
2582: <div class="titlepage"><div><div><h3 class="title">
1.272 wiz 2583: <a name="bulk.var.strings"></a>8.5.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.178 rillig 2584: <p>To ensure that the binary packages don't contain references to the
2585: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2586: that variable includes the item <code class="literal">extra</code>, it is
2587: possible to define additional patterns that must not appear in any
2588: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2589: <pre class="programlisting">
2590: CHECK_WRKREF= extra
2591: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2592: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2593: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2594: </pre>
2595: <p>The above patterns will probably generate many false positives,
2596: therefore the results need to be taken with a grain of salt.</p>
2597: </div>
2598: <div class="sect2">
2599: <div class="titlepage"><div><div><h3 class="title">
1.272 wiz 2600: <a name="bulk.var.test"></a>8.5.8. Reject packages whose self-test fails</h3></div></div></div>
1.178 rillig 2601: <p>To run the test suites that come with each package, add this line
2602: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2603: <pre class="programlisting">
2604: PKGSRC_RUN_TEST= yes
2605: </pre>
2606: <p>Be prepared that even the most basic packages fail this test. When
2607: doing a bulk build with this, it will often abort in the early phase
2608: where the packages are scanned for their dependencies since there are
2609: cyclic dependencies. There is still a lot to do in this area.</p>
2610: </div>
2611: <div class="sect2">
2612: <div class="titlepage"><div><div><h3 class="title">
1.272 wiz 2613: <a name="bulk.var.shvar"></a>8.5.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.178 rillig 2614: <p>To catch typos in the shell snippets from the Makefile fragments,
2615: add the <code class="literal">-u</code> flag to most of the commands by adding this
2616: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2617: <pre class="programlisting">
2618: RUN= @set -eu;
2619: </pre>
1.181 rillig 2620: <p>After that, ensure that none of the bulk build log files (even
2621: those for successfully built packages) contains the string
2622: <code class="literal">parameter not set</code> or whatever error message the
2623: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.178 rillig 2624: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2625: definition.</p>
2626: </div>
2627: <div class="sect2">
2628: <div class="titlepage"><div><div><h3 class="title">
1.272 wiz 2629: <a name="bulk.var.quiet"></a>8.5.10. Turn off verbose logging</h3></div></div></div>
1.178 rillig 2630: <p>The build logs of a package are often quite long. This allows error
2631: messages or other interesting details to hide between the noise. To make
2632: the actual error message stand out more, add these lines to
2633: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2634: <pre class="programlisting">
2635: GNU_CONFIGURE_QUIET= yes
2636: MAKE_FLAGS+= -s
2637: </pre>
2638: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2639: Make. On exotic platforms with their own make, it may be a little
2640: different.</p>
2641: </div>
2642: </div>
2643: <div class="sect1">
2644: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.272 wiz 2645: <a name="creating-cdroms"></a>8.6. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2646: <p>After your pkgsrc bulk-build has completed, you may wish to
2647: create a CD-ROM set of the resulting binary packages to assist
2648: in installing packages on other machines. The
1.207 leot 2649: <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 2650: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2651: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2652: way that keeps all the dependencies for a given package on the same
2653: CD as that package.</p>
1.41 asau 2654: <div class="sect2">
1.1 dsieger 2655: <div class="titlepage"><div><div><h3 class="title">
1.272 wiz 2656: <a name="cdpack-example"></a>8.6.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2657: <p>Complete documentation for cdpack is found in the cdpack(1)
2658: man page. The following short example assumes that the binary
2659: packages are left in
2660: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2661: sufficient disk space exists in <code class="filename">/u2</code> to
2662: hold the ISO 9660 images.</p>
2663: <pre class="screen">
2664: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2665: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2666: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2667: </pre>
2668: <p>If you wish to include a common set of files
2669: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2670: etc.) on each CD in the collection, then you need to create a
1.175 gutterid 2671: directory which contains these files, e.g.:</p>
1.1 dsieger 2672: <pre class="screen">
2673: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2674: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2675: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2676: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2677: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2678: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2679: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2680: </pre>
2681: <p>Now create the images:</p>
2682: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2683: <p>Each image will contain <code class="filename">README</code>,
2684: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2685: in their root directories.</p>
2686: </div>
2687: </div>
2688: </div>
1.41 asau 2689: <div class="chapter">
1.1 dsieger 2690: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 2691: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2692: <div class="toc">
2693: <p><b>Table of Contents</b></p>
1.100 leot 2694: <dl class="toc">
1.154 rillig 2695: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2696: <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 2697: </dl>
2698: </div>
2699: <p>The files that are installed by pkgsrc are organized in a way that
2700: is similar to what you find in the <code class="filename">/usr</code> directory
2701: of the base system. But some details are different. This is because
2702: pkgsrc initially came from FreeBSD and had adopted its file system
2703: hierarchy. Later it was largely influenced by NetBSD. But no matter
2704: which operating system you are using pkgsrc with, you can expect the
2705: same layout for pkgsrc.</p>
2706: <p>There are mainly four root directories for pkgsrc, which are all
2707: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2708: When pkgsrc has been installed as root, the default locations
2709: are:</p>
2710: <pre class="programlisting">
2711: LOCALBASE= /usr/pkg
2712: PKG_SYSCONFBASE= /usr/pkg/etc
2713: VARBASE= /var
1.119 sevan 2714: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2715: </pre>
2716: <p>In unprivileged mode (when pkgsrc has been installed as any other
2717: user), the default locations are:</p>
2718: <pre class="programlisting">
2719: LOCALBASE= ${HOME}/pkg
2720: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2721: VARBASE= ${HOME}/pkg/var
1.119 sevan 2722: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2723: </pre>
2724: <p>What these four directories are for, and what they look like is
2725: explained below.</p>
1.41 asau 2726: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2727: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2728: <code class="filename">/usr</code> directory in the base system. It is the
1.266 martin 2729: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2730: the well-known subdirectories like <code class="filename">bin</code>,
2731: <code class="filename">include</code>, <code class="filename">lib</code>,
2732: <code class="filename">share</code> and
2733: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2734: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2735: <code class="filename">/var</code> in the base system. Some programs (especially
2736: games, network daemons) need write access to it during normal
2737: operation.</p></li>
1.23 wiz 2738: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2739: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2740: 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 2741: itself.</p></li>
2742: </ul></div>
1.41 asau 2743: <div class="sect1">
1.1 dsieger 2744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2745: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2746: </h2></div></div></div>
2747: <p>The following directories exist in a typical pkgsrc installation
2748: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2749: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2750: <dt><span class="term"><code class="filename">bin</code></span></dt>
2751: <dd><p>Contains executable programs that are intended to be
2752: directly used by the end user.</p></dd>
2753: <dt><span class="term"><code class="filename">emul</code></span></dt>
2754: <dd><p>Contains files for the emulation layers of various other
2755: operating systems, especially for
2756: NetBSD.</p></dd>
2757: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2758: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2759: <dd><p>Contains
2760: the configuration files.</p></dd>
2761: <dt><span class="term"><code class="filename">include</code></span></dt>
2762: <dd><p>Contains headers for the C and C++ programming
2763: languages.</p></dd>
2764: <dt><span class="term"><code class="filename">info</code></span></dt>
2765: <dd><p>Contains GNU info files of various
2766: packages.</p></dd>
2767: <dt><span class="term"><code class="filename">lib</code></span></dt>
2768: <dd><p>Contains shared and static
2769: libraries.</p></dd>
2770: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2771: <dd><p>Contains data files that don't change after
2772: installation. Other data files belong into
2773: <code class="filename">${VARBASE}</code>.</p></dd>
2774: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2775: <dd><p>Contains programs that are not intended to be used by
2776: end users, such as helper programs or network
2777: daemons.</p></dd>
2778: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2779: <dd><p>Contains programs that are intended to be executed as
2780: CGI scripts by a web server.</p></dd>
2781: <dt><span class="term"><code class="filename">man</code> (the usual value of
2782: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2783: <dd><p>Contains brief
2784: documentation in form of manual pages.</p></dd>
2785: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2786: <dd><p>Contains programs that are intended to be used only by
2787: the super-user.</p></dd>
2788: <dt><span class="term"><code class="filename">share</code></span></dt>
2789: <dd><p>Contains platform-independent data files that don't
2790: change after installation.</p></dd>
2791: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2792: <dd><p>Contains documentation files provided by the
2793: packages.</p></dd>
2794: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2795: <dd><p>Contains example files provided by the packages. Among
2796: others, the original configuration files are saved here and copied to
2797: <code class="filename">${PKG_SYSCONFDIR}</code> during
2798: installation.</p></dd>
2799: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2800: <dd><p>Contains the original files for rc.d
2801: scripts.</p></dd>
2802: <dt><span class="term"><code class="filename">var</code> (the usual location of
2803: <code class="filename">${VARBASE}</code>)</span></dt>
2804: <dd><p>Contains files
2805: that may be modified after
2806: installation.</p></dd>
2807: </dl></div>
2808: </div>
1.41 asau 2809: <div class="sect1">
1.1 dsieger 2810: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2811: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2812: </h2></div></div></div>
1.41 asau 2813: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2814: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2815: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2816: <dd><p>Contains
2817: information about the currently installed
2818: packages.</p></dd>
2819: <dt><span class="term"><code class="filename">games</code></span></dt>
2820: <dd><p>Contains highscore
2821: files.</p></dd>
2822: <dt><span class="term"><code class="filename">log</code></span></dt>
2823: <dd><p>Contains log files.</p></dd>
2824: <dt><span class="term"><code class="filename">run</code></span></dt>
2825: <dd><p>Contains informational files about daemons that are
2826: currently running.</p></dd>
2827: </dl></div>
2828: </div>
2829: </div>
1.41 asau 2830: <div class="chapter">
1.1 dsieger 2831: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 2832: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2833: <div class="toc">
2834: <p><b>Table of Contents</b></p>
1.100 leot 2835: <dl class="toc">
1.154 rillig 2836: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2837: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2838: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2839: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2840: <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>
2841: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2842: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2843: <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>
2844: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
1.266 martin 2845: <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
2846: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
2847: <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 2848: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 2849: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2850: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2851: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2852: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
1.266 martin 2853: <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 2854: </dl>
2855: </div>
2856: <p>This section contains hints, tips & tricks on special things in
2857: pkgsrc that we didn't find a better place for in the previous chapters, and
2858: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2859: <div class="sect1">
1.1 dsieger 2860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2861: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2862: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2863: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2864: <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 2865: This is a general purpose list for most issues regarding
2866: pkgsrc, regardless of platform, e.g. soliciting user help
2867: for pkgsrc configuration, unexpected build failures, using
2868: particular packages, upgrading pkgsrc installations,
2869: questions regarding the pkgsrc release branches, etc. General announcements or
2870: proposals for changes that impact the pkgsrc user community,
2871: e.g. major infrastructure changes, new features, package
2872: removals, etc., may also be posted.</p></li>
1.174 leot 2873: <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 2874: A list where the results of pkgsrc bulk builds are sent and
2875: discussed.</p></li>
1.174 leot 2876: <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 2877: This list is for those who are interested in getting a
2878: commit message for every change committed to pkgsrc. It is
2879: also available in digest form, meaning one daily message
2880: containing all commit messages for changes to the package
2881: source tree in that 24 hour period.</p></li>
2882: </ul></div>
2883: <p>To subscribe, do:</p>
2884: <pre class="programlisting">
2885: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2886: </pre>
2887: <p>Archives for all these mailing lists are available from
1.174 leot 2888: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2889: </div>
1.41 asau 2890: <div class="sect1">
1.1 dsieger 2891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2892: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2893: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2894: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2895: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2896: they might be useful, and not to duplicate the documentation that comes
2897: with each package.</p>
2898: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.207 leot 2899: <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 2900: Symlinks for use by buildlink.</p></li></ul></div>
2901: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2902: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2903: <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 2904: Calculates various kinds of checksums (including SHA3).</p></li>
1.207 leot 2905: <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 2906: Compatibility library for pkgsrc tools.</p></li>
1.207 leot 2907: <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 2908: non-BSD systems due to lack of native mtree.</p></li>
1.207 leot 2909: <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 2910: Up-to-date replacement for
2911: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2912: systems where pkg_install is not present.</p></li>
2913: </ul></div>
2914: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2915: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2916: <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 2917: Create a binary package from an
1.10 hubertf 2918: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2919: save the old package.</p></li>
1.207 leot 2920: <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 2921: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2922: from multiple locations. It currently supports the following
2923: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.207 leot 2924: <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 2925: the best compiler flags to optimise code for your current
1.23 wiz 2926: CPU and compiler. </p></li>
1.1 dsieger 2927: </ul></div>
2928: <p>Utilities for keeping track of installed packages, being up to date,
2929: etc:</p>
1.41 asau 2930: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2931: <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 2932: update tool similar to apt(1). Download, install, and upgrade
2933: binary packages easily.</p></li>
1.207 leot 2934: <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 2935: packages whose installed versions do not match the latest pkgsrc
2936: entries.</p></li>
1.207 leot 2937: <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 2938: dependency graphs of packages, to aid in choosing a strategy for
2939: updating.</p></li>
1.207 leot 2940: <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
2941: 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>
2942: <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 2943: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.207 leot 2944: <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 2945: does various checks on the complete pkgsrc system.</p></li>
1.207 leot 2946: <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 2947: packages you have installed.</p></li>
2948: </ul></div>
2949: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2950: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2951: <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 2952: making and maintaining patches for a package (includes pkgdiff,
2953: pkgvi, mkpatches, etc.).</p></li>
1.207 leot 2954: <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 2955: converting to pkgsrc.</p></li>
2956: </ul></div>
2957: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2958: utilities)</p>
1.41 asau 2959: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2960: <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 2961: packages in a chrooted area.</p></li>
1.207 leot 2962: <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 2963: kernel version for chrooted cross builds.</p></li>
2964: </ul></div>
2965: </div>
1.41 asau 2966: <div class="sect1">
1.1 dsieger 2967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2968: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2969: <p>To install packages from source as a non-root user, download
1.266 martin 2970: 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 2971: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2972: --unprivileged</strong></span>.</p>
2973: <p>This will install the binary part of pkgsrc to
2974: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2975: into <code class="filename">~/pkg/etc</code>.</p>
2976: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2977: </div>
1.41 asau 2978: <div class="sect1">
1.1 dsieger 2979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2980: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2981: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2982: enable this feature by adding the option
2983: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2984: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2985: distfile is found, pkgsrc will try to resume it.</p>
2986: <p>You can also
1.61 wiz 2987: use a different program than the platform default program by changing the
1.16 jnemeth 2988: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2989: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2990: by using the value manual. A value of custom disables the system defaults
2991: and dependency tracking for the fetch program. In that case you have to
2992: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2993: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2994: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2995: <p>For example, if you want to use
1.16 jnemeth 2996: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2997: like:</p>
2998: <pre class="programlisting">
1.112 rillig 2999: FETCH_USING= wget
1.1 dsieger 3000: </pre>
3001: </div>
1.41 asau 3002: <div class="sect1">
1.1 dsieger 3003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3004: <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 3005: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3006: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3007: you will have to add the following line into
1.10 hubertf 3008: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3009: <pre class="programlisting">
1.4 rillig 3010: X11_TYPE=modular
1.1 dsieger 3011: </pre>
3012: </div>
1.41 asau 3013: <div class="sect1">
1.1 dsieger 3014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3015: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3016: <p>If you are sitting behind a firewall which does not allow direct
3017: connections to Internet hosts (i.e. non-NAT), you may specify the
3018: relevant proxy hosts. This is done using an environment variable in the
3019: form of a URL, e.g. in Amdahl, the machine
1.266 martin 3020: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 3021: port 80 as the proxy port number. So the proxy environment variables
3022: are:</p>
3023: <pre class="programlisting">
3024: ftp_proxy=ftp://orpheus.amdahl.com:80/
3025: http_proxy=http://orpheus.amdahl.com:80/
3026: </pre>
3027: </div>
1.41 asau 3028: <div class="sect1">
1.1 dsieger 3029: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3030: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 3031: <p>Some fetch tools are not prepared to support HTTPS by default
3032: (for example, the one in NetBSD 6.0), or the one installed by the
3033: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3034: dependency graph).</p>
3035: <p>Usually you won't notice, because distribution files are
1.266 martin 3036: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
1.65 wiz 3037: be often enough if you are following pkgsrc-current. In that case, set
3038: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
1.266 martin 3039: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
1.65 wiz 3040: with HTTPS support by default. Of course, these tools need to be
3041: installed before you can use them this way.</p>
3042: </div>
3043: <div class="sect1">
3044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3045: <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 3046: <p>This depends on which utility is used to retrieve distfiles. From
3047: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3048: the first available command from the following list:</p>
1.41 asau 3049: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3050: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3051: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 3052: </ul></div>
3053: <p>On a default NetBSD installation, this will be
3054: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3055: connections first, and falls back to active connections if the server
3056: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 3057: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3058: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3059: <p>Having that option present will prevent
3060: <code class="filename">/usr/bin/ftp</code> from falling back to active
3061: transfers.</p>
3062: </div>
1.41 asau 3063: <div class="sect1">
1.1 dsieger 3064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3065: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3066: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3067: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 3068: 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 3069: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3070: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3071: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3072: resulting list to your machine at work/school and use it there. If you
1.259 leot 3073: 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 3074: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3075: URL:</p>
3076: <p>At home:</p>
3077: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3078: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3079: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3080: <p>At work:</p>
3081: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3082: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3083: home.</p>
3084: <p>If you have a machine running NetBSD, and you want to get
3085: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3086: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3087: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3088: directly by running:</p>
3089: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3090: <p>If you even decide to ignore
3091: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3092: by running:</p>
3093: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3094: </div>
1.41 asau 3095: <div class="sect1">
1.1 dsieger 3096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3097: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">“<span class="quote">Don't know how to make
3098: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.207 leot 3099: <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 3100: package, you get the error from make that it doesn't know how to make
3101: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.266 martin 3102: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 3103: the NetBSD base distribution on your machine. It is recommended to do
3104: that to format man pages.</p>
1.207 leot 3105: <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 3106: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3107: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3108: </div>
1.41 asau 3109: <div class="sect1">
1.1 dsieger 3110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3111: <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 3112: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3113: when you installed your NetBSD machine. Please get and install it, by
3114: extracting it in <code class="filename">/</code>:</p>
3115: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3116: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3117: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3118: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3119: -r</strong></span>).</p>
3120: </div>
1.41 asau 3121: <div class="sect1">
1.1 dsieger 3122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3123: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.1 dsieger 3124: <p>When installing packages as non-root user and using the just-in-time
1.259 leot 3125: <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 3126: password for each required package installed. To avoid this, the sudo
3127: package can be used, which does password caching over a limited time. To
1.221 nia 3128: use it, install <span class="command"><strong>sudo</strong></span> or
3129: <span class="command"><strong>priv</strong></span> (either as binary package, from
3130: <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 3131: <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 3132: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3133: <span class="emphasis"><em>after</em></span> the definition of the
3134: <code class="varname">LOCALBASE</code> variable:</p>
3135: <pre class="programlisting">
3136: .if exists(${LOCALBASE}/bin/sudo)
1.260 wiz 3137: SU_CMD= ${LOCALBASE}/bin/sudo -E /bin/sh -c
1.1 dsieger 3138: .endif
3139: </pre>
1.260 wiz 3140: <p>Note the <span class="command"><strong>-E</strong></span> flag; that tells
3141: <span class="command"><strong>sudo</strong></span> to preserve the environment.
3142: Without this, the bin-install target will fail when building a
3143: package with a non-default python version.
3144: </p>
1.1 dsieger 3145: </div>
1.41 asau 3146: <div class="sect1">
1.1 dsieger 3147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3148: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3149: <p>As the system administrator, you can choose where configuration files
3150: are installed. The default settings make all these files go into
3151: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3152: be suboptimal depending on your expectations (e.g., a read-only,
3153: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3154: configuration of the provided packages).</p>
3155: <p>In order to change the defaults, you can modify the
3156: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3157: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3158: directory; some common examples include <code class="filename">/etc</code> or
3159: <code class="filename">/etc/pkg</code>.</p>
3160: <p>Furthermore, you can change this value on a per-package basis by
3161: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3162: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3163: package you would like to modify, that is, the contents of
3164: <code class="varname">PKGBASE</code>.</p>
3165: <p>Note that after changing these settings, you must rebuild and
3166: reinstall any affected packages.</p>
3167: </div>
1.41 asau 3168: <div class="sect1">
1.1 dsieger 3169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3170: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3171: <p>Please be aware that there can often be bugs in third-party software,
3172: and some of these bugs can leave a machine vulnerable to exploitation by
3173: attackers. In an effort to lessen the exposure, the NetBSD packages team
3174: maintains a database of known-exploits to packages which have at one time
3175: been included in pkgsrc. The database can be downloaded automatically, and
3176: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3177: do this, refer to the following two tools (installed as part of the
1.207 leot 3178: <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 3179: <div class="orderedlist"><ol class="orderedlist" type="1">
3180: <li class="listitem">
1.20 snj 3181: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3182: download a list of the security vulnerabilities information. This list
1.25 spz 3183: is kept up to date by the pkgsrc security team, and is distributed
3184: from the NetBSD ftp server:</p>
1.177 leot 3185: <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 3186: </li>
1.23 wiz 3187: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3188: current machine, checking each known vulnerability. If a
1.1 dsieger 3189: vulnerable package is installed, it will be shown by output to stdout,
3190: including a description of the type of vulnerability, and a URL
3191: containing more information.</p></li>
3192: </ol></div>
1.121 sevan 3193: <p>Use of these tools is strongly recommended!
1.266 martin 3194: 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 3195: reporting.</p>
3196: <p>If this database is installed, pkgsrc builds will use it to
3197: perform a security check before building any package.</p>
1.1 dsieger 3198: </div>
1.41 asau 3199: <div class="sect1">
1.1 dsieger 3200: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3201: <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 3202: <p>When you add your own preferences to the
3203: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3204: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3205: environment variables to the <code class="filename">./configure</code>
1.259 leot 3206: 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 3207: <code class="varname">CFLAGS</code> from the environment variable by
3208: overriding them in the <code class="filename">Makefile</code>s of their
3209: package.</p>
3210: <p>Currently there is no solution to this problem. If you
3211: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3212: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3213: directory and then inspect any <code class="filename">Makefile</code> and
3214: <code class="filename">Makefile.in</code> for whether they define
3215: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.266 martin 3216: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3217: programmers write so bad code that it only works for the
3218: specific combination of <code class="varname">CFLAGS</code> they have
3219: chosen.</p>
1.172 rillig 3220: <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>
3221: <pre class="programlisting">
3222: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3223: CFLAGS+= -Dpkgsrc___CFLAGS
3224: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3225: </pre>
3226: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3227: to see whether the above flags are passed to the actual build
3228: commands in general.</p>
3229: <p>To find out whether the flags are passed to individual compiler
3230: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3231: most cases, the flags from the original command lines (the lines starting
3232: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3233: (the lines starting with <code class="literal"><.></code>). If the flag is
3234: missing from the actual compiler command, it must have been removed by
1.266 martin 3235: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.1 dsieger 3236: </div>
1.41 asau 3237: <div class="sect1">
1.1 dsieger 3238: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3239: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3240: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3241: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3242: case that occurs often is that people only update pkgsrc in
3243: parts, because of performance reasons. Since pkgsrc is one large
3244: system, not a collection of many small systems, there are
3245: sometimes changes that only work when the whole pkgsrc tree is
3246: updated.</p></li>
1.41 asau 3247: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.266 martin 3248: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3249: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3250: files.</p></li>
1.41 asau 3251: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3252: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3253: verify this.</p></li>
1.108 rillig 3254: <li class="step"><p>If you are a package developer who wants to invest
1.266 martin 3255: 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 3256: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3257: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3258: </ol></div>
3259: </div>
1.41 asau 3260: <div class="sect1">
1.1 dsieger 3261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3262: <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 3263: <p>You have modified a file from pkgsrc, and someone else has
3264: modified that same file afterwards in the CVS repository. Both changes
3265: are in the same region of the file, so when you updated pkgsrc, the
3266: <code class="literal">cvs</code> command marked the conflicting changes in the
3267: file. Because of these markers, the file is no longer a valid
3268: <code class="filename">Makefile</code>.</p>
3269: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3270: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3271: -dP</strong></span> in that directory to download the current version.</p>
3272: </div>
3273: </div>
3274: </div>
1.41 asau 3275: <div class="part">
1.1 dsieger 3276: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 3277: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3278: <div class="partintro">
1.1 dsieger 3279: <div></div>
3280: <p>This part of the book deals with creating and
1.266 martin 3281: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3282: guide on creating a new package. The remaining chapters are more
3283: like a reference manual for pkgsrc.</p>
3284: <div class="toc">
3285: <p><b>Table of Contents</b></p>
1.100 leot 3286: <dl class="toc">
1.154 rillig 3287: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 3288: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 3289: <dd><dl>
1.184 rillig 3290: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3291: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3292: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 3293: <dd><dl>
1.184 rillig 3294: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3295: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3296: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3297: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3298: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 3299: </dl></dd>
1.184 rillig 3300: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3301: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3302: <dd><dl>
3303: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3304: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3305: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3306: </dl></dd>
3307: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3308: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3309: </dl></dd>
1.184 rillig 3310: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 3311: <dd><dl>
1.184 rillig 3312: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3313: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3314: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3315: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3316: <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 3317: <dd><dl>
1.184 rillig 3318: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3319: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 3320: </dl></dd>
1.184 rillig 3321: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3322: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3323: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3324: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3325: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3326: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3327: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3328: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3329: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3330: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3331: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3332: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3333: </dl></dd>
3334: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3335: <dd><dl>
3336: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 3337: <dd><dl>
1.219 nia 3338: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
3339: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
3340: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.6 rillig 3341: </dl></dd>
1.184 rillig 3342: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3343: <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 3344: </dl></dd>
1.184 rillig 3345: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3346: <dd><dl>
1.184 rillig 3347: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3348: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3349: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3350: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 3351: <dd><dl>
1.184 rillig 3352: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3353: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3354: <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>
3355: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 3356: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.6 rillig 3357: </dl></dd>
3358: </dl></dd>
1.184 rillig 3359: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 3360: <dd><dl>
1.184 rillig 3361: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3362: <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>
3363: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3364: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3365: </dl></dd>
1.184 rillig 3366: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 3367: <dd><dl>
1.184 rillig 3368: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3369: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3370: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3371: </dl></dd>
3372: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3373: <dd><dl>
3374: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3375: <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 3376: <dd><dl>
1.184 rillig 3377: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3378: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 3379: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3380: and
3381: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3382: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3383: </dl></dd>
1.184 rillig 3384: <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 3385: <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 3386: </dl></dd>
3387: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 3388: <dd><dl>
1.184 rillig 3389: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3390: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3391: <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>
3392: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3393: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3394: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3395: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3396: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3397: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 3398: </dl></dd>
1.184 rillig 3399: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3400: <dd><dl>
3401: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3402: <dd><dl>
3403: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3404: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 3405: </dl></dd>
1.184 rillig 3406: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 3407: <dd><dl>
1.184 rillig 3408: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3409: <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 3410: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
3411: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
3412: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 3413: </dl></dd>
3414: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3415: <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>
3416: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3417: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3418: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3419: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3420: <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 3421: </dl></dd>
3422: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3423: <dd><dl>
3424: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3425: <dd><dl>
3426: <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>
3427: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3428: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3429: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3430: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3431: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3432: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3433: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3434: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3435: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3436: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3437: </dl></dd>
3438: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3439: <dd><dl>
3440: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3441: <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>
3442: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3443: </dl></dd>
3444: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3445: <dd><dl>
3446: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3447: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3448: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 3449: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.260 wiz 3450: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.154 rillig 3451: </dl></dd>
3452: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3453: <dd><dl>
3454: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3455: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 3456: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 3457: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
3458: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
3459: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
3460: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 3461: </dl></dd>
3462: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3463: <dd><dl>
3464: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3465: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 3466: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
1.266 martin 3467: <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>
1.172 rillig 3468: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 3469: </dl></dd>
3470: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3471: <dd><dl>
3472: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3473: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3474: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3475: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3476: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 3477: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.254 wiz 3478: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
3479: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
3480: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
3481: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
3482: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
3483: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
3484: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
3485: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
3486: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
3487: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.1 dsieger 3488: emulation</a></span></dt>
1.254 wiz 3489: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
3490: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.1 dsieger 3491: </dl></dd>
1.154 rillig 3492: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3493: </dl></dd>
1.184 rillig 3494: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3495: <dd><dl>
3496: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3497: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3498: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3499: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3500: </dl></dd>
1.154 rillig 3501: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3502: <dd><dl>
1.154 rillig 3503: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3504: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3505: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3506: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3507: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3508: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3509: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3510: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3511: </dl></dd>
1.263 wiz 3512: <dt><span class="chapter"><a href="#policies">24. pkgsrc Policies</a></span></dt>
3513: <dd><dl>
3514: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
3515: <dd><dl>
3516: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
3517: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
3518: </dl></dd>
3519: </dl></dd>
3520: <dt><span class="chapter"><a href="#devfaq">25. Frequently Asked Questions</a></span></dt>
1.1 dsieger 3521: </dl>
3522: </div>
3523: </div>
1.41 asau 3524: <div class="chapter">
1.1 dsieger 3525: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 3526: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
1.154 rillig 3527: <p>
3528: To get help when developing pkgsrc, the definitive source is this
3529: document, the pkgsrc guide. If you don't find anything here,
3530: there are alternatives:
3531: </p>
3532: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3533: <li class="listitem">
3534: <p>
3535: The built-in pkgsrc help, which is available after bootstrapping
1.266 martin 3536: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
1.154 rillig 3537: help for any topic, such as a variable name like
3538: <code class="varname">BUILD_DEFS</code>, a make target like
3539: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3540: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.266 martin 3541: <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 3542: </li>
3543: <li class="listitem"><p>
1.163 rillig 3544: To see the value of a single variable, run <span class="command"><strong>bmake
3545: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3546: </p></li>
3547: <li class="listitem"><p>
3548: To see the values of the most common variables, run
3549: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3550: topic. To see the variables for a single topic, run
3551: <span class="command"><strong>bmake
3552: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3553: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3554: </p></li>
3555: <li class="listitem"><p>
1.154 rillig 3556: The tech-pkg mailing list, to which
3557: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3558: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3559: questions</a>.</p></li>
3560: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
1.262 dholland 3561: <a class="ulink" href="https://web.libera.chat/" target="_top">via a web browser</a>
1.154 rillig 3562: or by using a specialized chat program such as
3563: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3564: Pick any user name and join the channel #pkgsrc.</p></li>
3565: </ul></div>
3566: </div>
3567: <div class="chapter">
3568: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 3569: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3570: <div class="toc">
3571: <p><b>Table of Contents</b></p>
1.100 leot 3572: <dl class="toc">
1.184 rillig 3573: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3574: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3575: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3576: <dd><dl>
3577: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3578: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3579: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3580: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3581: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3582: </dl></dd>
3583: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3584: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3585: <dd><dl>
3586: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3587: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3588: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3589: </dl></dd>
1.184 rillig 3590: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3591: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3592: </dl>
3593: </div>
1.184 rillig 3594: <p>Whenever you're preparing a package, there are a number of
3595: files involved which are described in the following
3596: sections.</p>
3597: <div class="sect1">
3598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3599: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
1.184 rillig 3600: </h2></div></div></div>
3601: <p>Building, installation and creation of a binary package are all
3602: controlled by the package's <code class="filename">Makefile</code>.
3603: The <code class="filename">Makefile</code> describes various things about
3604: a package, for example from where to get it, how to configure,
3605: build, and install it.</p>
3606: <p>A package <code class="filename">Makefile</code> contains several
3607: sections that describe the package.</p>
3608: <p>In the first section there are the following variables, which
3609: should appear exactly in the order given here. The order and
3610: grouping of the variables is mostly historical and has no further
3611: meaning.</p>
3612: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3613: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3614: distribution file to be downloaded from the package's
3615: website.</p></li>
3616: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3617: package, as used by pkgsrc. You need to provide it if
3618: <code class="varname">DISTNAME</code> (which is the default) is not a good
3619: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3620: provided (no distribution file is required). Usually it is the pkgsrc
3621: directory name together with the version number. It must match the
3622: regular expression
3623: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3624: starts with a letter or digit, and contains only letters, digits,
1.204 nia 3625: dashes, underscores, dots and plus signs.
3626: New packages should have entirely lower-case names, with the exception
3627: of some that must follow pre-existing conventions
3628: (e.g. R packages begin with <code class="varname">R-</code>).
3629: You can use the <code class="code">:tl</code> variable modifier to lower-case
3630: the package name.</p></li>
1.184 rillig 3631: <li class="listitem">
3632: <p><code class="varname">CATEGORIES</code> is a list of categories
3633: which the package fits in. You can choose any of the top-level
3634: directories of pkgsrc for it.</p>
3635: <p>Currently the following values are available for
3636: <code class="varname">CATEGORIES</code>. If more than
3637: one is used, they need to be separated by spaces:</p>
1.1 dsieger 3638: <pre class="programlisting">
1.184 rillig 3639: archivers cross geography meta-pkgs security
3640: audio databases graphics misc shells
3641: benchmarks devel ham multimedia sysutils
3642: biology editors inputmethod net textproc
3643: cad emulators lang news time
3644: chat finance mail parallel wm
3645: comms fonts math pkgtools www
3646: converters games mbone print x11
1.1 dsieger 3647: </pre>
3648: </li>
1.184 rillig 3649: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3650: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3651: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3652: and <code class="varname">DISTFILES</code> are discussed in detail in
1.266 martin 3653: <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>
1.184 rillig 3654: </ul></div>
3655: <p>The second section contains information about separately
3656: downloaded patches, if any.
3657: </p>
3658: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3659: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3660: Name(s) of additional files that contain distribution patches.
3661: There is no default. pkgsrc will look for them at
3662: <code class="varname">PATCH_SITES</code>.
3663: They will automatically be uncompressed before patching if
3664: the names end with <code class="filename">.gz</code> or
3665: <code class="filename">.Z</code>.</p></li>
3666: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3667: Primary location(s) for distribution patch files (see
3668: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3669: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.259 leot 3670: 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 3671: help find the correct files to patch. It defaults to
3672: <span class="command"><strong>-p0</strong></span>.</p></li>
3673: </ul></div>
3674: <p>The third section contains the following variables.
3675: </p>
3676: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.253 gutterid 3677: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email address
3678: of the person who is currently responsible for this package. In
3679: theory, the maintainer will be aware of upstream release, keep it
3680: updated, and generally resolve problems. Others contemplating
3681: significant changes should ask the maintainer for advice or review
3682: of a proposed change. This is not necessary for micro updates,
3683: bug fixes, pkgsrc-wide changes affecting many packages, and other
3684: things expected to be uncontroversial. It goes with this "should
3685: ask" that the maintainer should respond to inquiries reasonably
3686: promptly (most of the time), and either approve changes or provide
3687: reasons why not. Typically, when packaging a new program, set
3688: <code class="varname">MAINTAINER</code> to yourself. If you don't intend to
3689: maintain the package (especially if you feel you have no special
3690: insight), set it to <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>. This
3691: special value is a code point indicating that there is no
1.274 wiz 3692: maintainer.</p></li>
1.184 rillig 3693: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3694: find more information about the package.</p></li>
3695: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3696: description of the package (should not include the package
3697: name).</p></li>
3698: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.266 martin 3699: 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>
1.184 rillig 3700: </ul></div>
3701: <p>Other variables that affect the build:
3702: </p>
3703: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3704: <p><code class="varname">WRKSRC</code>: The directory where the
3705: interesting distribution files of the package are found. The
3706: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3707: works for most packages.</p>
3708: <p>If a package doesn't create a subdirectory for itself
3709: (most GNU software does, for instance), but extracts itself in
3710: the current directory, you should set
3711: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3712: <p>If a package doesn't create a subdirectory with the
3713: name of <code class="varname">DISTNAME</code> but some different name,
3714: set <code class="varname">WRKSRC</code> to point to the proper name in
3715: <code class="filename">${WRKDIR}</code>, for example
3716: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.207 leot 3717: <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 3718: <p>The name of the working directory created by pkgsrc is
3719: taken from the <code class="varname">WRKDIR_BASENAME</code>
3720: variable. By default, its value is
3721: <code class="filename">work</code>. If you want to use the same
3722: pkgsrc tree for building different kinds of binary packages,
3723: you can change the variable according to your needs. Two
3724: other variables handle common cases of setting
3725: <code class="varname">WRKDIR_BASENAME</code> individually. If
3726: <code class="varname">OBJHOSTNAME</code> is defined in
3727: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3728: the host's name is attached to the directory name. If
3729: <code class="varname">OBJMACHINE</code> is defined, the platform name
3730: is attached, which might look like
3731: <code class="filename">work.i386</code> or
3732: <code class="filename">work.sparc</code>.</p>
3733: </li></ul></div>
3734: <p>Please pay attention to the following gotchas:</p>
3735: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3736: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3737: installed in compressed form by the package. For packages using
3738: BSD-style makefiles which honor MANZ, there is
3739: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3740: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
1.266 martin 3741: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.184 rillig 3742: below).</p></li>
1.266 martin 3743: <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 3744: </ul></div>
3745: </div>
1.41 asau 3746: <div class="sect1">
1.1 dsieger 3747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3748: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
1.184 rillig 3749: </h2></div></div></div>
3750: <p>The <code class="filename">distinfo</code> file contains the message
3751: digest, or checksum, of each distfile needed for the package. This
3752: ensures that the distfiles retrieved from the Internet have not been
3753: corrupted during transfer or altered by a malign force to introduce
3754: a security hole. To provide maximum security, all distfiles are
1.243 gutterid 3755: protected using two different message digest algorithms (BLAKE2s
3756: and SHA512), as well as the file size.</p>
1.184 rillig 3757: <p>The <code class="filename">distinfo</code> file also contains the
3758: checksums for all the patches found in the
1.266 martin 3759: <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
1.184 rillig 3760: are only applied intentionally and that they don't accidentally change,
3761: e.g. when merging different changes together. They also make sure that
3762: new patches are actually added to CVS and old ones are removed.
3763: Too see whether the patches and the <code class="filename">distinfo</code> file
3764: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3765: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3766: <span class="command"><strong>make distinfo</strong></span> command.</p>
3767: <p>Some packages have different sets of distfiles depending on
1.207 leot 3768: 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 3769: <code class="filename">distinfo</code> file and care should be taken when
3770: upgrading such a package to ensure distfile information is not
3771: lost.</p>
3772: </div>
3773: <div class="sect1">
3774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3775: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
1.184 rillig 3776: </h2></div></div></div>
3777: <p>Some packages don't work out-of-the box on the various
3778: platforms that are supported by pkgsrc. These packages need
3779: to be patched to make them work. The patch files can be
3780: found in the <code class="filename">patches/</code> directory.</p>
3781: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3782: applied to the files in <code class="varname">WRKSRC</code> directory after
3783: extracting them, in alphabetic order.</p>
1.41 asau 3784: <div class="sect2">
1.1 dsieger 3785: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 3786: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
1.184 rillig 3787: <p>The <code class="filename">patch-*</code> files should be in
3788: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3789: problems. (To force patches to apply with fuzz you can set
3790: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3791: should contain only changes for a single file, and no file should be
3792: patched by more than one patch file. This helps to keep future
3793: modifications simple.</p>
3794: <p>Each patch file is structured as follows: In the first line,
3795: there is the RCS Id of the patch itself. The second line should be
3796: empty for aesthetic reasons. After that, there should be a comment for
3797: each change that the patch does. There are a number of standard
3798: cases:</p>
3799: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3800: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3801: mention the vulnerability ID (CAN, CVE).</p></li>
3802: <li class="listitem"><p>Patches that change source code should mention the
3803: platform and other environment (for example, the compiler) that the
3804: patch is needed for.</p></li>
3805: </ul></div>
3806: <p>The patch should be commented so that any
3807: developer who knows the code of the application can make some use of
3808: the patch. Special care should be taken for the upstream developers,
3809: since we generally want that they accept our patches, so we have less
3810: work in the future.</p>
1.1 dsieger 3811: </div>
1.41 asau 3812: <div class="sect2">
1.1 dsieger 3813: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 3814: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
1.184 rillig 3815: <p>One important thing to mention is to pay attention that no RCS
3816: IDs get stored in the patch files, as these will cause problems when
3817: later checked into the NetBSD CVS tree. Use the
1.207 leot 3818: <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 3819: problems.</p>
3820: <p>For even more automation, we recommend using
3821: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.222 gutterid 3822: whole set of patches. You just have to back up files before you
3823: edit them to <code class="filename">filename.orig</code>, e.g., with
1.184 rillig 3824: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3825: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3826: you upgrade a package this way, you can easily compare the new
3827: set of patches with the previously existing one with
3828: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3829: are replaced by new files, so carefully check if you want to take all
3830: the changes.</p>
3831: <p>When you have finished a package, remember to generate
3832: the checksums for the patch files by using the <span class="command"><strong>make
1.266 martin 3833: 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>
1.184 rillig 3834: <p>When adding a patch that corrects a problem in the
3835: distfile (rather than e.g. enforcing pkgsrc's view of where
3836: man pages should go), send the patch as a bug report to the
3837: maintainer. This benefits non-pkgsrc users of the package,
3838: and usually makes it possible to remove the patch in future
3839: version.</p>
3840: <p>The file names of the patch files are usually of the form
3841: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3842: Many packages still use the previous convention
3843: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3844: but new patches should be of the form containing the filename.
1.207 leot 3845: <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 3846: automatically.</p>
1.222 gutterid 3847: <p>When updating pre-existing patch files, if a file uses the old
3848: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
3849: convention, it's best not to change it to the new form, as that will
3850: just cause churn that makes it harder to track changes to patching
3851: over time. Similarly, if a patch now applies at different line offsets,
3852: but still applies cleanly as-is, there's no need to update it, as that
3853: also unnecessarily complicates the patch history.</p>
1.17 imil 3854: </div>
1.160 brook 3855: <div class="sect2">
3856: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 3857: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
1.184 rillig 3858: <p>If you want to share patches between multiple packages
3859: in pkgsrc, e.g. because they use the same distfiles, set
3860: <code class="varname">PATCHDIR</code> to the path where the patch files
3861: can be found, e.g.:</p>
3862: <pre class="programlisting">
3863: PATCHDIR= ../../editors/xemacs/patches
3864: </pre>
3865: <p>Patch files that are distributed by the author or other
3866: maintainers can be listed in
3867: <code class="varname">PATCHFILES</code>.</p>
3868: <p>If it is desired to store any patches that should not be
3869: committed into pkgsrc, they can be kept outside the pkgsrc
3870: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3871: directory tree there is expected to have the same
1.266 martin 3872: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.184 rillig 3873: patches are expected to be stored inside these dirs (also
3874: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3875: example, if you want to keep a private patch for
3876: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3877: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3878: files in the named directory are expected to be patch files,
3879: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3880: applied</em></span>.</p>
1.160 brook 3881: </div>
3882: <div class="sect2">
3883: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 3884: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
1.184 rillig 3885: <p>When fixing a portability issue in the code do not use
3886: preprocessor magic to check for the current operating system nor
3887: platform. Doing so hurts portability to other platforms because
3888: the OS-specific details are not abstracted appropriately.</p>
3889: <p>The general rule to follow is: instead of checking for the
3890: operating system the application is being built on, check for the
3891: specific <span class="emphasis"><em>features</em></span> you need. For example,
3892: instead of assuming that kqueue is available under NetBSD and
3893: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3894: kqueue support, add a check that detects kqueue itself —
3895: yes, this generally involves patching the
3896: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3897: that prevents some OSes from adopting interfaces from other OSes
3898: (e.g. Linux implementing kqueue), something that the above checks
3899: cannot take into account.</p>
3900: <p>Of course, checking for features generally involves more
3901: work on the developer's side, but the resulting changes are
3902: cleaner and there are chances they will work on many other
3903: platforms. Not to mention that there are higher chances of being
3904: later integrated into the mainstream sources. Remember:
3905: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3906: <p>Some typical examples:</p>
3907: <div class="table">
1.266 martin 3908: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
1.184 rillig 3909: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3910: <colgroup>
3911: <col>
3912: <col>
3913: <col>
3914: </colgroup>
3915: <thead><tr>
3916: <th>Where</th>
3917: <th>Incorrect</th>
3918: <th>Correct</th>
3919: </tr></thead>
3920: <tbody>
3921: <tr>
3922: <td>configure script</td>
3923: <td>
1.160 brook 3924: <pre class="programlisting">
1.184 rillig 3925: case ${target_os} in
3926: netbsd*) have_kvm=yes ;;
3927: *) have_kvm=no ;;
3928: esac
1.160 brook 3929: </pre>
1.184 rillig 3930: </td>
3931: <td>
1.160 brook 3932: <pre class="programlisting">
1.184 rillig 3933: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.160 brook 3934: </pre>
1.184 rillig 3935: </td>
3936: </tr>
3937: <tr>
3938: <td>C source file</td>
3939: <td>
1.1 dsieger 3940: <pre class="programlisting">
1.184 rillig 3941: #if defined(__NetBSD__)
3942: # include <sys/event.h>
3943: #endif
1.1 dsieger 3944: </pre>
1.184 rillig 3945: </td>
3946: <td>
1.1 dsieger 3947: <pre class="programlisting">
1.184 rillig 3948: #if defined(HAVE_SYS_EVENT_H)
3949: # include <sys/event.h>
3950: #endif
1.1 dsieger 3951: </pre>
1.184 rillig 3952: </td>
3953: </tr>
3954: <tr>
3955: <td>C source file</td>
3956: <td>
1.1 dsieger 3957: <pre class="programlisting">
1.184 rillig 3958: int
3959: monitor_file(...)
3960: {
3961: #if defined(__NetBSD__)
3962: int fd = kqueue();
3963: ...
3964: #else
3965: ...
3966: #endif
3967: }
1.1 dsieger 3968: </pre>
1.184 rillig 3969: </td>
3970: <td>
1.1 dsieger 3971: <pre class="programlisting">
1.184 rillig 3972: int
3973: monitor_file(...)
3974: {
3975: #if defined(HAVE_KQUEUE)
3976: int fd = kqueue();
3977: ...
3978: #else
3979: ...
3980: #endif
3981: }
1.1 dsieger 3982: </pre>
1.184 rillig 3983: </td>
3984: </tr>
3985: </tbody>
3986: </table></div>
3987: </div>
3988: <br class="table-break">
3989: </div>
3990: <div class="sect2">
3991: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 3992: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
1.184 rillig 3993: <p>Always, always, <span class="strong"><strong>always</strong></span>
3994: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3995: improvements you do to a package to the mainstream developers.
3996: This is the only way to get their attention on portability issues
3997: and to ensure that future versions can be built out-of-the box on
3998: NetBSD. Furthermore, any user that gets newer distfiles will get
3999: the fixes straight from the packaged code.</p>
4000: <p>This generally involves cleaning up the patches
4001: (because sometimes the patches that are
4002: added to pkgsrc are quick hacks), filing bug reports in the
4003: appropriate trackers for the projects and working with the
4004: mainstream authors to accept your changes. It is
4005: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4006: the packages in pkgsrc are kept simple and thus further changes
4007: can be done without much hassle.</p>
4008: <p>When you have done this, please add a URL to the upstream
4009: bug report to the patch comment.</p>
4010: <p>Support the idea of free software!</p>
4011: </div>
1.1 dsieger 4012: </div>
1.184 rillig 4013: <div class="sect1">
4014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4015: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
1.184 rillig 4016: <div class="variablelist"><dl class="variablelist">
4017: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4018: <dd><p>A multi-line description of the piece of software. This should include
4019: any credits where they are due. Please bear in mind that others do not
4020: share your sense of humour (or spelling idiosyncrasies), and that others
4021: will read everything that you write here.</p></dd>
4022: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4023: <dd><p>This file governs the files that are installed on your
4024: system: all the binaries, manual pages, etc. There are other
4025: directives which may be entered in this file, to control the
4026: creation and deletion of directories, and the location of
1.266 martin 4027: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
1.184 rillig 4028: information.</p></dd>
4029: </dl></div>
4030: </div>
4031: <div class="sect1">
4032: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4033: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
1.184 rillig 4034: <div class="sect2">
4035: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 4036: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
1.184 rillig 4037: <div class="variablelist"><dl class="variablelist">
4038: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
4039: <dd>
1.259 leot 4040: <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 4041: First time after package extraction and before files are
4042: moved in place, the second time after the files to install
4043: are moved in place. This can be used to do any custom
4044: procedures not possible with @exec commands in
1.259 leot 4045: <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
1.266 martin 4046: <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 4047: Please note that you can modify variables in it easily by using
4048: <code class="varname">FILES_SUBST</code> in the package's
4049: <code class="filename">Makefile</code>:</p>
1.1 dsieger 4050: <pre class="programlisting">
1.184 rillig 4051: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 4052: </pre>
1.266 martin 4053: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
1.184 rillig 4054: <code class="filename">INSTALL</code>. By default, substitution is
4055: performed for <code class="varname">PREFIX</code>,
4056: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4057: <code class="varname">VARBASE</code>, and a few others, type
4058: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4059: complete list.</p>
4060: </dd>
4061: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4062: <dd><p>This script is executed before and after any files are removed. It is
4063: this script's responsibility to clean up any additional messy details
4064: around the package's installation, since all pkg_delete knows is how to
4065: delete the files created in the original distribution.
1.259 leot 4066: 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>
4067: 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 4068: The same methods to replace variables can be used as for
4069: the <code class="filename">INSTALL</code> file.</p></dd>
4070: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4071: <dd>
4072: <p>This file is displayed after installation of the package.
1.198 leot 4073: While this was used often in the past, it has two
4074: problems: the display will be missed if many packages are
1.257 jkoshy 4075: installed at once, and the person installing the package
1.198 leot 4076: and the one using or configuring it may be different. It
4077: should therefore be used only in exceptional circumstances
4078: where lasting negative consequences would result from
4079: someone not reading it.</p>
4080: <p>MESSAGE should not be used for:</p>
4081: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4082: <li class="listitem"><p>exhortations to read the documentation</p></li>
4083: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
4084: <li class="listitem"><p>anything that should be explained in the
4085: installation/configuration documentation that should
4086: come with the package</p></li>
4087: </ul></div>
4088: <p>If the documentation provided by upstream needs
4089: enhancing, create e.g. files/README.pkgsrc and install it
4090: in the package's documentation directory.
4091: </p>
4092: <p>Note that MESSAGE is shown for all operating
4093: systems and all init systems. If a MESSAGE is necessary,
4094: it should be narrowed to only those operating systems and
4095: init systems to which it applies.</p>
4096: <p>Note that you can modify variables in it easily by using
1.184 rillig 4097: <code class="varname">MESSAGE_SUBST</code> in the package's
4098: <code class="filename">Makefile</code>:</p>
1.1 dsieger 4099: <pre class="programlisting">
1.184 rillig 4100: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 4101: </pre>
1.266 martin 4102: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.184 rillig 4103: <code class="filename">MESSAGE</code>. By default, substitution is
4104: performed for <code class="varname">PKGNAME</code>,
4105: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4106: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4107: <code class="varname">PKG_SYSCONFDIR</code>,
4108: <code class="varname">ROOT_GROUP</code>, and
4109: <code class="varname">ROOT_USER</code>.</p>
4110: <p>You can display a different or additional files by
4111: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4112: default is <code class="filename">MESSAGE</code>, if the file
4113: exists.</p>
4114: </dd>
4115: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4116: <dd>
4117: <p>This file is used by the alternatives framework.
4118: It creates, configures, and destroys generic wrappers used to
4119: run programs with similar interfaces.
4120: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4121: for more information.</p>
4122: <p>Each line of the file contains two filenames, first
4123: the wrapper and then the alternative provided by the package.
4124: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4125: </dd>
4126: </dl></div>
4127: </div>
4128: <div class="sect2">
4129: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 4130: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
1.184 rillig 4131: <div class="variablelist"><dl class="variablelist">
4132: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4133: <dd><p>This file contains arbitrary things that could
4134: also go into a <code class="filename">Makefile</code>, but its purpose is
4135: to be used by more than one package. This file should only be
4136: used when the packages that will use the file are known in
4137: advance. For other purposes it is often better to write a
4138: <code class="filename">*.mk</code> file and give it a good name that
4139: describes what it does.</p></dd>
4140: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4141: <dd><p>This file contains the dependency information
1.266 martin 4142: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
1.184 rillig 4143: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4144: <dd><p>This file contains workarounds for compiler bugs
4145: and similar things. It is included automatically by the pkgsrc
4146: infrastructure, so you don't need an extra
4147: <code class="literal">.include</code> line for
4148: it.</p></dd>
4149: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4150: <dd><p>This file contains the code for the
1.266 martin 4151: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.184 rillig 4152: selected by the user. If a package has only one or two options,
4153: it is equally acceptable to put the code directly into the
4154: <code class="filename">Makefile</code>.</p></dd>
4155: </dl></div>
4156: </div>
4157: <div class="sect2">
4158: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 4159: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
1.184 rillig 4160: <div class="variablelist"><dl class="variablelist">
4161: <dt><span class="term"><code class="filename">README*</code></span></dt>
4162: <dd><p>These files do not take place in the creation of
4163: a package and thus are purely informative to the package
4164: developer.</p></dd>
4165: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4166: <dd><p>This file contains things that need to be done
4167: to make the package even
4168: better.</p></dd>
4169: </dl></div>
4170: </div>
4171: </div>
4172: <div class="sect1">
4173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4174: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
1.184 rillig 4175: </h2></div></div></div>
4176: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4177: unpacked into the directory denoted by
4178: <code class="varname">WRKDIR</code>. It can be removed by running
4179: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4180: directory is also used to keep various timestamp files.
4181: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4182: The default is <code class="filename">${.CURDIR}/work</code>
4183: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4184: if <code class="varname">OBJMACHINE</code> is set.</p>
1.1 dsieger 4185: </div>
1.184 rillig 4186: <div class="sect1">
4187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4188: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
1.184 rillig 4189: </h2></div></div></div>
4190: <p>If you have any files that you wish to be placed in the package
4191: prior to configuration or building, you can place these files here
4192: and use a <span class="command"><strong>${CP}</strong></span> command in the
1.266 martin 4193: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
1.184 rillig 4194: <p>If you want to share files in this way with other
4195: packages, set the <code class="varname">FILESDIR</code> variable to point
4196: to the other package's <code class="filename">files</code> directory,
4197: e.g.:</p>
1.1 dsieger 4198: <pre class="programlisting">
1.184 rillig 4199: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 4200: </pre>
4201: </div>
4202: </div>
1.41 asau 4203: <div class="chapter">
1.1 dsieger 4204: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 4205: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.1 dsieger 4206: <div class="toc">
4207: <p><b>Table of Contents</b></p>
1.100 leot 4208: <dl class="toc">
1.184 rillig 4209: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4210: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4211: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4212: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4213: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4214: <dd><dl>
4215: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4216: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4217: </dl></dd>
4218: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4219: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4220: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4221: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4222: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4223: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4224: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4225: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4226: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4227: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4228: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4229: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.1 dsieger 4230: </dl>
4231: </div>
1.41 asau 4232: <div class="sect1">
1.1 dsieger 4233: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4234: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
1.184 rillig 4235: <p>This chapter gives a detailed description on how a package is
4236: built. Building a package is separated into different
4237: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4238: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4239: described in the following sections. Each phase is split into
4240: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4241: containing phase, prefixed by one of <code class="varname">pre-</code>,
4242: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4243: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4244: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4245: <p>Never override the regular targets (like
4246: <code class="varname">fetch</code>), if you have to, override the
4247: <code class="varname">do-*</code> ones instead.</p>
4248: <p>The basic steps for building a program are always the same. First
4249: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4250: the local system and then extracted. After any pkgsrc-specific patches
4251: to compile properly are applied, the software can be configured, then
4252: built (usually by compiling), and finally the generated binaries, etc.
4253: can be put into place on the system.</p>
4254: <p>To get more details about what is happening at each step,
4255: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4256: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4257: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4258: </div>
4259: <div class="sect1">
4260: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4261: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
1.184 rillig 4262: <p>Before outlining the process performed by the NetBSD package system in
4263: the next section, here's a brief discussion on where programs are
4264: installed, and which variables influence this.</p>
4265: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4266: where all files of the final program shall be installed. It is
4267: usually set to <code class="varname">LOCALBASE</code>
4268: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4269: for pkgs in the <code class="filename">cross</code> category. The value of
4270: <code class="varname">PREFIX</code> needs to be put
4271: into the various places in the program's source where paths to
1.266 martin 4272: 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>
1.184 rillig 4273: <p>When choosing which of these variables to use,
4274: follow the following rules:</p>
1.41 asau 4275: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 4276: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4277: where the current pkg will be installed. When referring to a
4278: pkg's own installation path, use
1.266 martin 4279: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
1.223 nia 4280: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.184 rillig 4281: are installed. If you need to construct a -I or -L argument
4282: to the compiler to find includes and libraries installed by
1.266 martin 4283: another pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.184 rillig 4284: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4285: installed all packages in <code class="filename">/usr/local</code>. As
4286: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4287: administrator, this variable is a misnomer.</p></li>
4288: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4289: distribution (from xsrc, etc.) is installed. When looking for
4290: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.266 martin 4291: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.184 rillig 4292: <li class="listitem"><p>X11-based packages using imake must set
4293: <code class="varname">USE_IMAKE</code> to be installed correctly under
4294: <code class="varname">LOCALBASE</code>.</p></li>
4295: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.259 leot 4296: 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 4297: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4298: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4299: </ul></div>
4300: </div>
4301: <div class="sect1">
4302: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4303: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
1.184 rillig 4304: <p>When building a package, various directories are used to store
4305: source files, temporary files, pkgsrc-internal files, and so on. These
4306: directories are explained here.</p>
4307: <p>Some of the directory variables contain relative pathnames. There
4308: are two common base directories for these relative directories:
4309: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4310: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4311: inside the package itself.</p>
4312: <div class="variablelist"><dl class="variablelist">
4313: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4314: <dd><p>This is an absolute pathname that points to the pkgsrc
4315: root directory. Generally, you don't need
4316: it.</p></dd>
4317: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4318: <dd><p>This is an absolute pathname that points to the
4319: current package.</p></dd>
4320: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.228 gutterid 4321: <dd>
4322: <p>This is a pathname relative to
4323: <code class="varname">PKGSRCDIR</code> that points to the current package.
4324: It is defined after including <code class="filename">bsd.prefs.mk</code>
4325: and can be used in makefile fragments that are used by several
4326: packages to distinguish between these packages. Other variables
4327: that would serve the same purpose are <code class="varname">PKGBASE</code>
4328: and <code class="varname">PKGNAME</code>, but these are only defined after
4329: including <code class="filename">bsd.pkg.mk</code>, which is too
4330: late.</p>
4331: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
4332: <code class="varname">PKGPATH</code> to tweak variables like
4333: <code class="varname">MAKE_JOBS</code> and
4334: <code class="varname">CFLAGS</code>.</p>
4335: </dd>
1.184 rillig 4336: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4337: <dd><p>This is an absolute pathname pointing to the directory
4338: where all work takes place. The distfiles are extracted to this
4339: directory. It also contains temporary directories and log files used by
4340: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4341: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4342: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4343: <dd><p>This is an absolute pathname pointing to the directory
4344: where the distfiles are extracted. It is usually a direct subdirectory
4345: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4346: that isn't hidden. This variable may be changed by a package
4347: <code class="filename">Makefile</code>.</p></dd>
4348: </dl></div>
4349: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4350: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4351: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4352: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4353: If users would like to have their pkgsrc trees behave in a
4354: read-only manner, then the value of
4355: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4356: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 4357: </div>
1.41 asau 4358: <div class="sect1">
1.1 dsieger 4359: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4360: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
1.184 rillig 4361: <p>You can run a particular phase by typing <span class="command"><strong>make
1.228 gutterid 4362: <em class="replaceable"><code>phase</code></em></strong></span>, where
4363: <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
4364: automatically run all phases that are required for this phase. The
4365: default phase is <code class="varname">build</code>, that is, when you run
4366: <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.184 rillig 4367: the package will be built, but not installed.</p>
1.1 dsieger 4368: </div>
1.41 asau 4369: <div class="sect1">
1.1 dsieger 4370: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4371: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.184 rillig 4372: <p>The first step in building a package is to fetch the
4373: distribution files (distfiles) from the sites that are providing
4374: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4375: phase.</p>
1.41 asau 4376: <div class="sect2">
1.1 dsieger 4377: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 4378: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
1.184 rillig 4379: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4380: defines all URLs from where the distfile, whose name is
4381: derived from the <code class="varname">DISTNAME</code> variable, is
4382: fetched. The more complicated cases are described
4383: below.</p>
4384: <p>The variable <code class="varname">DISTFILES</code> specifies
4385: the list of distfiles that have to be fetched. Its value
4386: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4387: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4388: so that most packages don't need to define it at all.
4389: <code class="varname">EXTRACT_SUFX</code> is
4390: <code class="literal">.tar.gz</code> by default, but can be changed
4391: freely. Note that if your package requires additional
4392: distfiles to the default one, you cannot just append the
4393: additional filenames using the <code class="literal">+=</code>
4394: operator, but you have write for example:</p>
4395: <pre class="programlisting">
4396: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4397: </pre>
4398: <p>Each distfile is fetched from a list of sites, usually
4399: <code class="varname">MASTER_SITES</code>. If the package has multiple
4400: <code class="varname">DISTFILES</code> or multiple
4401: <code class="varname">PATCHFILES</code> from different sites, you can
4402: set
4403: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4404: to the list of URLs where the file
4405: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4406: (including the suffix) can be found.</p>
4407: <pre class="programlisting">
4408: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4409: DISTFILES+= foo-file.tar.gz
4410: SITES.foo-file.tar.gz= \
4411: https://www.somewhere.com/somehow/ \
4412: https://www.somewhereelse.com/mirror/somehow/
4413: </pre>
4414: <p>When actually fetching the distfiles, each item from
4415: <code class="varname">MASTER_SITES</code> or
4416: <code class="varname">SITES.*</code> gets the name of each distfile
4417: appended to it, without an intermediate slash. Therefore,
4418: all site values have to end with a slash or other separator
4419: character. This allows for example to set
4420: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4421: that gets the name of the distfile as a parameter. In this
4422: case, the definition would look like:</p>
4423: <pre class="programlisting">
4424: MASTER_SITES= https://www.example.com/download.cgi?file=
4425: </pre>
4426: <p> The exception to this rule are URLs starting with a dash.
4427: In that case the URL is taken as is, fetched and the result
4428: stored under the name of the distfile. You can use this style
4429: for the case when the download URL style does not match the
4430: above common case. For example, if permanent download URL is a
4431: redirector to the real download URL, or the download file name
4432: is offered by an HTTP Content-Disposition header. In the
4433: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4434: created instead of the default
4435: <code class="filename">v1.0.0.tar.gz</code>.</p>
4436: <pre class="programlisting">
4437: DISTNAME= foo-1.0.0
4438: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4439: </pre>
4440: <p>There are some predefined values for
4441: <code class="varname">MASTER_SITES</code>, which can be used in
4442: packages. The names of the variables should speak for
4443: themselves.</p>
4444: <table border="0" summary="Simple list" class="simplelist">
4445: <tr>
4446: <td>MASTER_SITE_APACHE</td>
4447: <td>MASTER_SITE_BACKUP</td>
4448: </tr>
4449: <tr>
4450: <td>MASTER_SITE_CRATESIO</td>
4451: <td>MASTER_SITE_CYGWIN</td>
4452: </tr>
4453: <tr>
4454: <td>MASTER_SITE_DEBIAN</td>
4455: <td>MASTER_SITE_FREEBSD</td>
4456: </tr>
4457: <tr>
4458: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4459: <td>MASTER_SITE_GENTOO</td>
4460: </tr>
4461: <tr>
4462: <td>MASTER_SITE_GITHUB</td>
1.225 gutterid 4463: <td>MASTER_SITE_GITLAB</td>
4464: </tr>
4465: <tr>
1.184 rillig 4466: <td>MASTER_SITE_GNOME</td>
1.225 gutterid 4467: <td>MASTER_SITE_GNU</td>
1.184 rillig 4468: </tr>
4469: <tr>
1.260 wiz 4470: <td>MASTER_SITE_GNUPG</td>
1.184 rillig 4471: <td>MASTER_SITE_GNUSTEP</td>
4472: </tr>
4473: <tr>
1.260 wiz 4474: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.184 rillig 4475: <td>MASTER_SITE_IFARCHIVE</td>
4476: </tr>
4477: <tr>
1.260 wiz 4478: <td>MASTER_SITE_KDE</td>
1.184 rillig 4479: <td>MASTER_SITE_MOZILLA</td>
4480: </tr>
4481: <tr>
1.260 wiz 4482: <td>MASTER_SITE_MOZILLA_ALL</td>
1.184 rillig 4483: <td>MASTER_SITE_MYSQL</td>
4484: </tr>
4485: <tr>
1.260 wiz 4486: <td>MASTER_SITE_NETLIB</td>
1.184 rillig 4487: <td>MASTER_SITE_OPENBSD</td>
4488: </tr>
4489: <tr>
1.260 wiz 4490: <td>MASTER_SITE_OPENOFFICE</td>
1.184 rillig 4491: <td>MASTER_SITE_OSDN</td>
4492: </tr>
4493: <tr>
1.260 wiz 4494: <td>MASTER_SITE_PERL_CPAN</td>
1.184 rillig 4495: <td>MASTER_SITE_PGSQL</td>
4496: </tr>
4497: <tr>
1.260 wiz 4498: <td>MASTER_SITE_PYPI</td>
1.184 rillig 4499: <td>MASTER_SITE_RUBYGEMS</td>
4500: </tr>
4501: <tr>
1.260 wiz 4502: <td>MASTER_SITE_R_CRAN</td>
1.184 rillig 4503: <td>MASTER_SITE_SOURCEFORGE</td>
4504: </tr>
1.1 dsieger 4505: <tr>
1.260 wiz 4506: <td>MASTER_SITE_SUNSITE</td>
1.184 rillig 4507: <td>MASTER_SITE_SUSE</td>
1.1 dsieger 4508: </tr>
4509: <tr>
1.260 wiz 4510: <td>MASTER_SITE_TEX_CTAN</td>
1.184 rillig 4511: <td>MASTER_SITE_XCONTRIB</td>
1.1 dsieger 4512: </tr>
4513: <tr>
1.260 wiz 4514: <td>MASTER_SITE_XEMACS</td>
1.184 rillig 4515: <td>MASTER_SITE_XORG</td>
4516: </tr>
4517: </table>
4518: <p>Some explanations for the less self-explaining ones:
4519: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.254 wiz 4520: 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 4521: 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>
4522: <p>If you choose one of these predefined sites, you may
4523: want to specify a subdirectory of that site. Since these
4524: macros may expand to more than one actual site, you
4525: <span class="emphasis"><em>must</em></span> use the following construct to
4526: specify a subdirectory:</p>
1.1 dsieger 4527: <pre class="programlisting">
1.184 rillig 4528: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4529: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 4530: </pre>
1.184 rillig 4531: <p>Note the trailing slash after the subdirectory
4532: name.</p>
4533: </div>
4534: <div class="sect2">
4535: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 4536: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
1.184 rillig 4537: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4538: all the distfiles exist in a local directory
4539: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4540: user). If the files do not exist, they are fetched using
4541: commands of the form</p>
1.1 dsieger 4542: <pre class="programlisting">
1.184 rillig 4543: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4544: </pre>
4545: <p>where <code class="literal">${site}</code> varies through
4546: several possibilities in turn: first,
4547: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4548: sites specified in either <code class="varname">SITES.file</code> if
4549: defined, else <code class="varname">MASTER_SITES</code> or
4550: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4551: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4552: all except the first and the last can be optionally sorted
4553: by the user, via setting either
4554: <code class="varname">MASTER_SORT_RANDOM</code>, and
4555: <code class="varname">MASTER_SORT_AWK</code> or
4556: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4557: <p> The specific command and arguments used depend on the
4558: <code class="varname">FETCH_USING</code> parameter. The example above is
4559: for <code class="literal">FETCH_USING=custom</code>.</p>
4560: <p>The distfiles mirror run by the NetBSD Foundation uses the
4561: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4562: distfiles, if they are freely distributable. Packages setting
4563: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.266 martin 4564: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.184 rillig 4565: mirrored.</p>
1.1 dsieger 4566: </div>
4567: </div>
1.184 rillig 4568: <div class="sect1">
4569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4570: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.184 rillig 4571: <p>After the distfile(s) are fetched, their checksum is
4572: generated and compared with the checksums stored in the
4573: distinfo file. If the checksums don't match, the build is
4574: aborted. This is to ensure the same distfile is used for
4575: building, and that the distfile wasn't changed, e.g. by some
4576: malign force, deliberately changed distfiles on the master
4577: distribution site or network lossage.</p>
1.1 dsieger 4578: </div>
1.41 asau 4579: <div class="sect1">
1.1 dsieger 4580: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4581: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.184 rillig 4582: <p>When the distfiles are present on the local system, they
4583: need to be extracted, as they usually come in the form of some
4584: compressed archive format.</p>
4585: <p>By default, all <code class="varname">DISTFILES</code> are
4586: extracted. If you only need some of them, you can set the
4587: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4588: files.</p>
4589: <p>Extracting the files is usually done by a little
4590: program, <code class="filename">mk/extract/extract</code>, which
4591: already knows how to extract various archive formats, so most
4592: likely you will not need to change anything here. But if you
4593: need, the following variables may help you:</p>
1.41 asau 4594: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4595: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4596: <dd><p>Use these variables to override the default
4597: options for an extract command, which are defined in
4598: <code class="filename">mk/extract/extract</code>.</p></dd>
4599: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4600: <dd><p>This variable can be set to
4601: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4602: (which is the default value), <code class="literal">pax</code>, or an
4603: absolute pathname pointing to the command with which tar
4604: archives should be extracted. It is preferred to choose bsdtar over gtar
4605: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 4606: </dl></div>
1.184 rillig 4607: <p>If the <code class="filename">extract</code> program doesn't
4608: serve your needs, you can also override the
4609: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4610: command used for extracting the files. This command is
4611: executed in the <code class="filename">${WRKSRC}</code>
4612: directory. During execution of this command, the shell
4613: variable <code class="varname">extract_file</code> holds the absolute
4614: pathname of the file that is going to be extracted.</p>
4615: <p>And if that still does not suffice, you can override the
4616: <code class="varname">do-extract</code> target in the package
4617: Makefile.</p>
1.1 dsieger 4618: </div>
1.41 asau 4619: <div class="sect1">
1.1 dsieger 4620: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4621: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.184 rillig 4622: <p>After extraction, all the patches named by the
4623: <code class="varname">PATCHFILES</code>, those present in the patches
4624: subdirectory of the package as well as in
4625: $LOCALPATCHES/$PKGPATH (e.g.
4626: <code class="filename">/usr/local/patches/graphics/png</code>) are
4627: applied. Patchfiles ending in <code class="filename">.Z</code> or
4628: <code class="filename">.gz</code> are uncompressed before they are
4629: applied, files ending in <code class="filename">.orig</code> or
4630: <code class="filename">.rej</code> are ignored. Any special options to
1.259 leot 4631: <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.266 martin 4632: <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 4633: <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 4634: fail if the expected text from the patch context is not found in the
4635: patched file. If that happens, fix the patch file by comparing it
4636: with the actual text in the file to be patched.</p>
1.1 dsieger 4637: </div>
1.41 asau 4638: <div class="sect1">
1.1 dsieger 4639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4640: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4641: <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>.
1.184 rillig 4642: </p>
1.1 dsieger 4643: </div>
1.41 asau 4644: <div class="sect1">
1.1 dsieger 4645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4646: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.184 rillig 4647: <p>This phase creates wrapper programs for the compilers and
4648: linkers. The following variables can be used to tweak the
4649: wrappers.</p>
4650: <div class="variablelist"><dl class="variablelist">
4651: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4652: <dd><p>The command used to print progress
4653: messages. Does nothing by default. Set to
4654: <code class="literal">${ECHO}</code> to see the progress
4655: messages.</p></dd>
4656: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4657: <dd><p>This variable can be set to
4658: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4659: depending on whether you want additional information in the
4660: wrapper log file.</p></dd>
4661: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4662: <dd><p>This variable can be set to
4663: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4664: on whether the wrapper should use its cache, which will
4665: improve the speed. The default value is
4666: <code class="literal">yes</code>, but is forced to
4667: <code class="literal">no</code> if the platform does not support
4668: it.</p></dd>
4669: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4670: <dd><p>A list of reordering commands. A reordering
4671: command has the form
4672: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4673: It ensures that that
4674: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4675: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4676: </p></dd>
4677: </dl></div>
4678: </div>
4679: <div class="sect1">
4680: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4681: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.184 rillig 4682: <p>Most pieces of software need information on the header
4683: files, system calls, and library routines which are available
4684: on the platform they run on. The process of determining this
4685: information is known as configuration, and is usually
4686: automated. In most cases, a script is supplied with the
4687: distfiles, and its invocation results in generation of header
4688: files, Makefiles, etc.</p>
4689: <p>If the package contains a configure script, this can be
4690: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.266 martin 4691: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.184 rillig 4692: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.266 martin 4693: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
1.187 rillig 4694: <p>In the <code class="literal">do-configure</code> stage, a rough
4695: equivalent of the following command is run. See
4696: <code class="filename">mk/configure/configure.mk</code>, target
4697: <code class="literal">do-configure-script</code> for the exact
4698: definition.</p>
4699: <pre class="programlisting">
4700: .for dir in ${CONFIGURE_DIRS}
4701: cd ${WRKSRC} && cd ${dir} \
4702: && env ${CONFIGURE_ENV} \
4703: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 4704: .endfor
1.1 dsieger 4705: </pre>
1.184 rillig 4706: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.266 martin 4707: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.184 rillig 4708: <code class="varname">WRKSRC</code>. In each of these directories, the
4709: configure script is run with the environment
4710: <code class="varname">CONFIGURE_ENV</code> and arguments
4711: <code class="varname">CONFIGURE_ARGS</code>. The variables
4712: <code class="varname">CONFIGURE_ENV</code>,
4713: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.266 martin 4714: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.184 rillig 4715: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4716: package.</p>
4717: <p>If the program uses the Perl way of configuration (mainly Perl
4718: modules, but not only), i.e. a file called
4719: <code class="filename">Makefile.PL</code>, it should include
4720: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4721: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4722: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4723: <p>If the program uses an <code class="filename">Imakefile</code>
4724: for configuration, the appropriate steps can be invoked by
4725: setting <code class="varname">USE_IMAKE</code> to
1.266 martin 4726: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
1.184 rillig 4727: You can add variables to xmkmf's environment by adding them to the
4728: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4729: <p>If the program uses <code class="filename">cmake</code>
4730: for configuration, the appropriate steps can be invoked by
1.233 wiz 4731: including <code class="filename">../../devel/cmake/build.mk</code>.
1.184 rillig 4732: You can add variables to cmake's environment by adding them to the
4733: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
1.256 wiz 4734: by adding them to the <code class="varname">CMAKE_CONFIGURE_ARGS</code> variable.
1.233 wiz 4735: If you want to add arguments only for particular stages, you can use the
4736: <code class="varname">CMAKE_CONFIGURE_ARGS</code>,
4737: <code class="varname">CMAKE_BUILD_ARGS</code>, and
4738: <code class="varname">CMAKE_INSTALL_ARGS</code> variables.
4739: You can set the <code class="varname">CONFIGURE_DIRS</code> variable to the
4740: directories in which CMake should be run, relative to
1.266 martin 4741: <code class="varname">WRKSRC</code>. This defaults to to <span class="quote">“<span class="quote">.</span>”</span>.
1.233 wiz 4742: </p>
1.256 wiz 4743: <p>Any package using the now-deprecated
4744: <code class="varname">USE_CMAKE=yes</code> should be converted.
4745: Essentially, replace with an include of
4746: <code class="filename">../../devel/cmake/build.mk</code>, prune creation of a build
4747: directory and settings to use it, and check/fix settings that
4748: intend to perform the build in a subdirectory.
4749: </p>
1.184 rillig 4750: <p>If there is no configure step at all, set
1.266 martin 4751: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4752: </div>
1.41 asau 4753: <div class="sect1">
1.1 dsieger 4754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4755: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.187 rillig 4756: <p>For building a package, a rough equivalent of the following
4757: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4758: <code class="literal">do-build</code> for the exact definition.</p>
1.1 dsieger 4759: <pre class="programlisting">
1.187 rillig 4760: .for dir in ${BUILD_DIRS}
4761: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 4762: && env ${MAKE_ENV} \
1.187 rillig 4763: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 4764: -f ${MAKE_FILE} \
4765: ${BUILD_TARGET}
4766: .endfor
1.1 dsieger 4767: </pre>
1.184 rillig 4768: <p><code class="varname">BUILD_DIRS</code> (default:
1.266 martin 4769: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.184 rillig 4770: <code class="varname">WRKSRC</code>. In each of these directories,
4771: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4772: <code class="varname">MAKE_ENV</code> and arguments
4773: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4774: <code class="varname">MAKE_ENV</code>,
4775: <code class="varname">BUILD_MAKE_FLAGS</code>,
4776: <code class="varname">MAKE_FILE</code> and
4777: <code class="varname">BUILD_TARGET</code> may all be changed by the
4778: package.</p>
4779: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.266 martin 4780: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4781: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.184 rillig 4782: default value of <code class="varname">MAKE_FILE</code> is
1.266 martin 4783: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4784: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.184 rillig 4785: <p>If there is no build step at all, set
1.266 martin 4786: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4787: </div>
1.41 asau 4788: <div class="sect1">
1.1 dsieger 4789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4790: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.273 wiz 4791: <p>The test phase is for running a program's self
4792: tests. Dependencies that are only required for testing can be
4793: specified using <code class="varname">TEST_DEPENDS</code>.</p>
4794: <p>For packages using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for building, you can set
4795: <code class="varname">TEST_TARGET</code>. Often, the proper value is
4796: <span class="quote">“<span class="quote">check</span>”</span> or <span class="quote">“<span class="quote">test</span>”</span>. If more elaborate
4797: steps are needed, you can define a <code class="literal">do-test</code>
4798: target.</p>
4799: <p>To run the tests, call <span class="quote">“<span class="quote">make test</span>”</span>.</p>
4800: <p>When building a package, the tests are not run
4801: automatically, except if <code class="varname">PKGSRC_RUN_TEST</code> is set
4802: to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4803: </div>
1.41 asau 4804: <div class="sect1">
1.1 dsieger 4805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4806: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.184 rillig 4807: <p>Once the build stage has completed, the final step is to
4808: install the software in public directories, so users can
4809: access the programs and files.</p>
1.187 rillig 4810: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4811: of the following code is executed; see
4812: <code class="filename">mk/install/install.mk</code>, target
4813: <code class="literal">do-install</code> for the exact definition. Additionally,
4814: before and after this code, several consistency checks are run
4815: against the files-to-be-installed, see
4816: <code class="filename">mk/check/*.mk</code> for details.</p>
4817: <pre class="programlisting">
4818: .for dir in ${INSTALL_DIRS}
4819: cd ${WRKSRC} && cd ${dir} \
4820: && env ${INSTALL_ENV} ${MAKE_ENV} \
4821: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4822: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 4823: .endfor
1.1 dsieger 4824: </pre>
1.184 rillig 4825: <p>The variable's meanings are analogous to the ones in the
4826: <span class="emphasis"><em>build</em></span> phase.
4827: <code class="varname">INSTALL_DIRS</code> defaults to
4828: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.266 martin 4829: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4830: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.184 rillig 4831: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4832: defined.</p>
4833: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4834: variables are useful. They are all variations of the
1.259 leot 4835: <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 4836: permissions preset. <code class="varname">INSTALL</code> is the plain
4837: install command. The specialized variants, together with their
4838: intended use, are:</p>
4839: <div class="variablelist"><dl class="variablelist">
4840: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4841: <dd><p>directories that contain
4842: binaries</p></dd>
4843: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4844: <dd><p>directories that contain
4845: scripts</p></dd>
4846: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4847: <dd><p>directories that contain shared and static
4848: libraries</p></dd>
4849: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4850: <dd><p>directories that contain data
4851: files</p></dd>
4852: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4853: <dd><p>directories that contain man
4854: pages</p></dd>
4855: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4856: <dd><p>directories that contain data files for games
4857: </p></dd>
4858: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4859: <dd><p>binaries that can be stripped from debugging
4860: symbols</p></dd>
4861: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4862: <dd><p>binaries that cannot be
4863: stripped</p></dd>
4864: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4865: <dd><p>game
4866: binaries</p></dd>
4867: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4868: <dd><p>shared and static
4869: libraries</p></dd>
4870: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4871: <dd><p>data files</p></dd>
4872: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4873: <dd><p>data files for
4874: games</p></dd>
4875: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4876: <dd><p>man pages</p></dd>
4877: </dl></div>
4878: <p>Some other variables are:</p>
4879: <div class="variablelist"><dl class="variablelist">
4880: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.259 leot 4881: <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 4882: when installing binaries. Any debugging sections and symbols present in
4883: binaries will be preserved.
4884: </p></dd>
4885: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4886: <dd><p>A list of directories relative to
4887: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4888: beginning of the <span class="emphasis"><em>install</em></span> phase.
4889: The package is supposed to create all needed directories itself
4890: before installing files to it and list all other directories here.
4891: </p></dd>
4892: </dl></div>
4893: <p>In the rare cases that a package shouldn't install anything,
1.266 martin 4894: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.184 rillig 4895: mostly relevant for packages in the <code class="filename">regress</code>
4896: category.</p>
1.1 dsieger 4897: </div>
1.41 asau 4898: <div class="sect1">
1.1 dsieger 4899: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4900: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.184 rillig 4901: <p>Once the install stage has completed, a binary package of
4902: the installed files can be built. These binary packages can be
4903: used for quick installation without previous compilation, e.g. by
4904: the <span class="command"><strong>make bin-install</strong></span> or by using
4905: <span class="command"><strong>pkg_add</strong></span>.</p>
4906: <p>By default, the binary packages are created in
4907: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4908: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4909: one for each category in the <code class="varname">CATEGORIES</code>
4910: variable. <code class="varname">PACKAGES</code> defaults to
4911: <code class="filename">pkgsrc/packages</code>.</p>
1.1 dsieger 4912: </div>
1.41 asau 4913: <div class="sect1">
1.1 dsieger 4914: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4915: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
1.184 rillig 4916: <p>Once you're finished with a package, you can clean the work
4917: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4918: to clean the work directories of all dependencies too, use
4919: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 4920: </div>
1.41 asau 4921: <div class="sect1">
1.1 dsieger 4922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4923: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.41 asau 4924: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4925: <dt><span class="term">pre/post-*</span></dt>
4926: <dd>
4927: <p>For any of the main targets described in the previous
4928: section (configure, build, install, etc.), two auxiliary
4929: targets exist with
1.266 martin 4930: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.184 rillig 4931: prefix for the main target's name. These targets are
4932: invoked before and after the main target is called,
4933: allowing extra configuration or installation steps be
4934: performed from a package's Makefile, for example, which
4935: a program's configure script or install target
4936: omitted.</p>
4937: <p>About 5% of the pkgsrc packages define their custom
4938: post-extract target, another 5% define pre-configure, and 10%
4939: define post-install. The other pre/post-* targets are defined
4940: even less often.</p>
4941: </dd>
4942: <dt><span class="term">do-*</span></dt>
1.1 dsieger 4943: <dd>
1.184 rillig 4944: <p>Should one of the main targets do the wrong thing,
4945: and should there be no variable to fix this, you can
4946: redefine it with the do-* target. (Note that redefining
4947: the target itself instead of the do-* target is a bad
4948: idea, as the pre-* and post-* targets won't be called
4949: anymore, etc.)</p>
4950: <p>About 15% of the pkgsrc packages override the default
4951: do-install, the other do-* targets are overridden even less
4952: often.</p>
1.1 dsieger 4953: </dd>
1.184 rillig 4954: <dt><span class="term">reinstall</span></dt>
1.1 dsieger 4955: <dd>
1.184 rillig 4956: <p>If you did a <span class="command"><strong>make install</strong></span> and
4957: you noticed some file was not installed properly, you
4958: can repeat the installation with this target, which will
1.266 martin 4959: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.184 rillig 4960: <p>This is the default value of
4961: <code class="varname">DEPENDS_TARGET</code> except in the case of
4962: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4963: package</strong></span>, where the defaults are
1.266 martin 4964: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.184 rillig 4965: respectively.</p>
1.1 dsieger 4966: </dd>
1.184 rillig 4967: <dt><span class="term">deinstall</span></dt>
4968: <dd>
1.259 leot 4969: <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 4970: current directory, effectively de-installing the
4971: package. The following variables can be used to tune the
4972: behaviour:</p>
4973: <div class="variablelist"><dl class="variablelist">
4974: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.259 leot 4975: <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 4976: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4977: <dd><p>Remove all packages that require (depend on)
4978: the given package. This can be used to remove any
4979: packages that may have been pulled in by a given
4980: package, e.g. if <span class="command"><strong>make deinstall
4981: DEINSTALLDEPENDS=1</strong></span> is done in
4982: <code class="filename">pkgsrc/x11/kde</code>, this is
4983: likely to remove whole KDE. Works by adding
1.266 martin 4984: <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 4985: command line.</p></dd>
4986: </dl></div>
4987: </dd>
4988: <dt><span class="term">bin-install</span></dt>
4989: <dd><p>Install a binary package from local disk and via FTP
4990: from a list of sites (see the
4991: <code class="varname">BINPKG_SITES</code> variable), and do a
4992: <span class="command"><strong>make package</strong></span> if no binary package is
4993: available anywhere. The arguments given to
4994: <span class="command"><strong>pkg_add</strong></span> can be set via
4995: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4996: operation, etc.</p></dd>
4997: <dt><span class="term">install-clean</span></dt>
4998: <dd><p>This target removes the state files for the "install" and later
4999: phases so that the "install" target may be re-invoked. This can be
5000: used after editing the PLIST to install the package without
5001: rebuilding it.</p></dd>
5002: <dt><span class="term">build-clean</span></dt>
5003: <dd><p>This target removes the state files for the "build" and later
5004: phases so that the "build" target may be re-invoked.</p></dd>
5005: <dt><span class="term">update</span></dt>
5006: <dd>
5007: <p>This target causes the current package to be
5008: updated to the latest version. The package and all
5009: depending packages first get de-installed, then current
5010: versions of the corresponding packages get compiled and
5011: installed. This is similar to manually noting which
5012: packages are currently installed, then performing a
5013: series of <span class="command"><strong>make deinstall</strong></span> and
5014: <span class="command"><strong>make install</strong></span> (or whatever
5015: <code class="varname">UPDATE_TARGET</code> is set to) for these
5016: packages.</p>
1.266 martin 5017: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.184 rillig 5018: resume package updating in case a previous <span class="command"><strong>make
5019: update</strong></span> was interrupted for some reason.
5020: However, in this case, make sure you don't call
5021: <span class="command"><strong>make clean</strong></span> or otherwise remove the
5022: list of dependent packages in <code class="varname">WRKDIR</code>.
5023: Otherwise, you lose the ability to automatically update
5024: the current package along with the dependent packages
5025: you have installed.</p>
5026: <p>Resuming an interrupted <span class="command"><strong>make
5027: update</strong></span> will only work as long as the package
5028: tree remains unchanged. If the source code for one of
5029: the packages to be updated has been changed, resuming
5030: <span class="command"><strong>make update</strong></span> will most certainly
5031: fail!</p>
5032: <p>The following variables can be used either on the
5033: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
5034: alter the behaviour of <span class="command"><strong>make
5035: update</strong></span>:</p>
5036: <div class="variablelist"><dl class="variablelist">
5037: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
5038: <dd><p>Install target to recursively use for the
5039: updated package and the dependent packages.
5040: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.266 martin 5041: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.184 rillig 5042: <span class="command"><strong>make update</strong></span>. Other good
1.266 martin 5043: targets are <span class="quote">“<span class="quote">package</span>”</span> or
5044: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
5045: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.184 rillig 5046: endless loop!</p></dd>
5047: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
5048: <dd><p>Don't clean up after updating. Useful if
5049: you want to leave the work sources of the updated
5050: packages around for inspection or other purposes.
5051: Be sure you eventually clean up the source tree
1.266 martin 5052: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.184 rillig 5053: or you may run into troubles with old source code
5054: still lying around on your next
5055: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
5056: update</strong></span>.</p></dd>
5057: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
5058: <dd><p>Deinstall each package before installing
5059: (making <code class="varname">DEPENDS_TARGET</code>). This
5060: may be necessary if the
1.266 martin 5061: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.184 rillig 5062: called after interrupting a running <span class="command"><strong>make
5063: update</strong></span>.</p></dd>
5064: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
5065: <dd><p>Allows you to disable recursion and hardcode
5066: the target for packages. The default is
1.266 martin 5067: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.184 rillig 5068: facilitating a recursive update of prerequisite
5069: packages. Only set
5070: <code class="varname">DEPENDS_TARGET</code> if you want to
5071: disable recursive updates. Use
5072: <code class="varname">UPDATE_TARGET</code> instead to just
5073: set a specific target for each package to be
5074: installed during <span class="command"><strong>make update</strong></span>
5075: (see above).</p></dd>
5076: </dl></div>
5077: </dd>
5078: <dt><span class="term">clean-update</span></dt>
5079: <dd>
5080: <p>Clean the source tree for all packages that would
5081: get updated if <span class="command"><strong>make update</strong></span> was called
5082: from the current directory. This target should not be
5083: used if the current package (or any of its depending
5084: packages) have already been de-installed (e.g., after
5085: calling <span class="command"><strong>make update</strong></span>) or you may lose
5086: some packages you intended to update. As a rule of
5087: thumb: only use this target <span class="emphasis"><em>before</em></span>
5088: the first time you run <span class="command"><strong>make update</strong></span>
5089: and only if you have a dirty package tree (e.g., if you
5090: used <code class="varname">NOCLEAN</code>).</p>
5091: <p>If you are unsure about whether your tree is
5092: clean, you can either perform a <span class="command"><strong>make
5093: clean</strong></span> at the top of the tree, or use the
5094: following sequence of commands from the directory of the
5095: package you want to update (<span class="emphasis"><em>before</em></span>
5096: running <span class="command"><strong>make update</strong></span> for the first
5097: time, otherwise you lose all the packages you wanted to
5098: update!):</p>
5099: <pre class="screen">
5100: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
5101: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
5102: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
5103: </pre>
5104: <p>The following variables can be used either on the
5105: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
5106: <span class="command"><strong>make clean-update</strong></span>:</p>
5107: <div class="variablelist"><dl class="variablelist">
5108: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
5109: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
5110: reconstruct the list of directories to update for
5111: this package. Only use this if <span class="command"><strong>make
5112: update</strong></span> successfully installed all
5113: packages you wanted to update. Normally, this is
5114: done automatically on <span class="command"><strong>make
5115: update</strong></span>, but may have been suppressed by
5116: the <code class="varname">NOCLEAN</code> variable (see
5117: above).</p></dd>
5118: </dl></div>
5119: </dd>
5120: <dt><span class="term">replace</span></dt>
5121: <dd>
5122: <p>Update the installation of the current package. This
5123: differs from update in that it does not replace dependent
1.207 leot 5124: 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 5125: target to work.</p>
5126: <p><span class="emphasis"><em>Be careful when using this
5127: target!</em></span> There are no guarantees that dependent
5128: packages will still work, in particular they will most
5129: certainly break if you <span class="command"><strong>make replace</strong></span> a
5130: library package whose shared library major version changed
5131: between your installed version and the new one. For this
5132: reason, this target is not officially supported and only
5133: recommended for advanced users.</p>
5134: </dd>
5135: <dt><span class="term">info</span></dt>
1.259 leot 5136: <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 5137: package. You can use this to check which version of a
5138: package is installed.</p></dd>
5139: <dt><span class="term">index</span></dt>
5140: <dd>
5141: <p>This is a top-level command, i.e. it should be used in
5142: the <code class="filename">pkgsrc</code> directory. It creates a
5143: database of all packages in the local pkgsrc tree, including
5144: dependencies, comment, maintainer, and some other useful
5145: information. Individual entries are created by running
5146: <span class="command"><strong>make describe</strong></span> in the packages'
5147: directories. This index file is saved as
5148: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
5149: verbose format by running <span class="command"><strong>make
5150: print-index</strong></span>. You can search in it with
5151: <span class="command"><strong>make search
5152: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
5153: extract a list of all packages that depend on a particular
5154: one by running <span class="command"><strong>make show-deps
5155: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
5156: <p>Running this command takes a very long time, some
5157: hours even on fast machines!</p>
5158: </dd>
5159: <dt><span class="term">readme</span></dt>
5160: <dd>
5161: <p>This target generates a
1.199 nia 5162: <code class="filename">index.html</code> file, which can be
1.207 leot 5163: 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 5164: contain references to any packages which are in the
5165: <code class="varname">PACKAGES</code> directory on the local
5166: host. The generated files can be made to refer to URLs
5167: based on <code class="varname">FTP_PKG_URL_HOST</code> and
5168: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.199 nia 5169: wanted to generate <code class="filename">index.html</code>
1.184 rillig 5170: files which pointed to binary packages on the local
5171: machine, in the directory
5172: <code class="filename">/usr/packages</code>, set
5173: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
5174: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
5175: <code class="varname">${PACKAGES}</code> directory and its
5176: subdirectories will be searched for all the binary
5177: packages.</p>
5178: <p>The target can be run at the toplevel or in category
5179: directories, in which case it descends recursively.</p>
5180: </dd>
5181: <dt><span class="term">readme-all</span></dt>
5182: <dd><p>This is a top-level command, run it in
5183: <code class="filename">pkgsrc</code>. Use this target to create a
5184: file <code class="filename">README-all.html</code> which contains a
5185: list of all packages currently available in the NetBSD
5186: Packages Collection, together with the category they belong
5187: to and a short description. This file is compiled from the
1.199 nia 5188: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.184 rillig 5189: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
5190: readme</strong></span>.</p></dd>
5191: <dt><span class="term">cdrom-readme</span></dt>
5192: <dd><p>This is very much the same as the
1.266 martin 5193: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.184 rillig 5194: used when generating a pkgsrc tree to be written to a
5195: CD-ROM. This target also produces
1.199 nia 5196: <code class="filename">index.html</code> files, and can be made
1.184 rillig 5197: to refer to URLs based on
5198: <code class="varname">CDROM_PKG_URL_HOST</code> and
5199: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
5200: <dt><span class="term">show-distfiles</span></dt>
5201: <dd><p>This target shows which distfiles and patchfiles
5202: are needed to build the package
5203: (<code class="varname">ALLFILES</code>, which contains all
5204: <code class="varname">DISTFILES</code> and
5205: <code class="varname">PATCHFILES</code>, but not
5206: <code class="filename">patches/*</code>).</p></dd>
5207: <dt><span class="term">show-downlevel</span></dt>
5208: <dd><p>This target shows nothing if the package is not
5209: installed. If a version of this package is installed,
5210: but is not the version provided in this version of
5211: pkgsrc, then a warning message is displayed. This target
5212: can be used to show which of your installed packages are
5213: downlevel, and so the old versions can be deleted, and
5214: the current ones added.</p></dd>
5215: <dt><span class="term">show-pkgsrc-dir</span></dt>
5216: <dd><p>This target shows the directory in the pkgsrc
5217: hierarchy from which the package can be built and
5218: installed. This may not be the same directory as the one
5219: from which the package was installed. This target is
5220: intended to be used by people who may wish to upgrade
5221: many packages on a single host, and can be invoked from
5222: the top-level pkgsrc Makefile by using the
1.266 martin 5223: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.184 rillig 5224: <dt><span class="term">show-installed-depends</span></dt>
5225: <dd><p>This target shows which installed packages match
5226: the current package's <code class="varname">DEPENDS</code>. Useful
5227: if out of date dependencies are causing build
5228: problems.</p></dd>
5229: <dt><span class="term">print-build-depends-list</span></dt>
5230: <dd><p>This target shows the list of packages that the current package
5231: depends on for building.</p></dd>
5232: <dt><span class="term">print-run-depends-list</span></dt>
5233: <dd><p>This target shows the list of packages that the current package
5234: depends on for running.</p></dd>
5235: <dt><span class="term">check-shlibs</span></dt>
5236: <dd><p>After a package is installed, check all its
5237: binaries and (on ELF platforms) shared libraries to see
5238: if they find the shared libs they need. Run by default
5239: 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>
5240: <dt><span class="term">print-PLIST</span></dt>
5241: <dd>
1.266 martin 5242: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.184 rillig 5243: upgraded pkg, this prints out an attempt to generate a
5244: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5245: -newer work/.extract_done</strong></span>. An attempt is made
5246: to care for shared libs etc., but it is
5247: <span class="emphasis"><em>strongly</em></span> recommended to review the
5248: result before putting it into
5249: <code class="filename">PLIST</code>. On upgrades, it's useful to
5250: diff the output of this command against an already
5251: existing <code class="filename">PLIST</code> file.</p>
1.259 leot 5252: <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 5253: other methods that don't update file access times, be
5254: sure to add these files manually to your
1.266 martin 5255: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5256: -newer</span>”</span> command used by this target won't catch
1.184 rillig 5257: them!</p>
1.266 martin 5258: <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
1.184 rillig 5259: information on this target.</p>
5260: </dd>
1.255 wiz 5261: <dt><span class="term">rebuild</span></dt>
5262: <dd><p>If you did a <span class="command"><strong>make build</strong></span> and you
5263: noticed some further modifications of sources are needed,
5264: you can repeat the build with this target, which will ignore
1.266 martin 5265: the <span class="quote">“<span class="quote">already built</span>”</span> flag. This target is
1.255 wiz 5266: helpful while working with patches.</p></dd>
5267: <dt><span class="term">repackage</span></dt>
5268: <dd><p>If you did a <span class="command"><strong>make package</strong></span> and you
5269: noticed some further modifications of sources are needed,
5270: you can repeat the package with this target, which will ignore
1.266 martin 5271: the <span class="quote">“<span class="quote">already packaged</span>”</span> flag. This target is
1.255 wiz 5272: helpful while working with patches, PLIST* files etc.</p></dd>
5273: <dt><span class="term">retest</span></dt>
5274: <dd><p>If you did a <span class="command"><strong>make test</strong></span> and you
5275: noticed some further modifications of sources are needed,
5276: you can repeat the test with this target, which will ignore
1.266 martin 5277: the <span class="quote">“<span class="quote">already tested</span>”</span> flag. This target is
1.255 wiz 5278: helpful while working with patches.</p></dd>
1.184 rillig 5279: </dl></div>
5280: </div>
5281: </div>
5282: <div class="chapter">
5283: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 5284: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.184 rillig 5285: <div class="toc">
5286: <p><b>Table of Contents</b></p>
5287: <dl class="toc">
5288: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5289: <dd><dl>
1.219 nia 5290: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
5291: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
5292: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.184 rillig 5293: </dl></dd>
5294: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5295: <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>
5296: </dl>
5297: </div>
5298: <p>When you find a package that is not yet in pkgsrc, you
5299: most likely have a URL from where you can download the source
5300: code. Starting with this URL, creating a package involves only a
5301: few steps.</p>
5302: <div class="procedure"><ol class="procedure" type="1">
5303: <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
5304: enable the basic quality checks.</p></li>
5305: <li class="step">
1.207 leot 5306: <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 5307: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5308: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5309: <span class="command"><strong>mkpatches</strong></span>:</p>
5310: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5311: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5312: </li>
5313: <li class="step">
5314: <p>Choose one of the top-level directories as the category in
5315: which you want to place your package. You can also create a directory of
1.219 nia 5316: your own (maybe called <code class="filename">local</code>). Change into that
5317: category directory:</p>
5318: <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 5319: </li>
5320: <li class="step">
1.219 nia 5321: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
5322: argument the URL of the distribution file (in most cases a
5323: <code class="filename">.tar.gz</code> file). This will download the distribution
5324: file and create the necessary files of the package, based on what's in
5325: the distribution file:</p>
1.184 rillig 5326: <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>
5327: </li>
5328: <li class="step">
5329: <p>Examine the extracted files to determine the dependencies of
5330: your package. Ideally, this is mentioned in some
5331: <code class="filename">README</code> file, but things may differ. For each of
5332: these dependencies, look where it exists in pkgsrc, and if there is a
5333: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5334: line to your package <code class="filename">Makefile</code> which includes that
5335: file just before the last line. If the
5336: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5337: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5338: that the package's include files and libraries are provided.</p>
1.219 nia 5339: <p>If you just need binaries from a dependent package, add a
1.184 rillig 5340: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5341: version of the dependency and where it can be found in pkgsrc. This line
5342: should be placed in the third paragraph. If the dependency is only
5343: needed for building the package, but not when using it, use
5344: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5345: instead of <code class="varname">DEPENDS</code>.
5346: The difference between <code class="varname">TOOL_DEPENDS</code> and
5347: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5348: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.219 nia 5349: packages, i.e. packages for the platform where the package is built;
1.184 rillig 5350: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.219 nia 5351: packages, i.e. packages for the platform for which the package
5352: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
5353: specifies a dependency used only for testing the resulting package
5354: built, using the upstream project's included test suite, on the native
5355: platform.
1.184 rillig 5356: Your package may then look like this:</p>
5357: <pre class="programlisting">
5358: [...]
5359:
5360: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5361: DEPENDS+= screen-[0-9]*:../../misc/screen
5362: DEPENDS+= screen>=4.0:../../misc/screen
5363:
5364: [...]
5365:
5366: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5367: .include "../../devel/glib2/buildlink3.mk"
5368: .include "../../mk/bsd.pkg.mk"
5369: </pre>
5370: </li>
5371: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.266 martin 5372: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.184 rillig 5373: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5374: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5375: additional explanations.</p></li>
5376: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.266 martin 5377: 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
1.184 rillig 5378: over there, you can hopefully continue here.</p></li>
5379: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5380: directory from the extracted files. Besides these files, a lot of cache
1.219 nia 5381: files and other system information have been saved in the working
5382: directory, which may have become outdated after you edited the
1.184 rillig 5383: <code class="filename">Makefile</code>.</p></li>
5384: <li class="step">
5385: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.266 martin 5386: 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 5387: <p>If the extracted files from the package need to be fixed, run
5388: multiple rounds of these commands:</p>
5389: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.184 rillig 5390: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5391: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.219 nia 5392: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
5393: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.184 rillig 5394: </li>
5395: <li class="step"><p>When the package builds fine, the next step is to install
5396: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5397: everything works.</p></li>
5398: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5399: contains a list of the files that are installed by the package, is
5400: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5401: >PLIST</strong></span> to generate a probably correct list. Check
5402: the file using your preferred text editor to see if the list of
5403: files looks plausible.</p></li>
5404: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5405: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5406: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5407: had been registered in the database of installed files, but with an
5408: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5409: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5410: registered with the list of files from
5411: <code class="filename">PLIST</code>.</p></li>
5412: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5413: from above again in a single step, making sure that the PLIST is correct
5414: and the whole package is created as intended.</p></li>
1.219 nia 5415: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
5416: left to do.</p></li>
1.266 martin 5417: <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>
1.184 rillig 5418: </ol></div>
5419: <div class="sect1">
5420: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 5421: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
1.184 rillig 5422: <div class="sect2">
5423: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5424: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.184 rillig 5425: <p>Python modules and programs packages are easily created using a
5426: set of predefined variables.</p>
5427: <p>
5428: If some Python versions are not supported by the software, set the
5429: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5430: that are not supported, e.g.
5431: </p>
5432: <pre class="programlisting">
5433: PYTHON_VERSIONS_INCOMPATIBLE= 27
5434: </pre>
5435: <p>
1.249 gutterid 5436: If the packaged software is a Python module, include
1.255 wiz 5437: <code class="filename">../../lang/python/wheel.mk</code>. Note per PEP-518,
1.258 wiz 5438: 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
5439: other possible tools that projects can use. Thus inclusion of
1.255 wiz 5440: <code class="filename">wheel.mk</code> does not imply these defaults are
5441: defined as <code class="varname">TOOL_DEPENDS</code>. Whatever the project
5442: specifically requires as packaging tools must be defined in the
5443: package Makefile.
1.215 wiz 5444: </p>
1.248 wiz 5445: <p>The package directory should be called
1.266 martin 5446: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5447: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.184 rillig 5448: </p>
5449: <pre class="programlisting">
5450: DISTNAME= foopymodule-1.2.10
5451: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5452: </pre>
1.226 gutterid 5453: <p>
5454: For software in PyPi, the name should match what PyPi specifies for
5455: "pip install software".
5456: </p>
1.184 rillig 5457: <p>If it is an application, include
1.266 martin 5458: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
1.184 rillig 5459: In order to correctly set the path to the Python interpreter, use the
5460: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5461: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5462: For example:
5463: </p>
5464: <pre class="programlisting">
5465: REPLACE_PYTHON= *.py
5466: </pre>
5467: </div>
5468: <div class="sect2">
5469: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5470: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.184 rillig 5471: <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>
5472: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.207 leot 5473: 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 5474: Individual packages (and optionally their dependencies) may be created
5475: and updated. R packages generally follow the same form, and most of
5476: the relevant information needed is contained in a
5477: <code class="filename">DESCRIPTION</code> file as part of each R package on
5478: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5479: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5480: creates or updates a package in the canonical form. The resulting
5481: package should be reviewed for correctness.</p>
5482: </div>
5483: <div class="sect2">
5484: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5485: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.184 rillig 5486: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.207 leot 5487: <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 5488: <p>If the TeXlive package name is not known, it may be useful to
5489: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
1.266 martin 5490: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
1.184 rillig 5491: 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
5492: archive</a>.</p>
5493: <p>If the TeXlive package name is known, download the files from
5494: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5495: archive</a>. For package <code class="filename">foo</code>, you will need
5496: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5497: also have associated documentation packages, so download
5498: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5499: should be placed in the appropriate category directory, which is often
5500: but not always <code class="filename">print</code>. Then run the following
5501: command in the category directory.</p>
5502: <pre class="programlisting">
5503: texlive2pkg foo.tar.xz foo.doc.tar.xz
5504: </pre>
5505: <p>This will create two packages, <code class="filename">tex-foo</code> and
5506: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5507: are correct.</p>
5508: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5509: currently does not include version information in package filenames
5510: and changes their contents periodically when updates occur.
5511: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5512: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5513: main one and the corresponding documentation, upload the distfiles
5514: with the following command in each package directory.</p>
5515: <pre class="programlisting">
5516: make upload-distfiles
5517: </pre>
5518: </div>
5519: </div>
5520: <div class="sect1">
5521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 5522: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
1.184 rillig 5523: <div class="sect2">
5524: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5525: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.184 rillig 5526: <div class="sect3">
5527: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 5528: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
1.184 rillig 5529: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.266 martin 5530: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.184 rillig 5531: pkgsrc. As the description says it has to do with the web, the obvious
1.266 martin 5532: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.184 rillig 5533: <pre class="programlisting">
5534: <code class="prompt">$</code> mkdir www/nvu
5535: <code class="prompt">$</code> cd www/nvu
5536: </pre>
5537: <p>The web site says that the sources are available as a tar file, so
5538: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5539: <pre class="programlisting">
5540: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5541: </pre>
5542: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5543: below the <code class="varname">DISTNAME</code> line, as the package name should
1.266 martin 5544: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.184 rillig 5545: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5546: <code class="varname">COMMENT</code> fields. Then the package
5547: <code class="filename">Makefile</code> looked like that:</p>
5548: <pre class="programlisting">
5549: # $NetBSD $
5550: #
5551:
5552: DISTNAME= nvu-1.0-sources
5553: PKGNAME= nvu-1.0
5554: CATEGORIES= www
5555: MASTER_SITES= http://cvs.nvu.com/download/
5556: EXTRACT_SUFX= .tar.bz2
5557:
5558: MAINTAINER= rillig@NetBSD.org
5559: HOMEPAGE= http://cvs.nvu.com/
5560: COMMENT= Web Authoring System
5561:
5562: # url2pkg-marker (please do not remove this line.)
5563: .include "../../mk/bsd.pkg.mk"
5564: </pre>
5565: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5566: this is a workaround to prevent CVS expanding to the filename of the
5567: guide.</p>
5568: <p>Then, I quit the editor and watched pkgsrc downloading a large
5569: source archive:</p>
5570: <pre class="programlisting">
5571: url2pkg> Running "make makesum" ...
5572: => Required installed package digest>=20010302: digest-20060826 found
5573: => Fetching nvu-1.0-sources.tar.bz2
5574: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5575: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5576: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5577: url2pkg> Running "make extract" ...
5578: => Required installed package digest>=20010302: digest-20060826 found
5579: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5580: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5581: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5582: ===> Installing dependencies for nvu-1.0
5583: ===> Overriding tools for nvu-1.0
5584: ===> Extracting for nvu-1.0
5585: url2pkg> Adjusting the Makefile.
5586:
5587: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5588:
5589: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5590: </pre>
5591: </div>
5592: <div class="sect3">
5593: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 5594: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.184 rillig 5595: <p>Now that the package has been extracted, let's see what's inside
5596: it. The package has a <code class="filename">README.txt</code>, but that only
5597: says something about mozilla, so it's probably useless for seeing what
5598: dependencies this package has. But since there is a GNU configure script
5599: in the package, let's hope that it will complain about everything it
5600: needs.</p>
5601: <pre class="programlisting">
5602: <code class="prompt">$</code> bmake
5603: => Required installed package digest>=20010302: digest-20060826 found
5604: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5605: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5606: ===> Patching for nvu-1.0
5607: ===> Creating toolchain wrappers for nvu-1.0
5608: ===> Configuring for nvu-1.0
5609: [...]
5610: configure: error: Perl 5.004 or higher is required.
5611: [...]
5612: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5613: [...]
5614: </pre>
5615: <p>That worked quite well. So I opened the package Makefile in my
5616: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.266 martin 5617: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.184 rillig 5618: package have changed now, and since a perl wrapper is automatically
1.266 martin 5619: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.184 rillig 5620: from scratch.</p>
5621: <pre class="programlisting">
5622: <code class="prompt">$</code> bmake clean
5623: ===> Cleaning for nvu-1.0
5624: <code class="prompt">$</code> bmake
5625: [...]
5626: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5627: GNU Make. You will not be able to build Mozilla without GNU Make.
5628: [...]
5629: </pre>
1.266 martin 5630: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.184 rillig 5631: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5632: <pre class="programlisting">
5633: [...]
5634: checking for GTK - version >= 1.2.0... no
5635: *** Could not run GTK test program, checking why...
5636: [...]
5637: </pre>
5638: <p>Now to the other dependencies. The first question is: Where is the
5639: GTK package hidden in pkgsrc?</p>
5640: <pre class="programlisting">
5641: <code class="prompt">$</code> echo ../../*/gtk*
5642: [many packages ...]
5643: <code class="prompt">$</code> echo ../../*/gtk
5644: ../../x11/gtk
5645: <code class="prompt">$</code> echo ../../*/gtk2
5646: ../../x11/gtk2
5647: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5648: ../../x11/gtk2/buildlink3.mk
5649: </pre>
5650: <p>The first try was definitely too broad. The second one had exactly
5651: one result, which is very good. But there is one pitfall with GNOME
5652: packages. Before GNOME 2 had been released, there were already many
5653: GNOME 1 packages in pkgsrc. To be able to continue to use these
5654: packages, the GNOME 2 packages were imported as separate packages, and
1.266 martin 5655: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.184 rillig 5656: whether this was the case here, and indeed it was.</p>
5657: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5658: file, adding the dependency is very easy. I just inserted an
5659: <code class="literal">.include</code> line before the last line of the package
5660: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5661: <pre class="programlisting">
5662: [...]
5663: .include "../../x11/gtk2/buildlink3.mk"
5664: .include "../../mk/bsd.pkg.mk
5665: </pre>
5666: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5667: was:</p>
1.1 dsieger 5668: <pre class="programlisting">
1.184 rillig 5669: [...]
5670: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5671: checking for GTK - version >= 1.2.0... no
5672: *** Could not run GTK test program, checking why...
5673: *** The test program failed to compile or link. See the file config.log for the
5674: *** exact error that occured. This usually means GTK was incorrectly installed
5675: *** or that you have moved GTK since it was installed. In the latter case, you
5676: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5677: configure: error: Test for GTK failed.
5678: [...]
1.111 sevan 5679: </pre>
1.266 martin 5680: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5681: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.184 rillig 5682: told me that this package really wanted to have the GNOME 1 version of
5683: GTK. If the package had looked for GTK2, it would have looked for
5684: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5685: So I changed the <code class="literal">x11/gtk2</code> to
5686: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5687: and tried again.</p>
1.18 snj 5688: <pre class="programlisting">
1.184 rillig 5689: [...]
5690: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5691: In file included from xpidl.c:42:
5692: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5693: In file included from xpidl.c:42:
5694: xpidl.h:132: error: parse error before "IDL_ns"
5695: [...]
1.111 sevan 5696: </pre>
1.184 rillig 5697: <p>The package still does not find all of its dependencies. Now the
5698: question is: Which package provides the
5699: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.18 snj 5700: <pre class="programlisting">
1.184 rillig 5701: <code class="prompt">$</code> echo ../../*/*idl*
5702: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5703: <code class="prompt">$</code> echo ../../*/*IDL*
5704: ../../net/libIDL
1.111 sevan 5705: </pre>
1.184 rillig 5706: <p>Let's take the one from the second try. So I included the
5707: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5708: again. But the error didn't change. After digging through some of the
5709: code, I concluded that the build process of the package was broken and
5710: couldn't have ever worked, but since the Mozilla source tree is quite
5711: large, I didn't want to fix it. So I added the following to the package
5712: <code class="filename">Makefile</code> and tried again:</p>
1.86 wiz 5713: <pre class="programlisting">
1.184 rillig 5714: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5715: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.111 sevan 5716: </pre>
1.184 rillig 5717: <p>The latter line is needed because the package expects the library
5718: <code class="filename">libIDL.so</code>, but only
5719: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5720: wrapper to rewrite that on the fly.</p>
5721: <p>The next problem was related to a recent change of the FreeType
1.207 leot 5722: 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 5723: which patch files were relevant for this issue and copied them to the
5724: <code class="filename">patches</code> directory. Then I retried, fixed the
5725: patches so that they applied cleanly and retried again. This time,
5726: everything worked.</p>
1.86 wiz 5727: </div>
1.184 rillig 5728: <div class="sect3">
5729: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 5730: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 5731: <pre class="programlisting">
1.184 rillig 5732: <code class="prompt">$</code> bmake CHECK_FILES=no install
5733: [...]
5734: <code class="prompt">$</code> bmake print-PLIST >PLIST
5735: <code class="prompt">$</code> bmake deinstall
5736: <code class="prompt">$</code> bmake install
1.111 sevan 5737: </pre>
1.184 rillig 5738: </div>
5739: </div>
1.1 dsieger 5740: </div>
5741: </div>
1.41 asau 5742: <div class="chapter">
1.1 dsieger 5743: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 5744: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 5745: <div class="toc">
5746: <p><b>Table of Contents</b></p>
1.100 leot 5747: <dl class="toc">
1.184 rillig 5748: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5749: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5750: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5751: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5752: <dd><dl>
5753: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5754: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5755: <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>
5756: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 5757: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.1 dsieger 5758: </dl></dd>
5759: </dl>
5760: </div>
1.184 rillig 5761: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5762: each of which forms a well-defined part of the pkgsrc system. Using
1.259 leot 5763: 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 5764: like pkgsrc requires some discipline to keep the code correct and
5765: understandable.</p>
5766: <p>The basic ingredients for <code class="filename">Makefile</code>
5767: programming are variables and shell
5768: commands. Among these shell commands may even be more complex ones
1.259 leot 5769: 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 5770: as intended it is necessary to quote all variables correctly when they
5771: are used.</p>
5772: <p>This chapter describes some patterns that appear quite often in
5773: <code class="filename">Makefile</code>s, including the pitfalls that come along
5774: with them.</p>
1.41 asau 5775: <div class="sect1">
1.1 dsieger 5776: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 5777: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
1.184 rillig 5778: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5779: <p>When you are creating a file as a
5780: target of a rule, always write the data to a temporary file first
5781: and finally rename that file. Otherwise there might occur an error
5782: in the middle of generating the file, and when the user runs
1.259 leot 5783: <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 5784: regenerated properly. Example:</p>
1.1 dsieger 5785: <pre class="programlisting">
1.184 rillig 5786: wrong:
5787: @echo "line 1" > ${.TARGET}
5788: @echo "line 2" >> ${.TARGET}
5789: @false
5790:
5791: correct:
5792: @echo "line 1" > ${.TARGET}.tmp
5793: @echo "line 2" >> ${.TARGET}.tmp
5794: @false
5795: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 5796: </pre>
1.184 rillig 5797: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5798: <code class="filename">wrong</code> will exist, although there was an error
5799: message in the first run. On the other hand, running <span class="command"><strong>make
5800: correct</strong></span> gives an error message twice, as expected.</p>
1.259 leot 5801: <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 5802: <code class="literal">${.TARGET}</code> in case of error, but this only
5803: happens when it is interrupted, for example by pressing
5804: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.259 leot 5805: 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 5806: </li></ul></div>
5807: </div>
5808: <div class="sect1">
5809: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 5810: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.184 rillig 5811: <p><code class="filename">Makefile</code> variables contain strings that
5812: can be processed using the five operators <code class="code">=</code>,
5813: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.259 leot 5814: <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 5815: page.</p>
5816: <p>When a variable's value is parsed from a
5817: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5818: the backslash character <code class="code">\</code> are handled specially. If a
5819: backslash is the last character in a line, that backslash is removed
5820: from the line and the line continues with the next line of the file.</p>
5821: <p>The <code class="code">#</code> character starts a comment that reaches
5822: until the end of the line. To get an actual <code class="code">#</code> character,
5823: such as in a URL, write <code class="code">\#</code> instead.</p>
5824: <p>The evaluation of variables either happens immediately or lazy.
5825: It happens immediately when the variable occurs on the right-hand
5826: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5827: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5828: In the other cases, it is evaluated lazily.</p>
5829: <p>Some of the modifiers split the string into words and then
5830: operate on the words, others operate on the string as a whole. When a
5831: string is split into words, double quotes and single quotes are
1.259 leot 5832: 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 5833: <div class="sect2">
5834: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5835: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
1.184 rillig 5836: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5837: <li class="listitem"><p>All variable names starting with an underscore
5838: are reserved for use by the pkgsrc infrastructure. They shall
5839: not be used by packages.</p></li>
5840: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5841: lowercase variable names for the iteration
5842: variables.</p></li>
5843: <li class="listitem"><p>All list variables should have a plural name,
5844: such as <code class="varname">PKG_OPTIONS</code> or
5845: <code class="varname">DISTFILES</code>.</p></li>
5846: </ul></div>
5847: </div>
5848: </div>
5849: <div class="sect1">
5850: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 5851: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
1.184 rillig 5852: <div class="sect2">
5853: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5854: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
1.184 rillig 5855: <p>When adding a string that possibly contains whitespace or quotes to
5856: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5857: modifier.</p>
5858: <p>When adding another list to a list (example 2), it must not be
5859: quoted, since its elements are already quoted.</p>
1.1 dsieger 5860: <pre class="programlisting">
1.184 rillig 5861: STRING= foo * bar `date`
5862: LIST= # empty
5863: ANOTHER_LIST= a=b c=d
5864:
5865: LIST+= ${STRING:Q} # 1
5866: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 5867: </pre>
1.184 rillig 5868: </div>
5869: <div class="sect2">
5870: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5871: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.184 rillig 5872: <p>Echoing a string containing special characters needs special
5873: work.</p>
1.1 dsieger 5874: <pre class="programlisting">
1.184 rillig 5875: STRING= foo bar < > * `date` $$HOME ' "
5876: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5877:
5878: all:
5879: echo ${STRING} # 1
5880: echo ${STRING:Q} # 2
5881: printf '%s\n' ${STRING:Q}'' # 3
5882: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 5883: </pre>
1.184 rillig 5884: <p>Example 1 leads to a syntax error in the shell, as the characters
5885: are just copied.</p>
5886: <p>Example 2 quotes the string so that the shell interprets it
5887: correctly. But the echo command may additionally interpret strings with a
5888: leading dash or those containing backslashes.</p>
1.259 leot 5889: <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 5890: interprets the format string, but not the next argument. The trailing
5891: single quotes handle the case when the string is empty. In that case, the
5892: :Q modifier would result in an empty string too, which would then be
1.259 leot 5893: 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 5894: but other programs may care.</p>
5895: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5896: need to be quoted because the quoting has already been done
5897: when adding elements to the list.</p>
1.1 dsieger 5898: </div>
1.41 asau 5899: <div class="sect2">
1.1 dsieger 5900: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5901: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
1.184 rillig 5902: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5903: GNU-style configure script (especially those that call other configure
5904: scripts), it must not have leading or trailing whitespace, since
5905: otherwise the configure script gets confused. To trim leading and
5906: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5907: following example:</p>
1.1 dsieger 5908: <pre class="programlisting">
1.184 rillig 5909: CPPFLAGS= # empty
5910: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5911: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 5912:
1.184 rillig 5913: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 5914:
1.184 rillig 5915: all:
5916: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5917: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5918: </pre>
5919: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5920: trailing whitespace because the <code class="code">+=</code> operator always adds a
5921: space.</p>
5922: </div>
5923: <div class="sect2">
5924: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5925: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
1.184 rillig 5926: <p>When a possibly empty variable is used in a shell program, it may
5927: lead to a syntax error.</p>
5928: <pre class="programlisting">
5929: EGFILES= # empty
1.1 dsieger 5930:
1.184 rillig 5931: install-examples: # produces a syntax error in the shell
5932: for egfile in ${EGFILES}; do \
5933: echo "Installing $$egfile"; \
5934: done
5935: </pre>
5936: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.259 leot 5937: <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 5938: To fix this syntax error, use one of the snippets below.</p>
5939: <pre class="programlisting">
1.229 gutterid 5940: EGFILES= # empty
1.1 dsieger 5941:
1.184 rillig 5942: install-examples:
5943: for egfile in ${EGFILES} ""; do \
5944: [ -n "$$egfile" ] || continue; \
5945: echo "Installing $$egfile"; \
5946: done
5947: </pre>
5948: <p>In this case, an empty string is appended to the iteration list (to
5949: prevent the syntax error) and filtered out later.</p>
5950: <pre class="programlisting">
5951: EGFILES= # empty
1.1 dsieger 5952:
1.184 rillig 5953: install-examples:
5954: .for egfile in ${EGFILES}
5955: echo "Installing ${egfile}"
5956: .endfor
1.1 dsieger 5957: </pre>
1.184 rillig 5958: <p>If one of the filenames contains special characters, it should be
5959: enclosed in single or double quotes.</p>
5960: <p>To have a shell command test whether a make variable is empty, use
5961: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5962: </div>
1.229 gutterid 5963: <div class="sect2">
5964: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5965: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
1.229 gutterid 5966: <p>When a variable can have the values <code class="literal">yes</code> or
5967: <code class="literal">no</code>, use the following pattern to test the variable:</p>
5968: <pre class="programlisting">
5969: .if ${VAR:U:tl} == "yes"
5970: # do something
5971: .endif
5972: </pre>
5973: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
5974: can be undefined. If the variable is guaranteed to be defined, the
5975: <code class="literal">:U</code> can be omitted.</p>
5976: <p>The <code class="literal">:tl</code> modifier converts the variable value to
5977: lowercase, allowing for the values <code class="literal">yes</code>,
5978: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
5979: </div>
1.184 rillig 5980: </div>
5981: </div>
5982: <div class="chapter">
5983: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 5984: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.184 rillig 5985: <div class="toc">
5986: <p><b>Table of Contents</b></p>
5987: <dl class="toc">
5988: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5989: <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>
5990: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5991: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5992: </dl>
1.1 dsieger 5993: </div>
1.184 rillig 5994: <p>Many packages have the ability to be built to support different
5995: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5996: in pkgsrc that provides generic handling of those options that
5997: determine different ways in which the packages can be built. It's
5998: possible for the user to specify exactly which sets of options will be
5999: built into a package or to allow a set of global default options
6000: apply.</p>
6001: <p>There are two broad classes of behaviors that one might want to
6002: control via options. One is whether some particular feature is
6003: enabled in a program that will be built anyway, often by including or
6004: not including a dependency on some other package. The other is
6005: whether or not an additional program will be built as part of the
6006: package. Generally, it is better to make a split package for such
6007: additional programs instead of using options, because it enables
6008: binary packages to be built which can then be added separately. For
6009: example, the foo package might have minimal dependencies (those
6010: packages without which foo doesn't make sense), and then the foo-gfoo
6011: package might include the GTK frontend program gfoo. This is better
6012: than including a gtk option to foo that adds gfoo, because either that
6013: option is default, in which case binary users can't get foo without
6014: gfoo, or not default, in which case they can't get gfoo. With split
6015: packages, they can install foo without having GTK, and later decide to
6016: install gfoo (pulling in GTK at that time). This is an advantage to
6017: source users too, avoiding the need for rebuilds.</p>
6018: <p>Plugins with widely varying dependencies should usually be split
6019: instead of options.</p>
6020: <p>It is often more work to maintain split packages, especially if
6021: the upstream package does not support this. The decision of split
6022: vs. option should be made based on the likelihood that users will want
6023: or object to the various pieces, the size of the dependencies that are
6024: included, and the amount of work.</p>
6025: <p>A further consideration is licensing. Non-free parts, or parts
6026: that depend on non-free dependencies (especially plugins) should
6027: almost always be split if feasible.</p>
6028: <div class="sect1">
6029: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6030: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.184 rillig 6031: <p>Global default options are listed in
6032: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6033: that should be built into every package if that option is supported.
6034: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 6035: </div>
1.41 asau 6036: <div class="sect1">
1.1 dsieger 6037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6038: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.184 rillig 6039: </h2></div></div></div>
6040: <p>The following example shows how
6041: <code class="filename">bsd.options.mk</code> should be used
6042: by the hypothetical ``wibble'' package, either in the package
6043: <code class="filename">Makefile</code>, or in a file,
6044: e.g. <code class="filename">options.mk</code>, that is included by the
6045: main package <code class="filename">Makefile</code>.</p>
1.1 dsieger 6046: <pre class="programlisting">
1.184 rillig 6047: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6048: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6049: PKG_OPTIONS_OPTIONAL_GROUPS= database
6050: PKG_OPTIONS_GROUP.database= mysql pgsql
6051: PKG_SUGGESTED_OPTIONS= wibble-foo
6052: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6053: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6054:
6055: .include "../../mk/bsd.prefs.mk"
6056:
6057: # this package was previously named wibble2
6058: .if defined(PKG_OPTIONS.wibble2)
6059: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6060: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6061: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6062: .endif
6063:
6064: .include "../../mk/bsd.options.mk"
6065:
6066: # Package-specific option-handling
1.1 dsieger 6067:
1.184 rillig 6068: ###
6069: ### FOO support
6070: ###
6071: .if !empty(PKG_OPTIONS:Mwibble-foo)
6072: CONFIGURE_ARGS+= --enable-foo
6073: .endif
1.1 dsieger 6074:
1.184 rillig 6075: ###
6076: ### LDAP support
6077: ###
6078: .if !empty(PKG_OPTIONS:Mldap)
6079: . include "../../databases/openldap-client/buildlink3.mk"
6080: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6081: .endif
1.1 dsieger 6082:
1.184 rillig 6083: ###
6084: ### database support
6085: ###
6086: .if !empty(PKG_OPTIONS:Mmysql)
6087: . include "../../mk/mysql.buildlink3.mk"
6088: .endif
6089: .if !empty(PKG_OPTIONS:Mpgsql)
6090: . include "../../mk/pgsql.buildlink3.mk"
6091: .endif
6092: </pre>
6093: <p>The first section contains the information about which build
6094: options are supported by the package, and any default options settings
6095: if needed.</p>
6096: <div class="orderedlist"><ol class="orderedlist" type="1">
6097: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.259 leot 6098: <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 6099: options. It should be set to
6100: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6101: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6102: at the point where the options are processed.</p></li>
6103: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6104: build options supported by the package.</p></li>
6105: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6106: list of names of groups of mutually exclusive options. The options in
6107: each group are listed in
6108: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6109: The most specific setting of any option from the group takes
6110: precedence over all other options in the group. Options from the
6111: groups will be automatically added to
6112: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6113: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6114: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6115: packages will fail if no option from the group is
6116: selected.</p></li>
6117: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6118: of names of sets of options. At least one option from each set must
6119: be selected. The options in each set are listed in
6120: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6121: Options from the sets will be automatically added to
6122: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6123: fail if no option from the set is selected.</p></li>
6124: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6125: build options which are enabled by default.</p></li>
6126: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6127: of
1.266 martin 6128: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.184 rillig 6129: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
6130: their option counterparts. Pairs should be added with
1.266 martin 6131: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.184 rillig 6132: warning will be issued if the user uses a legacy
6133: variable.</p></li>
6134: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6135: of
1.266 martin 6136: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
1.184 rillig 6137: pairs that map options that have been renamed to their new
1.266 martin 6138: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.184 rillig 6139: the listing of global legacy options. A warning will be issued if
6140: the user uses a legacy option.</p></li>
6141: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6142: options implied by deprecated variables used. This can be used for
6143: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6144: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6145: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6146: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6147: a list of warnings about deprecated variables or options used, and
6148: what to use instead.</p></li>
6149: </ol></div>
6150: <p>A package should never modify
6151: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6152: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6153: To suggest a default set of options, use
6154: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6155: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6156: including <code class="filename">bsd.options.mk</code>. If none of
6157: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6158: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6159: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6160: happen with platform-specific options if none of them is supported on
6161: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6162: empty list and the package is otherwise treated as not using the
6163: options framework.</p>
6164: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6165: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6166: build options, properly filtered to remove unsupported and duplicate
6167: options.</p>
6168: <p>The remaining sections contain the logic that is specific to
6169: each option. The correct way to check for an option is to check
6170: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6171: <pre class="programlisting">
6172: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.1 dsieger 6173: </pre>
6174: </div>
1.184 rillig 6175: <div class="sect1">
6176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6177: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.184 rillig 6178: <p>Options that enable similar features in different packages (like
6179: optional support for a library) should use a common name in all
6180: packages that support it (like the name of the library). If another
6181: package already has an option with the same meaning, use the same
6182: name.</p>
6183: <p>Options that enable features specific to one package, where it's
6184: unlikely that another (unrelated) package has the same (or a similar)
6185: optional feature, should use a name prefixed with
6186: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6187: <p>If a group of related packages share an optional feature
6188: specific to that group, prefix it with the name of the
1.266 martin 6189: <span class="quote">“<span class="quote">main</span>”</span> package
1.184 rillig 6190: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6191: <p>For new options, add a line to
6192: <code class="filename">mk/defaults/options.description</code>. Lines have two
6193: fields, separated by tab. The first field is the option name, the
6194: second its description. The description should be a whole sentence
6195: (starting with an uppercase letter and ending with a period) that
1.266 martin 6196: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6197: support.</span>”</span> The file is sorted by option names.</p>
1.184 rillig 6198: </div>
6199: <div class="sect1">
6200: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6201: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.184 rillig 6202: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6203: different dependencies based on the options with which the package was
6204: built. For querying these options, the file
6205: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6206: typical example looks like this:</p>
1.1 dsieger 6207: <pre class="programlisting">
1.184 rillig 6208: pkgbase := libpurple
6209: .include "../../mk/pkg-build-options.mk"
6210:
6211: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6212: ...
6213: .endif
1.117 sevan 6214: </pre>
1.184 rillig 6215: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6216: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6217: options of the libpurple package, which can then be queried like
6218: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6219: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6220: details.</p>
1.1 dsieger 6221: </div>
6222: </div>
1.41 asau 6223: <div class="chapter">
1.1 dsieger 6224: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 6225: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6226: <div class="toc">
6227: <p><b>Table of Contents</b></p>
1.100 leot 6228: <dl class="toc">
1.184 rillig 6229: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
6230: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
6231: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6232: </dl>
6233: </div>
1.184 rillig 6234: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6235: by pkgsrc and also for individual packages to define what commands
6236: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6237: or for later run-time of an installed packaged (such as
6238: <code class="varname">DEPENDS</code>).
6239: If the native system provides an adequate tool, then in many cases, a pkgsrc
6240: package will not be used.</p>
6241: <p>When building a package, the replacement tools are
6242: made available in a directory (as symlinks or wrapper scripts)
6243: that is early in the executable search path. Just like the buildlink
6244: system, this helps with consistent builds.</p>
6245: <p>A tool may be needed to help build a specific package. For example,
6246: perl, GNU make (gmake) or yacc may be needed.</p>
6247: <p>Also a tool may be needed, for example, because the native system's supplied
6248: tool may be inefficient for building a package with pkgsrc.
6249: For example, a package may need GNU awk, bison (instead of
6250: yacc) or a better sed.</p>
6251: <p>The tools used by a package can be listed by running
6252: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6253: <div class="sect1">
1.1 dsieger 6254: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6255: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.184 rillig 6256: <p>The default set of tools used by pkgsrc is defined in
6257: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6258: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6259: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6260: These can be seen by running:
6261: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6262: <p>If a package needs a specific program to build
6263: then the <code class="varname">USE_TOOLS</code> variable can be used
6264: to define the tools needed.</p>
1.1 dsieger 6265: </div>
1.184 rillig 6266: <div class="sect1">
6267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6268: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.184 rillig 6269: <p>In the following examples, the :run means that it is needed at
6270: run-time (and becomes a DEPENDS).
6271: The default is a build dependency which can be set with
6272: :build. (So in this example, it is the same as gmake:build
6273: and pkg-config:build.)</p>
1.1 dsieger 6274: <pre class="programlisting">
1.184 rillig 6275: USE_TOOLS+= gmake perl:run pkg-config
1.1 dsieger 6276: </pre>
1.184 rillig 6277: <p>When using the tools framework, a
6278: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6279: which contains the full path to the appropriate tool. For example,
1.266 martin 6280: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.184 rillig 6281: on Linux systems.</p>
6282: <p>If you always need a pkgsrc version of the
6283: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6284: </p>
1.1 dsieger 6285: </div>
1.184 rillig 6286: <div class="sect1">
6287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6288: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.184 rillig 6289: <p>When improving or porting pkgsrc to a new platform, have a look
6290: at (or create) the corresponding platform specific make file fragment under
6291: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6292: the name of the common tools. For example:</p>
1.1 dsieger 6293: <pre class="programlisting">
1.184 rillig 6294: .if exists(/usr/bin/bzcat)
6295: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6296: .elif exists(/usr/bin/bzip2)
6297: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6298: .endif
6299:
6300: TOOLS_PLATFORM.true?= true # shell builtin
1.1 dsieger 6301: </pre>
6302: </div>
6303: </div>
1.184 rillig 6304: <div class="chapter">
6305: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 6306: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
1.184 rillig 6307: <div class="toc">
6308: <p><b>Table of Contents</b></p>
6309: <dl class="toc">
6310: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6311: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6312: <dd><dl>
6313: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6314: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6315: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6316: and
6317: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6318: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6319: </dl></dd>
6320: <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 6321: <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 6322: </dl>
1.1 dsieger 6323: </div>
1.184 rillig 6324: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6325: are seen by a package's configure and build processes. This is implemented
6326: in a two step process:</p>
6327: <div class="orderedlist"><ol class="orderedlist" type="1">
6328: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6329: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6330: of <code class="varname">WRKDIR</code>.</p></li>
6331: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6332: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6333: <code class="option">-L${LOCALBASE}/lib</code> into references to
6334: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6335: native compiler on some operating systems look like GCC, so that
6336: packages that expect GCC won't require modifications to build with
6337: those native compilers.</p></li>
6338: </ol></div>
6339: <p>This normalizes the environment in which a package is built so that the
6340: package may be built consistently despite what other software may be
6341: installed. Please note that the normal system header and library paths,
6342: e.g. <code class="filename">/usr/include</code>,
6343: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6344: designed to insulate the package build from non-system-supplied
6345: software.</p>
1.41 asau 6346: <div class="sect1">
1.1 dsieger 6347: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6348: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
1.184 rillig 6349: <p>The process of converting packages to use the buildlink3
1.266 martin 6350: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.184 rillig 6351: The things to keep in mind are:</p>
1.23 wiz 6352: <div class="orderedlist"><ol class="orderedlist" type="1">
1.184 rillig 6353: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6354: instead of the actual toolchain. Some packages are tricky,
6355: and the only way to know for sure is the check
6356: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6357: wrappers are being invoked.</p></li>
6358: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6359: the package Makefile, e.g. Java VMs, standalone shells,
6360: etc., because the code to symlink files into
6361: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.266 martin 6362: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.184 rillig 6363: </p></li>
6364: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6365: <code class="filename">buildlink3.mk</code> files that you list in a
6366: package's Makefile are added as dependencies for that package.
6367: </p></li>
6368: </ol></div>
6369: <p>If a dependency on a particular package is required for its libraries and
6370: headers, then we replace:</p>
6371: <pre class="programlisting">
6372: DEPENDS+= foo>=1.1.0:../../category/foo
6373: </pre>
6374: <p>with</p>
6375: <pre class="programlisting">
6376: .include "../../category/foo/buildlink3.mk"
6377: </pre>
6378: <p>The buildlink3.mk files usually define the required dependencies.
6379: If you need a newer version of the dependency when using buildlink3.mk
6380: files, then you can define it in your Makefile; for example:</p>
1.1 dsieger 6381: <pre class="programlisting">
1.184 rillig 6382: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6383: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 6384: </pre>
1.184 rillig 6385: <p>There are several <code class="filename">buildlink3.mk</code>
6386: files in <code class="filename">pkgsrc/mk</code>
6387: that handle special package issues:</p>
6388: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6389: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6390: the native or a pkgsrc Berkeley DB implementation based on
6391: the values of <code class="varname">BDB_ACCEPTED</code> and
6392: <code class="varname">BDB_DEFAULT</code>.</p></li>
6393: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6394: comes with neither Curses nor NCurses, this will take care
1.207 leot 6395: 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 6396: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6397: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6398: adding a dependency on Heimdal or MIT-krb5 for packages that
6399: require a Kerberos 5 implementation.</p></li>
6400: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6401: system-provided Motif installation or adds a dependency on
1.270 wiz 6402: <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
6403: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span> or
6404: <span class="quote">“<span class="quote">motif</span>”</span> to choose which Motif version will be
6405: used.</p></li>
1.184 rillig 6406: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6407: system-provided GNU readline or editline (libedit) installation,
1.207 leot 6408: 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>,
6409: <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 6410: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6411: If your package really needs GNU readline library, its Makefile
6412: should include <code class="filename">devel/readline/buildlink3.mk</code>
6413: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6414: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6415: variables that may be used by packages that use the
6416: Open Sound System (OSS) API.</p></li>
6417: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6418: any of the Postgres versions in the variable
6419: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6420: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6421: the file for more information.</p></li>
6422: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6423: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.207 leot 6424: 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 6425: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6426: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6427: library.</p></li>
6428: </ul></div>
6429: <p>The comments in those <code class="filename">buildlink3.mk</code>
6430: files provide a more complete
6431: description of how to use them properly.</p>
1.1 dsieger 6432: </div>
1.41 asau 6433: <div class="sect1">
1.1 dsieger 6434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6435: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.184 rillig 6436: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6437: included by Makefiles to indicate the need to compile and link
6438: against header files and libraries provided by the package. A
6439: <code class="filename">buildlink3.mk</code> file should always provide
6440: enough information to add the correct type of dependency
6441: relationship and include any other
6442: <code class="filename">buildlink3.mk</code> files that it needs to find
6443: headers and libraries that it needs in turn.</p>
6444: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.207 leot 6445: 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 6446: package is highly recommended. For most packages, the following
6447: command will generate a good starting point for
6448: <code class="filename">buildlink3.mk</code> files:</p>
6449: <pre class="screen">
6450: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6451: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6452: </pre>
1.41 asau 6453: <div class="sect2">
1.1 dsieger 6454: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 6455: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.184 rillig 6456: <p>The following real-life example
6457: <code class="filename">buildlink3.mk</code> is taken
6458: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.1 dsieger 6459: <pre class="programlisting">
1.184 rillig 6460: BUILDLINK_TREE+= tiff
6461:
6462: .if !defined(TIFF_BUILDLINK3_MK)
6463: TIFF_BUILDLINK3_MK:=
6464:
6465: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6466: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6467: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6468:
6469: .include "../../devel/zlib/buildlink3.mk"
6470: .include "../../graphics/jpeg/buildlink3.mk"
6471: .endif # TIFF_BUILDLINK3_MK
6472:
6473: BUILDLINK_TREE+= -tiff
1.1 dsieger 6474: </pre>
1.184 rillig 6475: <p>The header and footer manipulate
6476: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6477: <code class="filename">buildlink3.mk</code> files and is used to track
6478: the dependency tree.</p>
6479: <p>The main section is protected from multiple inclusion
6480: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6481: added. Several important variables are set in the section:</p>
6482: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6483: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6484: is the dependency version recorded in the installed
1.184 rillig 6485: package; this should always be set using
6486: <span class="command"><strong>+=</strong></span> to ensure that
6487: we're appending to any pre-existing list of values. This
1.185 wiz 6488: variable should be set to the last version of the
1.184 rillig 6489: package that had an backwards-incompatible API change.
6490: </p></li>
6491: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6492: is the location of the <em class="replaceable"><code>pkg</code></em>
6493: pkgsrc directory.</p></li>
6494: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6495: (not shown above) controls whether we use
1.236 gutterid 6496: <code class="varname">BUILD_DEPENDS</code> or
1.184 rillig 6497: <code class="varname">DEPENDS</code> to add the dependency on
6498: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6499: selected by setting
6500: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.266 martin 6501: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.184 rillig 6502: used.</p></li>
6503: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6504: and
6505: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6506: (not shown above) are lists of subdirectories of
6507: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6508: to add to the header and library search paths. These
1.266 martin 6509: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.184 rillig 6510: respectively.</p></li>
6511: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6512: (not shown above) is the list of preprocessor flags to add
6513: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.266 martin 6514: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.184 rillig 6515: should be avoided and instead be handled using
6516: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6517: above.</p></li>
6518: </ul></div>
6519: <p>The following variables are all optionally defined within
6520: this second section (protected against multiple inclusion) and
6521: control which package files are symlinked into
6522: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6523: transformed during the symlinking:</p>
6524: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6525: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6526: (not shown above) is a shell glob pattern relative to
6527: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6528: to be symlinked into
6529: <code class="filename">${BUILDLINK_DIR}</code>,
6530: e.g. <code class="filename">include/*.h</code>.</p></li>
6531: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6532: (not shown above) is a shell pipeline that
6533: outputs to stdout a list of files relative to
6534: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6535: The resulting files are to be symlinked
6536: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6537: this takes the <code class="filename">+CONTENTS</code> of a
6538: <em class="replaceable"><code>pkg</code></em> and filters it through
6539: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6540: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6541: (not shown above) is a filter command that filters
6542: <code class="filename">+CONTENTS</code> input into a list of files
6543: relative to
6544: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6545: on stdout. By default,
6546: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6547: outputs the contents of the <code class="filename">include</code>
6548: and <code class="filename">lib</code> directories in the package
6549: <code class="filename">+CONTENTS</code>.</p></li>
6550: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6551: (not shown above) is a list of sed arguments used to
6552: transform the name of the source filename into a
6553: destination filename, e.g. <span class="command"><strong>-e
6554: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6555: </ul></div>
6556: <p>This section can additionally include any
6557: <code class="filename">buildlink3.mk</code> needed for
6558: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6559: Including these <code class="filename">buildlink3.mk</code> files
6560: means that the headers and libraries for these
6561: dependencies are also symlinked into
6562: <code class="filename">${BUILDLINK_DIR}</code>
6563: whenever the <em class="replaceable"><code>pkg</code></em>
6564: <code class="filename">buildlink3.mk</code>
6565: file is included. Dependencies are only added for directly
6566: include <code class="filename">buildlink3.mk</code> files.</p>
6567: <p>When providing a <code class="filename">buildlink3.mk</code> and
6568: including other <code class="filename">buildlink3.mk</code> files in it,
6569: please only add necessary ones, i.e., those whose libraries or
6570: header files are automatically exposed when the package is
6571: use.</p>
6572: <p>In particular, if only an executable
6573: (<code class="filename">bin/foo</code>) is linked against a library, that
6574: library does not need to be propagated in the
6575: <code class="filename">buildlink3.mk</code> file.</p>
6576: <p>The following steps should help you decide if a
6577: <code class="filename">buildlink3.mk</code> file needs to be included:
6578: </p>
6579: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6580: <li class="listitem"><p>Look at the installed header files: What
6581: headers do they include? The packages providing these files
6582: must be buildlinked.</p></li>
6583: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6584: libraries and look against what other libraries they link.
6585: Some of the packages providing these probably need to be
6586: buildlinked; however, it's not automatic, since e.g. GTK on
6587: some systems pulls in the X libraries, so they will show up in
6588: the <code class="filename">ldd</code> output, while on others (like OS
6589: X) it won't. <code class="filename">ldd</code> output can thus only be
6590: used as a hint.</p></li>
6591: </ul></div>
6592: <p>
6593: </p>
6594: </div>
1.41 asau 6595: <div class="sect2">
1.1 dsieger 6596: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 6597: <a name="updating-buildlink-depends"></a>18.2.2. Updating
1.184 rillig 6598: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6599: and
6600: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6601: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.185 wiz 6602: <p>Both variables set lower bounds for a version of this package.
6603: The two variables differ in that one describes source
1.184 rillig 6604: compatibility (API) and the other binary compatibility (ABI).
6605: The difference is that a change in the API breaks compilation of
6606: programs while changes in the ABI stop compiled programs from
6607: running.</p>
1.185 wiz 6608: <p>The
6609: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6610: variable in a <code class="filename">buildlink3.mk</code> should be
6611: changed very rarely. (One possible scenario: If all packages
6612: using this package need a higher version than defined in the
6613: <code class="filename">buildlink3.mk</code>,
1.184 rillig 6614: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6615: could be updated to that higher version.)</p>
6616: <p>On the other hand, changes to
1.184 rillig 6617: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6618: are more common. The variable will need to be updated every
6619: time the major version of one of its shared libraries is changed,
6620: or any other change where a binary built against the previous
6621: version of the package will not run against the new version any
6622: longer.</p>
6623: <p>In such a case, the package's
1.184 rillig 6624: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6625: must be increased to require the new package version. Then the
6626: <code class="varname">PKGREVISION</code> of all packages
6627: <em class="replaceable"><code>foo</code></em> that depend on this package need
6628: to be increased, and if they have
6629: <code class="filename">buildlink3.mk</code> files,
6630: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6631: in their <code class="filename">buildlink3.mk</code> files must be
6632: increased to the new version as well. This is required so that a
6633: package will pull in the versions of the packages that use the
6634: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6635: uniquely identify the packages built against the new ABI. The
1.207 leot 6636: <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 6637: help with these updates.</p>
1.266 martin 6638: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
1.185 wiz 6639: about dependencies on other packages, including the
6640: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.184 rillig 6641: <p>Please take careful consideration before adjusting
6642: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6643: or
6644: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6645: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6646: cause unneeded package deletions and rebuilds. In many cases,
6647: new versions of packages work just fine with older
6648: dependencies.</p>
1.211 gutterid 6649: <p>Also, it is not needed to set
1.184 rillig 6650: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6651: when it is identical to
1.211 gutterid 6652: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
6653: <p>Note there is also the distinction that users are able to disable
6654: enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
6655: variable, but there is no equivalent option for API dependencies.</p>
1.1 dsieger 6656: </div>
6657: </div>
1.41 asau 6658: <div class="sect1">
1.1 dsieger 6659: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6660: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.184 rillig 6661: <p>Some packages in pkgsrc install headers and libraries that
6662: coincide with headers and libraries present in the base system.
6663: Aside from a <code class="filename">buildlink3.mk</code> file, these
6664: packages should also include a <code class="filename">builtin.mk</code>
6665: file that includes the necessary checks to decide whether using
6666: the built-in software or the pkgsrc software is
6667: appropriate.</p>
6668: <p>The only requirements of a builtin.mk file for
6669: <em class="replaceable"><code>pkg</code></em> are:</p>
6670: <div class="orderedlist"><ol class="orderedlist" type="1">
6671: <li class="listitem"><p>It should set
6672: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.266 martin 6673: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.184 rillig 6674: after it is included.</p></li>
6675: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6676: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6677: which is already set before the
6678: <code class="filename">builtin.mk</code> file is included.</p></li>
6679: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6680: is <span class="emphasis"><em>very</em></span> important and takes careful
6681: attention to <code class="filename">Makefile</code> coding.</p></li>
6682: </ol></div>
6683: <div class="sect2">
6684: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 6685: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.184 rillig 6686: <p>The following is the recommended template for builtin.mk
6687: files:</p>
1.1 dsieger 6688: <pre class="programlisting">
1.184 rillig 6689: .if !defined(IS_BUILTIN.foo)
6690: #
6691: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6692: # genuinely exists in the system or not.
6693: #
6694: IS_BUILTIN.foo?= no
1.1 dsieger 6695:
1.184 rillig 6696: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6697: # version can be determined.
6698: #
6699: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6700: BUILTIN_PKG.foo?= foo-1.0
6701: . endif
6702: .endif # IS_BUILTIN.foo
1.1 dsieger 6703:
1.184 rillig 6704: .if !defined(USE_BUILTIN.foo)
6705: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6706: . if defined(BUILTIN_PKG.foo)
6707: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6708: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6709: USE_BUILTIN.foo!= \
6710: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6711: && ${ECHO} "yes" || ${ECHO} "no"
6712: . endif
6713: . endfor
6714: . endif
6715: .endif # USE_BUILTIN.foo
1.1 dsieger 6716:
1.184 rillig 6717: CHECK_BUILTIN.foo?= no
6718: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6719: #
6720: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6721: # "yes" or "no".
6722: #
6723: .endif # CHECK_BUILTIN.foo
1.1 dsieger 6724: </pre>
1.184 rillig 6725: <p>The first section sets
6726: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6727: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6728: in the base system. This should not be a base system software
6729: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.266 martin 6730: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.184 rillig 6731: included as part of the base system. This variable is only
6732: used internally within the <code class="filename">builtin.mk</code>
6733: file.</p>
6734: <p>The second section sets
6735: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6736: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6737: system if it exists (if
6738: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.266 martin 6739: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.184 rillig 6740: within the <code class="filename">builtin.mk</code> file.</p>
6741: <p>The third section sets
6742: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6743: and is <span class="emphasis"><em>required</em></span> in all
6744: <code class="filename">builtin.mk</code> files. The code in this
6745: section must make the determination whether the built-in
6746: software is adequate to satisfy the dependencies listed in
6747: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6748: This is typically done by comparing
6749: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6750: against each of the dependencies in
6751: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6752: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6753: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6754: end of the <code class="filename">builtin.mk</code> file. Note that
6755: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.266 martin 6756: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.184 rillig 6757: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.266 martin 6758: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.184 rillig 6759: that the built-in version of the software is similar enough to
6760: be used as a replacement.</p>
6761: <p>The last section is guarded by
6762: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6763: and includes code that uses the value of
6764: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6765: set in the previous section. This typically includes, e.g.,
6766: adding additional dependency restrictions and listing additional
6767: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6768: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6769: </div>
1.7 rillig 6770: </div>
1.1 dsieger 6771: </div>
1.41 asau 6772: <div class="chapter">
1.1 dsieger 6773: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 6774: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.1 dsieger 6775: <div class="toc">
6776: <p><b>Table of Contents</b></p>
1.100 leot 6777: <dl class="toc">
1.184 rillig 6778: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6779: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6780: <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>
6781: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6782: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6783: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6784: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6785: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6786: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 6787: </dl>
6788: </div>
1.184 rillig 6789: <p>The <code class="filename">PLIST</code> file contains a package's
1.266 martin 6790: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.184 rillig 6791: the package (relative to the <code class="filename">${PREFIX}</code>
6792: directory it's been installed in) plus some additional statements
1.259 leot 6793: - 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 6794: This chapter addresses some issues that need attention when
6795: dealing with the <code class="filename">PLIST</code> file (or files, see
6796: below!).</p>
1.41 asau 6797: <div class="sect1">
1.1 dsieger 6798: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6799: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
1.184 rillig 6800: <p>Be sure to add a RCS ID line as the first thing in any
6801: <code class="filename">PLIST</code> file you write:</p>
6802: <pre class="programlisting">
6803: @comment $NetBSD $
6804: </pre>
6805: <p>An artificial space has been added between NetBSD and $, this is a
6806: workaround here to prevent CVS expanding to the filename of the guide. When
6807: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6808: </div>
1.41 asau 6809: <div class="sect1">
1.1 dsieger 6810: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6811: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.184 rillig 6812: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6813: to output a PLIST that matches any new files since the package
1.266 martin 6814: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
1.184 rillig 6815: more information on this target.</p>
1.1 dsieger 6816: </div>
1.41 asau 6817: <div class="sect1">
1.1 dsieger 6818: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6819: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.184 rillig 6820: </h2></div></div></div>
6821: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6822: of AWK patterns and actions that are used to filter the output of
6823: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6824: scripting you like to it, but be careful with quoting.</p>
6825: <p>For example, to get all files inside the
6826: <code class="filename">libdata/foo</code> directory removed from the
6827: resulting PLIST:</p>
1.1 dsieger 6828: <pre class="programlisting">
1.184 rillig 6829: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 6830: </pre>
1.185 wiz 6831: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6832: evaluated after the file list and directory list are sorted.
6833: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6834: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6835: list and directory list are sorted.</p>
1.184 rillig 6836: </div>
6837: <div class="sect1">
6838: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6839: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
1.184 rillig 6840: <p>A number of variables are substituted automatically in
6841: PLISTs when a package is installed on a system. This includes the
6842: following variables:</p>
6843: <div class="variablelist"><dl class="variablelist">
6844: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6845: <dd>
6846: <p>Some packages like emacs and perl embed information
6847: about which architecture they were built on into the
6848: pathnames where they install their files. To handle this
6849: case, PLIST will be preprocessed before actually used, and
6850: the symbol
1.266 martin 6851: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.184 rillig 6852: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6853: same is done if the string
6854: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6855: PLIST somewhere - use this on packages that have GNU
6856: autoconf-created configure scripts.</p>
6857: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6858: <h3 class="title">Legacy note</h3>
6859: <p>There used to be a symbol
1.266 martin 6860: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.184 rillig 6861: was replaced by the output of <span class="command"><strong>uname
6862: -m</strong></span>, but that's no longer supported and has
6863: been removed.</p>
6864: </div>
6865: </dd>
6866: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6867: <dd>
6868: <p>Some packages want to embed the OS name and version
6869: into some paths. To do this, use these variables in the
6870: <code class="filename">PLIST</code>:
6871: </p>
6872: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.266 martin 6873: <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>
6874: <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>
6875: <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>
1.184 rillig 6876: </ul></div>
6877: </dd>
6878: </dl></div>
6879: <p>For a list of values which are replaced by
6880: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6881: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6882: <code class="varname">PLIST_SUBST</code> should help.</p>
6883: <p>If you want to change other variables not listed above, you
6884: can add variables and their expansions to this variable in the
1.266 martin 6885: 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 6886: <pre class="programlisting">
1.184 rillig 6887: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 6888: </pre>
1.266 martin 6889: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.184 rillig 6890: in the <code class="filename">PLIST</code> with
1.266 martin 6891: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.184 rillig 6892: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6893: the common case of conditionally including some
6894: <code class="filename">PLIST</code> entries. It can be done by adding
6895: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6896: setting the corresponding <code class="varname">PLIST.foo</code> variable
6897: to <code class="literal">yes</code> if the entry should be included.
1.266 martin 6898: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.184 rillig 6899: in the <code class="filename">PLIST</code> with either
1.266 martin 6900: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6901: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.184 rillig 6902: For example, in <code class="filename">Makefile</code>:</p>
1.66 asau 6903: <pre class="programlisting">
1.184 rillig 6904: PLIST_VARS+= foo
6905: .if <em class="replaceable"><code>condition</code></em>
6906: PLIST.foo= yes
6907: .else
1.66 asau 6908: </pre>
1.184 rillig 6909: <p>And then in <code class="filename">PLIST</code>:</p>
1.1 dsieger 6910: <pre class="programlisting">
1.184 rillig 6911: @comment $NetBSD $
6912: bin/bar
6913: man/man1/bar.1
6914: ${PLIST.foo}bin/foo
6915: ${PLIST.foo}man/man1/foo.1
6916: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 6917: </pre>
1.184 rillig 6918: <p>An artificial space has been added between NetBSD and $, this is a
6919: workaround here to prevent CVS expanding to the filename of the guide. When
1.195 gutterid 6920: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6921: </div>
1.184 rillig 6922: <div class="sect1">
6923: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6924: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
1.184 rillig 6925: <p>Man pages should be installed in compressed form if
6926: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6927: and uncompressed otherwise. To handle this in the
1.266 martin 6928: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.184 rillig 6929: appended/removed automatically for man pages according to
6930: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6931: or not, see above for details. This modification of the
6932: <code class="filename">PLIST</code> file is done on a copy of it, not
6933: <code class="filename">PLIST</code> itself.</p>
1.1 dsieger 6934: </div>
1.41 asau 6935: <div class="sect1">
1.1 dsieger 6936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6937: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.184 rillig 6938: </h2></div></div></div>
6939: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6940: in generating the binary package, set the variable
6941: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.259 leot 6942: 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 6943: important. The default for <code class="varname">PLIST_SRC</code> is
6944: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.1 dsieger 6945: </div>
1.41 asau 6946: <div class="sect1">
1.1 dsieger 6947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6948: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.184 rillig 6949: <p>Some packages decide to install a different set of files based on
6950: the operating system being used. These differences can be
6951: automatically handled by using the following files:</p>
6952: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6953: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6954: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6955: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6956: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6957: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6958: </ul></div>
1.1 dsieger 6959: </div>
1.41 asau 6960: <div class="sect1">
1.1 dsieger 6961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6962: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
1.184 rillig 6963: <p>Some packages decide to generate hard-to-guess file names
6964: during installation that are hard to wire down.</p>
6965: <p>In such cases, you can set the
6966: <code class="varname">GENERATE_PLIST</code> variable to shell code
6967: terminated (with a semicolon) that will output PLIST entries which
6968: will be appended to the PLIST</p>
6969: <p>You can find one example in editors/xemacs:</p>
6970: <pre class="programlisting">
6971: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6972: </pre>
6973: <p>which will append something like
6974: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6975: <code class="filename">PLIST</code>.
6976: </p>
1.1 dsieger 6977: </div>
1.41 asau 6978: <div class="sect1">
1.1 dsieger 6979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6980: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6981: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.184 rillig 6982: multiple (and unrelated) packages install files. These
6983: directories were problematic because you had to add special
6984: tricks in the PLIST to conditionally remove them, or have some
6985: centralized package handle them.</p>
6986: <p>In pkgsrc, it is now easy: Each package should create
6987: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6988: will remove any directories left empty after uninstalling a
6989: package.</p>
6990: <p>If a package needs an empty directory to work, create
6991: the directory during installation as usual, and also add an
6992: entry to the PLIST:
6993:
6994: </p>
6995: <pre class="programlisting">
6996: @pkgdir path/to/empty/directory
6997: </pre>
6998: <p>
6999:
7000: or take a look at <code class="varname">MAKE_DIRS</code> and
7001: <code class="varname">OWN_DIRS</code>.
1.1 dsieger 7002: </p>
7003: </div>
1.184 rillig 7004: </div>
7005: <div class="chapter">
7006: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 7007: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
1.184 rillig 7008: <div class="toc">
7009: <p><b>Table of Contents</b></p>
7010: <dl class="toc">
7011: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
7012: <dd><dl>
7013: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
7014: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
7015: </dl></dd>
7016: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
7017: <dd><dl>
7018: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
7019: <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 7020: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
7021: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
7022: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 7023: </dl></dd>
7024: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
7025: <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>
7026: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
7027: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
7028: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
7029: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
7030: <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>
7031: </dl>
7032: </div>
7033: <p>This chapter describes the framework known as
7034: <code class="literal">pkginstall</code>, whose key features are:</p>
7035: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7036: <li class="listitem"><p>Generic installation and manipulation of directories and files
7037: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
7038: <li class="listitem"><p>Automatic handling of configuration files during installation,
7039: provided that packages are correctly designed.</p></li>
7040: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
7041: <li class="listitem"><p>Registration of system users and groups.</p></li>
7042: <li class="listitem"><p>Registration of system shells.</p></li>
7043: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
7044: </ul></div>
7045: <p>The following sections inspect each of the above points in detail.</p>
7046: <p>You may be thinking that many of the things described here could be
7047: easily done with simple code in the package's post-installation target
7048: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
7049: as the code in them is only executed when building from source. Machines
7050: using binary packages could not benefit from it at all (as the code itself
7051: could be unavailable). Therefore, the only way to achieve any of the items
7052: described above is by means of the installation scripts, which are
7053: automatically generated by pkginstall.</p>
1.41 asau 7054: <div class="sect1">
1.1 dsieger 7055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7056: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
1.184 rillig 7057: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
7058: of files and directories that belong to a package. The names used in it
7059: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
7060: which means that it cannot register files outside this directory (absolute
7061: path names are not allowed). Despite this restriction, some packages need
7062: to install files outside this location; e.g., under
7063: <code class="filename">${VARBASE}</code> or
7064: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
7065: is to create such files during installation time by using
7066: installation scripts.</p>
7067: <p>The generic installation scripts are shell scripts that can
7068: contain arbitrary code. The list of scripts to execute is taken from
7069: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
7070: <code class="filename">INSTALL</code>. A similar variable exists for package
7071: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
7072: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
7073: commands, so they have the potential to create and manage files
7074: anywhere in the file system.</p>
7075: <p>Using these general installation files is not recommended, but
7076: may be needed in some special cases. One reason for avoiding them is
7077: that the user has to trust the packager that there is no unwanted or
7078: simply erroneous code included in the installation script. Also,
7079: previously there were many similar scripts for the same functionality,
7080: and fixing a common error involved finding and changing all of
7081: them.</p>
7082: <p>The pkginstall framework offers another, standardized way. It
7083: provides generic scripts to abstract the manipulation of such files
7084: and directories based on variables set in the package's
7085: <code class="filename">Makefile</code>. The rest of this section describes
7086: these variables.</p>
7087: <div class="sect2">
7088: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7089: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
1.184 rillig 7090: <p>The following variables can be set to request the creation of
7091: directories anywhere in the file system:</p>
7092: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7093: <li class="listitem">
7094: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
7095: contain a list of directories that should be created and should attempt
7096: to be destroyed by the installation scripts. The difference between
7097: the two is that the latter prompts the administrator to remove any
7098: directories that may be left after deinstallation (because they were
7099: not empty), while the former does not. Example:</p>
7100: <pre class="programlisting">
7101: MAKE_DIRS+= ${VARBASE}/foo/private
7102: </pre>
7103: </li>
7104: <li class="listitem">
7105: <p><code class="varname">MAKE_DIRS_PERMS</code> and
7106: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
7107: which directories should be created and should attempt to be destroyed
7108: by the installation scripts. Each tuple holds the following values,
7109: separated by spaces: the directory name, its owner, its group and its
7110: numerical mode. For example:</p>
7111: <pre class="programlisting">
7112: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
7113: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
7114: </pre>
7115: <p>The difference between the two is exactly the same as their
7116: non-<code class="varname">PERMS</code> counterparts.</p>
7117: </li>
7118: </ul></div>
1.1 dsieger 7119: </div>
1.184 rillig 7120: <div class="sect2">
7121: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7122: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
1.184 rillig 7123: <p>Creating non-empty files outside the installation prefix is tricky
7124: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.239 dholland 7125: To overcome this problem, the only solution is to extract the file in a
1.184 rillig 7126: known place (i.e., inside the installation prefix) and copy it to the
7127: appropriate location during installation (done by the installation scripts
1.239 dholland 7128: generated by pkginstall). We will call the former the <span class="emphasis"><em>reference
1.184 rillig 7129: file</em></span> in the following paragraphs, which describe the variables
7130: that can be used to automatically and consistently handle files outside the
7131: installation prefix:</p>
7132: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.239 dholland 7133: <li class="listitem"><p><code class="varname">REQD_FILES</code> is a list of pairs of reference
7134: and target files. At installation time, the reference file is copied
7135: to the target if and only if the latter does not exist. Upon
7136: deinstallation, the reference file is removed provided that it was
7137: not modified by the installation.</p></li>
1.184 rillig 7138: <li class="listitem">
1.239 dholland 7139: <p><code class="varname">REQD_FILES_PERMS</code> contains tuples describing
7140: reference files and targets, including owner, group, and numeric
7141: permissions that should be set. For example:</p>
1.1 dsieger 7142: <pre class="programlisting">
1.184 rillig 7143: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
7144: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 7145: </pre>
1.184 rillig 7146: </li>
1.239 dholland 7147: <li class="listitem"><p><code class="varname">CONF_FILES</code> and
7148: <code class="varname">CONF_FILES_PERMS</code> have the same syntax as
7149: <code class="varname">REQD_FILES</code> and
7150: <code class="varname">REQD_FILES_PERMS</code> respectively. The difference
7151: is that these variables are specifically intended for handling
7152: configuration files, for which additional conventions and
1.266 martin 7153: constraints apply. See <a class="xref" href="#conf-files" title="20.2. Configuration files">Section 20.2, “Configuration files”</a> for further
1.239 dholland 7154: discussion. Note in particular that while handling of
1.266 martin 7155: 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
1.239 dholland 7156: <code class="varname">REQD_FILES</code> and
7157: <code class="varname">REQD_FILES_PERMS</code>.</p></li>
1.184 rillig 7158: </ul></div>
1.239 dholland 7159: <p>To install an empty file, one can use these macros and
7160: <code class="filename">/dev/null</code> as the reference file.</p>
1.184 rillig 7161: </div>
1.1 dsieger 7162: </div>
1.41 asau 7163: <div class="sect1">
1.1 dsieger 7164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7165: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
1.239 dholland 7166: <p>There are two principles that govern the handling of
7167: configuration files in pkgsrc: first, the user's configuration must
7168: not be lost or overwritten by upgrades or reinstallations; and second,
7169: the default configuration should always be available for reference.
7170: To that end, pkgsrc has a framework specifically for handling
7171: configuration files. In general, configuration files are installed
7172: into <code class="filename">${PREFIX}/share/examples</code>, and copied from
7173: there to the pertinent <code class="filename">etc</code> directory as a
7174: separate step and only as needed.</p>
7175: <p>To make this work, there are three things that need to happen,
7176: any of which may require patching. First, the package must be told to
7177: read its configuration from the correct place at runtime; this place
7178: is <code class="filename">${PKG_SYSCONFDIR}</code> (or possibly a subdirectory
7179: of it) which is often but not always
7180: <code class="filename">${PREFIX}/etc</code>. Second, the package must be
7181: taught to install its default configuration files in
7182: <code class="filename">${PREFIX}/share/examples/${PKGBASE}</code>; this is the
7183: point at which patching often becomes required because it is not the
7184: same place as the runtime location. Third, the configuration files
7185: need to be declared in the package makefile; this is the easy part.
7186: </p>
7187: <p>With those elements in place, the right things will happen: the
7188: package install phase and resulting binary package will not touch
7189: <code class="filename">${PKG_SYSCONFDIR}</code>, and the default configuration
7190: will be copied into place by the pkgsrc framework only if not already
7191: present. Similarly, upon deinstall the configuration will not be
7192: removed if it has been modified. (This means that in the case of
7193: reinstallation and upgrades, unmodified configuration files are
7194: updated but modifications are never discarded.)</p>
7195: <p>The following sections describe how to make these things happen
7196: and document other relevant knobs available in the pkgsrc
7197: infrastructure.</p>
1.184 rillig 7198: <div class="sect2">
7199: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7200: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.184 rillig 7201: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7202: specifies where configuration files shall be installed. Its contents are
7203: set based upon the following variables:</p>
7204: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7205: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7206: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.239 dholland 7207: be overridden by the user to point to their preferred location (e.g.,
1.184 rillig 7208: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7209: Packages must not use it directly.</p></li>
7210: <li class="listitem">
7211: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7212: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7213: for the package being built shall be installed. The definition of this
7214: variable only makes sense in the package's
7215: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7216: <p>As an example, consider the Apache package,
1.207 leot 7217: <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 7218: configuration files under the
7219: <code class="filename">httpd/</code> subdirectory of
7220: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7221: Makefile.</p>
7222: </li>
7223: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7224: variable that holds this package's configuration directory (if
7225: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7226: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7227: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7228: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7229: directory where the configuration files for the package identified by
7230: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7231: </ul></div>
7232: <p>Based on the above variables, pkginstall determines the value of
7233: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
1.239 dholland 7234: variable that may be used within a package to refer to its configuration
1.184 rillig 7235: directory. The algorithm used to set its value is basically the
7236: following:</p>
7237: <div class="orderedlist"><ol class="orderedlist" type="1">
7238: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7239: its value is used.</p></li>
7240: <li class="listitem"><p>If the previous variable is not defined but
7241: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7242: <code class="filename">Makefile</code>, the resulting value is
7243: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7244: <li class="listitem"><p>Otherwise, it is set to
7245: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7246: </ol></div>
7247: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.239 dholland 7248: automatically added to <code class="filename">OWN_DIRS</code>. This causes it
1.266 martin 7249: 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
1.239 dholland 7250: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>; they must be manually
7251: created with <code class="varname">OWN_DIRS</code> or
7252: <code class="varname">MAKE_DIRS</code>.</p>
1.184 rillig 7253: </div>
7254: <div class="sect2">
7255: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7256: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
1.184 rillig 7257: <p>Given that pkgsrc (and users!) expect configuration files to be in a
1.239 dholland 7258: known place, you need to teach each package where to install its files. In
7259: some cases you will have to patch the package Makefiles to achieve it. If
7260: you are lucky, though, it may be as easy as passing an extra flag to the
7261: configuration script. This is the case for packages using GNU
7262: autoconf:</p>
1.1 dsieger 7263: <pre class="programlisting">
1.184 rillig 7264: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 7265: </pre>
1.184 rillig 7266: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
1.239 dholland 7267: for</em></span> its configuration files, not where they will be installed.
7268: Fortunately, there is a different way to specify the latter, as seen
1.240 gutterid 7269: in the next section, although the combination is rather confusing at
1.239 dholland 7270: first glance.</p>
1.1 dsieger 7271: </div>
1.184 rillig 7272: <div class="sect2">
7273: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7274: <a name="conf-files-patching"></a>20.2.3. Patching installation</h3></div></div></div>
1.239 dholland 7275: <p>As discussed above, <span class="strong"><strong>packages themselves must not
1.184 rillig 7276: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7277: directly</strong></span>. Bad news is that many software installation scripts
7278: will, out of the box, mess with the contents of that directory. So what is
7279: the correct procedure to fix this issue?</p>
7280: <p>You must teach the package (usually by manually patching it) to
7281: install any configuration files under the examples hierarchy,
7282: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7283: <code class="filename">PLIST</code> registers them and the administrator always
7284: has the original copies available.</p>
1.239 dholland 7285: <p>It turns out that for packages using GNU autoconf it is possible
7286: to create the desired effect by setting <code class="varname">sysconfdir</code>
7287: on the make command line at install time. Consider this example taken
7288: 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>
7289: <pre class="programlisting">
7290: EGDIR= ${PREFIX}/share/examples/mutt
7291: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
7292: </pre>
7293: <p>Note that the <code class="varname">EGDIR</code> variable, though commonly
7294: used for this purpose, is local to that package and has no meaning
7295: outside it.</p>
7296: </div>
7297: <div class="sect2">
7298: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7299: <a name="conf-files-declare"></a>20.2.4. Declaring configuration files</h3></div></div></div>
1.184 rillig 7300: <p>Once the required configuration files are in place (i.e., under the
1.239 dholland 7301: examples hierarchy), the pkginstall framework can use them as reference copies
1.184 rillig 7302: during the package installation to update what is in
7303: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7304: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.266 martin 7305: 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
1.239 dholland 7306: information about their syntax and their purpose. Here is an example,
7307: 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>
7308: <pre class="programlisting">
7309: EGDIR= ${PREFIX}/share/examples/mutt
7310: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7311: </pre>
7312: <p>Note that (as in the previous section's example) the
7313: <code class="varname">EGDIR</code> variable is specific to the package and has
7314: no meaning outside it.</p>
7315: <p>For reference, the complete example from Mutt is as follows:</p>
1.1 dsieger 7316: <pre class="programlisting">
1.239 dholland 7317: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
7318: EGDIR= ${PREFIX}/share/examples/mutt
7319: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7320: INSTALLATION_DIRS+= ${EGDIR}
7321: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.1 dsieger 7322: </pre>
7323: </div>
1.184 rillig 7324: <div class="sect2">
7325: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7326: <a name="conf-files-disable"></a>20.2.5. Disabling handling of configuration files</h3></div></div></div>
1.184 rillig 7327: <p>The automatic copying of config files can be toggled by setting the
7328: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7329: installation.</p>
1.1 dsieger 7330: </div>
7331: </div>
1.41 asau 7332: <div class="sect1">
1.1 dsieger 7333: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7334: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
1.184 rillig 7335: <p>System startup scripts are special files because they must be
7336: installed in a place known by the underlying OS, usually outside the
1.266 martin 7337: 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
1.184 rillig 7338: can be used. However, pkginstall provides a special mechanism to handle
7339: these files.</p>
7340: <p>In order to provide system startup scripts, the package has
7341: to:</p>
7342: <div class="orderedlist"><ol class="orderedlist" type="1">
7343: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7344: the <code class="literal">.sh</code> suffix appended. Considering the
1.223 nia 7345: <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
7346: has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.184 rillig 7347: <li class="listitem">
7348: <p>Tell pkginstall to handle it, appending the name of the script,
7349: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7350: Continuing the previous example:</p>
7351: <pre class="programlisting">
7352: RCD_SCRIPTS+= cupsd
7353: </pre>
7354: </li>
7355: </ol></div>
7356: <p>Once this is done, pkginstall will do the following steps for each
7357: script in an automated fashion:</p>
7358: <div class="orderedlist"><ol class="orderedlist" type="1">
7359: <li class="listitem"><p>Process the file found in the files directory applying all the
7360: substitutions described in the <code class="filename">FILES_SUBST</code>
7361: variable.</p></li>
7362: <li class="listitem"><p>Copy the script from the files directory to the examples
7363: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.239 dholland 7364: that this reference file must be explicitly registered in the
1.184 rillig 7365: <code class="filename">PLIST</code>.</p></li>
7366: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7367: from the examples hierarchy into the system-wide startup scripts
7368: directory.</p></li>
7369: </ol></div>
7370: <div class="sect2">
7371: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7372: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.184 rillig 7373: <p>The automatic copying of config files can be toggled by setting the
7374: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7375: installation. Note that the scripts will be always copied inside the
7376: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7377: matter what the value of this variable is.</p>
1.1 dsieger 7378: </div>
7379: </div>
1.184 rillig 7380: <div class="sect1">
7381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7382: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
1.184 rillig 7383: <p>If a package needs to create special users and/or groups during
7384: installation, it can do so by using the pkginstall framework.</p>
7385: <p>Users can be created by adding entries to the
7386: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7387: syntax:</p>
7388: <pre class="programlisting">
7389: user:group
7390: </pre>
7391: <p>Further specification of user details may be done by setting
7392: per-user variables.
7393: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7394: numeric UID for the user.
7395: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7396: user's description or comment.
7397: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7398: user's home directory, and defaults to
7399: <code class="filename">/nonexistent</code> if not specified.
7400: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7401: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7402: not specified.</p>
7403: <p>Similarly, groups can be created by adding entries to the
7404: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7405: <pre class="programlisting">
7406: group
7407: </pre>
7408: <p>The numeric GID of the group may be set by defining
7409: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7410: <p>If a package needs to create the users and groups at an earlier
7411: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7412: <code class="literal">configure</code>,<code class="literal">build</code>, or
7413: <code class="literal">pre-install</code> to indicate the phase before which the
7414: users and groups are created. In this case, the numeric UIDs and GIDs
7415: of the created users and groups are automatically hardcoded into the
7416: final installation scripts.</p>
1.1 dsieger 7417: </div>
1.41 asau 7418: <div class="sect1">
1.1 dsieger 7419: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7420: <a name="shells"></a>20.5. System shells</h2></div></div></div>
1.184 rillig 7421: <p>Packages that install system shells should register them in the shell
7422: database, <code class="filename">/etc/shells</code>, to make things easier to the
7423: administrator. This must be done from the installation scripts to keep
7424: binary packages working on any system. pkginstall provides an easy way to
7425: accomplish this task.</p>
7426: <p>When a package provides a shell interpreter, it has to set the
7427: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7428: add some hooks to the installation scripts to handle it. Consider the
1.207 leot 7429: 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 7430: <pre class="programlisting">
7431: PKG_SHELL= ${PREFIX}/bin/zsh
7432: </pre>
7433: <div class="sect2">
7434: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7435: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
1.184 rillig 7436: <p>The automatic registration of shell interpreters can be disabled by
7437: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7438: environment variable to <code class="literal">NO</code>.</p>
7439: </div>
1.1 dsieger 7440: </div>
1.41 asau 7441: <div class="sect1">
1.1 dsieger 7442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7443: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
1.184 rillig 7444: <p>Packages that install X11 fonts should update the database files
7445: that index the fonts within each fonts directory. This can easily be
7446: accomplished within the pkginstall framework.</p>
7447: <p>When a package installs X11 fonts, it must list the directories in
7448: which fonts are installed in the
7449: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.266 martin 7450: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7451: <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
1.184 rillig 7452: installation scripts to run the appropriate commands to update the fonts
7453: database files within each of those directories. For convenience, if the
7454: directory path is relative, it is taken to be relative to the package's
1.207 leot 7455: 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 7456: <pre class="programlisting">
1.184 rillig 7457: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 7458: </pre>
1.184 rillig 7459: <div class="sect2">
7460: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7461: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.184 rillig 7462: <p>The automatic update of fonts databases can be disabled by
7463: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7464: environment variable to <code class="literal">NO</code>.</p>
1.1 dsieger 7465: </div>
7466: </div>
7467: </div>
1.41 asau 7468: <div class="chapter">
1.1 dsieger 7469: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 7470: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 7471: <div class="toc">
7472: <p><b>Table of Contents</b></p>
1.100 leot 7473: <dl class="toc">
1.154 rillig 7474: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 7475: <dd><dl>
1.154 rillig 7476: <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>
7477: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7478: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7479: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7480: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7481: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7482: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7483: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7484: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7485: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7486: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7487: </dl></dd>
7488: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7489: <dd><dl>
7490: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7491: <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>
7492: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7493: </dl></dd>
7494: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7495: <dd><dl>
7496: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7497: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7498: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 7499: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.260 wiz 7500: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.154 rillig 7501: </dl></dd>
7502: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7503: <dd><dl>
7504: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7505: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 7506: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 7507: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
7508: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
7509: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
7510: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 7511: </dl></dd>
7512: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7513: <dd><dl>
7514: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7515: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 7516: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
1.266 martin 7517: <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>
1.172 rillig 7518: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 7519: </dl></dd>
7520: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7521: <dd><dl>
7522: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7523: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7524: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7525: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7526: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 7527: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.254 wiz 7528: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
7529: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
7530: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
7531: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
7532: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
7533: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
7534: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
7535: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
7536: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
7537: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.1 dsieger 7538: emulation</a></span></dt>
1.254 wiz 7539: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
7540: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.1 dsieger 7541: </dl></dd>
1.154 rillig 7542: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7543: </dl>
7544: </div>
1.41 asau 7545: <div class="sect1">
1.1 dsieger 7546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7547: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 7548: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 7549: different platforms. As a result, it is important to ensure,
7550: where possible, that packages in pkgsrc are portable. This
7551: chapter mentions some particular details you should pay
7552: attention to while working on pkgsrc.</p>
1.41 asau 7553: <div class="sect2">
1.1 dsieger 7554: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7555: <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 7556: </h3></div></div></div>
7557: <p>The pkgsrc user can configure pkgsrc by overriding several
7558: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7559: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7560: want to use those variables in the preprocessor directives of
1.259 leot 7561: <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 7562: <code class="literal">.for</code>), you need to include the file
7563: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7564: loads the user preferences.</p>
7565: <p>But note that some variables may not be completely defined
7566: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7567: included, as they may contain references to variables that are
1.108 rillig 7568: not yet defined. In shell commands (the lines in
7569: <code class="filename">Makefile</code> that are indented with a tab) this
7570: is no problem, since variables are only expanded when they are
7571: used. But in the preprocessor directives mentioned above and in
7572: dependency lines (of the form <code class="literal">target:
1.1 dsieger 7573: dependencies</code>) the variables are expanded at load
7574: time.</p>
1.41 asau 7575: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7576: <h3 class="title">Note</h3>
1.108 rillig 7577: <p>To check whether a variable can be used at load time,
7578: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 7579: </div>
7580: </div>
1.41 asau 7581: <div class="sect2">
1.1 dsieger 7582: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7583: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 7584: <p>Occasionally, packages require interaction from the user,
7585: and this can be in a number of ways:</p>
1.41 asau 7586: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7587: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7588: interaction such as entering username/password or accepting a
7589: license on a web page.</p></li>
1.23 wiz 7590: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7591: passwords.</p></li>
1.23 wiz 7592: <li class="listitem"><p>help to configure the package before it is built</p></li>
7593: <li class="listitem"><p>help during the build process</p></li>
7594: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7595: </ul></div>
1.108 rillig 7596: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7597: variable to define which stages need interaction. This should be
7598: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 7599: <pre class="programlisting">
7600: INTERACTIVE_STAGE= configure install
1.111 sevan 7601: </pre>
1.1 dsieger 7602: <p>The user can then decide to skip this package by setting the
1.108 rillig 7603: <code class="varname">BATCH</code> variable. Packages that require interaction
7604: are also excluded from bulk builds.</p>
1.1 dsieger 7605: </div>
1.41 asau 7606: <div class="sect2">
1.1 dsieger 7607: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7608: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 7609: <p>Authors of software can choose the licence under which software
7610: can be copied. The Free Software Foundation has declared some
7611: licenses "Free", and the Open Source Initiative has a definition of
7612: "Open Source".</p>
7613: <p>By default, pkgsrc allows packages with Free or Open Source
7614: licenses to be built. To allow packages with other licenses to be
7615: built as well, the pkgsrc user needs to add these licenses to the
7616: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7617: that this variable only affects which packages may be
7618: <span class="emphasis"><em>built</em></span>, while the license terms often also
7619: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 7620: <p>One might want to only install packages with a BSD license,
1.108 rillig 7621: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 7622: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 7623: user can override the default by setting the
7624: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 7625: of "+=". The licenses accepted by default are defined in the
7626: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7627: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7628: <p>The license tag mechanism is intended to address
7629: copyright-related issues surrounding building, installing and
7630: using a package, and not to address redistribution issues (see
7631: <code class="varname">RESTRICTED</code> and
1.111 sevan 7632: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7633: Packages with redistribution restrictions should set these
7634: tags.</p>
1.1 dsieger 7635: <p>Denoting that a package may be copied according to a
7636: particular license is done by placing the license in
7637: <code class="filename">pkgsrc/licenses</code> and setting the
7638: <code class="varname">LICENSE</code> variable to a string identifying the
1.207 leot 7639: 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 7640: <pre class="programlisting">
7641: LICENSE= xv-license
1.111 sevan 7642: </pre>
1.1 dsieger 7643: <p>When trying to build, the user will get a notice that the
7644: package is covered by a license which has not been placed in the
7645: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7646: <pre class="programlisting">
7647: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7648: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7649: ===> To view the license, enter "/usr/bin/make show-license".
7650: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7651: ===> ACCEPTABLE_LICENSES+=xv-license
7652: *** Error code 1
1.111 sevan 7653: </pre>
1.260 wiz 7654: <p>In case a package requires multiple licenses, you can add all of
7655: them to the LICENSE variable, connected with the upper-case keyword
7656: <code class="varname">AND</code>. If the user has a choice between multiple
7657: licenses, you can add them connected with the upper-case keyword
7658: <code class="varname">OR</code>, for example:</p>
7659: <pre class="programlisting">
7660: LICENSE= isc AND apache-2.0
7661: LICENSE= 2-clause-bsd OR ruby-license
7662: </pre>
1.10 hubertf 7663: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7664: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7665: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7666: convey to pkgsrc that it should not in the future fail because of
7667: that license:</p>
7668: <pre class="programlisting">
7669: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7670: </pre>
7671: <p>The use of <code class="varname">LICENSE=shareware</code>,
7672: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7673: is deprecated because it does not crisply refer to a particular
7674: license text. Another problem with such usage is that it does not
7675: enable a user to tell pkgsrc to proceed for a single package
7676: without also telling pkgsrc to proceed for all packages with that
7677: tag.</p>
7678: <div class="sect3">
7679: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 7680: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7681: <p>When adding a package with a new license, the following steps
7682: are required:</p>
7683: <div class="orderedlist"><ol class="orderedlist" type="1">
7684: <li class="listitem">
1.169 rillig 7685: <p>Check whether the license qualifies as Free or Open Source by
7686: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7687: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111 sevan 7688: Open Source Initiative</a>. If this is the case, the filename in
7689: <code class="filename">pkgsrc/licenses/</code> does not need the
7690: <code class="filename">-license</code> suffix, and the license name should be
7691: added to:</p>
1.48 rodent 7692: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7693: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7694: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7695: <li class="listitem"><p>default_acceptable_licenses in
7696: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48 rodent 7697: </ul></div>
7698: </li>
1.169 rillig 7699: <li class="listitem"><p>The license text should be added to
7700: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7701: licenses can be seen in this directory.</p></li>
1.48 rodent 7702: </ol></div>
1.111 sevan 7703: </div>
7704: <div class="sect3">
7705: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 7706: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7707: <p>When the license changes (in a way other than formatting),
1.111 sevan 7708: make sure that the new license has a different name (e.g.,
1.1 dsieger 7709: append the version number if it exists, or the date). Just
7710: because a user told pkgsrc to build programs under a previous
7711: version of a license does not mean that pkgsrc should build
7712: programs under the new licenses. The higher-level point is that
7713: pkgsrc does not evaluate licenses for reasonableness; the only
7714: test is a mechanistic test of whether a particular text has been
1.111 sevan 7715: approved by either of two bodies (FSF or OSI).</p>
7716: </div>
1.1 dsieger 7717: </div>
1.41 asau 7718: <div class="sect2">
1.1 dsieger 7719: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7720: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7721: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7722: By declaring the restrictions, package tools can
1.1 dsieger 7723: automatically refrain from e.g. placing binary packages on FTP
7724: sites.</p>
1.111 sevan 7725: <p>There are four possible restrictions, which are
1.1 dsieger 7726: the cross product of sources (distfiles) and binaries not being
7727: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7728: language in any license, and because non-Free licenses tend to be
7729: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7730: CD-ROM.
7731:
7732: "FTP" means making the source or binary file available over the
7733: Internet at no charge.
7734:
7735: "CD-ROM" means making the source or binary available on some kind of
7736: media, together with other source and binary packages, which is sold
7737: for a distribution charge.
1.1 dsieger 7738: </p>
7739: <p>In order to encode these restrictions, the package system
7740: defines five make variables that can be set to note these
7741: restrictions:</p>
1.41 asau 7742: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7743: <li class="listitem">
1.1 dsieger 7744: <p><code class="varname">RESTRICTED</code></p>
7745: <p>This variable should be set whenever a restriction
7746: exists (regardless of its kind). Set this variable to a
7747: string containing the reason for the restriction. It should
7748: be understood that those wanting to understand the restriction
7749: will have to read the license, and perhaps seek advice of
7750: counsel.</p>
7751: </li>
1.23 wiz 7752: <li class="listitem">
1.1 dsieger 7753: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7754: <p>Binaries may not be placed on CD-ROM containing other
7755: binary packages, for which a distribution charge may be made.
7756: In this case, set this variable to
7757: <code class="varname">${RESTRICTED}</code>.</p>
7758: </li>
1.23 wiz 7759: <li class="listitem">
1.1 dsieger 7760: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7761: <p>Binaries may not made available on the Internet without
7762: charge. In this case, set this variable to
7763: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7764: binary packages will not be included on ftp.NetBSD.org.</p>
7765: </li>
1.23 wiz 7766: <li class="listitem">
1.1 dsieger 7767: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7768: <p>Distfiles may not be placed on CD-ROM, together with
7769: other distfiles, for which a fee may be charged. In this
7770: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7771: </p>
7772: </li>
1.23 wiz 7773: <li class="listitem">
1.1 dsieger 7774: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7775: <p>Distfiles may not made available via FTP at no charge.
7776: In this case, set this variable to
7777: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7778: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7779: </li>
7780: </ul></div>
1.111 sevan 7781: <p>Please note that packages will be removed from pkgsrc when the
7782: distfiles are not distributable and cannot be obtained for a period
7783: of one full quarter branch. Packages with manual/interactive fetch
7784: must have a maintainer and it is his/her responsibility to ensure
7785: this.</p>
1.1 dsieger 7786: </div>
1.41 asau 7787: <div class="sect2">
1.1 dsieger 7788: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7789: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.175 gutterid 7790: <p>Your package may depend on some other package being present,
7791: and there are various ways of expressing this dependency.
7792: pkgsrc supports the <code class="varname">DEPENDS</code>,
7793: <code class="varname">BUILD_DEPENDS</code>,
7794: <code class="varname">TOOL_DEPENDS</code>, and
7795: <code class="varname">TEST_DEPENDS</code> definitions, the
1.1 dsieger 7796: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7797: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7798: to handle dependencies, and which uses the variables named above.
1.266 martin 7799: 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 7800: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7801: definition registers that pre-requisite in the binary package so it
7802: will be pulled in when the binary package is later installed, whilst
7803: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7804: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7805: dependency that is only needed for building or testing the resulting
1.266 martin 7806: 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 7807: <p>This means that if you only need a package present whilst
1.175 gutterid 7808: you are building or testing, it should be noted as a
7809: <code class="varname">TOOL_DEPENDS</code>,
7810: <code class="varname">BUILD_DEPENDS</code>, or
7811: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.156 leot 7812: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7813: packages, i.e. packages for the architecture where the package
7814: is built;
7815: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.175 gutterid 7816: packages, i.e., packages for the architecture for which the package
1.156 leot 7817: is built.</p>
1.175 gutterid 7818: <p>The format for a <code class="varname">DEPENDS</code>,
7819: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7820: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.1 dsieger 7821: <pre class="programlisting">
7822: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7823: </pre>
1.266 martin 7824: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7825: may include any of the wildcard version numbers recognized by
1.259 leot 7826: <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 7827: <div class="orderedlist"><ol class="orderedlist" type="1">
7828: <li class="listitem">
1.1 dsieger 7829: <p>If your package needs another package's binaries or
1.54 wiz 7830: libraries to build and run, and if that package has a
1.1 dsieger 7831: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7832: <pre class="programlisting">
7833: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7834: </pre>
1.1 dsieger 7835: </li>
1.23 wiz 7836: <li class="listitem">
1.54 wiz 7837: <p>If your package needs another package's binaries or
7838: libraries only for building, and if that package has a
7839: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7840: <pre class="programlisting">
7841: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7842: </pre>
1.54 wiz 7843: <p>but set
7844: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7845: to make it a build dependency only. This case is rather
7846: rare.</p>
7847: </li>
7848: <li class="listitem">
1.25 spz 7849: <p>If your package needs binaries from another package to build,
1.156 leot 7850: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7851: <pre class="programlisting">
1.156 leot 7852: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7853: </pre>
1.1 dsieger 7854: </li>
1.156 leot 7855: <li class="listitem"><p>If your package needs static libraries to link against, header
7856: files to include, etc. from another package to build,
7857: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7858: <li class="listitem"><p>If your package needs a library with which to link and
7859: there is no <code class="filename">buildlink3.mk</code> file
7860: available, create one. Using
7861: <code class="varname">DEPENDS</code> won't be sufficient because the
7862: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7863: <li class="listitem">
1.25 spz 7864: <p>If your package needs some executable to be able to run
7865: correctly and if there's no
7866: <code class="filename">buildlink3.mk</code> file, this is specified
7867: using the <code class="varname">DEPENDS</code> variable. The
1.207 leot 7868: <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 7869: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7870: when it runs, and that is specified:</p>
1.1 dsieger 7871: <pre class="programlisting">
1.129 wiz 7872: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7873: </pre>
1.25 spz 7874: </li>
1.175 gutterid 7875: <li class="listitem"><p>If your package includes a test suite that has extra
7876: dependencies only required for this purpose (frequently this
1.266 martin 7877: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
1.175 gutterid 7878: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.25 spz 7879: <li class="listitem">
7880: <p>You can use wildcards in package dependencies. Note that
7881: such wildcard dependencies are retained when creating binary
7882: packages. The dependency is checked when installing the binary
7883: package and any package which matches the pattern will be
7884: used. Wildcard dependencies should be used with care.</p>
1.266 martin 7885: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7886: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7887: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7888: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7889: <p>Wildcards can also be used to specify that a package
7890: will only build against a certain minimum version of a
7891: pre-requisite:</p>
7892: <pre class="programlisting">
1.25 spz 7893: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7894: </pre>
1.25 spz 7895: <p>This means that the package will build using version 6.0
7896: of ImageMagick or newer. Such a dependency may be warranted
7897: if, for example, the command line options of an executable
7898: have changed.</p>
7899: <p>If you need to depend on minimum versions of libraries,
1.183 wiz 7900: set
7901: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7902: to the appropriate pattern before including its
7903: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7904: <pre class="programlisting">
7905: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7906: .include "../../graphics/jpeg/buildlink3.mk"
7907: </pre>
1.1 dsieger 7908: <p>For security fixes, please update the package
1.266 martin 7909: 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 7910: information.</p>
7911: </li>
7912: </ol></div>
7913: <p>If your package needs files from another package to build,
7914: add the relevant distribution files to
7915: <code class="varname">DISTFILES</code>, so they will be extracted
1.207 leot 7916: 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 7917: (It relies on the jpeg sources being present in source form
7918: during the build.)</p>
7919: </div>
1.41 asau 7920: <div class="sect2">
1.1 dsieger 7921: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7922: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.226 gutterid 7923: <p>Your package may conflict with other packages users might
7924: already have installed on their system, e.g., if your package
1.1 dsieger 7925: installs the same set of files as another package in the pkgsrc
1.227 wiz 7926: tree.</p>
1.207 leot 7927: <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>
7928: 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 7929: install the same shared library, thus you set in
7930: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7931: <pre class="programlisting">
7932: CONFLICTS= Xaw-Xpm-[0-9]*
1.238 wiz 7933: </pre>
1.142 leot 7934: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7935: <pre class="programlisting">
7936: CONFLICTS= libXaw3d-[0-9]*
1.238 wiz 7937: </pre>
1.259 leot 7938: <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 7939: that conflict with existing packages and abort. However, in many
7940: situations this is too late in the process. Binary package managers
7941: will not know about the conflict until they attempt to install the
7942: package after already downloading it and all its dependencies.
7943: Users may also waste time building a package and its dependencies
7944: only to find out at the end that it conflicts with another package
7945: they have installed.</p>
7946: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7947: should be added in all cases where it is known that packages conflict
7948: with each other. These <code class="varname">CONFLICTS</code> entries are
1.259 leot 7949: 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 7950: managers to inform users that packages cannot be installed onto
7951: the target system.</p>
1.1 dsieger 7952: </div>
1.41 asau 7953: <div class="sect2">
1.1 dsieger 7954: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7955: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7956: <p>There are several reasons why a package might be
7957: instructed to not build under certain circumstances. If the
7958: package builds and runs on most platforms, the exceptions
1.83 dholland 7959: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7960: the package builds and runs on a small handful of platforms,
7961: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7962: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7963: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7964: (OS-version-platform) that can use glob-style
7965: wildcards.</p>
7966: <p>If a package is not appropriate for some platforms (as
1.114 maya 7967: opposed to merely broken), a different set of variables should be
1.83 dholland 7968: used as this affects failure reporting and statistics.
7969: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7970: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7971: the package is appropriate for only a small handful of platforms
7972: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7973: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7974: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7975: (OS-version-platform) that can use glob-style
7976: wildcards.</p>
7977: <p>Some packages are tightly bound to a specific version of an
1.207 leot 7978: 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 7979: backwards compatible with other versions of the OS, and should be
7980: uploaded to a version specific directory on the FTP server. Mark
7981: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.266 martin 7982: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7983: the package system internals, but may be used in the
7984: future.</p>
7985: <p>If the package should be skipped (for example, because it
7986: provides functionality already provided by the system), set
7987: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7988: the package should fail because some preconditions are not met,
7989: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7990: message.</p>
7991: </div>
1.41 asau 7992: <div class="sect2">
1.1 dsieger 7993: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7994: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7995: <p>To ensure that a package may not be deleted, once it has been
7996: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7997: be set in the package Makefile. This will be carried into any
7998: binary package that is made from this pkgsrc entry. A
1.266 martin 7999: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.259 leot 8000: 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.266 martin 8001: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 8002: </div>
1.41 asau 8003: <div class="sect2">
1.1 dsieger 8004: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8005: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 8006: <p>When a vulnerability is found, this should be noted in
1.247 wiz 8007: <code class="filename">pkgsrc/doc/pkg-vulnerabilities</code>.
1.205 wiz 8008: Entries in that file consist of three parts:</p>
8009: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8010: <li class="listitem"><p>package version pattern</p></li>
8011: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
8012: <li class="listitem"><p>URL providing additional information about the issue</p></li>
8013: </ul></div>
8014: <p>For the package version pattern please always use `<' to
8015: mark an upper bound (not `<='!). This will avoid possible
8016: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
8017: related to security fixes. Lower bounds can be added too, using
8018: '>' or '>='. For example,
1.266 martin 8019: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.205 wiz 8020: versions 1.0 (included) to 1.2 (excluded) of
1.266 martin 8021: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
1.205 wiz 8022: issue.</p>
8023: <p>Entries should always be added at the bottom of the file.</p>
8024: <p>When fixing packages, please modify the upper bound of the
8025: corresponding entry. To continue the previous example, if a fix
8026: was backported to version 1.1nb2, change the previous pattern to
1.266 martin 8027: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.205 wiz 8028: <p>To locally test a package version pattern against a
8029: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
8030: pmatch</strong></span> command.</p>
8031: <p>The URL should be as permanent as possible and provide as
8032: much information about the issue as possible. CVE entries are
8033: preferred.</p>
8034: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.31 wiz 8035: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 8036: <p>After fixing the vulnerability by a patch, its
1.31 wiz 8037: <code class="varname">PKGREVISION</code> should be increased (this is of
8038: course not necessary if the problem is fixed by using a newer
8039: release of the software), and the pattern in the
8040: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 8041: <p>Also, if the fix should be applied to the stable pkgsrc
8042: branch, be sure to submit a pullup request!</p>
8043: <p>Binary packages already on ftp.NetBSD.org will be handled
8044: semi-automatically by a weekly cron job.</p>
1.205 wiz 8045: <p>In case a security issue is disputed, please contact
8046: pkgsrc-security@NetBSD.org.</p>
1.1 dsieger 8047: </div>
1.41 asau 8048: <div class="sect2">
1.1 dsieger 8049: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8050: <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 8051: <p>When making fixes to an existing package it can be useful
8052: to change the version number in <code class="varname">PKGNAME</code>. To
8053: avoid conflicting with future versions by the original author, a
1.266 martin 8054: <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 8055: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.266 martin 8056: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
8057: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 8058: <pre class="programlisting">
8059: DISTNAME= foo-17.42
8060: PKGREVISION= 9
1.111 sevan 8061: </pre>
1.1 dsieger 8062: <p>will result in a <code class="varname">PKGNAME</code> of
1.266 martin 8063: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
8064: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 8065: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8066: <code class="varname">PKGNAME_NOREV</code>.</p>
8067: <p>When a new release of the package is released, the
8068: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8069: minor release of the above package, things should be like:</p>
8070: <pre class="programlisting">
8071: DISTNAME= foo-17.43
1.111 sevan 8072: </pre>
1.1 dsieger 8073: <p><code class="varname">PKGREVISION</code> should be incremented for any
8074: non-trivial change in the resulting binary package. Without a
8075: <code class="varname">PKGREVISION</code> bump, someone with the previous
8076: version installed has no way of knowing that their package is out
8077: of date. Thus, changes without increasing
8078: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8079: trivial that no reasonable person would want to upgrade", and this
8080: is the rough test for when increasing
8081: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8082: changes that do not merit increasing
8083: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 8084: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8085: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.274 wiz 8086: <code class="varname">MAINTAINER</code>, or
1.169 rillig 8087: comments in Makefile.</p></li>
8088: <li class="listitem"><p>Changing build variables if the resulting binary
8089: package is the same.</p></li>
8090: <li class="listitem"><p>Changing
8091: <code class="filename">DESCR</code>.</p></li>
8092: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
8093: default options don't change.</p></li>
1.1 dsieger 8094: </ul></div>
8095: <p>Examples of changes that do merit an increase to
8096: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 8097: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 8098: <li class="listitem"><p>Security fixes</p></li>
8099: <li class="listitem"><p>Changes or additions to a patch
8100: file</p></li>
8101: <li class="listitem"><p>Changes to the
8102: <code class="filename">PLIST</code></p></li>
8103: <li class="listitem"><p>A dependency is changed or
8104: renamed.</p></li>
1.1 dsieger 8105: </ul></div>
8106: <p>PKGREVISION must also be incremented when dependencies have ABI
8107: changes.</p>
8108: </div>
1.41 asau 8109: <div class="sect2">
1.1 dsieger 8110: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8111: <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 8112: <p>When you want to replace the same text in multiple files, or
8113: multiple times in the same file, it is cumbersome to maintain a patch
8114: file for this. This is where the SUBST framework steps in. It provides an
8115: easy-to-use interface for replacing text in files. It just needs the
8116: following information:</p>
8117: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8118: <li class="listitem"><p>In which phase of the package build cycle should the
8119: replacement happen?</p></li>
8120: <li class="listitem"><p>In which files should the replacement
1.172 rillig 8121: happen?</p></li>
1.180 rillig 8122: <li class="listitem"><p>Which text should be replaced with
8123: what?</p></li>
1.172 rillig 8124: </ul></div>
8125: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.180 rillig 8126: variables. A minimal example is:</p>
8127: <pre class="programlisting">
8128: SUBST_CLASSES+= paths
8129: SUBST_STAGE.paths= pre-configure
8130: SUBST_FILES.paths= src/*.c
8131: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
8132: </pre>
8133: <p>Translated into English, it means: In the pre-configure stage (that
8134: is, after applying the patches from the patches/ directory and before
8135: running the configure script and the portability check), replace the text
8136: <code class="literal">/usr/local</code> with the content of the variable
8137: <code class="varname">PREFIX</code>.</p>
8138: <p>Each SUBST block starts by appending an identifier to
8139: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
8140: identifier can be chosen freely by the package. If there should ever be
8141: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
8142: early, so don't worry about name collisions.</p>
8143: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
8144: SUBST block are parameterized using this identifier. In the remainder of
8145: this section, these parameterized variables are written as
8146: <code class="varname">SUBST_STAGE.*</code>.</p>
8147: <pre class="programlisting">
8148: SUBST_CLASSES+= paths
8149: SUBST_STAGE.paths= pre-configure
8150: SUBST_MESSAGE.paths= Fixing absolute paths.
8151: SUBST_FILES.paths= src/*.c
8152: SUBST_FILES.paths+= scripts/*.sh
8153: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
8154: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8155: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
8156: </pre>
8157: <p>To get a complete picture about the SUBST substitutions, run
8158: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
8159: expected, run pkglint on the package, which detects several typical
8160: mistakes surrounding the SUBST blocks. For any questions that might
8161: remain after this, have a look at
8162: <code class="filename">mk/subst.mk</code>.</p>
8163: <div class="sect3">
8164: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8165: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
1.180 rillig 8166: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
8167: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
8168: <code class="literal">pre-configure</code> is used most often, by far. The most
8169: popular stages are, in chronological order:</p>
8170: <div class="variablelist"><dl class="variablelist">
8171: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
8172: <dd>
8173: <p>The substitutions are applied immediately after the
8174: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
8175: package will leave no traces of the original files.</p>
8176: <p>When the substitution applies to files for which there is also a
8177: patch in the <code class="filename">patches/</code> directory, this means that the
8178: patches will be computed based on the result of the substitution. When
8179: these patches are sent to the upstream maintainer later, to be fixed in
8180: the upstream package, these patches may no longer match what the upstream
8181: author is used to. Because of this, <code class="literal">pre-configure</code> is
8182: often a better choice.</p>
8183: </dd>
8184: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
8185: <dd>
8186: <p>The substitutions are applied after the patches from the
8187: <code class="filename">patches/</code> directory. This makes it possible to run
8188: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.207 leot 8189: 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 8190: <p>When updating the patches, it is helpful to explicitly separate the
8191: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
8192: configure</strong></span>, and to only edit the patches between these commands.
8193: Otherwise the substitutions from the SUBST block will end up in the patch
8194: file. When this happens in really obvious ways, pkglint will complain
8195: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
8196: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
8197: can only detect these really obvious
8198: cases.</p>
8199: </dd>
8200: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
8201: <dd><p>This stage should only be used if the package defines a
8202: <code class="literal">pre-configure</code> action itself, and the substitution must
8203: happen after that. Typical examples are packages that use the
8204: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
8205: script from
8206: <code class="filename">configure.ac</code>.</p></dd>
8207: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
8208: <dd><p>This stage is used to fix up any mistakes by the
8209: configure stage.</p></dd>
8210: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
8211: <dd><p>This stage should only be used for substitutions that are
8212: clearly related to building the package, not for fixing the
8213: configuration. Substitutions for pathnames (such as replacing
8214: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
8215: user names (such as replacing <code class="literal">@MY_USER@</code> with the
8216: actual username) belong in pre-configure or post-configure
8217: instead.</p></dd>
8218: <dt><span class="term"><code class="literal">post-build</code></span></dt>
8219: <dd>
8220: <p>Just as with pre-build, this stage should only be used
8221: for substitutions that are clearly related to building the package, not
8222: for fixing the configuration. Substitutions for pathnames (such as
8223: replacing <code class="filename">/usr/local</code> with
8224: <code class="literal">${PREFIX}</code>) or user names (such as replacing
8225: <code class="literal">@MY_USER@</code> with the actual username) belong in
8226: pre-configure or post-configure instead.</p>
8227: <p>A typical use is to update pkg-config files to include the rpath
8228: compiler options.</p>
8229: </dd>
8230: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8231: <dd><p>In general, the install phase should be as simple as
8232: possible. As with the pre-build and post-build stages, it should not be
8233: used to fix pathnames or user names, these belong in pre-configure
8234: instead. There are only few legitimate use cases for applying
8235: substitutions in this stage.</p></dd>
8236: </dl></div>
8237: </div>
8238: <div class="sect3">
8239: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8240: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.180 rillig 8241: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8242: filename patterns. These patterns are relative to
8243: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8244: A typical example is:</p>
8245: <pre class="programlisting">
8246: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8247: </pre>
8248: <p>The above patterns, especially the last, are quite broad. The SUBST
8249: implementation checks that each filename pattern that is mentioned here
8250: has an effect. For example, if none of the
8251: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8252: and substituted, that filename pattern is redundant and should be left
1.181 rillig 8253: out. By default, the SUBST framework will complain with an error message.
8254: If the text to be substituted occurs in some of the files from a single
8255: pattern, but not in all of them, that is totally ok, and the SUBST
1.180 rillig 8256: framework will only print an INFO message for those files.</p>
8257: <p>If there is a good reason for having redundant filename patterns,
1.181 rillig 8258: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.180 rillig 8259: <p>Another popular way of choosing the files for the substitutions is
8260: via a shell command, like this:</p>
8261: <pre class="programlisting">
1.181 rillig 8262: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 8263: SUBST_FILES.path= ${C_FILES_CMD:sh}
8264: </pre>
8265: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8266: freely chosen and independent of the SUBST framework.</p>
8267: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8268: lists each file individually. Thereby chances are higher that there are
8269: filename patterns in which no substitution happens. Since the SUBST
8270: framework cannot know whether the filename patterns in
8271: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8272: Makefile (where any redundant filename pattern would be suspicious) or
8273: been generated by a shell command (in which redundant filename patterns
8274: are more likely and to be expected), it will complain about these
8275: redundant filename patterns. Therefore, SUBST blocks that use a shell
8276: command to generate the list of filename patterns often need to set
8277: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8278: </div>
8279: <div class="sect3">
8280: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8281: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
1.180 rillig 8282: <p>In most cases, the substitutions are given using one or more
1.259 leot 8283: <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 8284: <pre class="programlisting">
8285: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8286: </pre>
8287: <p>Each of the sed commands needs to be preceded by the
8288: <code class="literal">-e</code> option and should be specified on a line of its
8289: own, to avoid hiding short sed commands at the end of a line.</p>
8290: <p>Since the sed commands often contain shell metacharacters as the
8291: separator (the <code class="literal">|</code> in the above example), it is common
8292: to enclose them in single quotes.</p>
8293: <p>A common substitution is to replace placeholders of the form
8294: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8295: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8296: <pre class="programlisting">
8297: SUBST_VARS.path= PREFIX
8298: </pre>
8299: <p>This type of substitutions is typically done by the GNU configure
1.181 rillig 8300: scripts during the do-configure stage, but in some cases these need to be
8301: overridden. The same pattern is also used when a package defines patches
8302: that replace previously hard-coded paths like
8303: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8304: placeholder first, which then gets substituted by the actual
8305: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8306: cases, it works equally well to just use the SUBST framework to directly
8307: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8308: thereby omitting the intermediate patch file.</p>
1.180 rillig 8309: <p>If the above is not flexible enough, it is possible to not use sed
8310: at all for the substitution but to specify an entirely different command,
8311: like this:</p>
1.1 dsieger 8312: <pre class="programlisting">
1.180 rillig 8313: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8314: </pre>
8315: <p>This is used for the few remaining packages in which the
8316: distributed files use Windows-style line endings that need to be
8317: converted to UNIX-style line endings.</p>
8318: </div>
8319: <div class="sect3">
8320: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8321: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
1.180 rillig 8322: <p>When a SUBST block is applied during a package build, a message is
8323: logged. The default message is fine for most purposes but can be
8324: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8325: message.</p>
8326: </div>
1.1 dsieger 8327: </div>
8328: </div>
1.41 asau 8329: <div class="sect1">
1.1 dsieger 8330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 8331: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 8332: <div class="sect2">
1.1 dsieger 8333: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8334: <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 8335: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8336: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8337: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8338: with the name of each file to download as an argument, expecting
8339: it to output the URL of the directory from which to download
1.207 leot 8340: 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 8341: example of this usage.</p>
8342: <p>If the download can't be automated, because the user must
8343: submit personal information to apply for a password, or must pay
8344: for the source, or whatever, you can set
8345: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8346: displayed to the user before aborting the build. Example:</p>
8347: <pre class="programlisting">
8348: FETCH_MESSAGE= "Please download the files"
8349: FETCH_MESSAGE+= " "${DISTFILES:Q}
8350: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 8351: </pre>
1.1 dsieger 8352: </div>
1.41 asau 8353: <div class="sect2">
1.1 dsieger 8354: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8355: <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 8356: <p>Sometimes authors of a software package make some
8357: modifications after the software was released, and they put up a
8358: new distfile without changing the package's version number. If a
8359: package is already in pkgsrc at that time, the checksum will
8360: no longer match. The contents of the new distfile should be
8361: compared against the old one before changing anything, to make
8362: sure the distfile was really updated on purpose, and that
8363: no trojan horse or so crept in.
8364: Please mention that the distfiles were compared and what was found
1.53 rodent 8365: in your commit message.</p>
1.109 wiz 8366: <p>Then, the correct way to work around this is to set
8367: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8368: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8369: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8370: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 8371: <code class="varname">PATCHFILES</code> for this package will be put in that
1.266 martin 8372: 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 8373: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 8374: including the <code class="filename">nbX</code> suffix) or a date stamp can
8375: be appended, like
8376: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169 rillig 8377: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8378: name does not contain a version and the distfile is apt to change. In
8379: cases where the likelihood of this is very small,
8380: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8381: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8382: distfile name changes, even if a package is being moved or
8383: renamed.</p>
1.53 rodent 8384: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8385: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8386: path in the filenames.
1.53 rodent 8387: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8388: Furthermore, a mail to the package's authors seems appropriate
8389: telling them that changing distfiles after releases without
8390: changing the file names is not good practice.</p>
8391: </div>
1.88 tnn 8392: <div class="sect2">
8393: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8394: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169 rillig 8395: <p>Helper methods exist for packages hosted on github.com which
8396: will often have distfile names that clash with other packages, for
8397: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8398: from below:</p>
1.88 tnn 8399: <div class="sect3">
8400: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8401: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169 rillig 8402: <p>If your distfile URL looks similar to
1.189 bacon 8403: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.169 rillig 8404: then you are packaging a tagged release.</p>
1.88 tnn 8405: <pre class="programlisting">
1.189 bacon 8406: DISTNAME= example-1.0
1.90 tnn 8407: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8408: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8409: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 8410: EXTRACT_SUFX= .zip
8411: </pre>
1.230 gutterid 8412: <p>Here, DISTNAME combined with use of GITHUB_TAG leads the
8413: file fetching infrastructure to save the resulting file locally as
8414: <code class="literal">example-1.0.zip</code>.</p>
1.88 tnn 8415: </div>
8416: <div class="sect3">
8417: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8418: <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>
1.189 bacon 8419: <p>If your distfile looks similar to
8420: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8421: release, then set the package version to 0.0.0.N, where N is the number
8422: of commits to the repository, and set GITHUB_TAG to the commit hash.
8423: This will (almost) ensure that the first tagged release will have a
8424: version greater than this one so that package upgrades will function
8425: properly.</p>
8426: <pre class="programlisting">
8427: DISTNAME= example-0.0.0.347
8428: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8429: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8430: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8431: </pre>
8432: </div>
8433: <div class="sect3">
8434: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8435: <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>
1.189 bacon 8436: <p>If your distfile looks similar to
8437: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8438: then include the last release version and the commit count since that
8439: release in the package version and set GITHUB_TAG to the commit hash.
8440: The latest release and commit count are shown in the output of
8441: "git describe --tags":
8442: </p>
8443: <pre class="screen">
8444: # git clone https://github.com/username/example
8445: # cd example
8446: # git describe --tags
8447: 1.2.3-5-g988881a
8448: </pre>
1.88 tnn 8449: <pre class="programlisting">
1.189 bacon 8450: DISTNAME= example-1.2.3.5
8451: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8452: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8453: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 8454: </pre>
1.88 tnn 8455: </div>
8456: <div class="sect3">
8457: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8458: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.169 rillig 8459: <p>If your distfile URL looks similar to
1.189 bacon 8460: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.169 rillig 8461: then you are packaging a release.</p>
1.88 tnn 8462: <pre class="programlisting">
8463: DISTNAME= offensive-1.6
1.90 tnn 8464: PKGNAME= ${DISTNAME:S/offensive/proper/}
8465: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8466: GITHUB_PROJECT= example
1.90 tnn 8467: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8468: EXTRACT_SUFX= .zip
1.111 sevan 8469: </pre>
1.88 tnn 8470: </div>
8471: </div>
1.1 dsieger 8472: </div>
1.41 asau 8473: <div class="sect1">
1.1 dsieger 8474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 8475: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8476: <div class="sect2">
1.1 dsieger 8477: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8478: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8479: <p>pkgsrc supports many different machines, with different
8480: object formats like a.out and ELF, and varying abilities to do
8481: shared library and dynamic loading at all. To accompany this,
8482: varying commands and options have to be passed to the
8483: compiler, linker, etc. to get the Right Thing, which can be
8484: pretty annoying especially if you don't have all the machines
8485: at your hand to test things. The
1.207 leot 8486: <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.266 martin 8487: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8488: both static and dynamic libraries from a set of source files,
8489: thus being platform-independent.</p>
8490: <p>Here's how to use libtool in a package in seven simple
8491: steps:</p>
1.23 wiz 8492: <div class="orderedlist"><ol class="orderedlist" type="1">
8493: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8494: Makefile.</p></li>
1.266 martin 8495: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8496: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8497: add it to the definition of <code class="varname">CC</code>, if only
8498: libraries are being built in a given Makefile. This one command
8499: will build both PIC and non-PIC library objects, so you need not
8500: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8501: <li class="listitem">
1.1 dsieger 8502: <p>For the linking of the library, remove any
1.266 martin 8503: <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
8504: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8505: <pre class="programlisting">
8506: ${LIBTOOL} --mode=link \
8507: ${CC} -o ${.TARGET:.a=.la} \
8508: ${OBJS:.o=.lo} \
8509: -rpath ${PREFIX}/lib \
8510: -version-info major:minor
1.111 sevan 8511: </pre>
1.1 dsieger 8512: <p>Note that the library is changed to have a
8513: <code class="filename">.la</code> extension, and the objects are
8514: changed to have a <code class="filename">.lo</code>
8515: extension. Change <code class="varname">OBJS</code> as
8516: necessary. This automatically creates all of the
8517: <code class="filename">.a</code>,
8518: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8519: necessary) in the build directory. Be sure to include
1.266 martin 8520: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8521: minor are zero, as libtool will otherwise strip off the
8522: shared library version.</p>
8523: <p>From the libtool manual:</p>
8524: <pre class="programlisting">
8525: So, libtool library versions are described by three integers:
8526:
8527: CURRENT
8528: The most recent interface number that this library implements.
8529:
8530: REVISION
8531: The implementation number of the CURRENT interface.
8532:
8533: AGE
8534: The difference between the newest and oldest interfaces that
8535: this library implements. In other words, the library implements
8536: all the interface numbers in the range from number `CURRENT -
8537: AGE' to `CURRENT'.
8538:
8539: If two libraries have identical CURRENT and AGE numbers, then the
8540: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 8541: </pre>
1.266 martin 8542: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8543: different results for a.out and ELF (excluding symlinks)
8544: in only one case. An ELF library of the form
1.266 martin 8545: <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 8546: will have a symlink of
1.266 martin 8547: <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 8548: on an a.out platform. This is handled
8549: automatically.</p>
1.266 martin 8550: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8551: directory of the library being built.</p>
8552: <p>In the <code class="filename">PLIST</code>, include only the
8553: <code class="filename">.la</code> file, the other files will be
8554: added automatically.</p>
8555: </li>
1.23 wiz 8556: <li class="listitem">
1.1 dsieger 8557: <p>When linking shared object (<code class="filename">.so</code>)
1.259 leot 8558: 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.266 martin 8559: shared libraries, use <span class="quote">“<span class="quote">-module
8560: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8561: tacked on.</p>
8562: <p>The <code class="filename">PLIST</code> file gets the
8563: <code class="filename">foo.so</code> entry.</p>
8564: </li>
1.23 wiz 8565: <li class="listitem">
1.1 dsieger 8566: <p>When linking programs that depend on these libraries
8567: <span class="emphasis"><em>before</em></span> they are installed, preface
1.266 martin 8568: 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}
8569: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8570: libraries (static or shared), but please be aware that
8571: libtool will not allow you to specify a relative path in
1.266 martin 8572: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8573: expects you to change that argument to be the
8574: <code class="filename">.la</code> file. e.g.</p>
8575: <pre class="programlisting">
8576: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 8577: </pre>
1.1 dsieger 8578: <p>should be changed to:</p>
8579: <pre class="programlisting">
8580: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 8581: </pre>
1.1 dsieger 8582: <p>and it will do the right thing with the libraries.</p>
8583: </li>
1.23 wiz 8584: <li class="listitem">
1.259 leot 8585: <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>
1.266 martin 8586: 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}
8587: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8588: <code class="filename">.la</code>. e.g.</p>
8589: <pre class="programlisting">
1.22 jakllsch 8590: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 8591: </pre>
1.1 dsieger 8592: <p>This will install the static <code class="filename">.a</code>,
8593: shared library, any needed symlinks, and run
1.259 leot 8594: <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 8595: </li>
1.23 wiz 8596: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8597: the <code class="filename">.la</code>
8598: file (this is a change from previous behaviour).</p></li>
8599: </ol></div>
8600: </div>
1.41 asau 8601: <div class="sect2">
1.1 dsieger 8602: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8603: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8604: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8605: package Makefile. This will override the package's own libtool
8606: in most cases. For older libtool using packages, libtool is
8607: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8608: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8609: configure; find work*/ -name libtool</strong></span>.</p>
8610: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8611: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.266 martin 8612: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8613: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8614: package's libtool script(s), set it as appropriate.</p>
8615: <p>If you do not need <code class="filename">*.a</code> static
8616: libraries built and installed, then use
8617: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8618: <p>If your package makes use of the platform-independent library
8619: for loading dynamic shared objects, that comes with libtool
8620: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8621: <p>Some packages use libtool incorrectly so that the package
8622: may not work or build in some circumstances. Some of the more
8623: common errors are:</p>
1.41 asau 8624: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8625: <li class="listitem">
1.1 dsieger 8626: <p>The inclusion of a shared object (-module) as a dependent library in an
8627: executable or library. This in itself isn't a problem if one of two things
8628: has been done:</p>
1.23 wiz 8629: <div class="orderedlist"><ol class="orderedlist" type="1">
8630: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8631: <code class="filename">libfoo.la</code>, not
8632: <code class="filename">foo.la</code></p></li>
1.23 wiz 8633: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8634: </ol></div>
8635: </li>
1.23 wiz 8636: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8637: The function lt_dlinit() should be called and the macro
8638: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8639: executables.</p></li>
8640: </ul></div>
8641: </div>
1.41 asau 8642: <div class="sect2">
1.1 dsieger 8643: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8644: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8645: <p>If a package needs GNU autoconf or automake to be executed
1.223 nia 8646: to regenerate the
8647: <code class="filename">configure</code>
8648: script and <code class="filename">Makefile.in</code> makefile
8649: templates from <code class="filename">configure.ac</code> and
8650: <code class="filename">Makefile.am</code>,
8651: then they should be executed in a pre-configure target:</p>
1.1 dsieger 8652: <pre class="programlisting">
1.223 nia 8653: USE_TOOLS+= autoconf automake autoreconf
8654: GNU_CONFIGURE= yes
1.1 dsieger 8655: ...
8656:
8657: pre-configure:
1.223 nia 8658: set -e; cd ${WRKSRC} && autoreconf -fi
1.1 dsieger 8659: ...
1.111 sevan 8660: </pre>
1.223 nia 8661: <p>Packages which use GNU Automake will sometimes
8662: require GNU Make (<code class="literal">gmake</code> in
8663: <code class="varname">USE_TOOLS</code>),
8664: but not always. Note that autoreconf
8665: only needs to be executed if <code class="filename">configure.ac</code>
8666: or Makefiles are modified, or <code class="filename">configure</code>
8667: is not present.</p>
1.1 dsieger 8668: <p>There are times when the configure process makes
8669: additional changes to the generated files, which then causes
8670: the build process to try to re-execute the automake sequence.
8671: This is prevented by touching various files in the configure
8672: stage. If this causes problems with your package you can set
8673: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8674: Makefile.</p>
8675: </div>
1.223 nia 8676: <div class="sect2">
8677: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8678: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
1.223 nia 8679: <p>Packages using Meson to configure need to include:
8680:
8681: </p>
8682: <pre class="programlisting">
8683: .include "../../devel/meson/build.mk"
8684: </pre>
8685: <p>In nearly all cases (any program with dependencies),
8686: pkg-config needs to be added to
8687: <code class="varname">USE_TOOLS</code>. If the package installs
8688: translation files for non-English languages, also
8689: add msgfmt and xgettext:
8690:
8691: </p>
8692: <pre class="programlisting">
8693: USE_TOOLS+= pkg-config msgfmt xgettext
8694: </pre>
8695: <p>If any options need to be passed to Meson, use
8696: <code class="varname">MESON_ARGS</code> instead of
8697: <code class="varname">CONFIGURE_ARGS</code>:
8698:
8699: </p>
8700: <pre class="programlisting">
8701: MESON_ARGS+= -Dx11=false
8702: </pre>
8703: </div>
1.260 wiz 8704: <div class="sect2">
8705: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8706: <a name="endian"></a>21.3.5. Determining the endianness</h3></div></div></div>
1.260 wiz 8707: <p>To determine the endianness of the target platform,
8708: have a look at <code class="filename">mk/endian.mk</code>.</p>
8709: </div>
1.1 dsieger 8710: </div>
1.41 asau 8711: <div class="sect1">
1.1 dsieger 8712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 8713: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41 asau 8714: <div class="sect2">
1.1 dsieger 8715: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8716: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.244 gutterid 8717: <p>Compilers for the C and C++ languages come with
1.1 dsieger 8718: the NetBSD base system. By default, pkgsrc assumes that a package
8719: is written in C and will hide all other compilers (via the wrapper
1.266 martin 8720: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.243 gutterid 8721: <p>To declare which languages should be made available through
8722: pkgsrc's compiler wrappers, use
1.1 dsieger 8723: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.212 wiz 8724: currently are:
1.238 wiz 8725: </p>
1.212 wiz 8726: <pre class="programlisting">
1.244 gutterid 8727: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.238 wiz 8728: </pre>
1.212 wiz 8729: <p>
8730: (and any combination). The default is
1.266 martin 8731: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8732: written in C++, usually need a C compiler for the configure
1.244 gutterid 8733: phase.</p>
1.250 jnemeth 8734: <p>To declare which features a package requires from the
1.243 gutterid 8735: compiler, set either <code class="varname">USE_CC_FEATURES</code>
8736: or <code class="varname">USE_CXX_FEATURES</code>. Allowed values for
8737: <code class="varname">USE_CC_FEATURES</code> are currently:
8738: </p>
8739: <pre class="programlisting">
8740: c11, c99, has_include
8741: </pre>
8742: <p>
8743: Allowed values for <code class="varname">USE_CXX_FEATURES</code> are
8744: currently:
8745: </p>
8746: <pre class="programlisting">
8747: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
8748: charconv, parallelism_ts, unique_ptr, put_time,
8749: is_trivially_copy_constructible
8750: </pre>
8751: <p>
1.251 gutterid 8752: Note at present these variables only affect use of GCC, not other
8753: compilers.
1.243 gutterid 8754: </p>
1.244 gutterid 8755: <p>Language variants like <code class="literal">gnu99</code> and
8756: <code class="literal">c++11</code> can be specified in <code class="varname">FORCE_C_STD</code>
8757: and <code class="varname">FORCE_CXX_STD</code> if the package does not explicitly set
8758: <code class="literal">-std=...</code> when compiling (i.e. the package
8759: assumes the compiler defaults to C++11 or some other standard).
8760: This is a common bug in upstream build systems.</p>
8761: <p>Allowed values for <code class="varname">FORCE_C_STD</code> are
8762: currently:
8763: </p>
8764: <pre class="programlisting">
8765: c90, c99, c11, gnu90, gnu99, gnu11
8766: </pre>
8767: <p>
8768: </p>
8769: <p>Allowed values for <code class="varname">FORCE_CXX_STD</code> are
8770: currently:
8771: </p>
8772: <pre class="programlisting">
8773: c++03, c++11, c++14, c++17, c++20,
8774: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
8775: </pre>
8776: <p>
1.251 gutterid 8777: Note at present these variables only affect use of GCC and Clang.
1.244 gutterid 8778: </p>
1.1 dsieger 8779: </div>
1.41 asau 8780: <div class="sect2">
1.1 dsieger 8781: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8782: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 8783: <p>If a program is written in Java, use the Java framework in
8784: pkgsrc. The package must include
8785: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8786: provides the following variables:</p>
1.41 asau 8787: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8788: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8789: dependency on the JDK is added. If
1.266 martin 8790: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8791: there is only a runtime dependency on the JDK. The default is
1.266 martin 8792: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8793: JDK.</p></li>
1.23 wiz 8794: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8795: a package needs a Java2 implementation. The supported values
1.266 martin 8796: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8797: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8798: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8799: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8800: above. This variable is not set by default.</p></li>
1.24 wiz 8801: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8802: automatically set to the runtime location of the used Java
8803: implementation dependency. It may be used to set
8804: <code class="varname">JAVA_HOME</code> to a good value if the program
8805: needs this variable to be defined.
8806: </p></li>
1.1 dsieger 8807: </ul></div>
8808: </div>
1.41 asau 8809: <div class="sect2">
1.1 dsieger 8810: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8811: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
1.205 wiz 8812: <p>If a program is written in Go and has any dependencies on
8813: other Go modules, have the package include
8814: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8815: <div class="orderedlist"><ol class="orderedlist" type="1">
8816: <li class="listitem"><p>Generate a list of those dependencies with
8817: <span class="command"><strong>make clean && make patch && make show-go-modules >
8818: go-modules.mk</strong></span>.</p></li>
1.223 nia 8819: <li class="listitem"><p>Prepend
8820: <code class="literal">.include "go-modules.mk"</code> to any other
8821: <code class="literal">.include</code>s.</p></li>
8822: <li class="listitem"><p>Incorporate these modules in
8823: <code class="filename">distinfo</code> with <span class="command"><strong>make
8824: makesum</strong></span>.</p></li>
8825: </ol></div>
8826: </div>
8827: <div class="sect2">
8828: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8829: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
1.223 nia 8830: <p>If a program is written in Rust and uses Cargo to build,
8831: have the package include
8832: <code class="filename">../../lang/rust/cargo.mk</code>.</p>
8833: <div class="orderedlist"><ol class="orderedlist" type="1">
1.275 ! wiz 8834: <li class="listitem"><p>It will usually depend on a lot of other code
! 8835: (distributed in so-called crates). Generate a list of those
! 8836: dependencies with <span class="command"><strong>make extract && make
! 8837: print-cargo-depends >
! 8838: cargo-depends.mk</strong></span>.</p></li>
1.223 nia 8839: <li class="listitem"><p>Prepend
8840: <code class="literal">.include "cargo-depends.mk"</code> to any other
8841: <code class="literal">.include</code>s.</p></li>
1.205 wiz 8842: <li class="listitem"><p>Incorporate these modules in
8843: <code class="filename">distinfo</code> with <span class="command"><strong>make
8844: makesum</strong></span>.</p></li>
8845: </ol></div>
8846: </div>
8847: <div class="sect2">
8848: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8849: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.203 nia 8850: <p>If your package contains interpreted Perl scripts, add
1.266 martin 8851: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8852: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8853: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8854: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8855: that you want adjusted. Every occurrence of
8856: <code class="filename">*/bin/perl</code> in a she-bang line will be
1.210 gutterid 8857: replaced with the full path to the Perl executable.</p>
8858: <p>If a particular version of Perl is needed, set the
1.1 dsieger 8859: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.266 martin 8860: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
8861: <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 8862: about handling Perl modules.</p>
8863: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
8864: for the language now known as Raku.</p>
1.1 dsieger 8865: </div>
1.41 asau 8866: <div class="sect2">
1.1 dsieger 8867: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8868: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 8869: <p><code class="varname">REPLACE_SH</code>,
8870: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8871: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.225 gutterid 8872: she-bangs in files. Please use the appropriate one, preferring
8873: <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.74 wiz 8874: Each should contain a list of scripts, relative to
8875: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8876: occurrence of the matching shell in a she-bang line will be
8877: replaced with the full path to the shell executable.
1.40 wiz 8878: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8879: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8880: </div>
1.41 asau 8881: <div class="sect2">
1.40 wiz 8882: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8883: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.210 gutterid 8884: <p>There are further similar REPLACE variables available, e.g.,
8885: <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
8886: and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.211 gutterid 8887: noted above, have their actions defined centrally in
1.210 gutterid 8888: <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.211 gutterid 8889: languages define the actions of these variables within their own
8890: dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
1.245 gutterid 8891: actioned in <code class="filename">lang/php/replace.mk</code>, and
1.211 gutterid 8892: <code class="varname">REPLACE_PYTHON</code> is actioned in
1.210 gutterid 8893: <code class="filename">lang/python/application.mk</code>. For other languages,
8894: consult the mk files found within their specific directories (the
1.216 gutterid 8895: naming convention varies), or check the list found in
1.266 martin 8896: <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.210 gutterid 8897: <p>Currently, special handling for other languages varies
1.1 dsieger 8898: in pkgsrc. If a compiler package provides a
8899: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8900: just add a (build) dependency on the appropriate compiler
8901: package.</p>
8902: </div>
8903: </div>
1.41 asau 8904: <div class="sect1">
1.1 dsieger 8905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 8906: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8907: <p>The most common failures when building a package are that
8908: some platforms do not provide certain header files, functions or
8909: libraries, or they provide the functions in a library that the
8910: original package author didn't know. To work around this, you
8911: can rewrite the source code in most cases so that it does not
8912: use the missing functions or provides a replacement function.</p>
1.41 asau 8913: <div class="sect2">
1.1 dsieger 8914: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8915: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8916: <p>If a package already comes with a GNU configure script, the
8917: preferred way to fix the build failure is to change the
8918: configure script, not the code. In the other cases, you can
8919: utilize the C preprocessor, which defines certain macros
8920: depending on the operating system and hardware architecture it
8921: compiles for. These macros can be queried using for example
8922: <code class="varname">#if defined(__i386)</code>. Almost every operating
8923: system, hardware architecture and compiler has its own macro.
8924: For example, if the macros <code class="varname">__GNUC__</code>,
8925: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8926: are all defined, you know that you are using NetBSD on an i386
8927: compatible CPU, and your compiler is GCC.</p>
8928: <p>The list of the following macros for hardware and
8929: operating system depends on the compiler that is used. For
8930: example, if you want to conditionally compile code on Solaris,
8931: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8932: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8933: <div class="sect3">
1.1 dsieger 8934: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8935: <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 8936: <p>To distinguish between specific NetBSD versions,
8937: you should use the following code.</p>
8938: <pre class="programlisting">
8939: #ifdef __NetBSD__
8940: #include <sys/param.h>
8941: #if __NetBSD_Prereq__(9,99,17)
8942: /* use a newer feature */
8943: #else
8944: /* older code */
8945: #endif
8946: #endif
8947:
8948: #ifndef _WIN32
8949: /* Unix-like specific code */
8950: #endif
8951: </pre>
1.1 dsieger 8952: <p>To distinguish between 4.4 BSD-derived systems and the
8953: rest of the world, you should use the following code.</p>
8954: <pre class="programlisting">
8955: #include <sys/param.h>
8956: #if (defined(BSD) && BSD >= 199306)
8957: /* BSD-specific code goes here */
8958: #else
8959: /* non-BSD-specific code goes here */
8960: #endif
8961: </pre>
1.223 nia 8962: <p>You can also test for the following macros:</p>
1.1 dsieger 8963: <pre class="programlisting">
1.45 obache 8964: Cygwin __CYGWIN__
8965: DragonFly __DragonFly__
1.1 dsieger 8966: FreeBSD __FreeBSD__
1.45 obache 8967: Haiku __HAIKU__
1.1 dsieger 8968: IRIX __sgi (TODO: get a definite source for this)
1.223 nia 8969: Linux __linux
1.83 dholland 8970: Mac OS X __APPLE__
1.45 obache 8971: Minix3 __minix
1.1 dsieger 8972: NetBSD __NetBSD__
8973: OpenBSD __OpenBSD__
8974: Solaris sun, __sun
8975: </pre>
8976: </div>
1.41 asau 8977: <div class="sect3">
1.1 dsieger 8978: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8979: <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 8980: <pre class="programlisting">
8981: i386 i386, __i386, __i386__
1.223 nia 8982: x86-64 __amd64__, __x86_64__
8983: ARM __arm__
1.1 dsieger 8984: MIPS __mips
8985: SPARC sparc, __sparc
1.223 nia 8986: PowerPC __powerpc
1.1 dsieger 8987: </pre>
8988: </div>
1.41 asau 8989: <div class="sect3">
1.1 dsieger 8990: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8991: <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 8992: <pre class="programlisting">
8993: GCC __GNUC__ (major version), __GNUC_MINOR__
8994: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8995: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8996: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8997: </pre>
8998: </div>
8999: </div>
1.41 asau 9000: <div class="sect2">
1.1 dsieger 9001: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9002: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 9003: <p>Some source files trigger bugs in the compiler, based on
9004: combinations of compiler version and architecture and almost
9005: always relation to optimisation being enabled. Common symptoms
9006: are gcc internal errors or never finishing compiling a
9007: file.</p>
9008: <p>Typically, a workaround involves testing the
9009: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
9010: optimisation for that combination of file,
1.87 tnn 9011: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
9012: <p>This used to be a big problem in the past, but is rarely
9013: needed now as compiler technology has matured. If you still need
9014: to add a compiler specific workaround, please do so in the file
9015: <code class="filename">hacks.mk</code> and describe the symptom and
9016: compiler version as detailed as possible.</p>
1.1 dsieger 9017: </div>
1.41 asau 9018: <div class="sect2">
1.1 dsieger 9019: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9020: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
1.172 rillig 9021: <p>Compilation sometimes fails with an error message like this:</p>
9022: <pre class="programlisting">
9023: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
9024: fatal error: pango/pango.h: No such file or directory
9025: </pre>
9026: <p>The proper way to fix this problem depends on the type of the
9027: header, which is described in the following sections.</p>
9028: <div class="sect3">
9029: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9030: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
1.172 rillig 9031: <p>If the header name looks like it comes from a different package,
9032: that other package should be included via the buildlink3
9033: framework.</p>
9034: <p>First, look whether the header is somewhere in the buildlink3
9035: directory below <code class="varname">WRKDIR</code>. In the above case of
9036: the missing Pango header:</p>
9037: <pre class="programlisting">
9038: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
9039: </pre>
9040: <p>In the case of Pango, the output is:</p>
9041: <pre class="programlisting">
9042: work/.buildlink/include/pango-1.0/pango/pango.h
9043: </pre>
9044: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
9045: in the <code class="filename">.buildlink</code> directory, it would have been
9046: found automatically. There is an extra <code class="filename">pango-1.0</code>
9047: path component though, which means that the compiler command line must
9048: contain an option of the form
9049: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
9050: most cases this option is generated by the configure script, which can be examined using:</p>
9051: <pre class="programlisting">
9052: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
9053: -I/usr/pkg/include/pango-1.0
9054: -I/usr/pkg/include/pango-1.0
9055: -I/usr/pkg/include/pango-1.0
9056: -I/usr/pkg/include/pango-1.0
9057: -I/usr/pkg/include/pango-1.0
9058: </pre>
9059: <p>This looks good. These options are transformed by the buildlink
9060: wrapper to refer to the correct path inside
9061: <code class="filename">work/.buildlink</code>.</p>
9062: <p>Since the compilation fails though, examine the compiler command
9063: lines in <code class="filename">work/.work.log</code> to see whether the
9064: <code class="literal">-I</code> option is included in the particular command
9065: line.</p>
9066: <p>To further analyze the situation, run <span class="command"><strong>bmake
9067: build-env</strong></span>, which sets up an interactive, realistic environment
9068: including all the pkgsrc wrapper commands and environment variables. From
9069: there, try to compile some simple example programs that use the
9070: header.</p>
9071: </div>
9072: <div class="sect3">
9073: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9074: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
1.172 rillig 9075: <p>If the name of the header seems to come from the package itself,
9076: and if the build is run with parallel jobs, the package may have some
9077: undeclared dependencies between the <code class="filename">.c</code> and the
9078: <code class="filename">.h</code> files, and a C file is compiled before its
9079: required header is generated.</p>
9080: <p>To see whether the build runs with parallel jobs, run
9081: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
9082: like this:</p>
9083: <pre class="programlisting">
9084: usr MAKE_JOBS= 7
9085: pkg MAKE_JOBS_SAFE # undefined
9086: def _MAKE_JOBS_N= 7
9087: </pre>
9088: <p>In this case the pkgsrc user has asked pkgsrc to build packages
9089: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
9090: package could have disabled parallel builds by setting
9091: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
9092: in this case it hasn't.</p>
9093: <p>To see whether the build failure is caused by parallel builds,
9094: first save the exact error message and a bit of context, maybe you need
9095: it later for reporting a bug. Next, run:</p>
9096: <pre class="programlisting">
9097: MAKE_JOBS_SAFE=no bmake clean build
9098: </pre>
9099: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
9100: report</a> against the pkgsrc package, including the exact error
9101: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
9102: </div>
1.173 rillig 9103: <div class="sect3">
9104: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9105: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
1.173 rillig 9106: <p>Pkgsrc does not work reliably if any of
9107: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
9108: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
9109: bootstrap program prevents installing pkgsrc in symlink-based
9110: directories. Existing pkgsrc installations are not checked for symlinks
9111: though.</p>
9112: <p>The "No such file or directory" error messages are a typical
9113: symptom of symlinks, and it's quite difficult to find out that this is
9114: the actual cause.</p>
9115: </div>
9116: <div class="sect3">
9117: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9118: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
1.173 rillig 9119: <p>When building a hierarchy of packages, it may happen that one
9120: package is built and then pkgsrc is updated. This situation can provoke
9121: various hard to diagnose build errors. To clean up the situation:</p>
9122: <pre class="programlisting">
1.223 nia 9123: <code class="prompt">$</code> (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.173 rillig 9124: </pre>
1.223 nia 9125: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
9126: prevent running this command in the wrong directory.)</p>
1.173 rillig 9127: <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
9128: that directory as well.</p>
9129: </div>
9130: <div class="sect3">
9131: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9132: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
1.173 rillig 9133: <p>On platforms other than BSD, third-party packages are installed in
9134: <code class="filename">/usr/include</code>, together with the base system. This
9135: means that pkgsrc cannot distinguish between headers provided by the base
9136: system (which it needs) and headers from third-party packages (which are
9137: often included in pkgsrc as well). This can lead to subtle version
9138: mismatches.</p>
9139: <p>In pkgsrc installations that have been active for several years, it
9140: may happen that some files are manually deleted. To exclude this unlikely
9141: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
9142: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
9143: check/fix dependencies.</p>
1.266 martin 9144: <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>
1.173 rillig 9145: for contact information. Be prepared to describe what you have tried so
9146: far and what any error messages were.</p>
9147: </div>
1.172 rillig 9148: </div>
9149: <div class="sect2">
9150: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9151: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 9152: </h3></div></div></div>
1.1 dsieger 9153: <p>This error message often means that a package did not
9154: link to a shared library it needs. The following functions are
9155: known to cause this error message over and over.</p>
9156: <div class="informaltable">
1.106 tnn 9157: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 9158: <colgroup>
9159: <col>
9160: <col>
9161: <col>
9162: </colgroup>
9163: <thead><tr>
9164: <th>Function</th>
9165: <th>Library</th>
9166: <th>Affected platforms</th>
9167: </tr></thead>
9168: <tbody>
9169: <tr>
9170: <td>accept, bind, connect</td>
9171: <td>-lsocket</td>
9172: <td>Solaris</td>
9173: </tr>
9174: <tr>
9175: <td>crypt</td>
9176: <td>-lcrypt</td>
9177: <td>DragonFly, NetBSD</td>
9178: </tr>
9179: <tr>
9180: <td>dlopen, dlsym</td>
9181: <td>-ldl</td>
9182: <td>Linux</td>
9183: </tr>
9184: <tr>
9185: <td>gethost*</td>
9186: <td>-lnsl</td>
9187: <td>Solaris</td>
9188: </tr>
9189: <tr>
9190: <td>inet_aton</td>
9191: <td>-lresolv</td>
9192: <td>Solaris</td>
9193: </tr>
9194: <tr>
9195: <td>nanosleep, sem_*, timer_*</td>
9196: <td>-lrt</td>
9197: <td>Solaris</td>
9198: </tr>
9199: <tr>
9200: <td>openpty</td>
9201: <td>-lutil</td>
9202: <td>Linux</td>
9203: </tr>
9204: </tbody>
9205: </table>
9206: </div>
1.223 nia 9207: <p>To fix these linker errors, it is often sufficient to add
1.1 dsieger 9208: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
9209: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.223 nia 9210: <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.1 dsieger 9211: bmake</strong></span>.</p>
1.41 asau 9212: <div class="sect3">
1.1 dsieger 9213: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9214: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.1 dsieger 9215: <p>When you are using the SunPro compiler, there is another
9216: possibility. That compiler cannot handle the following code:</p>
9217: <pre class="programlisting">
9218: extern int extern_func(int);
9219:
9220: static inline int
9221: inline_func(int x)
9222: {
9223: return extern_func(x);
9224: }
9225:
9226: int main(void)
9227: {
9228: return 0;
9229: }
9230: </pre>
9231: <p>It generates the code for <code class="function">inline_func</code> even if
9232: that function is never used. This code then refers to
9233: <code class="function">extern_func</code>, which can usually not be resolved. To
9234: solve this problem you can try to tell the package to disable inlining
9235: of functions.</p>
9236: </div>
1.228 gutterid 9237: <div class="sect3">
9238: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9239: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
1.228 gutterid 9240: <p>When building for older machine architectures (e.g., i386, PowerPC),
9241: builds may fail because the package expects modern 64-bit atomic functions
9242: which the underlying hardware either doesn't support, or will only support
9243: with specific compiler flags. This is generally handled via inclusion of
9244: mk/atomic64.mk.</p>
9245: </div>
1.1 dsieger 9246: </div>
1.41 asau 9247: <div class="sect2">
1.1 dsieger 9248: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9249: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1 dsieger 9250: <p>Sometimes packages fail to build because the compiler runs
9251: into an operating system specific soft limit. With the
9252: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.223 nia 9253: to unlimit the resources. The allowed values are any combination of
1.266 martin 9254: <span class="quote">“<span class="quote">cputime</span>”</span>,
9255: <span class="quote">“<span class="quote">datasize</span>”</span>,
9256: <span class="quote">“<span class="quote">memorysize</span>”</span>,
9257: <span class="quote">“<span class="quote">stacksize</span>”</span> and
9258: <span class="quote">“<span class="quote">virtualsize</span>”</span>.
1.1 dsieger 9259: Setting this variable is similar to running the shell builtin
1.10 hubertf 9260: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 9261: segment size or maximum stack size of a process, respectively, to
9262: their hard limits.</p>
9263: </div>
9264: </div>
1.41 asau 9265: <div class="sect1">
1.1 dsieger 9266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 9267: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 9268: <div class="sect2">
1.1 dsieger 9269: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9270: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 9271: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 9272: with some operating systems cannot create more than one
9273: directory at a time. As such, you should call
9274: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
9275: <pre class="programlisting">
9276: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
9277: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 9278: </pre>
1.223 nia 9279: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
1.266 martin 9280: directly, you can also append <span class="quote">“<span class="quote"><code class="literal">dir1
9281: dir2</code></span>”</span> to the <code class="varname">INSTALLATION_DIRS</code>
1.223 nia 9282: variable, which will automatically do the right thing.</p>
1.1 dsieger 9283: </div>
1.41 asau 9284: <div class="sect2">
1.1 dsieger 9285: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9286: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 9287: <p>In general, documentation should be installed into
9288: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.223 nia 9289: <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.1 dsieger 9290: includes the version number of the package).</p>
9291: <p>Many modern packages using GNU autoconf allow to set the
9292: directory where HTML documentation is installed with the
1.266 martin 9293: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag is
1.223 nia 9294: needed because otherwise the documentation ends up in
9295: <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
9296: pkgsrc, the HTML documentation should go into the package-specific
9297: directory, just like any other documentation.</p>
1.1 dsieger 9298: <p>An exception to the above is that library API documentation
1.207 leot 9299: 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 9300: browsers (devhelp) should be left at their default location, which
9301: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
9302: documentation can be recognized from files ending in
9303: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
9304: (It is also acceptable to install such files in
9305: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
9306: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
9307: <code class="filename">.devhelp*</code> file must be directly in that
9308: directory then, no additional subdirectory level is allowed in
9309: this case. This is usually achieved by using
1.266 martin 9310: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 9311: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
9312: though.)</p>
9313: </div>
1.41 asau 9314: <div class="sect2">
1.1 dsieger 9315: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9316: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 9317: <p>Certain packages, most of them in the games category, install
9318: a score file that allows all users on the system to record their
9319: highscores. In order for this to work, the binaries need to be
9320: installed setgid and the score files owned by the appropriate
1.35 wiz 9321: group and/or owner (traditionally the "games" user/group). Set
9322: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 9323: following variables, documented in more detail in
9324: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 9325: behaviour: <code class="varname">GAMEDATAMODE</code>,
9326: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 9327: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
9328: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
9329: <code class="varname">GAMEDATA_PERMS</code> and
9330: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
9331: <p>An example that illustrates some of the variables described above is
9332: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
9333: used to properly set directory permissions of the directory where the
9334: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
9335: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
9336: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
9337: binary:</p>
9338: <pre class="programlisting">
1.112 rillig 9339: USE_GAMESGROUP= yes
1.100 leot 9340:
1.112 rillig 9341: BUILD_DEFS+= VARBASE
1.100 leot 9342:
1.112 rillig 9343: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
9344: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
9345: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 9346: </pre>
1.100 leot 9347: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
9348: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
9349: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
9350: needed to be accessed by setgid games and
9351: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 9352: <p>A package should therefore never hard code file ownership or
1.100 leot 9353: access permissions but rely on <code class="varname">*_PERMS</code> as described above
9354: or alternatively on <code class="varname">INSTALL_GAME</code>,
9355: <code class="varname">INSTALL_GAME_DATA</code> and
9356: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 9357: </div>
1.41 asau 9358: <div class="sect2">
1.1 dsieger 9359: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9360: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 9361: <p><code class="varname">DESTDIR</code> support means that a package
9362: installs into a staging directory, not the final location of the
9363: files. Then a binary package is created which can be used for
9364: installation as usual. There are two ways: Either the package must
1.266 martin 9365: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9366: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 9367: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9368: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.266 martin 9369: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
1.113 leot 9370: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.266 martin 9371: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
1.38 wiz 9372: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 9373: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9374: the inclusion.</p></li>
1.23 wiz 9375: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 9376: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 9377: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 9378: automatically. Many manual rules and pre/post-install often are
9379: incorrect; fix them.</p></li>
1.23 wiz 9380: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 9381: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 9382: <li class="listitem"><p>In general, packages should support
1.4 rillig 9383: <code class="varname">UNPRIVILEGED</code> to be able to use
9384: DESTDIR.</p></li>
9385: </ul></div>
9386: </div>
1.41 asau 9387: <div class="sect2">
1.4 rillig 9388: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9389: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 9390: <p>Your package may also contain scripts with hardcoded paths to
1.203 nia 9391: other interpreters besides (or as well as) Perl. To correct the
1.1 dsieger 9392: full pathname to the script interpreter, you need to set the
9393: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 9394: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 9395: <pre class="programlisting">
9396: REPLACE_INTERPRETER+= tcl
9397: REPLACE.tcl.old= .*/bin/tclsh
9398: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9399: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9400: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 9401: </pre>
1.1 dsieger 9402: </div>
1.41 asau 9403: <div class="sect2">
1.1 dsieger 9404: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9405: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.1 dsieger 9406: <p>Makefiles of packages providing perl5 modules should include
9407: the Makefile fragment
9408: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 9409: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 9410: configuration for such modules as well as various hooks to tune
9411: this configuration. See comments in this file for
9412: details.</p>
9413: <p>Perl5 modules will install into different places depending
9414: on the version of perl used during the build process. To
9415: address this, pkgsrc will append lines to the
9416: <code class="filename">PLIST</code> corresponding to the files listed in
9417: the installed <code class="filename">.packlist</code> file generated by
9418: most perl5 modules. This is invoked by defining
9419: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 9420: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9421: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9422: e.g.:</p>
1.1 dsieger 9423: <pre class="programlisting">
1.47 wiz 9424: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 9425: </pre>
1.47 wiz 9426: <p>The perl5 config variables
9427: <code class="varname">installarchlib</code>,
9428: <code class="varname">installscript</code>,
9429: <code class="varname">installvendorbin</code>,
9430: <code class="varname">installvendorscript</code>,
9431: <code class="varname">installvendorarch</code>,
9432: <code class="varname">installvendorlib</code>,
9433: <code class="varname">installvendorman1dir</code>, and
9434: <code class="varname">installvendorman3dir</code> represent those
9435: locations in which components of perl5 modules may be installed,
9436: provided as variable with uppercase and prefixed with
9437: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9438: and may be used by perl5 packages that don't have a packlist.
9439: These variables are also substituted for in the
9440: <code class="filename">PLIST</code> as uppercase prefixed with
9441: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 9442: </div>
1.41 asau 9443: <div class="sect2">
1.1 dsieger 9444: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9445: <a name="faq.pkg-config-files"></a>21.6.7. Packages installing pkg-config files</h3></div></div></div>
1.254 wiz 9446: <p>Some packages, usually those providing libraries, install
9447: pkg-config files so that their headers and libraries can easily be
9448: found. The file names end with <code class="filename">.pc</code>.</p>
9449: <p>Most of the time, these files only provide the linker flags
9450: for the library, but do not include the flags for setting the
9451: rpath so the libraries can also be found at runtime. Since this is
9452: so common, pkgsrc provides <code class="varname">PKGCONFIG_OVERRIDE</code>
9453: for this. Many packages generate the <code class="filename">.pc</code> from
9454: <code class="filename">.pc.in</code>, in that case add those files to the
9455: <code class="varname">PKGCONFIG_OVERRIDE</code> variable:</p>
9456: <pre class="programlisting">
9457: PKGCONFIG_OVERRIDE+= foo.pc.in
9458: </pre>
9459: <p>For packages using meson, the files are generated during
9460: build and you also need to change the phase in which the
9461: replacement is done. For example:</p>
9462: <pre class="programlisting">
9463: PKGCONFIG_OVERRIDE+= output/meson-private/foo.pc
9464: PKGCONFIG_OVERRIDE_STAGE= post-build
9465: </pre>
9466: </div>
9467: <div class="sect2">
9468: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9469: <a name="faq.info-files"></a>21.6.8. Packages installing info files</h3></div></div></div>
1.1 dsieger 9470: <p>Some packages install info files or use the
1.266 martin 9471: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 9472: commands. <code class="varname">INFO_FILES</code> should be defined in
9473: the package Makefile so that <code class="filename">INSTALL</code> and
9474: <code class="filename">DEINSTALL</code> scripts will be generated to
9475: handle registration of the info files in the Info directory
1.266 martin 9476: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 9477: files registration is either provided by the system, or by a
9478: special purpose package automatically added as dependency if
9479: needed.</p>
9480: <p><code class="varname">PKGINFODIR</code> is the directory under
9481: <code class="filename">${PREFIX}</code> where info files are primarily
9482: located. <code class="varname">PKGINFODIR</code> defaults to
1.266 martin 9483: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 9484: <p>The info files for the package should be listed in the
9485: package <code class="filename">PLIST</code>; however any split info files
9486: need not be listed.</p>
1.266 martin 9487: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9488: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 9489: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.266 martin 9490: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 9491: should be noted with the <code class="varname">TEXINFO_REQD</code>
9492: variable in the package <code class="filename">Makefile</code>. By
9493: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 9494: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 9495: does not match the required minimum, a build dependency on the
1.207 leot 9496: <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 9497: be added automatically.</p>
9498: <p>The build and installation process of the software provided
9499: by the package should not use the
1.10 hubertf 9500: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 9501: info files is the task of the package
9502: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 9503: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 9504: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 9505: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9506: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 9507: in <code class="varname">PATH</code>.</p>
1.10 hubertf 9508: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 9509: no effect except the logging of a message. The script overriding
1.10 hubertf 9510: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 9511: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 9512: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 9513: </div>
1.41 asau 9514: <div class="sect2">
1.1 dsieger 9515: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9516: <a name="manpages"></a>21.6.9. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9517: <p>All packages that install manual pages should install them
9518: into the same directory, so that there is one common place to look
9519: for them. In pkgsrc, this place is
9520: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9521: should be used in packages. The default for
9522: <code class="varname">PKGMANDIR</code> is
1.266 martin 9523: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9524: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 9525: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9526: <h3 class="title">Note</h3>
9527: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9528: is far from complete.</p>
9529: </div>
9530: <p>The <code class="filename">PLIST</code> files can just use
9531: <code class="filename">man/</code> as the top level directory for the man
9532: page file entries, and the pkgsrc framework will convert as
9533: needed. In all other places, the correct
9534: <code class="varname">PKGMANDIR</code> must be used.</p>
9535: <p>Packages that are
9536: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.266 martin 9537: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 9538: <code class="filename">./configure</code>
9539: --mandir switch to set where the man pages should be installed.
9540: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9541: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9542: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9543: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.266 martin 9544: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 9545: Or if the <code class="filename">./configure</code> script uses
9546: a non-standard use of --mandir, you can set
9547: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.266 martin 9548: <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 9549: information on installation of compressed manual pages.</p>
9550: </div>
1.41 asau 9551: <div class="sect2">
1.1 dsieger 9552: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9553: <a name="x11-fonts"></a>21.6.10. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9554: <p>If a package installs font files, you will need to rebuild
9555: the fonts database in the directory where they get installed at
9556: installation and deinstallation time. This can be automatically
9557: done by using the pkginstall framework.</p>
9558: <p>You can list the directories where fonts are installed in the
9559: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9560: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.266 martin 9561: <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 9562: Also make sure that the database file
9563: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9564: <p>Note that you should not create new directories for fonts;
9565: instead use the standard ones to avoid that the user needs to
9566: manually configure his X server to find them.</p>
9567: </div>
1.41 asau 9568: <div class="sect2">
1.1 dsieger 9569: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9570: <a name="sgml-xml-data"></a>21.6.11. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9571: <p>If a package installs SGML or XML data files that need to be
9572: registered in system-wide catalogs (like DTDs, sub-catalogs,
9573: etc.), you need to take some extra steps:</p>
1.23 wiz 9574: <div class="orderedlist"><ol class="orderedlist" type="1">
9575: <li class="listitem"><p>Include
1.1 dsieger 9576: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9577: your <code class="filename">Makefile</code>, which takes care of
9578: registering those files in system-wide catalogs at
9579: installation and deinstallation time.</p></li>
1.23 wiz 9580: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9581: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9582: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9583: any XML catalogs installed by the package.</p></li>
1.23 wiz 9584: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9585: to be added to the SGML catalog. These come in groups of
9586: three strings; see xmlcatmgr(1) for more information
9587: (specifically, arguments recognized by the 'add' action).
9588: Note that you will normally not use this variable.</p></li>
1.23 wiz 9589: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9590: to be added to the XML catalog. These come in groups of three
9591: strings; see xmlcatmgr(1) for more information (specifically,
9592: arguments recognized by the 'add' action). Note that you will
9593: normally not use this variable.</p></li>
9594: </ol></div>
9595: </div>
1.41 asau 9596: <div class="sect2">
1.1 dsieger 9597: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9598: <a name="mime-database"></a>21.6.12. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9599: <p>If a package provides extensions to the MIME database by
9600: installing <code class="filename">.xml</code> files inside
9601: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9602: need to take some extra steps to ensure that the database is kept
9603: consistent with respect to these new files:</p>
1.23 wiz 9604: <div class="orderedlist"><ol class="orderedlist" type="1">
9605: <li class="listitem"><p>Include
1.1 dsieger 9606: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9607: (avoid using the <code class="filename">buildlink3.mk</code> file from
9608: this same directory, which is reserved for inclusion from
9609: other <code class="filename">buildlink3.mk</code> files). It takes
9610: care of rebuilding the MIME database at installation and
9611: deinstallation time, and disallows any access to it directly
9612: from the package.</p></li>
1.23 wiz 9613: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9614: <code class="filename">share/mime</code> directory,
9615: <span class="emphasis"><em>except</em></span> for files saved under
9616: <code class="filename">share/mime/packages</code>. The former are
9617: handled automatically by
9618: the update-mime-database program, but the latter are
9619: package-dependent and must be removed by the package that
9620: installed them in the first place.</p></li>
1.23 wiz 9621: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9622: from the PLIST. They will be handled by the shared-mime-info
9623: package.</p></li>
9624: </ol></div>
9625: </div>
1.41 asau 9626: <div class="sect2">
1.1 dsieger 9627: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9628: <a name="intltool"></a>21.6.13. Packages using intltool</h3></div></div></div>
1.1 dsieger 9629: <p>If a package uses intltool during its build, add
9630: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9631: which forces it to use the intltool package provided by pkgsrc,
9632: instead of the one bundled with the distribution file.</p>
9633: <p>This tracks intltool's build-time dependencies and uses the
9634: latest available version; this way, the package benefits of any
9635: bug fixes that may have appeared since it was released.</p>
9636: </div>
1.41 asau 9637: <div class="sect2">
1.1 dsieger 9638: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9639: <a name="startup-scripts"></a>21.6.14. Packages installing startup scripts</h3></div></div></div>
1.256 wiz 9640: <p>If a package contains an rc.d script, it won't be copied into
9641: the startup directory (<code class="filename">/etc/rc.d</code>) by default,
9642: but you can enable copying by setting the option
9643: <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
9644: <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
9645: will be copied into <code class="filename">/etc/rc.d</code> when a package
9646: is installed, but only if the target does not already exist.
9647: Copies in <code class="filename">/etc/rc.d</code> will be automatically removed
9648: only if they have not been modified.
9649: </p>
9650: <p>Note that this alone does not enable the service: It must still be
9651: added to <code class="filename">/etc/rc.conf</code>.</p>
1.1 dsieger 9652: </div>
1.41 asau 9653: <div class="sect2">
1.1 dsieger 9654: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9655: <a name="tex-packages"></a>21.6.15. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9656: <p>If a package installs TeX packages into the texmf tree,
9657: the <code class="filename">ls-R</code> database of the tree needs to be
9658: updated.</p>
1.41 asau 9659: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9660: <h3 class="title">Note</h3>
1.22 jakllsch 9661: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9662: packages should install files
1.22 jakllsch 9663: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9664: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9665: </div>
1.23 wiz 9666: <div class="orderedlist"><ol class="orderedlist" type="1">
9667: <li class="listitem"><p>Include
1.22 jakllsch 9668: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9669: takes care of rebuilding the <code class="filename">ls-R</code>
9670: database at installation and deinstallation time.</p></li>
1.23 wiz 9671: <li class="listitem">
1.1 dsieger 9672: <p>If your package installs files into a texmf
9673: tree other than the one
1.22 jakllsch 9674: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9675: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9676: trees that need database update.</p>
9677: <p>If your package also installs font map files that need
1.10 hubertf 9678: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9679: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9680: set <code class="varname">TEX_MAP_FILES</code> and/or
9681: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9682: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9683: be run automatically at installation/deinstallation to
9684: enable/disable font map files for TeX output
9685: drivers.</p>
9686: </li>
1.23 wiz 9687: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9688: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9689: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9690: </ol></div>
9691: </div>
1.41 asau 9692: <div class="sect2">
1.1 dsieger 9693: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9694: <a name="emulation-packages"></a>21.6.16. Packages supporting running binaries in
1.1 dsieger 9695: emulation</h3></div></div></div>
9696: <p>There are some packages that provide libraries and
9697: executables for running binaries from a one operating system
9698: on a different one (if the latter supports it). One example
9699: is running Linux binaries on NetBSD.</p>
1.207 leot 9700: <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 9701: helps in extracting and packaging Linux rpm packages.</p>
9702: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9703: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9704: if all libraries for each installed executable can be found by
9705: the dynamic linker. Since the standard dynamic linker is run,
9706: this fails for emulation packages, because the libraries used
9707: by the emulation are not in the standard directories.</p>
9708: </div>
1.184 rillig 9709: <div class="sect2">
9710: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9711: <a name="hicolor-theme"></a>21.6.17. Packages installing hicolor icons</h3></div></div></div>
1.184 rillig 9712: <p>If a package installs images under the
9713: <code class="filename">share/icons/hicolor</code> and/or updates the
9714: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9715: database, you need to take some extra steps to make sure that the
9716: shared theme directory is handled appropriately and that the cache
9717: database is rebuilt:</p>
9718: <div class="orderedlist"><ol class="orderedlist" type="1">
9719: <li class="listitem"><p>Include
9720: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9721: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9722: entry that refers to the theme cache.</p></li>
9723: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9724: directories from the <code class="filename">share/icons/hicolor</code>
9725: hierarchy because they will be handled automatically.</p></li>
9726: </ol></div>
9727: <p>The best way to verify that the PLIST is correct with
9728: respect to the last two points is to regenerate it using
9729: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9730: </div>
9731: <div class="sect2">
9732: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9733: <a name="desktop-files"></a>21.6.18. Packages installing desktop files</h3></div></div></div>
1.184 rillig 9734: <p>If a package installs <code class="filename">.desktop</code> files
9735: under <code class="filename">share/applications</code> and these include
9736: MIME information (MimeType key), you need to take extra steps to
9737: ensure that they are registered into the MIME database:</p>
9738: <div class="orderedlist"><ol class="orderedlist" type="1">
9739: <li class="listitem"><p>Include
9740: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9741: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9742: <code class="filename">share/applications/mimeinfo.cache</code> file.
9743: It will be handled automatically.</p></li>
9744: </ol></div>
9745: <p>The best way to verify that the PLIST is correct with
9746: respect to the last point is to regenerate it using <span class="command"><strong>make
9747: print-PLIST</strong></span>.</p>
9748: </div>
9749: </div>
9750: <div class="sect1">
9751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 9752: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.184 rillig 9753: <p>In some cases one does not have the time to solve a problem
9754: immediately. In this case, one can plainly mark a package as broken. For
9755: this, one just sets the variable <code class="varname">BROKEN</code> to the
9756: reason why the package is broken (similar to the
9757: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9758: the package will immediately be shown this message, and the build
9759: will not be even tried.</p>
9760: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9761: intervals.</p>
9762: </div>
9763: </div>
9764: <div class="chapter">
9765: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 9766: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.184 rillig 9767: <div class="toc">
9768: <p><b>Table of Contents</b></p>
9769: <dl class="toc">
9770: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9771: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9772: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9773: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9774: </dl>
9775: </div>
9776: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9777: site</a>:</p>
9778: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9779: environment, an intuitive and attractive desktop for users, and the
9780: GNOME development platform, an extensive framework for building
9781: applications that integrate into the rest of the desktop.</p></blockquote></div>
9782: <p>pkgsrc provides a seamless way to automatically build and install
9783: a complete GNOME environment <span class="emphasis"><em>under many different
9784: platforms</em></span>. We can say with confidence that pkgsrc is one of
9785: the most advanced build and packaging systems for GNOME due to its
9786: included technologies buildlink3, the wrappers and tools framework and
9787: automatic configuration file management. Lots of efforts are put into
9788: achieving a completely clean deinstallation of installed software
9789: components.</p>
9790: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9791: the above also means that great efforts are put into making GNOME work
1.201 cirnatda 9792: under this operating system.</p>
1.184 rillig 9793: <p>This chapter is aimed at pkgsrc developers and other people
9794: interested in helping our GNOME porting and packaging efforts. It
9795: provides instructions on how to manage the existing packages and some
9796: important information regarding their internals.</p>
9797: <div class="sect1">
9798: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 9799: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.184 rillig 9800: <p>pkgsrc includes three GNOME-related meta packages:</p>
9801: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 9802: <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 9803: the core GNOME desktop environment. It only includes the necessary
9804: bits to get it to boot correctly, although it may lack important
9805: functionality for daily operation. The idea behind this package is
9806: to let end users build their own configurations on top of this one,
9807: first installing this meta package to achieve a functional setup and
9808: then adding individual applications.</p></li>
1.207 leot 9809: <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 9810: complete installation of the GNOME platform and desktop as defined
9811: by the GNOME project; this is based on the components distributed in
9812: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9813: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9814: official FTP server. Developer-only tools found in those
9815: directories are not installed unless required by some other
9816: component to work properly. Similarly, packages from the bindings
9817: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9818: in unless required as a dependency for an end-user component. This
1.207 leot 9819: 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>
9820: <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 9821: Installs all the tools required to build a GNOME component when
9822: fetched from the CVS repository. These are required to let the
9823: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9824: </ul></div>
9825: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9826: sorted in a way that eases updates: a package may depend on other
9827: packages listed before it but not on any listed after it. It is very
9828: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9829: change it to alphabetical sorting!</em></span></p>
9830: </div>
9831: <div class="sect1">
9832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 9833: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.184 rillig 9834: <p>Almost all GNOME applications are written in C and use a common
9835: set of tools as their build system. Things get different with the new
9836: bindings to other languages (such as Python), but the following will
9837: give you a general idea on the minimum required tools:</p>
9838: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9839: <li class="listitem">
9840: <p>Almost all GNOME applications use the GNU Autotools as their
9841: build system. As a general rule you will need to tell this to your
9842: package:</p>
9843: <pre class="programlisting">
1.223 nia 9844: GNU_CONFIGURE= yes
9845: USE_LIBTOOL= yes
9846: USE_TOOLS+= gmake
1.184 rillig 9847: </pre>
9848: </li>
9849: <li class="listitem">
9850: <p>If the package uses pkg-config to detect dependencies, add this
9851: tool to the list of required utilities:</p>
9852: <pre class="programlisting">
1.223 nia 9853: USE_TOOLS+= pkg-config
1.184 rillig 9854: </pre>
1.207 leot 9855: <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 9856: the end of the build process to ensure that you did not miss to
9857: specify any dependency in your package and that the version
9858: requirements are all correct.</p>
9859: </li>
9860: <li class="listitem"><p>If the package uses intltool, be sure to add
9861: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9862: to handle dependencies and to force the package to use the latest
9863: available version.</p></li>
9864: <li class="listitem">
9865: <p>If the package uses gtk-doc (a documentation generation
9866: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9867: tool is rather big and the distfile should come with pregenerated
9868: documentation anyway; if it does not, it is a bug that you ought to
9869: report. For such packages you should disable gtk-doc (unless it is
9870: the default):</p>
9871: <pre class="programlisting">
1.223 nia 9872: CONFIGURE_ARGS+= --disable-gtk-doc
1.184 rillig 9873: </pre>
9874: <p>The default location of installed HTML files
9875: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9876: and should not be changed unless the package insists on installing
9877: them somewhere else. Otherwise programs as
9878: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9879: do that with an entry similar to:</p>
9880: <pre class="programlisting">
1.223 nia 9881: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.184 rillig 9882: </pre>
9883: </li>
9884: </ul></div>
9885: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9886: files under the installation prefix to maintain databases. In this
9887: context, shared means that those exact same directories and files are
9888: used among several different packages, leading to conflicts in the
9889: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9890: handle the most common cases, so you have to forget about using
9891: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9892: omitting shared files from them. If you find yourself doing those,
9893: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9894: <p>The following table lists the common situations that result in
9895: using shared directories or files. For each of them, the appropriate
9896: solution is given. After applying the solution be sure to
9897: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9898: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9899: <div class="table">
1.266 martin 9900: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.184 rillig 9901: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9902: <colgroup>
9903: <col>
9904: <col>
9905: </colgroup>
9906: <thead><tr>
9907: <th>If the package...</th>
9908: <th>Then...</th>
9909: </tr></thead>
9910: <tbody>
9911: <tr>
9912: <td>Installs icons under the
9913: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9914: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.266 martin 9915: <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 9916: </tr>
9917: <tr>
9918: <td>Installs files under
9919: <code class="filename">share/mime/packages</code>.</td>
1.266 martin 9920: <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 9921: </tr>
9922: <tr>
9923: <td>Installs <code class="filename">.desktop</code> files under
9924: <code class="filename">share/applications</code> and these include MIME
9925: information.</td>
1.266 martin 9926: <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 9927: </tr>
9928: </tbody>
9929: </table></div>
1.1 dsieger 9930: </div>
1.184 rillig 9931: <br class="table-break">
1.1 dsieger 9932: </div>
1.41 asau 9933: <div class="sect1">
1.1 dsieger 9934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 9935: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.184 rillig 9936: <p>When seeing GNOME as a whole, there are two kinds of
9937: updates:</p>
9938: <div class="variablelist"><dl class="variablelist">
9939: <dt><span class="term">Major update</span></dt>
9940: <dd>
9941: <p>Given that there is still a very long way for GNOME 3 (if it
9942: ever appears), we consider a major update one that goes from a
9943: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9944: where <code class="literal">Y</code> is even and greater than
9945: <code class="literal">X</code>. These are hard to achieve because they
9946: introduce lots of changes in the components' code and almost all
9947: GNOME distfiles are updated to newer versions. Some of them can
9948: even break API and ABI compatibility with the previous major
9949: version series. As a result, the update needs to be done all at
9950: once to minimize breakage.</p>
9951: <p>A major update typically consists of around 80 package
9952: updates and the addition of some new ones.</p>
9953: </dd>
9954: <dt><span class="term">Minor update</span></dt>
9955: <dd>
9956: <p>We consider a minor update one that goes from a
9957: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9958: one where <code class="literal">Y</code> is greater than
9959: <code class="literal">X</code>. These are easy to achieve because they do
9960: not update all GNOME components, can be done in an incremental way
9961: and do not break API nor ABI compatibility.</p>
9962: <p>A minor update typically consists of around 50 package
9963: updates, although the numbers here may vary a lot.</p>
9964: </dd>
9965: </dl></div>
9966: <p>In order to update the GNOME components in pkgsrc to a new stable
9967: release (either major or minor), the following steps should be
9968: followed:</p>
9969: <div class="orderedlist"><ol class="orderedlist" type="1">
1.23 wiz 9970: <li class="listitem">
1.184 rillig 9971: <p>Get a list of all the tarballs that form the new release by
9972: using the following commands. These will leave the full list of the
9973: components' distfiles into the <code class="filename">list.txt</code>
9974: file:</p>
9975: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9976: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9977: awk '{ print $9 }' >list.txt</code></strong>
9978: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9979: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9980: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.1 dsieger 9981: </li>
1.184 rillig 9982: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9983: bump their version to the release you are updating them to. The
9984: three meta packages should be always consistent with versioning.
9985: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9986: in them.</p></li>
1.23 wiz 9987: <li class="listitem">
1.184 rillig 9988: <p>For each meta package, update all its
9989: <code class="varname">DEPENDS</code> lines to match the latest versions as
9990: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9991: newer version (even if found in the FTP) because the meta packages
9992: are supposed to list the exact versions that form a specific GNOME
9993: release. Exceptions are permitted here if a newer version solves a
9994: serious issue in the overall desktop experience; these typically
9995: come in the form of a revision bump in pkgsrc, not in newer versions
9996: from the developers.</p>
9997: <p>Packages not listed in the <code class="filename">list.txt</code> file
9998: should be updated to the latest version available (if found in
9999: pkgsrc). This is the case, for example, of the dependencies on the
1.207 leot 10000: 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 10001: </li>
1.23 wiz 10002: <li class="listitem">
1.184 rillig 10003: <p>Generate a patch from the modified meta packages and extract the
10004: list of "new" lines. This will provide you an outline on what
10005: packages need to be updated in pkgsrc and in what order:</p>
10006: <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 10007: </li>
1.184 rillig 10008: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
10009: installed packages and start over from scratch at this point.</p></li>
10010: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
10011: of <code class="filename">todo.txt</code> and update the packages listed in
10012: it in order. For major desktop updates none of these should be
10013: committed until the entire set is completed because there are chances
10014: of breaking not-yet-updated packages.</p></li>
10015: <li class="listitem"><p>Once the packages are up to date and working, commit them to
10016: the tree one by one with appropriate log messages. At the end,
10017: commit the three meta package updates and all the corresponding
10018: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10019: <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>
10020: </ol></div>
10021: </div>
10022: <div class="sect1">
10023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10024: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.184 rillig 10025: <p>GNOME is a very big component in pkgsrc which approaches 100
10026: packages. Please, it is very important that you always, always,
10027: <span class="strong"><strong>always</strong></span> feed back any portability
1.266 martin 10028: 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
1.184 rillig 10029: their attention on portability issues and to ensure that future versions
10030: can be built out-of-the box on NetBSD. The less custom patches in
10031: pkgsrc, the easier further updates are. Those developers in charge of
10032: issuing major GNOME updates will be grateful if you do that.</p>
1.200 cirnatda 10033: <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
10034: GitLab</a>. Not all components use these to track bugs, but most
1.184 rillig 10035: of them do. Do not be short on your reports: always provide detailed
10036: explanations of the current failure, how it can be improved to achieve
1.200 cirnatda 10037: maximum portability and, if at all possible, provide a patch against the
10038: main Git branch. The more verbose you are, the higher chances of your
10039: patch being accepted.</p>
1.184 rillig 10040: <p>Also, please avoid using preprocessor magic to fix portability
10041: issues. While the FreeBSD GNOME people are doing a great job in porting
10042: GNOME to their operating system, the official GNOME sources are now
10043: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10044: and similar macros. This hurts portability. Please see our patching
1.266 martin 10045: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
1.184 rillig 10046: details.</p>
10047: </div>
1.1 dsieger 10048: </div>
1.41 asau 10049: <div class="chapter">
1.1 dsieger 10050: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 10051: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 10052: <div class="toc">
10053: <p><b>Table of Contents</b></p>
1.100 leot 10054: <dl class="toc">
1.154 rillig 10055: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
10056: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
10057: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
10058: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
10059: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
10060: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
10061: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
10062: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 10063: </dl>
10064: </div>
1.41 asau 10065: <div class="sect1">
1.1 dsieger 10066: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10067: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 10068: <p>Our policy is that we accept binaries only from pkgsrc
10069: developers to guarantee that the packages don't contain any
10070: trojan horses etc. This is not to annoy anyone but rather to
10071: protect our users! You're still free to put up your home-made
10072: binary packages and tell the world where to get them. NetBSD
10073: developers doing bulk builds and wanting to upload them please
1.266 martin 10074: 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 10075: builds)</i></a>.</p>
1.1 dsieger 10076: </div>
1.41 asau 10077: <div class="sect1">
1.1 dsieger 10078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10079: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.218 nia 10080: <p>Firstly, you can import new packages into
1.266 martin 10081: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.218 nia 10082: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
10083: for details.</p>
10084: <p>Next, check that your package is complete, compiles and
1.266 martin 10085: 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 10086: 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>
10087: tool and fix any errors that appear.</p>
10088: <p>Finally, send a report to the pkgsrc bug tracking system,
1.259 leot 10089: 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 10090: that, go to the web page
1.174 leot 10091: <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 10092: which contains some instructions and a link to a form where you
10093: can submit packages. The
1.207 leot 10094: <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 10095: also available as a substitute for either of the above two tools.
10096: </p>
1.1 dsieger 10097: <p>In the form of the problem report, the category should be
1.266 martin 10098: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 10099: and version number, and the description field should contain a
10100: short description of your package (contents of the COMMENT
1.218 nia 10101: variable or DESCR file are OK).</p>
1.1 dsieger 10102: </div>
1.41 asau 10103: <div class="sect1">
1.1 dsieger 10104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10105: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 10106: <p>Please note all package additions, updates, moves, and
10107: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
10108: important to keep this file up to date and conforming to the
10109: existing format, because it will be used by scripts to
1.174 leot 10110: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 10111: sites. Additionally, check the
10112: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
10113: for the package you updated or removed, in case it was mentioned
10114: there.</p>
10115: <p>When the <code class="varname">PKGREVISION</code> of a package is
10116: bumped, the change should appear in
10117: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
10118: related or otherwise relevant. Mass bumps that result from a
10119: dependency being updated should not be mentioned. In all other
10120: cases it's the developer's decision.</p>
10121: <p>There is a make target that helps in creating proper
1.10 hubertf 10122: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 10123: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
10124: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
10125: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
10126: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 10127: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
10128: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 10129: For new packages, or package moves or removals, set the
10130: <code class="varname">CTYPE</code> variable on the command line to "Added",
10131: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 10132: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 10133: not the same as your NetBSD login name. The target also automatically
10134: removes possibly existing entries for the package in the
10135: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 10136: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 10137: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
10138: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
10139: makes the cvs commands use the main repository.
10140: </p>
1.1 dsieger 10141: </div>
1.41 asau 10142: <div class="sect1">
1.1 dsieger 10143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10144: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 10145: <p>For several years, there have been mirrors of pkgsrc in
1.257 jkoshy 10146: fossil, git, and hg. Standard practice when using these tools is to
1.130 wiz 10147: make the first line of a commit message function as a summary that
10148: can be read without the rest, such as is commonly done with "git log
10149: --oneline". For this reason, we have the following guidelines for
10150: pkgsrc commit messages:</p>
10151: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10152: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 10153: big picture in 65 characters or less. When a commit is for one
1.130 wiz 10154: package, include the name of the package. For updates, include the
10155: version to which it is updated.</p></li>
10156: <li class="listitem"><p>Leave the next line empty.</p></li>
10157: <li class="listitem"><p>Then come the details for the commit (changes in that
10158: package, reason for a change) and any relevant PRs. Wrap this
10159: section.</p></li>
10160: </ul></div>
10161: <p>Here is an example:
1.238 wiz 10162: </p>
1.130 wiz 10163: <pre class="programlisting">
1.238 wiz 10164: libxslt: update to 1.0.30
1.130 wiz 10165:
1.238 wiz 10166: Changes since 1.0.29:
10167: ...
10168: </pre>
1.130 wiz 10169: <p>
10170: </p>
10171: <p>Here is another example:
1.238 wiz 10172: </p>
1.130 wiz 10173: <pre class="programlisting">
1.238 wiz 10174: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.130 wiz 10175:
1.238 wiz 10176: (rationale)
10177: </pre>
1.130 wiz 10178: <p>
10179: </p>
1.266 martin 10180: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
1.130 wiz 10181: allowed on the pkgsrc repository to change commit messages.</p>
10182: </div>
10183: <div class="sect1">
10184: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10185: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 10186: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 10187: access to the pkgsrc repository.</p>
1.266 martin 10188: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
1.33 wiz 10189: Start by adding the directory and then files in the directory. Don't
10190: forget to add the new package to the category's
10191: <code class="filename">Makefile</code>. Make sure you don't forget any files;
1.266 martin 10192: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
1.33 wiz 10193: <pre class="programlisting">
10194: <code class="prompt">$</code> cd .../pkgsrc/category
10195: <code class="prompt">$</code> cvs add pkgname
10196: <code class="prompt">$</code> cd pkgname
10197: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
10198: <code class="prompt">$</code> cvs add patches/p*
10199: <code class="prompt">$</code> cvs status | less
1.34 wiz 10200: <code class="prompt">$</code> cvs commit
1.33 wiz 10201: <code class="prompt">$</code> cd ..
1.236 gutterid 10202: <code class="prompt">$</code> vi Makefile # add SUBDIR+=pkgname line
1.34 wiz 10203: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 10204: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 10205: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 10206: </pre>
1.1 dsieger 10207: <p>The commit message of the initial import should include part of the
10208: <code class="filename">DESCR</code> file, so people reading the mailing lists know
10209: what the package is/does.</p>
1.33 wiz 10210: <p>Also mention the new package in
10211: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
1.266 martin 10212: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
10213: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 10214: </div>
1.41 asau 10215: <div class="sect1">
1.1 dsieger 10216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10217: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 10218: <p>Please always put a concise, appropriate and relevant summary of the
10219: changes between old and new versions into the commit log when updating
10220: a package. There are various reasons for this:</p>
1.41 asau 10221: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10222: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 10223: or its information may be overwritten by newer information.</p></li>
1.23 wiz 10224: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 10225: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 10226: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 10227: repository is very useful for people who read the pkgsrc-changes mailing
10228: list, so that they can make tactical decisions about when to upgrade
10229: the package.</p></li>
10230: </ul></div>
10231: <p>Please also recognize that, just because a new version of a package
10232: has been released, it should not automatically be upgraded in the CVS
10233: repository. We prefer to be conservative in the packages that are
10234: included in pkgsrc - development or beta packages are not really the
10235: best thing for most places in which pkgsrc is used. Please use your
10236: judgement about what should go into pkgsrc, and bear in mind that
10237: stability is to be preferred above new and possibly untested features.</p>
10238: </div>
1.41 asau 10239: <div class="sect1">
1.1 dsieger 10240: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10241: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 10242: <p>Renaming packages is not recommended.</p>
1.175 gutterid 10243: <p>When renaming packages, be sure to fix any references to the old name
1.20 snj 10244: in other Makefiles, options, buildlink files, etc.</p>
1.167 leot 10245: <p>
1.175 gutterid 10246: Also, when renaming a package, please add
1.167 leot 10247: the package name and version pattern(s) of the previous package
10248: to <code class="varname">SUPERSEDES</code>.
1.20 snj 10249: This may be repeated for multiple renames.
10250: The new package would be an exact replacement.
1.167 leot 10251: Example:
1.20 snj 10252: </p>
1.167 leot 10253: <pre class="programlisting">
10254: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
10255: SUPERSEDES+= optcomp-[0-9]*
10256: </pre>
1.266 martin 10257: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 10258: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
10259: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
10260: not be an exact replacement but is a suggestion for the replaced
10261: functionality.</p>
10262: </div>
1.41 asau 10263: <div class="sect1">
1.20 snj 10264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10265: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 10266: <p>It is preferred that packages are not renamed or moved, but if needed
10267: please follow these steps.
10268: </p>
1.23 wiz 10269: <div class="orderedlist"><ol class="orderedlist" type="1">
10270: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
10271: <li class="listitem">
1.1 dsieger 10272: <p>Remove all CVS dirs.</p>
10273: <p>Alternatively to the first two steps you can also do:</p>
10274: <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>
10275: <p>and use that for further work.</p>
10276: </li>
1.23 wiz 10277: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
1.266 martin 10278: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
10279: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
1.23 wiz 10280: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 10281: <code class="varname">PREV_PKGPATH</code> to the previous category/package
10282: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
10283: for doing an update using pkgsrc building; for example, it can
1.259 leot 10284: 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 10285: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
10286: new <code class="varname">PKGPATH</code> for that moved package. Note that
10287: it may have multiple matches, so the tool should also check on the
10288: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
10289: probably has no value unless <code class="varname">SUPERSEDES</code> is not
10290: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.237 gutterid 10291: <li class="listitem"><p><span class="command"><strong>cvs add</strong></span> the modified package in the new
1.1 dsieger 10292: place.</p></li>
1.23 wiz 10293: <li class="listitem">
1.1 dsieger 10294: <p>Check if any package depends on it:
10295: </p>
10296: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
10297: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
10298: </li>
1.23 wiz 10299: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
10300: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
10301: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
10302: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
10303: <li class="listitem">
1.1 dsieger 10304: <p>Commit the changed and removed files:</p>
10305: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
10306: <p>(and any packages from step 5, of course).</p>
10307: </li>
10308: </ol></div>
10309: </div>
10310: </div>
1.41 asau 10311: <div class="chapter">
1.1 dsieger 10312: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 10313: <a name="policies"></a>Chapter 24. pkgsrc Policies</h2></div></div></div>
1.263 wiz 10314: <div class="toc">
10315: <p><b>Table of Contents</b></p>
10316: <dl class="toc">
10317: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
10318: <dd><dl>
10319: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
10320: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
10321: </dl></dd>
10322: </dl>
10323: </div>
10324: <div class="sect1">
10325: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10326: <a name="stability"></a>24.1. Packages for which updating is restricted</h2></div></div></div>
1.263 wiz 10327: <p>In the past, some packages have caused more package failures than others, and we'd like to reduce this in the future.</p>
10328: <p>For this reason, pkgsrc-pmc marks some packages with <code class="varname">POLICY_UPDATE_LIMITED</code>. The possible values currently are:
10329: </p>
10330: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10331: <li class="listitem"><p><code class="literal">abi</code> for packages where ABI/API changes often broke the packages depending on them</p></li>
10332: <li class="listitem"><p><code class="literal">bootstrap</code> for packages that are used during the pkgsrc bootstrap</p></li>
10333: </ul></div>
10334: <p>
10335: <code class="filename">pkglint</code> will warn when committing updates to these packages.</p>
10336: <div class="sect2">
10337: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10338: <a name="stability.abi"></a>24.1.1. Limited Updates - ABI</h3></div></div></div>
1.263 wiz 10339: <p>Before committing non-micro version updates to packages marked
10340: with <code class="varname">POLICY_UPDATE_LIMITED=abi</code>, a limited bulk
10341: build of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/bulk-test-${PACKAGE}/index.html" target="_top"><code class="filename">meta-pkgs/bulk-test-${PACKAGE}</code></a> needs to be run
10342: and the result posted to the tech-pkg mailing list, highlighting
10343: what packages would stop building (if any).</p>
10344: <p>Depending on the result, pkgsrc-pmc then decides:
10345: </p>
10346: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10347: <li class="listitem"><p>go ahead with the update</p></li>
10348: <li class="listitem"><p>wait for packages X, Y, Z to be fixed (upstream or
10349: locally) with the updated version, which is put in wip in the
10350: meantime</p></li>
10351: <li class="listitem"><p>In the second case, all pkgsrc developers are
10352: encouraged to work on fixing this - it is not only the updater's
10353: task to fix them.</p></li>
10354: </ul></div>
10355: <p>
10356: </p>
10357: <p>The decision to wait for packages can be revisited.</p>
10358: </div>
10359: <div class="sect2">
10360: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10361: <a name="stability.bootstrap"></a>24.1.2. Limited Updates - Bootstrap</h3></div></div></div>
1.263 wiz 10362: <p>When updating packages used in the bootstrap, i.e. marked with
10363: <code class="varname">POLICY_UPDATE_LIMITED=bootstrap</code>, test the
10364: bootstrap process and preferably some basic packages and send the
10365: patch to the tech-pkg mailing list so it can be tested on other
10366: platforms as well. Give at least two weeks for feedback and testing
10367: by others.</p>
10368: </div>
10369: </div>
10370: </div>
10371: <div class="chapter">
10372: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 10373: <a name="devfaq"></a>Chapter 25. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 10374: <p>This section contains the answers to questions that may
10375: arise when you are writing a package. If you don't find your
10376: question answered here, first have a look in the other chapters,
10377: and if you still don't have the answer, ask on the
10378: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 10379: <div class="qandaset">
1.174 leot 10380: <a name="devfaq.qandaset"></a><dl>
1.263 wiz 10381: <dt>25.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 10382: MAKEFLAGS, .MAKEFLAGS and
10383: MAKE_FLAGS?</a>
10384: </dt>
1.263 wiz 10385: <dt>25.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 10386: MAKE, GMAKE and
10387: MAKE_PROGRAM?</a>
10388: </dt>
1.263 wiz 10389: <dt>25.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 10390: CC, PKG_CC and
10391: PKGSRC_COMPILER?</a>
10392: </dt>
1.263 wiz 10393: <dt>25.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 10394: VARNAME=BUILDLINK_PREFIX.foo
10395: say it's empty?</a>
10396: </dt>
1.263 wiz 10397: <dt>25.5. <a href="#devfaq.master_sites">What does
1.1 dsieger 10398: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
10399: don't understand the := inside
10400: it.</a>
10401: </dt>
1.263 wiz 10402: <dt>25.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 10403: developers?</a>
10404: </dt>
1.263 wiz 10405: <dt>25.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 10406: documentation?</a>
10407: </dt>
1.263 wiz 10408: <dt>25.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.174 leot 10409: What shall I do?</a>
1.1 dsieger 10410: </dt>
10411: </dl>
1.41 asau 10412: <table border="0" style="width: 100%;">
10413: <colgroup>
1.1 dsieger 10414: <col align="left" width="1%">
1.23 wiz 10415: <col>
1.41 asau 10416: </colgroup>
1.1 dsieger 10417: <tbody>
1.41 asau 10418: <tr class="question">
1.1 dsieger 10419: <td align="left" valign="top">
1.263 wiz 10420: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>25.1.</b></p>
1.1 dsieger 10421: </td>
10422: <td align="left" valign="top"><p>What is the difference between
10423: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10424: <code class="varname">MAKE_FLAGS</code>?</p></td>
10425: </tr>
10426: <tr class="answer">
10427: <td align="left" valign="top"></td>
1.223 nia 10428: <td align="left" valign="top">
10429: <p><code class="varname">MAKEFLAGS</code> are the flags passed
1.259 leot 10430: 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 10431: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
10432: passed to the <code class="varname">MAKE_PROGRAM</code> when building the
10433: package.</p>
10434: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
10435: <span class="command"><strong>bmake</strong></span> and should not be used by
10436: packages.</p>
10437: </td>
1.1 dsieger 10438: </tr>
1.41 asau 10439: <tr class="question">
1.1 dsieger 10440: <td align="left" valign="top">
1.263 wiz 10441: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>25.2.</b></p>
1.1 dsieger 10442: </td>
10443: <td align="left" valign="top"><p>What is the difference between
10444: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10445: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10446: </tr>
10447: <tr class="answer">
10448: <td align="left" valign="top"></td>
1.223 nia 10449: <td align="left" valign="top">
10450: <p><code class="varname">MAKE</code> is the path to the
1.259 leot 10451: <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 10452: infrastructure.</p>
10453: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
10454: need to say <code class="varname">USE_TOOLS+=gmake</code> to use
10455: that.</p>
10456: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
10457: program that is used for building the package.</p>
10458: </td>
1.1 dsieger 10459: </tr>
1.41 asau 10460: <tr class="question">
1.1 dsieger 10461: <td align="left" valign="top">
1.263 wiz 10462: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>25.3.</b></p>
1.1 dsieger 10463: </td>
10464: <td align="left" valign="top"><p>What is the difference between
10465: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10466: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10467: </tr>
10468: <tr class="answer">
10469: <td align="left" valign="top"></td>
10470: <td align="left" valign="top">
1.223 nia 10471: <p><code class="varname">CC</code> is the path to the real C
10472: compiler, which can be configured by the pkgsrc user.</p>
10473: <p><code class="varname">PKG_CC</code> is the path to the compiler
10474: wrapper.</p>
10475: <p><code class="varname">PKGSRC_COMPILER</code> is
10476: <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
10477: compiler that should be used. See
10478: <code class="filename">mk/compiler.mk</code> for more information about
10479: the latter variable.</p>
1.1 dsieger 10480: </td>
10481: </tr>
1.41 asau 10482: <tr class="question">
1.1 dsieger 10483: <td align="left" valign="top">
1.263 wiz 10484: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>25.4.</b></p>
1.1 dsieger 10485: </td>
1.10 hubertf 10486: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 10487: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10488: say it's empty?</p></td>
10489: </tr>
10490: <tr class="answer">
10491: <td align="left" valign="top"></td>
10492: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.266 martin 10493: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10494: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 10495: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 10496: command.</p></td>
10497: </tr>
1.41 asau 10498: <tr class="question">
1.1 dsieger 10499: <td align="left" valign="top">
1.263 wiz 10500: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>25.5.</b></p>
1.1 dsieger 10501: </td>
10502: <td align="left" valign="top"><p>What does
1.108 rillig 10503: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10504: don't understand the <code class="code">:=</code> inside
1.1 dsieger 10505: it.</p></td>
10506: </tr>
10507: <tr class="answer">
10508: <td align="left" valign="top"></td>
1.223 nia 10509: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
10510: assignment operator, even though it may look like one.
1.1 dsieger 10511: Instead, it is a degenerate form of
1.108 rillig 10512: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.259 leot 10513: 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 10514: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 10515: case of <code class="varname">MASTER_SITE_*</code>,
10516: <em class="replaceable"><code>old_string</code></em> is the empty string and
10517: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 10518: <code class="code">package/</code>. That's where the
10519: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 10520: together.</p></td>
10521: </tr>
1.41 asau 10522: <tr class="question">
1.1 dsieger 10523: <td align="left" valign="top">
1.263 wiz 10524: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>25.6.</b></p>
1.1 dsieger 10525: </td>
10526: <td align="left" valign="top"><p>Which mailing lists are there for package
10527: developers?</p></td>
10528: </tr>
10529: <tr class="answer">
10530: <td align="left" valign="top"></td>
1.41 asau 10531: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.174 leot 10532: <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 10533: <dd><p>This is a list for technical discussions related
10534: to pkgsrc development, e.g. soliciting feedback for changes to
10535: pkgsrc infrastructure, proposed new features, questions related
10536: to porting pkgsrc to a new platform, advice for maintaining a
10537: package, patches that affect many packages, help requests moved
10538: from pkgsrc-users when an infrastructure bug is found,
10539: etc.</p></dd>
1.174 leot 10540: <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 10541: <dd><p>All bug reports in category "pkg" sent with
1.259 leot 10542: <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 10543: directly; use one of the other mailing
10544: lists.</p></dd>
10545: </dl></div></td>
10546: </tr>
1.41 asau 10547: <tr class="question">
1.1 dsieger 10548: <td align="left" valign="top">
1.263 wiz 10549: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>25.7.</b></p>
1.1 dsieger 10550: </td>
10551: <td align="left" valign="top"><p>Where is the pkgsrc
10552: documentation?</p></td>
10553: </tr>
10554: <tr class="answer">
10555: <td align="left" valign="top"></td>
10556: <td align="left" valign="top">
10557: <p>There are many places where you can find
10558: documentation about pkgsrc:</p>
1.41 asau 10559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10560: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 10561: of chapters that explain large parts of pkgsrc, but some
10562: chapters tend to be outdated. Which ones they are is hard to
10563: say.</p></li>
1.174 leot 10564: <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 10565: about certain features, announcements of new parts of the pkgsrc
10566: infrastructure and sometimes even announcements that a certain
10567: feature has been marked as obsolete. The benefit here is that
10568: each message has a date appended to it.</p></li>
1.23 wiz 10569: <li class="listitem"><p>Many of the files in the
1.1 dsieger 10570: <code class="filename">mk/</code> directory start with a comment that
10571: describes the purpose of the file and how it can be used by the
10572: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 10573: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 10574: help</strong></span>.</p></li>
1.23 wiz 10575: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 10576: information, but they tend to be highly abbreviated, especially
10577: for actions that occur often. Some contain a detailed
10578: description of what has changed, but they are geared towards the
10579: other pkgsrc developers, not towards an average pkgsrc user.
10580: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10581: don't know what has been before, these messages may not be worth
10582: too much to you.</p></li>
1.266 martin 10583: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10584: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 10585: mind of the developer who wrote the code. To get this
1.10 hubertf 10586: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 10587: to see who has written it and ask on the
10588: <code class="literal">tech-pkg</code> mailing list, so that others can
10589: find your questions later (see above). To be sure that the
10590: developer in charge reads the mail, you may CC him or
10591: her.</p></li>
10592: </ul></div>
1.184 rillig 10593: </td>
10594: </tr>
10595: <tr class="question">
10596: <td align="left" valign="top">
1.263 wiz 10597: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>25.8.</b></p>
1.184 rillig 10598: </td>
1.223 nia 10599: <td align="left" valign="top"><p>I have a little time to kill.
1.184 rillig 10600: What shall I do?</p></td>
10601: </tr>
10602: <tr class="answer">
10603: <td align="left" valign="top"></td>
10604: <td align="left" valign="top">
10605: <p>This is not really an FAQ yet, but here's the answer
10606: anyway.</p>
1.41 asau 10607: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 10608: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.207 leot 10609: <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 10610: will tell you about newer versions of installed packages that are
10611: available, but not yet updated in pkgsrc.</p></li>
10612: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10613: — it contains a list of suggested new packages and a list of
10614: cleanups and enhancements for pkgsrc that would be nice to
10615: have.</p></li>
10616: <li class="listitem"><p>Review packages for which review was requested on
10617: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10618: mailing list.</p></li>
1.1 dsieger 10619: </ul></div>
1.184 rillig 10620: </td>
1.1 dsieger 10621: </tr>
10622: </tbody>
1.184 rillig 10623: </table>
1.1 dsieger 10624: </div>
10625: </div>
10626: </div>
1.41 asau 10627: <div class="part">
1.1 dsieger 10628: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 10629: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10630: <div class="partintro">
1.1 dsieger 10631: <div></div>
10632: <p>This part of the guide deals with everything
10633: from the infrastructure that is behind the interfaces described
10634: in the developer's guide. A casual package maintainer should not
10635: need anything from this part.</p>
10636: <div class="toc">
10637: <p><b>Table of Contents</b></p>
1.100 leot 10638: <dl class="toc">
1.263 wiz 10639: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10640: <dd><dl>
1.263 wiz 10641: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
10642: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
10643: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 10644: <dd><dl>
1.263 wiz 10645: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
10646: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 10647: </dl></dd>
1.263 wiz 10648: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
10649: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10650: <dd><dl>
1.263 wiz 10651: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
10652: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10653: </dl></dd>
1.263 wiz 10654: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10655: <dd><dl>
1.263 wiz 10656: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10657: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10658: </dl></dd>
10659: </dl></dd>
1.263 wiz 10660: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1 dsieger 10661: <dd><dl>
1.263 wiz 10662: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
10663: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10664: <dd><dl>
1.263 wiz 10665: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
10666: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 10667: </dl></dd>
10668: </dl></dd>
1.263 wiz 10669: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
10670: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 10671: </dl>
10672: </div>
10673: </div>
1.41 asau 10674: <div class="chapter">
1.1 dsieger 10675: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 10676: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10677: <div class="toc">
10678: <p><b>Table of Contents</b></p>
1.100 leot 10679: <dl class="toc">
1.263 wiz 10680: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
10681: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
10682: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 10683: <dd><dl>
1.263 wiz 10684: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
10685: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 10686: </dl></dd>
1.263 wiz 10687: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
10688: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10689: <dd><dl>
1.263 wiz 10690: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
10691: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10692: </dl></dd>
1.263 wiz 10693: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10694: <dd><dl>
1.263 wiz 10695: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10696: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10697: </dl></dd>
10698: </dl>
10699: </div>
10700: <p>The pkgsrc infrastructure consists of many small Makefile
10701: fragments. Each such fragment needs a properly specified
10702: interface. This chapter explains how such an interface looks
10703: like.</p>
1.41 asau 10704: <div class="sect1">
1.1 dsieger 10705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10706: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10707: <p>Whenever a variable is defined in the pkgsrc
10708: infrastructure, the location and the way of definition provide
10709: much information about the intended use of that variable.
10710: Additionally, more documentation may be found in a header
10711: comment or in this pkgsrc guide.</p>
10712: <p>A special file is
10713: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10714: variables that are intended to be user-defined. They are either
10715: defined using the <code class="literal">?=</code> operator or they are
10716: left undefined because defining them to anything would
1.266 martin 10717: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10718: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10719: file.</p>
10720: <p>Outside this file, the following conventions apply:
10721: Variables that are defined using the <code class="literal">?=</code>
10722: operator may be overridden by a package.</p>
10723: <p>Variables that are defined using the <code class="literal">=</code>
10724: operator may be used read-only at run-time.</p>
10725: <p>Variables whose name starts with an underscore must not be
10726: accessed outside the pkgsrc infrastructure at all. They may
10727: change without further notice.</p>
1.41 asau 10728: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10729: <h3 class="title">Note</h3>
10730: <p>These conventions are currently not applied
10731: consistently to the complete pkgsrc
10732: infrastructure.</p>
10733: </div>
10734: </div>
1.41 asau 10735: <div class="sect1">
1.1 dsieger 10736: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10737: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10738: <p>All variables that contain lists of things should default
10739: to being empty. Two examples that do not follow this rule are
10740: <code class="varname">USE_LANGUAGES</code> and
10741: <code class="varname">DISTFILES</code>. These variables cannot simply be
10742: modified using the <code class="literal">+=</code> operator in package
10743: <code class="filename">Makefile</code>s (or other files included by
10744: them), since there is no guarantee whether the variable is
10745: already set or not, and what its value is. In the case of
1.266 martin 10746: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10747: the default value and just define it as in the following
10748: example.</p>
10749: <pre class="programlisting">
10750: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10751: </pre>
10752: <p>Because of the selection of this default value, the same
10753: value appears in many package Makefiles. Similarly for
10754: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.266 martin 10755: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10756: doesn't stand out. Nevertheless it is mentioned in many
10757: files.</p>
10758: </div>
1.41 asau 10759: <div class="sect1">
1.1 dsieger 10760: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10761: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.41 asau 10762: <div class="sect2">
1.1 dsieger 10763: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10764: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.1 dsieger 10765: <p>Variable evaluation takes place either at load time or at
10766: runtime, depending on the context in which they occur. The
10767: contexts where variables are evaluated at load time are:</p>
1.41 asau 10768: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10769: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10770: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10771: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10772: <code class="literal">.for</code>,</p></li>
1.23 wiz 10773: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10774: </ul></div>
10775: <p>A special exception are references to the iteration
10776: variables of <code class="literal">.for</code> loops, which are expanded
10777: inline, no matter in which context they appear.</p>
10778: <p>As the values of variables may change during load time,
10779: care must be taken not to evaluate them by accident. Typical
10780: examples for variables that should not be evaluated at load time
10781: are <code class="varname">DEPENDS</code> and
10782: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10783: clear, here is an example:</p>
10784: <pre class="programlisting">
10785: CONFIGURE_ARGS= # none
10786: CFLAGS= -O
10787: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10788:
10789: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10790:
10791: CFLAGS+= -Wall
1.111 sevan 10792: </pre>
1.1 dsieger 10793: <p>This code shows how the use of the <code class="literal">:=</code>
10794: operator can quickly lead to unexpected results. The first
10795: paragraph is fairly common code. The second paragraph evaluates
10796: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10797: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10798: <code class="literal">-Wall</code> is appended to the
10799: <code class="varname">CFLAGS</code>, but this addition will not appear in
10800: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10801: paragraphs from above typically occur in completely unrelated
10802: files.</p>
10803: </div>
1.41 asau 10804: <div class="sect2">
1.1 dsieger 10805: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10806: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10807: <p>After all the files have been loaded, the values of the
10808: variables cannot be changed anymore. Variables that are used in
10809: the shell commands are expanded at this point.</p>
10810: </div>
10811: </div>
1.41 asau 10812: <div class="sect1">
1.1 dsieger 10813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10814: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10815: <p>There are many ways in which the definition and use of a
1.108 rillig 10816: variable can be restricted in order to detect bugs and violations
10817: of the (mostly unwritten) policies. A package can be checked with
10818: <code class="literal">pkglint -Wall</code> to see whether it meets these
10819: rules.</p>
1.1 dsieger 10820: </div>
1.41 asau 10821: <div class="sect1">
1.1 dsieger 10822: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10823: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10824: <p>Most of the <code class="filename">.mk</code> files fall into one
10825: of the following classes. Cases where a file falls into more
10826: than one class should be avoided as it often leads to subtle
10827: bugs.</p>
1.41 asau 10828: <div class="sect2">
1.1 dsieger 10829: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10830: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10831: <p>In a traditional imperative programming language some of
10832: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10833: procedures. They take some input parameters and—after
10834: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10835: variables in <code class="filename">Makefile</code>s have global scope
10836: care must be taken not to use parameter names that have already
10837: another meaning. For example, <code class="varname">PKGNAME</code> is a
10838: bad choice for a parameter name.</p>
10839: <p>Procedures are completely evaluated at preprocessing time.
10840: That is, when calling a procedure all input parameters must be
10841: completely resolvable. For example,
10842: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10843: parameter since it is very likely that further text will be
10844: added after calling the procedure, which would effectively apply
10845: the procedure to only a part of the variable. Also, references
1.108 rillig 10846: to other variables will be modified after calling the
1.1 dsieger 10847: procedure.</p>
10848: <p>A procedure can declare its output parameters either as
10849: suitable for use in preprocessing directives or as only
10850: available at runtime. The latter alternative is for variables
10851: that contain references to other runtime variables.</p>
10852: <p>Procedures shall be written such that it is possible to
10853: call the procedure more than once. That is, the file must not
10854: contain multiple-inclusion guards.</p>
10855: <p>Examples for procedures are
10856: <code class="filename">mk/bsd.options.mk</code> and
10857: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10858: that the parameters are evaluated at load time, they should be
10859: assigned using the <code class="literal">:=</code> operator, which should
10860: be used only for this purpose.</p>
10861: </div>
1.41 asau 10862: <div class="sect2">
1.1 dsieger 10863: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10864: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10865: <p>Action files take some input parameters and may define
10866: runtime variables. They shall not define loadtime variables.
10867: There are action files that are included implicitly by the
10868: pkgsrc infrastructure, while other must be included
10869: explicitly.</p>
10870: <p>An example for action files is
10871: <code class="filename">mk/subst.mk</code>.</p>
10872: </div>
10873: </div>
1.41 asau 10874: <div class="sect1">
1.1 dsieger 10875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10876: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10877: <p>Package <code class="filename">Makefile</code>s usually consist of
10878: a set of variable definitions, and include the file
10879: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10880: Before that, they may also include various other
10881: <code class="filename">*.mk</code> files if they need to query the
10882: availability of certain features like the type of compiler or
10883: the X11 implementation. Due to the heavy use of preprocessor
10884: directives like <code class="literal">.if</code> and
10885: <code class="literal">.for</code>, the order in which the files are loaded
10886: matters.</p>
10887: <p>This section describes at which point the various files
10888: are loaded and gives reasons for that order.</p>
1.41 asau 10889: <div class="sect2">
1.1 dsieger 10890: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10891: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10892: </h3></div></div></div>
10893: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10894: is to define some essential variables like
10895: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10896: <code class="varname">MACHINE_ARCH</code>.</p>
10897: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10898: 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 10899: After that, those variables
1.1 dsieger 10900: that have not been overridden by the user are loaded from
10901: <code class="filename">mk/defaults/mk.conf</code>.</p>
10902: <p>After the user settings, the system settings and platform
10903: settings are loaded, which may override the user
10904: settings.</p>
10905: <p>Then, the tool definitions are loaded. The tool wrappers
10906: are not yet in effect. This only happens when building a
10907: package, so the proper variables must be used instead of the
10908: direct tool names.</p>
10909: <p>As the last steps, some essential variables from the
10910: wrapper and the package system flavor are loaded, as well as the
10911: variables that have been cached in earlier phases of a package
10912: build.</p>
10913: </div>
1.41 asau 10914: <div class="sect2">
1.1 dsieger 10915: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10916: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10917: </h3></div></div></div>
10918: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10919: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10920: loaded, which fill default values for those variables that have
10921: not been defined by the package. These variables may later
10922: be used even in unrelated files.</p>
10923: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10924: provides the target <code class="literal">error-check</code> that is added
10925: as a special dependency to all other targets that use
10926: <code class="varname">DELAYED_ERROR_MSG</code> or
10927: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10928: <p>Then, the package-specific hacks from
10929: <code class="filename">hacks.mk</code> are included.</p>
10930: <p>Then, various other files follow. Most of them don't have
10931: any dependencies on what they need to have included before or
10932: after them, though some do.</p>
10933: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10934: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10935: restricts the use of these variables to all the files that have
10936: been included before. Appearances in later files will be
10937: silently ignored.</p>
10938: <p>Then, the files for the main targets are included, in the
10939: order of later execution, though the actual order should not
10940: matter.</p>
10941: <p>At last, some more files are included that don't set any
10942: interesting variables but rather just define make targets to be
10943: executed.</p>
10944: </div>
10945: </div>
10946: </div>
1.41 asau 10947: <div class="chapter">
1.1 dsieger 10948: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 10949: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.1 dsieger 10950: <div class="toc">
10951: <p><b>Table of Contents</b></p>
1.100 leot 10952: <dl class="toc">
1.263 wiz 10953: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
10954: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10955: <dd><dl>
1.263 wiz 10956: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
10957: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 10958: </dl></dd>
10959: </dl>
10960: </div>
10961: <p>The pkgsrc infrastructure consists of a large codebase,
10962: and there are many corners where every little bit of a file is
10963: well thought out, making pkgsrc likely to fail as soon as
10964: anything is changed near those parts. To prevent most changes
10965: from breaking anything, a suite of regression tests should go
10966: along with every important part of the pkgsrc infrastructure.
10967: This chapter describes how regression tests work in pkgsrc and
10968: how you can add new tests.</p>
1.41 asau 10969: <div class="sect1">
1.1 dsieger 10970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10971: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.207 leot 10972: <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 10973: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10974: can simply run that command, which will run all tests in the
1.168 rillig 10975: <code class="filename">regress/</code> directory.</p>
1.1 dsieger 10976: </div>
1.41 asau 10977: <div class="sect1">
1.1 dsieger 10978: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10979: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.168 rillig 10980: <p>Every directory in the <code class="filename">regress/</code>
10981: directory that contains a file called <code class="filename">spec</code>
1.1 dsieger 10982: is considered a regression test. This file is a shell program
1.10 hubertf 10983: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10984: The following functions can be overridden to suit your
10985: needs.</p>
1.41 asau 10986: <div class="sect2">
1.1 dsieger 10987: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10988: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 10989: <p>These functions do not take any parameters. Although they
1.266 martin 10990: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.174 leot 10991: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108 rillig 10992: question</a> for details.</p>
1.41 asau 10993: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10994: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 10995: <dd><p>This function prepares the environment for the
10996: test. By default it does nothing.</p></dd>
1.108 rillig 10997: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10998: <dd>
10999: <p>This function runs the actual test. By default,
1.1 dsieger 11000: it calls <code class="varname">TEST_MAKE</code> with the arguments
11001: <code class="varname">MAKEARGS_TEST</code> and writes its output including
11002: error messages into the file
1.108 rillig 11003: <code class="varname">TEST_OUTFILE</code>.</p>
11004: <p>When defining this function, make sure that all output that
11005: needs to be checked is written to the correct output file.
11006: Example:</p>
11007: <pre class="programlisting">
11008: do_test() {
1.112 rillig 11009: echo "Example output"
1.108 rillig 11010: } 1>$TEST_OUTFILE 2>&1
11011: </pre>
11012: </dd>
11013: <dt><span class="term"><code class="varname">check_result</code></span></dt>
11014: <dd>
11015: <p>This function is run after the test and is
1.1 dsieger 11016: typically used to compare the actual output from the one that is
11017: expected. It can make use of the various helper functions from
1.108 rillig 11018: the next section. Example:</p>
11019: <pre class="programlisting">
11020: check_result() {
1.112 rillig 11021: exit_status 0
11022: output_require "Example"
11023: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
11024: output_prohibit "no such file or directory"
1.168 rillig 11025: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 11026: }
11027: </pre>
11028: </dd>
11029: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 11030: <dd><p>This function cleans everything up after the
11031: test has been run. By default it does nothing.</p></dd>
11032: </dl></div>
11033: </div>
1.41 asau 11034: <div class="sect2">
1.1 dsieger 11035: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11036: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.41 asau 11037: <div class="variablelist"><dl class="variablelist">
1.168 rillig 11038: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
11039: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108 rillig 11040: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 11041: <dd><p>This function compares the exitcode of the
1.108 rillig 11042: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 11043: If they differ, the test will fail.</p></dd>
1.108 rillig 11044: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
11045: <dd>
11046: <p>This function checks for each of its parameters
11047: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 11048: extended regular expression. If it does not, the test will
1.108 rillig 11049: fail. Example:</p>
11050: <pre class="programlisting">
11051: output_require "looks fine"
11052: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
11053: </pre>
11054: </dd>
1.177 leot 11055: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.1 dsieger 11056: <dd><p>This function checks for each of its parameters
1.10 hubertf 11057: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 11058: <span class="emphasis"><em>not</em></span> match the extended regular expression.
11059: If any of the regular expressions matches, the test will
11060: fail.</p></dd>
11061: </dl></div>
11062: </div>
11063: </div>
11064: </div>
1.41 asau 11065: <div class="chapter">
1.1 dsieger 11066: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 11067: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 11068: <div class="toc">
11069: <p><b>Table of Contents</b></p>
1.263 wiz 11070: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.1 dsieger 11071: </div>
11072: <p>The pkgsrc system has already been ported to many
11073: operating systems, hardware architectures and compilers. This
11074: chapter explains the necessary steps to make pkgsrc even more
11075: portable.</p>
1.41 asau 11076: <div class="sect1">
1.1 dsieger 11077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11078: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 11079: <p>To port pkgsrc to a new operating system (called
11080: <code class="literal">MyOS</code> in this example), you need to touch the
11081: following files:</p>
1.41 asau 11082: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 11083: <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>
11084: <dd><p>This file contains some basic definitions, for
11085: example the name of the C
11086: compiler.</p></dd>
11087: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
11088: <dd><p>Insert code that defines the variables
11089: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.212 wiz 11090: <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.1 dsieger 11091: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
11092: <code class="varname">APPEND_ELF</code>, and the other variables that
11093: appear in this file.</p></dd>
11094: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
11095: <dd><p>This file contains the platform-specific
11096: definitions that are used by pkgsrc. Start by copying one of the
11097: other files and edit it to your
11098: needs.</p></dd>
11099: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
11100: <dd><p>This file defines the paths to all the tools
11101: that are needed by one or the other package in pkgsrc, as well
11102: as by pkgsrc itself. Find out where these tools are on your
11103: platform and add them.</p></dd>
11104: </dl></div>
11105: <p>Now, you should be able to build some basic packages, like
1.207 leot 11106: <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 11107: </div>
11108: </div>
11109: </div>
1.41 asau 11110: <div class="appendix">
11111: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 11112: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 11113: <div class="toc">
11114: <p><b>Table of Contents</b></p>
1.100 leot 11115: <dl class="toc">
1.1 dsieger 11116: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
11117: <dd><dl>
11118: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
11119: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
11120: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 11121: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 11122: </dl></dd>
11123: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
11124: </dl>
11125: </div>
11126: <p>We checked to find a piece of software that wasn't in the packages
11127: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 11128: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 11129: present in the tree is beyond us, but it's useful for the purposes of
11130: this exercise.</p>
1.41 asau 11131: <div class="sect1">
1.1 dsieger 11132: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11133: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 11134: <div class="sect2">
1.1 dsieger 11135: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11136: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
1.1 dsieger 11137: <pre class="programlisting">
11138: # $NetBSD$
11139: #
11140:
11141: DISTNAME= bison-1.25
11142: CATEGORIES= devel
1.171 rillig 11143: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 11144:
1.29 dholland 11145: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 11146: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 11147: COMMENT= GNU yacc clone
11148:
11149: GNU_CONFIGURE= yes
1.46 wiz 11150: INFO_FILES= yes
1.1 dsieger 11151:
11152: .include "../../mk/bsd.pkg.mk"
11153: </pre>
11154: </div>
1.41 asau 11155: <div class="sect2">
1.1 dsieger 11156: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11157: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
1.1 dsieger 11158: <pre class="programlisting">
11159: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.259 leot 11160: 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 11161: of the NetBSD source tree is beyond me.
11162: </pre>
11163: </div>
1.41 asau 11164: <div class="sect2">
1.1 dsieger 11165: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11166: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
1.1 dsieger 11167: <pre class="programlisting">
11168: @comment $NetBSD$
11169: bin/bison
11170: man/man1/bison.1.gz
11171: share/bison.simple
11172: share/bison.hairy
11173: </pre>
11174: </div>
1.41 asau 11175: <div class="sect2">
1.1 dsieger 11176: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11177: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1 dsieger 11178: <p>The NetBSD package system comes with
1.207 leot 11179: <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 11180: which helps to check the contents of these
11181: files. After installation it is quite easy to use, just change to the
1.171 rillig 11182: directory of the package you wish to examine and run
1.10 hubertf 11183: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 11184: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171 rillig 11185: ERROR: Makefile: Each package must define its LICENSE.
11186: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
11187: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
11188: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
11189: 1 error, 2 warnings and 1 note found.
11190: (Run "pkglint -e" to show explanations.)
11191: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 11192: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1 dsieger 11193: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170 rillig 11194: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1 dsieger 11195: -Wall</strong></span> for a very thorough check.</p>
11196: </div>
11197: </div>
1.41 asau 11198: <div class="sect1">
1.1 dsieger 11199: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11200: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
1.1 dsieger 11201: <p>Create the directory where the package lives,
11202: plus any auxiliary directories:</p>
11203: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
11204: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
11205: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
11206: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
11207: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.266 martin 11208: <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 11209: then continue with fetching the distfile:</p>
11210: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
11211: >> bison-1.25.tar.gz doesn't seem to exist on this system.
11212: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
11213: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11214: ftp: Error retrieving file: 500 Internal error
11215:
11216: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
11217: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11218: ftp: Error retrieving file: 500 Internal error
11219:
11220: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
11221: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11222: Successfully retrieved file.</pre>
11223: <p>Generate the checksum of the distfile into
11224: <code class="filename">distinfo</code>:</p>
11225: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
11226: <p>Now compile:</p>
11227: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11228: >> Checksum OK for bison-1.25.tar.gz.
11229: ===> Extracting for bison-1.25
11230: ===> Patching for bison-1.25
11231: ===> Ignoring empty patch directory
11232: ===> Configuring for bison-1.25
11233: creating cache ./config.cache
11234: checking for gcc... cc
11235: checking whether we are using GNU C... yes
11236: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
11237: checking how to run the C preprocessor... cc -E
11238: checking for minix/config.h... no
11239: checking for POSIXized ISC... no
11240: checking whether cross-compiling... no
11241: checking for ANSI C header files... yes
11242: checking for string.h... yes
11243: checking for stdlib.h... yes
11244: checking for memory.h... yes
11245: checking for working const... yes
11246: checking for working alloca.h... no
11247: checking for alloca... yes
11248: checking for strerror... yes
11249: updating cache ./config.cache
11250: creating ./config.status
11251: creating Makefile
11252: ===> Building for bison-1.25
11253: 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
11254: 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
11255: 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
11256: 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
11257: 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
11258: 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
11259: 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
11260: 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
11261: 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
11262: 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
11263: 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
11264: 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
11265: 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
11266: 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
11267: 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
11268: 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
11269: 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
11270: 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
11271: 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
11272: 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
11273: 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
11274: 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
11275: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
11276: rm -f bison.s1
11277: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
11278: <p>Everything seems OK, so install the files:</p>
11279: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11280: >> Checksum OK for bison-1.25.tar.gz.
11281: ===> Installing for bison-1.25
11282: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
11283: rm -f /usr/pkg/bin/bison
11284: cd /usr/pkg/share; rm -f bison.simple bison.hairy
11285: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
11286: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
11287: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
11288: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
11289: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
11290: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
11291: ===> Registering installation for bison-1.25</pre>
11292: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 11293: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 11294: binary package, do this now:</p>
11295: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11296: >> Checksum OK for bison-1.25.tar.gz.
11297: ===> Building package for bison-1.25
11298: Creating package bison-1.25.tgz
11299: Registering depends:.
11300: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
11301: <p>Now that you don't need the source and object files
11302: any more, clean up:</p>
11303: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
11304: ===> Cleaning for bison-1.25</pre>
11305: </div>
11306: </div>
1.41 asau 11307: <div class="appendix">
11308: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 11309: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.1 dsieger 11310: <div class="toc">
11311: <p><b>Table of Contents</b></p>
1.100 leot 11312: <dl class="toc">
1.207 leot 11313: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
11314: <dd><dl>
11315: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
11316: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
11317: </dl></dd>
11318: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
11319: <dd><dl>
11320: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
11321: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
11322: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
11323: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
11324: </dl></dd>
11325: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
11326: <dd><dl>
11327: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
11328: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
11329: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
11330: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
11331: </dl></dd>
1.1 dsieger 11332: </dl>
11333: </div>
1.207 leot 11334: <p>
11335: A number of mechanisms are available in pkgsrc to improve the security of the
11336: resulting system. This page describes the mechanisms, and gives hints
11337: about detecting and fixing problems.
11338: </p>
11339: <p>
11340: Mechanisms can be enabled individually in
11341: <code class="filename">mk.conf</code>, and are
11342: individually described below.
11343: </p>
11344: <p>
11345: Typically, a feature will cause some programs to fail to build or work
11346: when first enabled. This can be due to latent problems in the
11347: program, and can be due to other reasons. After enough testing to
11348: have confidence that user problems will be quite rare, individual
11349: mechanisms will be enabled by default.
11350: </p>
11351: <p>
11352: For each mechanism, see the Caveats section below for an explanation
11353: of what might go wrong at compile time and at run time, and how to
11354: notice and address these problems.
11355: </p>
1.41 asau 11356: <div class="sect1">
1.1 dsieger 11357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11358: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
1.207 leot 11359: <div class="sect2">
11360: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11361: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
1.207 leot 11362: <div class="sect3">
11363: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11364: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
1.207 leot 11365: <p>
11366: This allows substitute wrappers to be used for some commonly used
11367: library functions that do not have built-in bounds checking - but
11368: could in some cases.
11369: </p>
11370: <p>
11371: Two mitigation levels are available:
11372: </p>
11373: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11374: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
11375: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
11376: </ul></div>
11377: <p>
11378: "strong" has been enabled by default since pkgsrc-2017Q3.
11379: </p>
11380: </div>
11381: <div class="sect3">
11382: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11383: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
1.207 leot 11384: <p>
11385: This enables a stack-smashing protection mitigation. It is done by adding a
11386: guard variable to functions with vulnerable objects. The guards are initialized
11387: when a function is entered and then checked when the function exits. The guard
11388: check will fail and the program forcibly exited if the variable was modified in
11389: the meantime. This can happen in case of buffer overflows or memory corruption,
11390: and therefore exposing these bugs.
11391: </p>
11392: <p>
11393: Different mitigation levels are available:
11394: </p>
11395: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11396: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
11397: by the compiler;</p></li>
11398: <li class="listitem"><p>"all", which will protect every function;</p></li>
11399: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
11400: two settings above.</p></li>
11401: </ul></div>
11402: <p>
11403: This mitigation is supported by both GCC and clang. It may be supported in
11404: additional compilers, possibly under a different name. It is particularly useful
11405: for unsafe programming languages, such as C/C++.
11406: </p>
11407: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11408: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
11409: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
11410: </ul></div>
11411: <p>More details can be found here:</p>
11412: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11413: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
11414: </p></li></ul></div>
11415: </div>
11416: <div class="sect3">
11417: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11418: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
1.207 leot 11419: <p>
11420: This requests the creation of PIE (Position Independent Executables) for all
11421: executables. The PIE mechanism is normally used for shared libraries, so that
11422: they can be loaded at differing addresses at runtime. PIE itself does not have
11423: useful security properties; however, it is necessary to fully leverage some,
11424: such as ASLR. Some operating systems support Address Space Layout Randomization
11425: (ASLR), which causes different addresses to be used each time a program is run.
11426: This makes it more difficult for an attacker to guess addresses and thus makes
11427: exploits harder to construct. With PIE, ASLR can really be applied to the entire
11428: program, instead of the stack and heap only.
11429: </p>
11430: <p>
11431: PIE executables will only be built for toolchains that are known to support PIE.
11432: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
11433: </p>
11434: <p>
11435: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
11436: </p>
1.1 dsieger 11437: </div>
1.210 gutterid 11438: <div class="sect3">
11439: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11440: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.207 leot 11441: <p>
11442: This also makes the exploitation of some security vulnerabilities more
11443: difficult in some cases.
11444: </p>
11445: <p>Two different mitigation levels are available:</p>
11446: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11447: <li class="listitem"><p>
1.219 nia 11448: partial (the default): the ELF sections are reordered so that internal data sections
1.207 leot 11449: precede the program's own data sections, and non-PLT GOT is read-only;
11450: </p></li>
11451: <li class="listitem"><p>
11452: full: in addition to partial RELRO, every relocation is performed immediately
1.218 nia 11453: when starting the program, allowing the entire GOT to be read-only. This
11454: can greatly slow down startup of large programs.
1.207 leot 11455: </p></li>
11456: </ul></div>
11457: <p>
11458: This is currently supported by GCC. Many software distributions now enable this
1.220 nia 11459: feature by default, at the "partial" level.
1.207 leot 11460: </p>
11461: <p>
11462: More details can be found here:
11463: </p>
11464: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11465: <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>
11466: </p></li></ul></div>
1.1 dsieger 11467: </div>
1.219 nia 11468: </div>
11469: <div class="sect2">
11470: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11471: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
1.219 nia 11472: <div class="sect3">
11473: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11474: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
1.219 nia 11475: <p>
11476: With this option, pkgsrc will try to build packages reproducibly. This allows
11477: packages built from the same tree and with the same options, to produce
11478: identical results bit by bit. This option should be combined with ASLR and
11479: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
11480: attackers attempting to exploit security vulnerabilities.
11481: </p>
11482: <p>
11483: More details can be found here:
11484: </p>
11485: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11486: <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>
11487: </p></li></ul></div>
11488: <p>
11489: More work likely needs to be done before pkgsrc is fully reproducible.
11490: </p>
11491: </div>
1.207 leot 11492: <div class="sect3">
11493: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11494: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.207 leot 11495: <p>
11496: This uses <code class="literal">-fstack-check</code> with GCC for
11497: another stack protection mitigation.
11498: </p>
11499: <p>
11500: It asks the compiler to generate code verifying that it does not corrupt the
11501: stack. According to GCC's manual page, this is really only useful for
11502: multi-threaded programs.
11503: </p>
1.1 dsieger 11504: </div>
11505: </div>
11506: </div>
1.41 asau 11507: <div class="sect1">
1.1 dsieger 11508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11509: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
1.207 leot 11510: <div class="sect2">
11511: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11512: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
1.207 leot 11513: <div class="sect3">
11514: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11515: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
1.207 leot 11516: <p>
11517: A number of packages may fail to build with this option enabled. The
11518: failures are often related to the absence of the <code class="literal">-fPIC</code>
11519: compilation flag when building libraries or executables (or ideally
11520: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
11521: <code class="varname">CFLAGS</code> already, but requires the package to
11522: actually support it.
11523: </p>
11524: <div class="sect4">
11525: <div class="titlepage"><div><div><h5 class="title">
1.266 martin 11526: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
1.207 leot 11527: <p>
11528: These instructions are meant as a reference only; they likely need to be adapted
11529: for many packages individually.
11530: </p>
11531: <p>
11532: For packages using <code class="filename">Makefiles</code>:
11533: </p>
11534: <pre class="programlisting">
11535: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
11536: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
11537: </pre>
11538: <p>
11539: For packages using <code class="filename">Imakefiles</code>:
11540: </p>
11541: <pre class="programlisting">
11542: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
11543: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
11544: </pre>
11545: </div>
11546: </div>
11547: <div class="sect3">
11548: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11549: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
1.207 leot 11550: <p>
11551: Some programs may fail to run, or crash at random times once built as PIE. Two
11552: scenarios are essentially possible. This is nearly always due to a bug in
11553: the program being exposed due to ASLR.
11554: </p>
11555: </div>
11556: <div class="sect3">
11557: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11558: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
1.207 leot 11559: <p>
11560: Ideally, packages should be fixed for compatibility with MKPIE.
11561: However, in some cases this is very difficult, due to complex build systems,
11562: packages using non-standard toolchains, or programming languages with odd
11563: bootstrapping mechanisms.
11564: </p>
11565: <p>
11566: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
11567: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
11568: <code class="filename">bsd.prefs.mk</code> is included.
11569: </p>
11570: </div>
11571: </div>
11572: <div class="sect2">
11573: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11574: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
1.207 leot 11575: <div class="sect3">
11576: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11577: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
1.207 leot 11578: <p>
11579: This feature makes use of pre-processing directives to look for hardened,
11580: alternative implementations of essential library calls. Some programs may fail
11581: to build as a result; this usually happens for those trying too hard to be
11582: portable, or otherwise abusing definitions in the standard library.
11583: </p>
11584: </div>
11585: <div class="sect3">
11586: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11587: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
1.207 leot 11588: <p>
11589: This feature may cause some programs to crash, usually indicating an
11590: actual bug in the program. The fix will typically involve patching the
11591: original program's source code.
11592: </p>
11593: </div>
11594: <div class="sect3">
11595: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11596: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
1.207 leot 11597: <p>
11598: At least in the case of GCC, FORTIFY will only be applied if optimization is
11599: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
11600: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
11601: optimization level. This cannot easily be applied globally, as some packages
11602: may require specific optimization levels.
11603: </p>
11604: </div>
11605: <div class="sect3">
11606: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11607: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
1.207 leot 11608: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11609: <h3 class="title">Note</h3>
11610: <p>FORTIFY should not be disabled to work around runtime crashes in
11611: the program! This is a very bad idea and will expose you to security
11612: vulnerabilities.
11613: </p>
11614: </div>
11615: <p>
11616: To disable FORTIFY on a per-package basis, set the following
11617: in the package's <code class="filename">Makefile</code>
11618: before <code class="filename">bsd.prefs.mk</code> is included:
11619: </p>
11620: <pre class="programlisting">
11621: FORTIFY_SUPPORTED= no
11622: </pre>
11623: </div>
11624: </div>
11625: <div class="sect2">
11626: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11627: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
1.207 leot 11628: <div class="sect3">
11629: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11630: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
1.207 leot 11631: <p>
11632: For better protection, full RELRO requires every symbol to be resolved when the
11633: program starts, rather than simply when required at run-time. This will have
11634: more impact on programs using a lot of symbols, or linked to libraries exposing
11635: a lot of symbols. Therefore, daemons or programs otherwise running in
11636: background are affected only when started. Programs loading plug-ins at
11637: run-time are affected when loading the plug-ins.
11638: </p>
11639: <p>
11640: The impact is not expected to be noticeable on modern hardware, except in some
11641: cases for big programs.
11642: </p>
11643: </div>
11644: <div class="sect3">
11645: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11646: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
1.207 leot 11647: <p>
11648: Some programs handle plug-ins and dependencies in a way that conflicts with
11649: RELRO: for instance, with an initialization routine listing any other plug-in
11650: required. With full RELRO, the missing symbols are resolved before the
11651: initialization routine can run, and the dynamic loader will not be able to find
11652: them directly and abort as a result. Unfortunately, this is how Xorg loads its
11653: drivers. Partial RELRO can be applied instead in this case.
11654: </p>
11655: </div>
11656: <div class="sect3">
11657: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11658: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
1.207 leot 11659: <p>
11660: To disable RELRO on a per-package basis, set the following
11661: in the package's <code class="filename">Makefile</code>
11662: before <code class="filename">bsd.prefs.mk</code> is included:
11663: </p>
11664: <pre class="programlisting">
11665: RELRO_SUPPORTED= no
11666: </pre>
1.209 nia 11667: <p>
11668: It is also possible to at most enable partial RELRO, by
11669: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
11670: </p>
1.207 leot 11671: </div>
11672: </div>
11673: <div class="sect2">
11674: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11675: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
1.207 leot 11676: <div class="sect3">
11677: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11678: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
1.207 leot 11679: <p>
11680: The stack-smashing protection provided by this option does not work for some
11681: programs. The most common situation in which this happens is when the program
11682: allocates variables on the stack, with the size determined at run-time.
11683: </p>
11684: </div>
11685: <div class="sect3">
11686: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11687: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
1.207 leot 11688: <p>
11689: Again, this feature may cause some programs to crash via a
11690: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
11691: </p>
11692: <p>
11693: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
11694: messages are sent and - by default -
11695: appended to <code class="filename">/var/log/messages</code>, e.g.:
11696: </p>
11697: <pre class="programlisting">
11698: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
11699: </pre>
11700: <p>
11701: (where <code class="literal">hostname</code> is the hostname(1) and
11702: <code class="literal">program</code> is the basename(1) of the program crashed).
11703: </p>
11704: <p>
11705: Patching the original program is then required.
11706: </p>
11707: <p>
11708: Rebuilding the package via:
11709: </p>
11710: <pre class="programlisting">
11711: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
11712: </pre>
11713: <p>
11714: and inspecting the backtrace of the coredump via the debugger
11715: should point out the problematic call by inspecting the frame
11716: calling the _chk() (SSP) function.
11717: </p>
11718: </div>
11719: <div class="sect3">
11720: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11721: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
1.207 leot 11722: <p>
11723: The compiler emits extra code when using this feature: a check for buffer
11724: overflows is performed when entering and exiting functions, requiring an extra
11725: variable on the stack. The level of protection can otherwise be adjusted to
11726: affect only those functions considered more sensitive by the compiler (with
11727: -fstack-protector instead of -fstack-protector-all).
11728: </p>
11729: <p>
11730: The impact is not expected to be noticeable on modern hardware. However,
11731: programs with a hard requirement to run at the fastest possible speed should
11732: avoid using this feature, or using libraries built with this feature.
11733: </p>
11734: </div>
11735: <div class="sect3">
11736: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11737: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
1.207 leot 11738: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11739: <h3 class="title">Note</h3>
11740: <p>SSP should not be disabled to work around runtime crashes in
11741: the program! This is a very bad idea and will expose you to security
11742: vulnerabilities.</p>
11743: </div>
11744: <p>
11745: To disable SSP on a per-package basis, set the following
11746: in the package's <code class="filename">Makefile</code>
11747: before <code class="filename">bsd.prefs.mk</code> is included:
11748: </p>
11749: <pre class="programlisting">
11750: SSP_SUPPORTED= no
11751: </pre>
11752: </div>
11753: </div>
11754: </div>
11755: <div class="sect1">
11756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11757: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
1.207 leot 11758: <p>
11759: The illusion of security is worse than having no security at all. This section
11760: lists a number of ways to ensure the security features requested are actually
11761: effective.
11762: </p>
11763: <p>
11764: These instructions were obtained and tested on a system derived from NetBSD 7
11765: (amd64). YMMV.
11766: </p>
11767: <div class="sect2">
11768: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11769: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
1.207 leot 11770: <p>
11771: The ELF executable type in use changes for binaries built as PIE; without:
11772: </p>
11773: <pre class="programlisting">
11774: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
11775: /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
11776: </pre>
11777: <p>as opposed to the following binary, built as PIE:</p>
11778: <pre class="programlisting">
11779: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
11780: /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
11781: </pre>
11782: <p>
11783: The latter result is then what is expected.
11784: </p>
11785: </div>
11786: <div class="sect2">
11787: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11788: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
1.207 leot 11789: <p>
11790: The following command should list a section called RELRO:
11791: </p>
11792: <pre class="programlisting">
11793: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
11794:
11795: /path/to/bin/ary: file format elf64-x86-64
11796:
11797: Program Header:
11798: [...]
11799: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
11800: </pre>
11801: <p>
11802: This check is now performed automatically if
11803: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
11804: </p>
11805: </div>
11806: <div class="sect2">
11807: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11808: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
1.207 leot 11809: <p>
11810: The dynamic loader will apply RELRO immediately when detecting the presence of
11811: the <code class="varname">BIND_NOW</code> flag:
11812: </p>
11813: <pre class="programlisting">
11814: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
11815:
11816: /path/to/bin/ary: file format elf64-x86-64
11817:
11818: Dynamic Section:
11819: [...]
11820: BIND_NOW 0x0000000000000000
11821: </pre>
11822: <p>
11823: This has to be combined with partial RELRO (see above) to be fully efficient.
11824: </p>
11825: <p>
11826: This check is now performed automatically (where supported) if
11827: <code class="varname">PKG_DEVELOPER</code> is set.
11828: </p>
11829: </div>
11830: <div class="sect2">
11831: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11832: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.208 nia 11833: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11834: <h3 class="title">Note</h3>
11835: <p>
11836: Checking for SSP using this method only works where the operating system
11837: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
11838: on recent NetBSD/FreeBSD/Linux versions.
11839: </p>
11840: </div>
1.207 leot 11841: <p>
11842: Building objects, binaries and libraries with SSP will affect the presence of
11843: additional symbols in the resulting file:
11844: </p>
11845: <pre class="programlisting">
11846: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
11847: [...]
11848: U __stack_chk_fail
11849: 0000000000600ea0 B __stack_chk_guard
11850: </pre>
11851: <p>
11852: This is an indicator that the program was indeed built with support for SSP.
11853: </p>
11854: <p>
11855: This check is now performed automatically (where supported) if
11856: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
11857: </p>
11858: </div>
11859: </div>
11860: </div>
11861: <div class="appendix">
11862: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 11863: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
1.207 leot 11864: <div class="toc">
11865: <p><b>Table of Contents</b></p>
11866: <dl class="toc">
11867: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
11868: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
11869: </dl>
11870: </div>
11871: <div class="sect1">
11872: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11873: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
1.207 leot 11874: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11875: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11876: => figlet221.tar.gz doesn't seem to exist on this system.
11877: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11878: => [172219 bytes]
11879: Connected to ftp.plig.net.
11880: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11881: 331 Guest login ok, send your complete e-mail address as password.
11882: 230-You are user #5 of 500 simultaneous users allowed.
11883: 230-
11884: 230- ___ _ _ _
11885: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11886: 230- | _| _| . |_| . | | | . |_| . | _| . |
11887: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11888: 230- |_| |_| |___| |___|
11889: 230-
11890: 230-** Welcome to ftp.plig.org **
11891: 230-
11892: 230-Please note that all transfers from this FTP site are logged. If you
11893: 230-do not like this, please disconnect now.
11894: 230-
11895: 230-This archive is available via
11896: 230-
11897: 230-HTTP: http://ftp.plig.org/
11898: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11899: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11900: 230-
11901: 230-Please email comments, bug reports and requests for packages to be
11902: 230-mirrored to ftp-admin@plig.org.
11903: 230-
11904: 230-
11905: 230 Logged in anonymously.
11906: Remote system type is UNIX.
11907: Using binary mode to transfer files.
11908: 200 Type okay.
11909: 250 "/pub" is new cwd.
11910: 250-"/pub/figlet" is new cwd.
11911: 250-
11912: 250-Welcome to the figlet archive at ftp.figlet.org
11913: 250-
11914: 250- ftp://ftp.figlet.org/pub/figlet/
11915: 250-
11916: 250-The official FIGlet web page is:
11917: 250- http://www.figlet.org/
11918: 250-
11919: 250-If you have questions, please mailto:info@figlet.org. If you want to
11920: 250-contribute a font or something else, you can email us.
11921: 250
11922: 250 "/pub/figlet/program" is new cwd.
11923: 250 "/pub/figlet/program/unix" is new cwd.
11924: local: figlet221.tar.gz remote: figlet221.tar.gz
11925: 502 Unimplemented command.
11926: 227 Entering Passive Mode (195,40,6,41,246,104)
11927: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11928: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11929: 226 Transfer completed.
11930: 172219 bytes received in 00:02 (75.99 KB/s)
11931: 221 Goodbye.
11932: => Checksum OK for figlet221.tar.gz.
11933: ===> Extracting for figlet-2.2.1nb2
11934: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11935: ===> Patching for figlet-2.2.1nb2
11936: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11937: ===> Overriding tools for figlet-2.2.1nb2
11938: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11939: ===> Configuring for figlet-2.2.1nb2
11940: ===> Building for figlet-2.2.1nb2
11941: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11942: chmod a+x figlet
11943: gcc -O2 -o chkfont chkfont.c
11944: => Unwrapping files-to-be-installed.
11945: <code class="prompt">#</code>
11946: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11947: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11948: ===> Installing for figlet-2.2.1nb2
11949: install -d -o root -g wheel -m 755 /usr/pkg/bin
11950: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11951: mkdir -p /usr/pkg/share/figlet
11952: cp figlet /usr/pkg/bin
11953: cp chkfont /usr/pkg/bin
11954: chmod 555 figlist showfigfonts
11955: cp figlist /usr/pkg/bin
11956: cp showfigfonts /usr/pkg/bin
11957: cp fonts/*.flf /usr/pkg/share/figlet
11958: cp fonts/*.flc /usr/pkg/share/figlet
11959: cp figlet.6 /usr/pkg/man/man6
11960: ===> Registering installation for figlet-2.2.1nb2
11961: <code class="prompt">#</code></pre>
11962: </div>
11963: <div class="sect1">
11964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11965: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
1.207 leot 11966: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11967: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11968: ===> Packaging figlet-2.2.1nb2
11969: ===> Building binary package for figlet-2.2.1nb2
11970: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11971: Using SrcDir value of /usr/pkg
11972: Registering depends:.
11973: <code class="prompt">#</code></pre>
11974: </div>
11975: </div>
11976: <div class="appendix">
11977: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 11978: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.207 leot 11979: <div class="toc">
11980: <p><b>Table of Contents</b></p>
11981: <dl class="toc">
11982: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11983: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11984: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11985: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11986: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
11987: <code class="filename">stable</code>,
11988: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11989: source packages</a></span></dt>
11990: </dl>
11991: </div>
11992: <p>As in other big projects, the directory layout of pkgsrc
11993: is quite complex for newbies. This chapter explains where you
11994: find things on the FTP server. The base directory on
11995: <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>.
11996: On other servers it may be different, but inside this directory,
11997: everything should look the same, no matter on which server you
11998: are. This directory contains some subdirectories, which are
11999: explained below.</p>
12000: <div class="sect1">
12001: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 12002: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.207 leot 12003: <p>The directory <code class="filename">distfiles</code> contains lots
12004: of archive files from all pkgsrc packages, which are mirrored
12005: here. The subdirectories are called after their package names
12006: and are used when the distributed files have names that don't
12007: explicitly contain a version number or are otherwise too generic
12008: (for example <code class="filename">release.tar.gz</code>).</p>
12009: </div>
12010: <div class="sect1">
12011: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 12012: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.207 leot 12013: <p>This directory contains things that individual pkgsrc
12014: developers find worth publishing.</p>
12015: </div>
12016: <div class="sect1">
12017: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 12018: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.207 leot 12019: <p>This directory contains binary packages for the various
12020: platforms that are supported by pkgsrc.
12021: 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>
12022: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
12023: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
12024: operating system for which the packages have been built. The
12025: name is taken from the output of the <span class="command"><strong>uname</strong></span>
12026: command, so it may differ from the one you are used to
12027: hear.</p></li>
12028: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
12029: architecture of the platform for which the packages have been
12030: built. It also includes the <code class="varname">ABI</code> (Application
12031: Binary Interface) for platforms that have several of
12032: them.</p></li>
12033: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.255 wiz 12034: the operating system. Typically it is the version defining an
12035: ABI, e.g. 9.0.</p></li>
1.207 leot 12036: <li class="listitem"><p><code class="varname">TAG</code> is either
1.255 wiz 12037: <code class="literal">20<em class="replaceable"><code>YY</code></em>Q<em class="replaceable"><code>N</code></em></code>
12038: for a stable branch, or <code class="literal">current</code> for packages
1.207 leot 12039: built from the HEAD branch. The latter should only be used when
1.255 wiz 12040: the packages are updated on a regular basis.</p></li>
1.207 leot 12041: </ul></div>
1.255 wiz 12042: <p>The rationale for this scheme is that users can first
12043: search by OPSYS and ARCH, since these are more or less
12044: unchangeable. After that, there is a management set of
12045: directories with OSVERSION and TAG.</p>
12046: <p>See also <code class="filename">README.md</code> in
12047: <code class="filename">packages</code> for more details, including
12048: about symlinks.</p>
1.207 leot 12049: <p>In each of these directories, there is a
12050: whole binary packages collection for a specific platform. It has a directory called
12051: <code class="filename">All</code> which contains all binary packages.
1.255 wiz 12052: </p>
1.207 leot 12053: </div>
12054: <div class="sect1">
12055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 12056: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 12057: <p>Here are the reports from bulk builds, for those who want
12058: to fix packages that didn't build on some of the platforms. The
1.266 martin 12059: 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 12060: </div>
1.41 asau 12061: <div class="sect1">
1.8 rillig 12062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 12063: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.148 leot 12064: <code class="filename">stable</code>,
1.22 jakllsch 12065: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 12066: source packages</h2></div></div></div>
1.266 martin 12067: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 12068: that is the files that define how to create binary packages from
12069: source archives.</p>
1.149 leot 12070: <p>Each of the <code class="filename">current</code>,
12071: <code class="filename">stable</code> and
12072: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
12073: directories share the same structure. They each contain a
12074: <code class="filename">pkgsrc</code> directory and
12075: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 12076: <p>The directory <code class="filename">pkgsrc</code> contains a
12077: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 12078: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
12079: as the directory, ready to be downloaded as a whole.</p>
12080: <p>The <code class="filename">current</code> directory contains files
12081: related to the HEAD branch of the CVS repository.
12082: In this directory there is an additional file called
12083: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
12084: all pkgsrc <code class="filename">README</code>s with information about
12085: categories and packages.
12086: </p>
12087: <p>The <code class="filename">stable</code> directory is a symlink to
12088: the latest
12089: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
12090: </p>
12091: <p>The
12092: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
12093: directories contain files related to the
12094: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
12095: stable branch of the CVS repository. In these directories there is
12096: an additional file called
12097: <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 12098: which contains the state of pkgsrc when it was branched.</p>
12099: </div>
12100: </div>
1.41 asau 12101: <div class="appendix">
12102: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 12103: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.154 rillig 12104: <p>
12105: The following list contains all help topics that are available
12106: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
12107: </p>
1.156 leot 12108: <table border="0" summary="Simple list" class="simplelist">
12109: <tr>
12110: <td>#!</td>
12111: <td>-lintl</td>
12112: </tr>
12113: <tr>
1.205 wiz 12114: <td>32bit</td>
1.156 leot 12115: <td>64bit</td>
1.205 wiz 12116: </tr>
12117: <tr>
1.156 leot 12118: <td>ABI</td>
1.205 wiz 12119: <td>ACCEPTABLE_LICENSES</td>
1.156 leot 12120: </tr>
12121: <tr>
12122: <td>ACROREAD_FONTPATH</td>
1.265 leot 12123: <td>AFAIK</td>
1.156 leot 12124: </tr>
12125: <tr>
1.205 wiz 12126: <td>AIX</td>
1.265 leot 12127: <td>ALLOW_NETWORK_ACCESS</td>
1.156 leot 12128: </tr>
12129: <tr>
1.243 gutterid 12130: <td>ALLOW_NEWER_COMPILER</td>
1.265 leot 12131: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.156 leot 12132: </tr>
12133: <tr>
1.243 gutterid 12134: <td>ALL_ENV</td>
1.265 leot 12135: <td>ALSA_PC</td>
1.254 wiz 12136: </tr>
12137: <tr>
1.249 gutterid 12138: <td>ALTERNATIVES_SRC</td>
1.265 leot 12139: <td>AMANDA_TMP</td>
1.263 wiz 12140: </tr>
12141: <tr>
12142: <td>AMANDA_USER</td>
1.265 leot 12143: <td>AMANDA_VAR</td>
1.258 wiz 12144: </tr>
12145: <tr>
1.263 wiz 12146: <td>APACHE_GROUP</td>
1.265 leot 12147: <td>APACHE_MODULE_NAME</td>
1.246 leot 12148: </tr>
12149: <tr>
1.263 wiz 12150: <td>APACHE_MODULE_SRC</td>
1.265 leot 12151: <td>APACHE_MODULE_SRCDIR</td>
1.241 rillig 12152: </tr>
12153: <tr>
1.263 wiz 12154: <td>APACHE_PKG_PREFIX</td>
1.265 leot 12155: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.238 wiz 12156: </tr>
12157: <tr>
1.263 wiz 12158: <td>APACHE_SUEXEC_DOCROOT</td>
1.265 leot 12159: <td>APACHE_USER</td>
1.233 wiz 12160: </tr>
12161: <tr>
1.263 wiz 12162: <td>ARGMAX_REQ</td>
1.265 leot 12163: <td>ARG_MAX</td>
1.227 wiz 12164: </tr>
12165: <tr>
1.263 wiz 12166: <td>ARLA_CACHE</td>
1.265 leot 12167: <td>AUDIT_PACKAGES_FLAGS</td>
1.223 nia 12168: </tr>
12169: <tr>
1.263 wiz 12170: <td>AUTOCONF_REQD</td>
1.265 leot 12171: <td>AUTOMAKE_OVERRIDE</td>
1.258 wiz 12172: </tr>
12173: <tr>
1.263 wiz 12174: <td>AUTOMAKE_REQD</td>
1.265 leot 12175: <td>AUTO_MKDIRS</td>
1.217 rillig 12176: </tr>
12177: <tr>
1.263 wiz 12178: <td>AUX</td>
1.265 leot 12179: <td>BDB185_DEFAULT</td>
1.214 leot 12180: </tr>
12181: <tr>
1.263 wiz 12182: <td>BDBBASE</td>
1.265 leot 12183: <td>BDB_ACCEPTED</td>
1.212 wiz 12184: </tr>
12185: <tr>
1.263 wiz 12186: <td>BDB_DEFAULT</td>
1.265 leot 12187: <td>BDB_LIBS</td>
1.197 leot 12188: </tr>
12189: <tr>
1.263 wiz 12190: <td>BDB_TYPE</td>
1.265 leot 12191: <td>BINCIMAP_GROUP</td>
1.177 leot 12192: </tr>
12193: <tr>
1.263 wiz 12194: <td>BINCIMAP_LOG_USER</td>
1.265 leot 12195: <td>BINCIMAP_USER</td>
1.161 leot 12196: </tr>
12197: <tr>
1.263 wiz 12198: <td>BIND_DIR</td>
1.265 leot 12199: <td>BIND_GROUP</td>
1.159 rillig 12200: </tr>
12201: <tr>
1.263 wiz 12202: <td>BIND_USER</td>
1.265 leot 12203: <td>BINOWN</td>
1.156 leot 12204: </tr>
12205: <tr>
1.263 wiz 12206: <td>BINPKG_SITES</td>
1.265 leot 12207: <td>BIN_INSTALL_FLAGS</td>
1.254 wiz 12208: </tr>
12209: <tr>
1.263 wiz 12210: <td>BISON_PKGDATADIR</td>
1.265 leot 12211: <td>BLAS</td>
1.156 leot 12212: </tr>
12213: <tr>
1.263 wiz 12214: <td>BLAS_ACCEPTED</td>
1.265 leot 12215: <td>BLAS_C_INTERFACE</td>
1.156 leot 12216: </tr>
12217: <tr>
1.263 wiz 12218: <td>BLAS_INCLUDES</td>
1.265 leot 12219: <td>BLAS_INDEX64</td>
1.156 leot 12220: </tr>
12221: <tr>
1.263 wiz 12222: <td>BLAS_LIBS</td>
1.265 leot 12223: <td>BLAS_PC</td>
1.156 leot 12224: </tr>
12225: <tr>
1.263 wiz 12226: <td>BLAS_TYPE</td>
1.265 leot 12227: <td>BOOTSTRAP_DEPENDS</td>
1.156 leot 12228: </tr>
12229: <tr>
1.263 wiz 12230: <td>BROKEN</td>
1.265 leot 12231: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.156 leot 12232: </tr>
12233: <tr>
1.263 wiz 12234: <td>BROKEN_ON_PLATFORM</td>
1.265 leot 12235: <td>BSDSRCDIR</td>
1.156 leot 12236: </tr>
12237: <tr>
1.265 leot 12238: <td>BSD_MAKE_ENV</td>
1.268 wiz 12239: <td>BUILDLINK_AUTO_DIRS</td>
1.156 leot 12240: </tr>
12241: <tr>
1.265 leot 12242: <td>BUILDLINK_AUTO_VARS</td>
1.268 wiz 12243: <td>BUILDLINK_CFLAGS</td>
1.156 leot 12244: </tr>
12245: <tr>
1.265 leot 12246: <td>BUILDLINK_CONTENTS_FILTER</td>
1.268 wiz 12247: <td>BUILDLINK_CPPFLAGS</td>
1.198 leot 12248: </tr>
12249: <tr>
1.265 leot 12250: <td>BUILDLINK_DEPMETHOD</td>
1.268 wiz 12251: <td>BUILDLINK_FILES</td>
1.229 gutterid 12252: </tr>
12253: <tr>
1.265 leot 12254: <td>BUILDLINK_FILES_CMD</td>
1.268 wiz 12255: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.156 leot 12256: </tr>
12257: <tr>
1.265 leot 12258: <td>BUILDLINK_LDFLAGS</td>
1.268 wiz 12259: <td>BUILDLINK_LIBS</td>
1.205 wiz 12260: </tr>
12261: <tr>
1.265 leot 12262: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.268 wiz 12263: <td>BUILDLINK_PKGNAME</td>
1.156 leot 12264: </tr>
12265: <tr>
1.265 leot 12266: <td>BUILDLINK_PREFIX</td>
1.268 wiz 12267: <td>BUILDLINK_RPATHDIRS</td>
1.156 leot 12268: </tr>
12269: <tr>
1.265 leot 12270: <td>BUILDLINK_TREE</td>
1.268 wiz 12271: <td>BUILD_DEFS</td>
1.156 leot 12272: </tr>
12273: <tr>
1.265 leot 12274: <td>BUILD_DEFS_EFFECTS</td>
1.268 wiz 12275: <td>BUILD_DEPENDS</td>
1.156 leot 12276: </tr>
12277: <tr>
1.265 leot 12278: <td>BUILD_DIRS</td>
1.268 wiz 12279: <td>BUILD_ENV_SHELL</td>
1.156 leot 12280: </tr>
12281: <tr>
1.265 leot 12282: <td>BUILD_MAKE_CMD</td>
1.268 wiz 12283: <td>BUILD_MAKE_FLAGS</td>
1.156 leot 12284: </tr>
12285: <tr>
1.265 leot 12286: <td>BUILD_TARGET</td>
1.268 wiz 12287: <td>BUILTIN_FIND_FILES</td>
1.156 leot 12288: </tr>
12289: <tr>
1.265 leot 12290: <td>BUILTIN_FIND_FILES_VAR</td>
1.268 wiz 12291: <td>BUILTIN_FIND_GREP</td>
1.156 leot 12292: </tr>
12293: <tr>
1.265 leot 12294: <td>BUILTIN_FIND_HEADERS</td>
1.268 wiz 12295: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.156 leot 12296: </tr>
12297: <tr>
1.265 leot 12298: <td>BUILTIN_FIND_PKGCONFIG</td>
1.268 wiz 12299: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.156 leot 12300: </tr>
12301: <tr>
1.265 leot 12302: <td>BUILTIN_PKG</td>
1.268 wiz 12303: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.156 leot 12304: </tr>
12305: <tr>
1.265 leot 12306: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.268 wiz 12307: <td>BUILTIN_VERSION_SCRIPT</td>
1.195 gutterid 12308: </tr>
12309: <tr>
1.265 leot 12310: <td>BUILTIN_X11_TYPE</td>
1.268 wiz 12311: <td>BUILTIN_X11_VERSION</td>
1.156 leot 12312: </tr>
12313: <tr>
1.265 leot 12314: <td>CACTI_GROUP</td>
1.268 wiz 12315: <td>CACTI_USER</td>
1.156 leot 12316: </tr>
12317: <tr>
1.265 leot 12318: <td>CANNA_GROUP</td>
1.268 wiz 12319: <td>CANNA_USER</td>
1.156 leot 12320: </tr>
12321: <tr>
1.265 leot 12322: <td>CAT</td>
1.268 wiz 12323: <td>CBLAS_LIBS</td>
1.156 leot 12324: </tr>
12325: <tr>
1.265 leot 12326: <td>CBLAS_PC</td>
1.268 wiz 12327: <td>CCACHE_BASE</td>
1.156 leot 12328: </tr>
12329: <tr>
1.265 leot 12330: <td>CCACHE_DIR</td>
1.268 wiz 12331: <td>CCACHE_LOGFILE</td>
1.156 leot 12332: </tr>
12333: <tr>
1.265 leot 12334: <td>CCACHE_RECACHE</td>
1.268 wiz 12335: <td>CC_VERSION</td>
1.156 leot 12336: </tr>
12337: <tr>
1.268 wiz 12338: <td>CDRECORD_CONF</td>
1.271 wiz 12339: <td>CDROM_PKG_URL_DIR</td>
1.156 leot 12340: </tr>
12341: <tr>
1.268 wiz 12342: <td>CDROM_PKG_URL_HOST</td>
1.271 wiz 12343: <td>CHANGES</td>
1.156 leot 12344: </tr>
12345: <tr>
1.268 wiz 12346: <td>CHECKOUT_DATE</td>
1.271 wiz 12347: <td>CHECK_COMPILER</td>
1.223 nia 12348: </tr>
12349: <tr>
1.268 wiz 12350: <td>CHECK_FAKEHOME</td>
1.271 wiz 12351: <td>CHECK_FILES</td>
1.263 wiz 12352: </tr>
12353: <tr>
1.268 wiz 12354: <td>CHECK_FILES_ONLY_PREFIX</td>
1.271 wiz 12355: <td>CHECK_FILES_SKIP</td>
1.258 wiz 12356: </tr>
12357: <tr>
1.268 wiz 12358: <td>CHECK_FILES_STRICT</td>
1.271 wiz 12359: <td>CHECK_HEADERS</td>
1.254 wiz 12360: </tr>
12361: <tr>
1.268 wiz 12362: <td>CHECK_HEADERS_SKIP</td>
1.271 wiz 12363: <td>CHECK_INTERPRETER</td>
1.246 leot 12364: </tr>
12365: <tr>
1.268 wiz 12366: <td>CHECK_INTERPRETER_SKIP</td>
1.271 wiz 12367: <td>CHECK_PERMS</td>
1.241 rillig 12368: </tr>
12369: <tr>
1.268 wiz 12370: <td>CHECK_PERMS_AUTOFIX</td>
1.271 wiz 12371: <td>CHECK_PERMS_SKIP</td>
1.238 wiz 12372: </tr>
12373: <tr>
1.268 wiz 12374: <td>CHECK_PIE</td>
1.271 wiz 12375: <td>CHECK_PIE_SKIP</td>
1.233 wiz 12376: </tr>
12377: <tr>
1.268 wiz 12378: <td>CHECK_PIE_SUPPORTED</td>
1.271 wiz 12379: <td>CHECK_PORTABILITY</td>
1.227 wiz 12380: </tr>
12381: <tr>
1.268 wiz 12382: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.271 wiz 12383: <td>CHECK_PORTABILITY_SKIP</td>
1.217 rillig 12384: </tr>
12385: <tr>
1.268 wiz 12386: <td>CHECK_RELRO</td>
1.271 wiz 12387: <td>CHECK_RELRO_SKIP</td>
1.214 leot 12388: </tr>
12389: <tr>
1.268 wiz 12390: <td>CHECK_RELRO_SUPPORTED</td>
1.271 wiz 12391: <td>CHECK_SHLIBS</td>
1.212 wiz 12392: </tr>
12393: <tr>
1.268 wiz 12394: <td>CHECK_SHLIBS_SKIP</td>
1.271 wiz 12395: <td>CHECK_SHLIBS_SUPPORTED</td>
1.205 wiz 12396: </tr>
12397: <tr>
1.268 wiz 12398: <td>CHECK_SHLIBS_TOXIC</td>
1.271 wiz 12399: <td>CHECK_SSP</td>
1.197 leot 12400: </tr>
12401: <tr>
1.268 wiz 12402: <td>CHECK_SSP_SKIP</td>
1.271 wiz 12403: <td>CHECK_SSP_SUPPORTED</td>
1.177 leot 12404: </tr>
12405: <tr>
1.268 wiz 12406: <td>CHECK_STRIPPED</td>
1.271 wiz 12407: <td>CHECK_STRIPPED_SKIP</td>
1.161 leot 12408: </tr>
12409: <tr>
1.268 wiz 12410: <td>CHECK_WRKREF</td>
1.271 wiz 12411: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.216 gutterid 12412: </tr>
12413: <tr>
1.268 wiz 12414: <td>CHECK_WRKREF_SKIP</td>
1.271 wiz 12415: <td>CLAMAV_DBDIR</td>
1.159 rillig 12416: </tr>
12417: <tr>
1.268 wiz 12418: <td>CLAMAV_GROUP</td>
1.271 wiz 12419: <td>CLAMAV_USER</td>
1.156 leot 12420: </tr>
12421: <tr>
1.268 wiz 12422: <td>CLANGBASE</td>
1.271 wiz 12423: <td>CLEANDEPENDS</td>
1.156 leot 12424: </tr>
12425: <tr>
1.268 wiz 12426: <td>CLT</td>
1.271 wiz 12427: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.156 leot 12428: </tr>
12429: <tr>
1.268 wiz 12430: <td>CMAKE_INSTALL_NAME_DIR</td>
1.271 wiz 12431: <td>CMAKE_INSTALL_PREFIX</td>
1.156 leot 12432: </tr>
12433: <tr>
1.268 wiz 12434: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.271 wiz 12435: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.156 leot 12436: </tr>
12437: <tr>
1.268 wiz 12438: <td>CMAKE_PREFIX_PATH</td>
1.271 wiz 12439: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.254 wiz 12440: </tr>
12441: <tr>
1.268 wiz 12442: <td>COMMON_LISP_DOCFILES</td>
1.271 wiz 12443: <td>COMMON_LISP_EXAMPLES</td>
1.156 leot 12444: </tr>
12445: <tr>
1.268 wiz 12446: <td>COMMON_LISP_EXTRAFILES</td>
1.271 wiz 12447: <td>COMMON_LISP_PACKAGES</td>
1.263 wiz 12448: </tr>
12449: <tr>
1.268 wiz 12450: <td>COMMON_LISP_SYSTEM</td>
1.271 wiz 12451: <td>COMPILER_RPATH_FLAG</td>
1.263 wiz 12452: </tr>
12453: <tr>
1.268 wiz 12454: <td>COMPILER_USE_SYMLINKS</td>
1.271 wiz 12455: <td>CONFIGURE_ARGS</td>
1.156 leot 12456: </tr>
12457: <tr>
1.268 wiz 12458: <td>CONFIGURE_DIRS</td>
1.271 wiz 12459: <td>CONFIGURE_ENV</td>
1.156 leot 12460: </tr>
12461: <tr>
1.268 wiz 12462: <td>CONFIGURE_ENV_SHELL</td>
1.271 wiz 12463: <td>CONFIGURE_HAS_INFODIR</td>
1.156 leot 12464: </tr>
12465: <tr>
1.268 wiz 12466: <td>CONFIGURE_HAS_MANDIR</td>
1.271 wiz 12467: <td>CONFIGURE_SCRIPT</td>
1.156 leot 12468: </tr>
12469: <tr>
1.268 wiz 12470: <td>CONFIG_SHELL</td>
1.271 wiz 12471: <td>CONFIG_SHELL_FLAGS</td>
1.156 leot 12472: </tr>
12473: <tr>
1.268 wiz 12474: <td>CONF_FILES</td>
1.271 wiz 12475: <td>CONF_FILES_MODE</td>
1.156 leot 12476: </tr>
12477: <tr>
1.268 wiz 12478: <td>CONF_FILES_PERMS</td>
1.271 wiz 12479: <td>CONSERVER_DEFAULTHOST</td>
1.156 leot 12480: </tr>
12481: <tr>
1.268 wiz 12482: <td>CONSERVER_DEFAULTPORT</td>
1.271 wiz 12483: <td>CP</td>
1.156 leot 12484: </tr>
12485: <tr>
1.268 wiz 12486: <td>CPE</td>
1.271 wiz 12487: <td>CPE_EDITION</td>
1.156 leot 12488: </tr>
12489: <tr>
1.268 wiz 12490: <td>CPE_LANG</td>
1.271 wiz 12491: <td>CPE_OTHER</td>
1.232 gutterid 12492: </tr>
12493: <tr>
1.268 wiz 12494: <td>CPE_PART</td>
1.271 wiz 12495: <td>CPE_PRODUCT</td>
1.232 gutterid 12496: </tr>
12497: <tr>
1.268 wiz 12498: <td>CPE_SW_EDITION</td>
1.271 wiz 12499: <td>CPE_TARGET_HW</td>
1.232 gutterid 12500: </tr>
12501: <tr>
1.268 wiz 12502: <td>CPE_TARGET_SW</td>
1.271 wiz 12503: <td>CPE_UPDATE</td>
1.232 gutterid 12504: </tr>
12505: <tr>
1.268 wiz 12506: <td>CPE_URI</td>
1.271 wiz 12507: <td>CPE_VENDOR</td>
1.232 gutterid 12508: </tr>
12509: <tr>
1.268 wiz 12510: <td>CPE_VERSION</td>
1.271 wiz 12511: <td>CPP</td>
1.232 gutterid 12512: </tr>
12513: <tr>
1.268 wiz 12514: <td>CPP_PRECOMP_FLAGS</td>
1.271 wiz 12515: <td>CREATE_WRKDIR_SYMLINK</td>
1.156 leot 12516: </tr>
12517: <tr>
1.268 wiz 12518: <td>CROSSBASE</td>
1.271 wiz 12519: <td>CTFCONVERT</td>
1.156 leot 12520: </tr>
12521: <tr>
1.268 wiz 12522: <td>CTF_FILES_SKIP</td>
1.271 wiz 12523: <td>CTF_SUPPORTED</td>
1.156 leot 12524: </tr>
12525: <tr>
1.268 wiz 12526: <td>CTYPE</td>
1.271 wiz 12527: <td>CUPS_GROUP</td>
1.156 leot 12528: </tr>
12529: <tr>
1.268 wiz 12530: <td>CUPS_SYSTEM_GROUPS</td>
1.271 wiz 12531: <td>CUPS_USER</td>
1.156 leot 12532: </tr>
12533: <tr>
1.268 wiz 12534: <td>CURSES_DEFAULT</td>
1.271 wiz 12535: <td>CURSES_TYPE</td>
1.177 leot 12536: </tr>
12537: <tr>
1.268 wiz 12538: <td>CVS_EXTRACTDIR</td>
1.271 wiz 12539: <td>CVS_MODULE</td>
1.227 wiz 12540: </tr>
12541: <tr>
1.268 wiz 12542: <td>CVS_PROJECT</td>
1.271 wiz 12543: <td>CVS_REPOSITORIES</td>
1.263 wiz 12544: </tr>
12545: <tr>
1.268 wiz 12546: <td>CVS_ROOT</td>
1.271 wiz 12547: <td>CVS_ROOT_GNU</td>
1.263 wiz 12548: </tr>
12549: <tr>
1.268 wiz 12550: <td>CVS_ROOT_NONGNU</td>
1.271 wiz 12551: <td>CVS_ROOT_SOURCEFORGE</td>
1.263 wiz 12552: </tr>
12553: <tr>
1.268 wiz 12554: <td>CVS_TAG</td>
1.271 wiz 12555: <td>CYRUS_GROUP</td>
1.263 wiz 12556: </tr>
12557: <tr>
1.268 wiz 12558: <td>CYRUS_IDLE</td>
1.271 wiz 12559: <td>CYRUS_USER</td>
1.258 wiz 12560: </tr>
12561: <tr>
1.268 wiz 12562: <td>DAEMONTOOLS_GROUP</td>
1.271 wiz 12563: <td>DAEMONTOOLS_LOG_USER</td>
1.254 wiz 12564: </tr>
12565: <tr>
1.268 wiz 12566: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.271 wiz 12567: <td>DARWIN_REQUIRES_FILTER</td>
1.246 leot 12568: </tr>
12569: <tr>
1.268 wiz 12570: <td>DBUS_GROUP</td>
1.271 wiz 12571: <td>DBUS_USER</td>
1.238 wiz 12572: </tr>
12573: <tr>
1.268 wiz 12574: <td>DEFANG_GROUP</td>
1.271 wiz 12575: <td>DEFANG_USER</td>
1.233 wiz 12576: </tr>
12577: <tr>
1.268 wiz 12578: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.271 wiz 12579: <td>DEFAULT_DISTFILES</td>
1.217 rillig 12580: </tr>
12581: <tr>
1.268 wiz 12582: <td>DEFAULT_IRC_SERVER</td>
1.271 wiz 12583: <td>DEFAULT_SERIAL_DEVICE</td>
1.214 leot 12584: </tr>
12585: <tr>
1.268 wiz 12586: <td>DEF_UMASK</td>
1.271 wiz 12587: <td>DEINSTALLDEPENDS</td>
1.212 wiz 12588: </tr>
12589: <tr>
1.268 wiz 12590: <td>DEINSTALL_SRC</td>
1.271 wiz 12591: <td>DEINSTALL_TEMPLATES</td>
1.205 wiz 12592: </tr>
12593: <tr>
1.268 wiz 12594: <td>DELAYED_ERROR_MSG</td>
1.271 wiz 12595: <td>DELAYED_WARNING_MSG</td>
1.197 leot 12596: </tr>
12597: <tr>
1.268 wiz 12598: <td>DEPENDS</td>
1.271 wiz 12599: <td>DEPENDS_TARGET</td>
1.159 rillig 12600: </tr>
12601: <tr>
1.268 wiz 12602: <td>DEPENDS_TYPE</td>
1.271 wiz 12603: <td>DESTDIR</td>
1.156 leot 12604: </tr>
12605: <tr>
1.268 wiz 12606: <td>DESTDIR_VARNAME</td>
1.271 wiz 12607: <td>DIALER_GROUP</td>
1.156 leot 12608: </tr>
12609: <tr>
1.268 wiz 12610: <td>DIGEST_REQD</td>
1.271 wiz 12611: <td>DISTDIR</td>
1.195 gutterid 12612: </tr>
12613: <tr>
1.268 wiz 12614: <td>DISTFILES</td>
1.271 wiz 12615: <td>DISTINFO_FILE</td>
1.156 leot 12616: </tr>
12617: <tr>
1.268 wiz 12618: <td>DISTNAME</td>
1.271 wiz 12619: <td>DIST_PATH</td>
1.156 leot 12620: </tr>
12621: <tr>
1.268 wiz 12622: <td>DIST_SUBDIR</td>
1.271 wiz 12623: <td>DJBDNS_AXFR_USER</td>
1.156 leot 12624: </tr>
12625: <tr>
1.268 wiz 12626: <td>DJBDNS_CACHE_USER</td>
1.271 wiz 12627: <td>DJBDNS_DJBDNS_GROUP</td>
1.156 leot 12628: </tr>
12629: <tr>
1.268 wiz 12630: <td>DJBDNS_LOG_USER</td>
1.271 wiz 12631: <td>DJBDNS_RBL_USER</td>
1.156 leot 12632: </tr>
12633: <tr>
1.268 wiz 12634: <td>DJBDNS_TINY_USER</td>
1.271 wiz 12635: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.156 leot 12636: </tr>
12637: <tr>
1.268 wiz 12638: <td>DL_AUTO_VARS</td>
1.271 wiz 12639: <td>DL_CFLAGS</td>
1.156 leot 12640: </tr>
12641: <tr>
1.268 wiz 12642: <td>DL_LDFLAGS</td>
1.271 wiz 12643: <td>DL_LIBS</td>
1.156 leot 12644: </tr>
12645: <tr>
1.268 wiz 12646: <td>DNS</td>
1.271 wiz 12647: <td>DOCOWN</td>
1.156 leot 12648: </tr>
12649: <tr>
1.268 wiz 12650: <td>DOWNLOADED_DISTFILE</td>
1.271 wiz 12651: <td>DQCACHE_GROUP</td>
1.156 leot 12652: </tr>
12653: <tr>
1.268 wiz 12654: <td>DQCACHE_USER</td>
1.271 wiz 12655: <td>DT_LAYOUT</td>
1.156 leot 12656: </tr>
12657: <tr>
1.268 wiz 12658: <td>DYNAMIC_SITES_CMD</td>
1.271 wiz 12659: <td>DYNAMIC_SITES_SCRIPT</td>
1.156 leot 12660: </tr>
12661: <tr>
1.268 wiz 12662: <td>ECHO</td>
1.271 wiz 12663: <td>ECHO_N</td>
1.156 leot 12664: </tr>
12665: <tr>
1.268 wiz 12666: <td>ELK_GUI</td>
1.271 wiz 12667: <td>EMACS_TYPE</td>
1.156 leot 12668: </tr>
12669: <tr>
1.268 wiz 12670: <td>EMULDIR</td>
1.271 wiz 12671: <td>EMULSUBDIR</td>
1.156 leot 12672: </tr>
12673: <tr>
1.268 wiz 12674: <td>EMULSUBDIRSLASH</td>
1.271 wiz 12675: <td>EMUL_ARCH</td>
1.156 leot 12676: </tr>
12677: <tr>
1.268 wiz 12678: <td>EMUL_DISTRO</td>
1.271 wiz 12679: <td>EMUL_EXEC_FMT</td>
1.243 gutterid 12680: </tr>
12681: <tr>
1.268 wiz 12682: <td>EMUL_IS_NATIVE</td>
1.271 wiz 12683: <td>EMUL_MODULES</td>
1.218 nia 12684: </tr>
12685: <tr>
1.268 wiz 12686: <td>EMUL_OPSYS</td>
1.271 wiz 12687: <td>EMUL_PKG_FMT</td>
1.156 leot 12688: </tr>
12689: <tr>
1.268 wiz 12690: <td>EMUL_PLATFORM</td>
1.271 wiz 12691: <td>EMUL_PLATFORMS</td>
1.156 leot 12692: </tr>
12693: <tr>
1.268 wiz 12694: <td>EMUL_PREFER</td>
1.271 wiz 12695: <td>EMUL_REQD</td>
1.156 leot 12696: </tr>
12697: <tr>
1.268 wiz 12698: <td>EMUL_TYPE</td>
1.271 wiz 12699: <td>ERROR_MSG</td>
1.156 leot 12700: </tr>
12701: <tr>
1.268 wiz 12702: <td>EXIM_GROUP</td>
1.271 wiz 12703: <td>EXIM_USER</td>
1.156 leot 12704: </tr>
12705: <tr>
1.268 wiz 12706: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.271 wiz 12707: <td>EXTRACTOR</td>
1.156 leot 12708: </tr>
12709: <tr>
1.268 wiz 12710: <td>EXTRACT_CMD</td>
1.271 wiz 12711: <td>EXTRACT_CMD_DEFAULT</td>
1.156 leot 12712: </tr>
12713: <tr>
1.268 wiz 12714: <td>EXTRACT_DIR</td>
1.271 wiz 12715: <td>EXTRACT_ELEMENTS</td>
1.156 leot 12716: </tr>
12717: <tr>
1.268 wiz 12718: <td>EXTRACT_ENV</td>
1.271 wiz 12719: <td>EXTRACT_ONLY</td>
1.156 leot 12720: </tr>
12721: <tr>
1.268 wiz 12722: <td>EXTRACT_OPTS</td>
1.271 wiz 12723: <td>EXTRACT_SUFX</td>
1.156 leot 12724: </tr>
12725: <tr>
1.268 wiz 12726: <td>EXTRACT_USING</td>
1.271 wiz 12727: <td>FAIL</td>
1.156 leot 12728: </tr>
12729: <tr>
1.268 wiz 12730: <td>FAILOVER_FETCH</td>
1.271 wiz 12731: <td>FAIL_MSG</td>
1.156 leot 12732: </tr>
12733: <tr>
1.268 wiz 12734: <td>FAKE_NCURSES</td>
1.271 wiz 12735: <td>FAM</td>
1.156 leot 12736: </tr>
12737: <tr>
1.268 wiz 12738: <td>FAM_ACCEPTED</td>
1.271 wiz 12739: <td>FAM_DEFAULT</td>
1.223 nia 12740: </tr>
12741: <tr>
1.268 wiz 12742: <td>FAM_SERVER</td>
1.271 wiz 12743: <td>FCPATH</td>
1.156 leot 12744: </tr>
12745: <tr>
1.268 wiz 12746: <td>FETCH_AFTER_ARGS</td>
1.271 wiz 12747: <td>FETCH_BEFORE_ARGS</td>
1.156 leot 12748: </tr>
12749: <tr>
1.268 wiz 12750: <td>FETCH_CMD</td>
1.271 wiz 12751: <td>FETCH_INSECURE</td>
1.156 leot 12752: </tr>
12753: <tr>
1.262 dholland 12754: <td>FETCH_OUTPUT_ARGS</td>
1.271 wiz 12755: <td>FETCH_PROXY</td>
1.156 leot 12756: </tr>
12757: <tr>
1.262 dholland 12758: <td>FETCH_RESUME_ARGS</td>
1.271 wiz 12759: <td>FETCH_TIMEOUT</td>
1.259 leot 12760: </tr>
12761: <tr>
1.262 dholland 12762: <td>FETCH_USE_IPV4_ONLY</td>
1.271 wiz 12763: <td>FETCH_USING</td>
1.156 leot 12764: </tr>
12765: <tr>
1.262 dholland 12766: <td>FILES_SUBST</td>
1.271 wiz 12767: <td>FILES_SUBST_SED</td>
1.156 leot 12768: </tr>
12769: <tr>
1.259 leot 12770: <td>FIX_SYSTEM_HEADERS</td>
1.271 wiz 12771: <td>FONTDIR</td>
1.177 leot 12772: </tr>
12773: <tr>
1.259 leot 12774: <td>FONTS_DIRS</td>
1.271 wiz 12775: <td>FONTS_VERBOSE</td>
1.263 wiz 12776: </tr>
12777: <tr>
12778: <td>FOO_HACKS_MK</td>
1.271 wiz 12779: <td>FORCE_CXX_STD</td>
1.156 leot 12780: </tr>
12781: <tr>
1.263 wiz 12782: <td>FORCE_C_STD</td>
1.271 wiz 12783: <td>FOSSIL_EXTRACTDIR</td>
1.263 wiz 12784: </tr>
12785: <tr>
12786: <td>FOSSIL_REPO</td>
1.271 wiz 12787: <td>FOSSIL_REPOSITORIES</td>
1.263 wiz 12788: </tr>
12789: <tr>
12790: <td>FOSSIL_VERSION</td>
1.271 wiz 12791: <td>FOX_USE_XUNICODE</td>
1.177 leot 12792: </tr>
12793: <tr>
1.263 wiz 12794: <td>FREEWNN_GROUP</td>
1.271 wiz 12795: <td>FREEWNN_USER</td>
1.258 wiz 12796: </tr>
12797: <tr>
1.263 wiz 12798: <td>FTP_PKG_URL_DIR</td>
1.271 wiz 12799: <td>FTP_PKG_URL_HOST</td>
1.156 leot 12800: </tr>
12801: <tr>
1.263 wiz 12802: <td>GAMEDATAMODE</td>
1.271 wiz 12803: <td>GAMEDATA_PERMS</td>
1.156 leot 12804: </tr>
12805: <tr>
1.263 wiz 12806: <td>GAMEDIRMODE</td>
1.271 wiz 12807: <td>GAMEDIR_PERMS</td>
1.156 leot 12808: </tr>
12809: <tr>
1.263 wiz 12810: <td>GAMEGRP</td>
1.271 wiz 12811: <td>GAMEMODE</td>
1.156 leot 12812: </tr>
12813: <tr>
1.263 wiz 12814: <td>GAMEOWN</td>
1.271 wiz 12815: <td>GAMES_GROUP</td>
1.156 leot 12816: </tr>
12817: <tr>
1.263 wiz 12818: <td>GAMES_USER</td>
1.271 wiz 12819: <td>GCC</td>
1.156 leot 12820: </tr>
12821: <tr>
1.263 wiz 12822: <td>GCCBASE</td>
1.271 wiz 12823: <td>GCC_REQD</td>
1.156 leot 12824: </tr>
12825: <tr>
1.263 wiz 12826: <td>GCC_VERSION_SUFFIX</td>
1.271 wiz 12827: <td>GEM_BUILD</td>
1.156 leot 12828: </tr>
12829: <tr>
1.263 wiz 12830: <td>GEM_CLEANBUILD</td>
1.271 wiz 12831: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.156 leot 12832: </tr>
12833: <tr>
1.263 wiz 12834: <td>GEM_DOCDIR</td>
1.271 wiz 12835: <td>GEM_EXTSDIR</td>
1.156 leot 12836: </tr>
12837: <tr>
1.263 wiz 12838: <td>GEM_HOME</td>
1.271 wiz 12839: <td>GEM_KEEPBUILD</td>
1.156 leot 12840: </tr>
12841: <tr>
1.263 wiz 12842: <td>GEM_LIBDIR</td>
1.271 wiz 12843: <td>GEM_NAME</td>
1.256 wiz 12844: </tr>
12845: <tr>
1.263 wiz 12846: <td>GEM_PATH</td>
1.271 wiz 12847: <td>GEM_PLUGINSDIR</td>
1.177 leot 12848: </tr>
12849: <tr>
1.263 wiz 12850: <td>GEM_SPECFILE</td>
1.271 wiz 12851: <td>GENERATE_PLIST</td>
1.156 leot 12852: </tr>
12853: <tr>
1.263 wiz 12854: <td>GHC</td>
1.271 wiz 12855: <td>GHOSTSCRIPT_REQD</td>
1.156 leot 12856: </tr>
12857: <tr>
1.263 wiz 12858: <td>GITHUB_PROJECT</td>
1.271 wiz 12859: <td>GITHUB_RELEASE</td>
1.198 leot 12860: </tr>
12861: <tr>
1.263 wiz 12862: <td>GITHUB_SUBMODULES</td>
1.271 wiz 12863: <td>GITHUB_TAG</td>
1.156 leot 12864: </tr>
12865: <tr>
1.263 wiz 12866: <td>GITHUB_TYPE</td>
1.271 wiz 12867: <td>GITLAB_PROJECT</td>
1.156 leot 12868: </tr>
12869: <tr>
1.263 wiz 12870: <td>GITLAB_RELEASE</td>
1.271 wiz 12871: <td>GITLAB_SUBMODULES</td>
1.177 leot 12872: </tr>
12873: <tr>
1.263 wiz 12874: <td>GITLAB_TAG</td>
1.271 wiz 12875: <td>GITLAB_TYPE</td>
1.159 rillig 12876: </tr>
12877: <tr>
1.263 wiz 12878: <td>GIT_BRANCH</td>
1.271 wiz 12879: <td>GIT_ENV</td>
1.263 wiz 12880: </tr>
12881: <tr>
12882: <td>GIT_EXTRACTDIR</td>
1.271 wiz 12883: <td>GIT_REPO</td>
1.263 wiz 12884: </tr>
12885: <tr>
12886: <td>GIT_REPOSITORIES</td>
1.271 wiz 12887: <td>GIT_REVISION</td>
1.263 wiz 12888: </tr>
12889: <tr>
12890: <td>GIT_TAG</td>
1.271 wiz 12891: <td>GNAT</td>
1.223 nia 12892: </tr>
12893: <tr>
1.260 wiz 12894: <td>GNU</td>
1.271 wiz 12895: <td>GNU_CONFIGURE</td>
1.258 wiz 12896: </tr>
12897: <tr>
1.260 wiz 12898: <td>GNU_CONFIGURE_ICONV</td>
1.271 wiz 12899: <td>GNU_CONFIGURE_INFODIR</td>
1.258 wiz 12900: </tr>
12901: <tr>
1.260 wiz 12902: <td>GNU_CONFIGURE_MANDIR</td>
1.271 wiz 12903: <td>GNU_CONFIGURE_QUIET</td>
1.254 wiz 12904: </tr>
12905: <tr>
1.260 wiz 12906: <td>GNU_CONFIGURE_STRICT</td>
1.273 wiz 12907: <td>GOFLAGS</td>
12908: </tr>
12909: <tr>
1.271 wiz 12910: <td>GO_BUILD_PATTERN</td>
1.273 wiz 12911: <td>GO_DIST_BASE</td>
1.246 leot 12912: </tr>
12913: <tr>
1.271 wiz 12914: <td>GO_EXTRA_MOD_DIRS</td>
1.273 wiz 12915: <td>GO_MODULE_EXTRACT</td>
1.241 rillig 12916: </tr>
12917: <tr>
1.271 wiz 12918: <td>GO_MODULE_FILES</td>
1.273 wiz 12919: <td>GO_SRCPATH</td>
1.233 wiz 12920: </tr>
12921: <tr>
1.271 wiz 12922: <td>GROUP_SPECIFIC_PKGS</td>
1.273 wiz 12923: <td>GRUB_NETWORK_CARDS</td>
1.156 leot 12924: </tr>
12925: <tr>
1.271 wiz 12926: <td>GRUB_PRESET_COMMAND</td>
1.273 wiz 12927: <td>GRUB_SCAN_ARGS</td>
1.156 leot 12928: </tr>
12929: <tr>
1.271 wiz 12930: <td>GZIP</td>
1.273 wiz 12931: <td>HASKELL_COMPILER</td>
1.238 wiz 12932: </tr>
12933: <tr>
1.271 wiz 12934: <td>HASKELL_DISABLE_EXECUTABLES</td>
1.273 wiz 12935: <td>HASKELL_DISABLE_LIBRARIES</td>
1.263 wiz 12936: </tr>
12937: <tr>
1.271 wiz 12938: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.273 wiz 12939: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.156 leot 12940: </tr>
12941: <tr>
1.271 wiz 12942: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.273 wiz 12943: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.156 leot 12944: </tr>
12945: <tr>
1.271 wiz 12946: <td>HASKELL_ENABLE_TESTS</td>
1.273 wiz 12947: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.217 rillig 12948: </tr>
12949: <tr>
1.271 wiz 12950: <td>HASKELL_PKG_NAME</td>
1.273 wiz 12951: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
1.226 gutterid 12952: </tr>
12953: <tr>
1.271 wiz 12954: <td>HEADER_TEMPLATES</td>
1.273 wiz 12955: <td>HG_REPO</td>
1.263 wiz 12956: </tr>
12957: <tr>
1.271 wiz 12958: <td>HG_REPOSITORIES</td>
1.273 wiz 12959: <td>HG_TAG</td>
1.220 nia 12960: </tr>
12961: <tr>
1.271 wiz 12962: <td>HOMEPAGE</td>
1.273 wiz 12963: <td>HOST_PKGTOOLS_ARGS</td>
1.258 wiz 12964: </tr>
12965: <tr>
1.271 wiz 12966: <td>HOST_SPECIFIC_PKGS</td>
1.273 wiz 12967: <td>HOWL_GROUP</td>
1.258 wiz 12968: </tr>
12969: <tr>
1.271 wiz 12970: <td>HOWL_USER</td>
1.273 wiz 12971: <td>ICCBASE</td>
1.246 leot 12972: </tr>
12973: <tr>
1.271 wiz 12974: <td>ICECAST_CHROOTDIR</td>
1.273 wiz 12975: <td>ICON_THEMES</td>
1.241 rillig 12976: </tr>
12977: <tr>
1.271 wiz 12978: <td>IDOBASE</td>
1.273 wiz 12979: <td>IGNORE_CCACHE</td>
1.233 wiz 12980: </tr>
12981: <tr>
1.271 wiz 12982: <td>IGNORE_INFO_DIRS</td>
1.273 wiz 12983: <td>IGNORE_INTERACTIVE_FETCH</td>
1.227 wiz 12984: </tr>
12985: <tr>
1.271 wiz 12986: <td>IMAKE</td>
1.273 wiz 12987: <td>IMAKEOPTS</td>
1.223 nia 12988: </tr>
12989: <tr>
1.271 wiz 12990: <td>IMAKE_MAKE</td>
1.273 wiz 12991: <td>IMAKE_MANINSTALL</td>
1.156 leot 12992: </tr>
12993: <tr>
1.271 wiz 12994: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.273 wiz 12995: <td>IMDICTDIR</td>
1.156 leot 12996: </tr>
12997: <tr>
1.271 wiz 12998: <td>INCOMPAT_CURSES</td>
1.273 wiz 12999: <td>INFO_DIR</td>
1.191 bacon 13000: </tr>
13001: <tr>
1.271 wiz 13002: <td>INFO_FILES</td>
1.273 wiz 13003: <td>INFO_MSG</td>
1.156 leot 13004: </tr>
13005: <tr>
1.271 wiz 13006: <td>INIT_SYSTEM</td>
1.273 wiz 13007: <td>INN_DATA_DIR</td>
1.156 leot 13008: </tr>
13009: <tr>
1.271 wiz 13010: <td>INN_GROUP</td>
1.273 wiz 13011: <td>INN_USER</td>
1.156 leot 13012: </tr>
13013: <tr>
1.271 wiz 13014: <td>INSTALLATION_DIRS</td>
1.273 wiz 13015: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.156 leot 13016: </tr>
13017: <tr>
1.271 wiz 13018: <td>INSTALL_ENV</td>
1.273 wiz 13019: <td>INSTALL_ENV_SHELL</td>
1.156 leot 13020: </tr>
13021: <tr>
1.271 wiz 13022: <td>INSTALL_SH_OVERRIDE</td>
1.273 wiz 13023: <td>INSTALL_SRC</td>
1.156 leot 13024: </tr>
13025: <tr>
1.271 wiz 13026: <td>INSTALL_TEMPLATES</td>
1.273 wiz 13027: <td>INSTALL_UNSTRIPPED</td>
1.156 leot 13028: </tr>
13029: <tr>
1.271 wiz 13030: <td>IRCD_HYBRID_IRC_GROUP</td>
1.273 wiz 13031: <td>IRCD_HYBRID_IRC_USER</td>
1.156 leot 13032: </tr>
13033: <tr>
1.271 wiz 13034: <td>IRCD_HYBRID_MAXCONN</td>
1.273 wiz 13035: <td>IRCD_HYBRID_NICLEN</td>
1.254 wiz 13036: </tr>
13037: <tr>
1.271 wiz 13038: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.273 wiz 13039: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.172 rillig 13040: </tr>
13041: <tr>
1.271 wiz 13042: <td>IRCD_HYBRID_TOPICLEN</td>
1.273 wiz 13043: <td>IRIX</td>
1.156 leot 13044: </tr>
13045: <tr>
1.271 wiz 13046: <td>IRRD_USE_PGP</td>
1.273 wiz 13047: <td>JABBERD_GROUP</td>
1.156 leot 13048: </tr>
13049: <tr>
1.271 wiz 13050: <td>JABBERD_LOGDIR</td>
1.273 wiz 13051: <td>JABBERD_PIDDIR</td>
1.156 leot 13052: </tr>
13053: <tr>
1.271 wiz 13054: <td>JABBERD_SPOOLDIR</td>
1.273 wiz 13055: <td>JABBERD_USER</td>
1.156 leot 13056: </tr>
13057: <tr>
1.271 wiz 13058: <td>JAVA_APP_PATH</td>
1.273 wiz 13059: <td>JAVA_APP_TARGETS</td>
1.263 wiz 13060: </tr>
13061: <tr>
1.271 wiz 13062: <td>JAVA_BINPREFIX</td>
1.273 wiz 13063: <td>JAVA_CLASSPATH</td>
1.156 leot 13064: </tr>
13065: <tr>
1.271 wiz 13066: <td>JAVA_HOME</td>
1.273 wiz 13067: <td>JAVA_LD_LIBRARY_PATH</td>
1.258 wiz 13068: </tr>
13069: <tr>
1.271 wiz 13070: <td>JAVA_NAME</td>
1.273 wiz 13071: <td>JAVA_UNLIMIT</td>
1.246 leot 13072: </tr>
13073: <tr>
1.271 wiz 13074: <td>JAVA_WRAPPERS</td>
1.273 wiz 13075: <td>JPEG_ACCEPTED</td>
1.156 leot 13076: </tr>
13077: <tr>
1.271 wiz 13078: <td>JPEG_DEFAULT</td>
1.273 wiz 13079: <td>KERBEROS</td>
1.233 wiz 13080: </tr>
13081: <tr>
1.271 wiz 13082: <td>KERMIT_SUID_UUCP</td>
1.273 wiz 13083: <td>KJS_USE_PCRE</td>
1.156 leot 13084: </tr>
13085: <tr>
1.271 wiz 13086: <td>KNEWS_DOMAIN_FILE</td>
1.273 wiz 13087: <td>KNEWS_DOMAIN_NAME</td>
1.227 wiz 13088: </tr>
13089: <tr>
1.271 wiz 13090: <td>KRB5_ACCEPTED</td>
1.273 wiz 13091: <td>KRB5_DEFAULT</td>
1.177 leot 13092: </tr>
13093: <tr>
1.271 wiz 13094: <td>LANGUAGES</td>
1.273 wiz 13095: <td>LAPACKE_LIBS</td>
1.156 leot 13096: </tr>
13097: <tr>
1.271 wiz 13098: <td>LAPACKE_PC</td>
1.273 wiz 13099: <td>LAPACK_LIBS</td>
1.217 rillig 13100: </tr>
13101: <tr>
1.271 wiz 13102: <td>LAPACK_PC</td>
1.273 wiz 13103: <td>LATEX2HTML_ICONPATH</td>
1.156 leot 13104: </tr>
13105: <tr>
1.271 wiz 13106: <td>LDCONFIG_ADD_CMD</td>
1.273 wiz 13107: <td>LDCONFIG_REMOVE_CMD</td>
1.156 leot 13108: </tr>
13109: <tr>
1.271 wiz 13110: <td>LDD</td>
1.273 wiz 13111: <td>LEAFNODE_DATA_DIR</td>
1.156 leot 13112: </tr>
13113: <tr>
1.271 wiz 13114: <td>LEAFNODE_GROUP</td>
1.273 wiz 13115: <td>LEAFNODE_USER</td>
1.156 leot 13116: </tr>
13117: <tr>
1.271 wiz 13118: <td>LIBDVDCSS_HOMEPAGE</td>
1.273 wiz 13119: <td>LIBDVDCSS_MASTER_SITES</td>
1.156 leot 13120: </tr>
13121: <tr>
1.271 wiz 13122: <td>LIBIMAGEQUANT_TYPE</td>
1.273 wiz 13123: <td>LIBRSVG_TYPE</td>
1.177 leot 13124: </tr>
13125: <tr>
1.271 wiz 13126: <td>LIBTOOL</td>
1.273 wiz 13127: <td>LIBTOOLIZE_PLIST</td>
1.156 leot 13128: </tr>
13129: <tr>
1.271 wiz 13130: <td>LIBTOOL_M4_OVERRIDE</td>
1.273 wiz 13131: <td>LIBUSB_TYPE</td>
1.156 leot 13132: </tr>
13133: <tr>
1.271 wiz 13134: <td>LICENSE</td>
1.273 wiz 13135: <td>LINKER_RPATH_FLAG</td>
1.156 leot 13136: </tr>
13137: <tr>
1.271 wiz 13138: <td>LINK_RPATH_FLAG</td>
1.273 wiz 13139: <td>LINUX_BASE_NODEPS</td>
1.258 wiz 13140: </tr>
13141: <tr>
1.271 wiz 13142: <td>LINUX_BASE_PREFERRED</td>
1.273 wiz 13143: <td>LINUX_BASE_REQUIRED</td>
1.263 wiz 13144: </tr>
13145: <tr>
1.271 wiz 13146: <td>LINUX_LOCALES</td>
1.273 wiz 13147: <td>LOCALBASE</td>
1.241 rillig 13148: </tr>
13149: <tr>
1.271 wiz 13150: <td>LOCALBASE_LOCKTYPE</td>
1.273 wiz 13151: <td>LOCALPATCHES</td>
1.156 leot 13152: </tr>
13153: <tr>
1.271 wiz 13154: <td>LOVE_DATA</td>
1.273 wiz 13155: <td>LOVE_GAME</td>
1.255 wiz 13156: </tr>
13157: <tr>
1.271 wiz 13158: <td>LOVE_VERSION</td>
1.273 wiz 13159: <td>LOWER_OPSYS</td>
1.238 wiz 13160: </tr>
13161: <tr>
1.271 wiz 13162: <td>LOWER_OPSYS_VERSUFFIX</td>
1.273 wiz 13163: <td>LOWER_VARIANT_VERSION</td>
1.255 wiz 13164: </tr>
13165: <tr>
1.271 wiz 13166: <td>LOWER_VENDOR</td>
1.273 wiz 13167: <td>LP32PLATFORMS</td>
1.223 nia 13168: </tr>
13169: <tr>
1.271 wiz 13170: <td>LP64PLATFORMS</td>
1.273 wiz 13171: <td>LUA_BUSTED_ARGS</td>
1.177 leot 13172: </tr>
13173: <tr>
1.271 wiz 13174: <td>LUA_CDIR</td>
1.273 wiz 13175: <td>LUA_COMPILER</td>
1.214 leot 13176: </tr>
13177: <tr>
1.271 wiz 13178: <td>LUA_DOCDIR</td>
1.273 wiz 13179: <td>LUA_EXAMPLESDIR</td>
1.197 leot 13180: </tr>
13181: <tr>
1.271 wiz 13182: <td>LUA_INCDIR</td>
1.273 wiz 13183: <td>LUA_INTERPRETER</td>
1.156 leot 13184: </tr>
13185: <tr>
1.271 wiz 13186: <td>LUA_LDIR</td>
1.273 wiz 13187: <td>LUA_LINKER_MAGIC</td>
1.156 leot 13188: </tr>
13189: <tr>
1.271 wiz 13190: <td>LUA_PKGPREFIX</td>
1.273 wiz 13191: <td>LUA_SELF_CONFLICT</td>
1.221 nia 13192: </tr>
13193: <tr>
1.271 wiz 13194: <td>LUA_USE_BUSTED</td>
1.273 wiz 13195: <td>LUA_VERSIONS_ACCEPTED</td>
1.218 nia 13196: </tr>
13197: <tr>
1.271 wiz 13198: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.273 wiz 13199: <td>LUA_VERSION_DEFAULT</td>
1.263 wiz 13200: </tr>
13201: <tr>
1.271 wiz 13202: <td>LUA_VERSION_REQD</td>
1.273 wiz 13203: <td>Lua</td>
1.218 nia 13204: </tr>
13205: <tr>
1.271 wiz 13206: <td>MACHINE_PLATFORM</td>
1.273 wiz 13207: <td>MAILAGENT_DOMAIN</td>
1.218 nia 13208: </tr>
13209: <tr>
1.271 wiz 13210: <td>MAILAGENT_EMAIL</td>
1.273 wiz 13211: <td>MAILAGENT_FQDN</td>
1.218 nia 13212: </tr>
13213: <tr>
1.271 wiz 13214: <td>MAILAGENT_ORGANIZATION</td>
1.273 wiz 13215: <td>MAJORDOMO_HOMEDIR</td>
1.218 nia 13216: </tr>
13217: <tr>
1.271 wiz 13218: <td>MAJOR_OS_VERSION</td>
1.273 wiz 13219: <td>MAKEINFO_ARGS</td>
1.218 nia 13220: </tr>
13221: <tr>
1.271 wiz 13222: <td>MAKE_DIRS</td>
1.273 wiz 13223: <td>MAKE_DIRS_PERMS</td>
1.258 wiz 13224: </tr>
13225: <tr>
1.271 wiz 13226: <td>MAKE_ENV</td>
1.273 wiz 13227: <td>MAKE_FILE</td>
1.246 leot 13228: </tr>
13229: <tr>
1.271 wiz 13230: <td>MAKE_FLAGS</td>
1.273 wiz 13231: <td>MAKE_JOBS</td>
1.205 wiz 13232: </tr>
13233: <tr>
1.271 wiz 13234: <td>MAKE_JOBS_SAFE</td>
1.273 wiz 13235: <td>MAKE_PROGRAM</td>
1.233 wiz 13236: </tr>
13237: <tr>
1.271 wiz 13238: <td>MANCOMPRESSED_IF_MANZ</td>
1.273 wiz 13239: <td>MANINSTALL</td>
1.227 wiz 13240: </tr>
13241: <tr>
1.271 wiz 13242: <td>MANZ</td>
1.273 wiz 13243: <td>MARIADB_VERSIONS_ALL</td>
1.156 leot 13244: </tr>
13245: <tr>
1.271 wiz 13246: <td>MASTER_SITES</td>
1.273 wiz 13247: <td>MASTER_SITE_BACKUP</td>
1.212 wiz 13248: </tr>
13249: <tr>
1.271 wiz 13250: <td>MASTER_SITE_LOCAL</td>
1.273 wiz 13251: <td>MASTER_SITE_MOZILLA</td>
1.156 leot 13252: </tr>
13253: <tr>
1.271 wiz 13254: <td>MASTER_SITE_OVERRIDE</td>
1.273 wiz 13255: <td>MASTER_SITE_PERL_CPAN</td>
1.156 leot 13256: </tr>
13257: <tr>
1.271 wiz 13258: <td>MASTER_SORT</td>
1.273 wiz 13259: <td>MASTER_SORT_RANDOM</td>
1.156 leot 13260: </tr>
13261: <tr>
1.271 wiz 13262: <td>MASTER_SORT_REGEX</td>
1.273 wiz 13263: <td>MECAB_CHARSET</td>
1.156 leot 13264: </tr>
13265: <tr>
1.271 wiz 13266: <td>MEDIATOMB_GROUP</td>
1.273 wiz 13267: <td>MEDIATOMB_USER</td>
1.189 bacon 13268: </tr>
13269: <tr>
1.271 wiz 13270: <td>MIPSPROBASE</td>
1.273 wiz 13271: <td>MIREDO_GROUP</td>
1.156 leot 13272: </tr>
13273: <tr>
1.271 wiz 13274: <td>MIREDO_USER</td>
1.273 wiz 13275: <td>MISSING_FEATURES</td>
1.156 leot 13276: </tr>
13277: <tr>
1.271 wiz 13278: <td>MKDIR</td>
1.273 wiz 13279: <td>MKPIE_SUPPORTED</td>
1.156 leot 13280: </tr>
13281: <tr>
1.271 wiz 13282: <td>MLDONKEY_GROUP</td>
1.273 wiz 13283: <td>MLDONKEY_HOME</td>
1.156 leot 13284: </tr>
13285: <tr>
1.271 wiz 13286: <td>MLDONKEY_USER</td>
1.273 wiz 13287: <td>MONOTONE_GROUP</td>
1.156 leot 13288: </tr>
13289: <tr>
1.271 wiz 13290: <td>MONOTONE_USER</td>
1.273 wiz 13291: <td>MOTIFBASE</td>
1.156 leot 13292: </tr>
13293: <tr>
1.271 wiz 13294: <td>MOTIF_TYPE</td>
1.273 wiz 13295: <td>MOTIF_TYPE_DEFAULT</td>
1.156 leot 13296: </tr>
13297: <tr>
1.271 wiz 13298: <td>MPI_TYPE</td>
1.273 wiz 13299: <td>MSGFMT_STRIP_MSGCTXT</td>
1.156 leot 13300: </tr>
13301: <tr>
1.271 wiz 13302: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.273 wiz 13303: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.156 leot 13304: </tr>
13305: <tr>
1.271 wiz 13306: <td>MUST</td>
1.273 wiz 13307: <td>MV</td>
1.263 wiz 13308: </tr>
13309: <tr>
1.271 wiz 13310: <td>MYSQL_CHARSET</td>
1.273 wiz 13311: <td>MYSQL_DATADIR</td>
1.241 rillig 13312: </tr>
13313: <tr>
1.271 wiz 13314: <td>MYSQL_EXTRA_CHARSET</td>
1.273 wiz 13315: <td>MYSQL_GROUP</td>
1.156 leot 13316: </tr>
13317: <tr>
1.271 wiz 13318: <td>MYSQL_USER</td>
1.273 wiz 13319: <td>MYSQL_VERSION</td>
1.238 wiz 13320: </tr>
13321: <tr>
1.271 wiz 13322: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.273 wiz 13323: <td>MYSQL_VERSION_DEFAULT</td>
1.223 nia 13324: </tr>
13325: <tr>
1.271 wiz 13326: <td>NAGIOSCMD_GROUP</td>
1.273 wiz 13327: <td>NAGIOSDIR</td>
1.214 leot 13328: </tr>
13329: <tr>
1.271 wiz 13330: <td>NAGIOS_GROUP</td>
1.273 wiz 13331: <td>NAGIOS_USER</td>
1.197 leot 13332: </tr>
13333: <tr>
1.271 wiz 13334: <td>NATIVE_EXEC_FMT</td>
1.273 wiz 13335: <td>NATIVE_LOWER_OPSYS</td>
1.205 wiz 13336: </tr>
13337: <tr>
1.271 wiz 13338: <td>NATIVE_LOWER_VENDOR</td>
1.273 wiz 13339: <td>NATIVE_MACHINE_PLATFORM</td>
1.156 leot 13340: </tr>
13341: <tr>
1.271 wiz 13342: <td>NATIVE_OBJECT_FMT</td>
1.273 wiz 13343: <td>NATIVE_OPSYS_VERSION</td>
1.156 leot 13344: </tr>
13345: <tr>
1.271 wiz 13346: <td>NATIVE_OS_VARIANT</td>
1.273 wiz 13347: <td>NATIVE_OS_VERSION</td>
1.156 leot 13348: </tr>
13349: <tr>
1.271 wiz 13350: <td>NBPAX_PROGRAM_PREFIX</td>
1.273 wiz 13351: <td>NETBSD_LOGIN_NAME</td>
1.255 wiz 13352: </tr>
13353: <tr>
1.271 wiz 13354: <td>NMH_EDITOR</td>
1.273 wiz 13355: <td>NMH_MTA</td>
1.255 wiz 13356: </tr>
13357: <tr>
1.271 wiz 13358: <td>NMH_PAGER</td>
1.273 wiz 13359: <td>NODE_VERSIONS_ACCEPTED</td>
1.156 leot 13360: </tr>
13361: <tr>
1.271 wiz 13362: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.273 wiz 13363: <td>NODE_VERSION_DEFAULT</td>
1.195 gutterid 13364: </tr>
13365: <tr>
1.271 wiz 13366: <td>NODE_VERSION_REQD</td>
1.273 wiz 13367: <td>NOLOGIN</td>
1.156 leot 13368: </tr>
13369: <tr>
1.271 wiz 13370: <td>NOTE</td>
1.273 wiz 13371: <td>NOT_FOR_PLATFORM</td>
1.156 leot 13372: </tr>
13373: <tr>
1.271 wiz 13374: <td>NOT_PAX_ASLR_SAFE</td>
1.273 wiz 13375: <td>NOT_PAX_MPROTECT_SAFE</td>
1.156 leot 13376: </tr>
13377: <tr>
1.271 wiz 13378: <td>NO_BUILD</td>
1.273 wiz 13379: <td>NO_CHECKSUM</td>
1.156 leot 13380: </tr>
13381: <tr>
1.271 wiz 13382: <td>NO_CONFIGURE</td>
1.273 wiz 13383: <td>NO_SKIP</td>
1.156 leot 13384: </tr>
13385: <tr>
1.271 wiz 13386: <td>NSD_GROUP</td>
1.273 wiz 13387: <td>NSD_LOG_FACILITY</td>
1.229 gutterid 13388: </tr>
13389: <tr>
1.271 wiz 13390: <td>NSD_USER</td>
1.273 wiz 13391: <td>NS_PREFERRED</td>
1.260 wiz 13392: </tr>
13393: <tr>
1.271 wiz 13394: <td>NULLMAILER_GROUP</td>
1.273 wiz 13395: <td>NULLMAILER_USER</td>
1.218 nia 13396: </tr>
13397: <tr>
1.271 wiz 13398: <td>OBJECT_FMT</td>
1.273 wiz 13399: <td>OBJHOSTNAME</td>
1.218 nia 13400: </tr>
13401: <tr>
1.271 wiz 13402: <td>OBJMACHINE</td>
1.273 wiz 13403: <td>OCAML_FINDLIB_DIRS</td>
1.156 leot 13404: </tr>
13405: <tr>
1.271 wiz 13406: <td>OCAML_FINDLIB_REGISTER</td>
1.273 wiz 13407: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.178 rillig 13408: </tr>
13409: <tr>
1.271 wiz 13410: <td>OCAML_SITELIBDIR</td>
1.273 wiz 13411: <td>OMF</td>
1.156 leot 13412: </tr>
13413: <tr>
1.271 wiz 13414: <td>ONLY_FOR_COMPILER</td>
1.273 wiz 13415: <td>ONLY_FOR_PLATFORM</td>
1.156 leot 13416: </tr>
13417: <tr>
1.271 wiz 13418: <td>OPENSSH_CHROOT</td>
1.273 wiz 13419: <td>OPENSSH_GROUP</td>
1.156 leot 13420: </tr>
13421: <tr>
1.271 wiz 13422: <td>OPENSSH_USER</td>
1.273 wiz 13423: <td>OPSYS</td>
1.156 leot 13424: </tr>
13425: <tr>
1.271 wiz 13426: <td>OPSYS_EMULDIR</td>
1.273 wiz 13427: <td>OPSYS_VERSION</td>
1.156 leot 13428: </tr>
13429: <tr>
1.271 wiz 13430: <td>OS</td>
1.273 wiz 13431: <td>OSS_TYPE</td>
1.156 leot 13432: </tr>
13433: <tr>
1.271 wiz 13434: <td>OSX</td>
1.273 wiz 13435: <td>OSX_PATH_TO_M4</td>
1.156 leot 13436: </tr>
13437: <tr>
1.271 wiz 13438: <td>OSX_PATH_TO_YACC</td>
1.273 wiz 13439: <td>OS_HAVE_ALSA</td>
1.263 wiz 13440: </tr>
13441: <tr>
1.271 wiz 13442: <td>OS_HAVE_RCD</td>
1.273 wiz 13443: <td>OS_VARIANT</td>
1.254 wiz 13444: </tr>
13445: <tr>
1.271 wiz 13446: <td>OS_VERSION</td>
1.273 wiz 13447: <td>OTF_FONTS_DIR</td>
1.254 wiz 13448: </tr>
13449: <tr>
1.271 wiz 13450: <td>OVERRIDE_DIRDEPTH</td>
1.273 wiz 13451: <td>OVERRIDE_GEMSPEC</td>
1.238 wiz 13452: </tr>
13453: <tr>
1.271 wiz 13454: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.273 wiz 13455: <td>OVERRIDE_ROCKSPEC</td>
1.156 leot 13456: </tr>
13457: <tr>
1.271 wiz 13458: <td>OWN_DIRS</td>
1.273 wiz 13459: <td>OWN_DIRS_PERMS</td>
1.258 wiz 13460: </tr>
13461: <tr>
1.271 wiz 13462: <td>P4GROUP</td>
1.273 wiz 13463: <td>P4PORT</td>
1.246 leot 13464: </tr>
13465: <tr>
1.271 wiz 13466: <td>P4ROOT</td>
1.273 wiz 13467: <td>P4USER</td>
1.233 wiz 13468: </tr>
13469: <tr>
1.271 wiz 13470: <td>PACKAGES</td>
1.273 wiz 13471: <td>PALMOS_DEFAULT_SDK</td>
1.214 leot 13472: </tr>
13473: <tr>
1.271 wiz 13474: <td>PAMBASE</td>
1.273 wiz 13475: <td>PAM_DEFAULT</td>
1.227 wiz 13476: </tr>
13477: <tr>
1.271 wiz 13478: <td>PAPERSIZE</td>
1.273 wiz 13479: <td>PASSIVE_FETCH</td>
1.205 wiz 13480: </tr>
13481: <tr>
1.271 wiz 13482: <td>PATCHDIR</td>
1.273 wiz 13483: <td>PATCHFILES</td>
1.161 leot 13484: </tr>
13485: <tr>
1.271 wiz 13486: <td>PATCH_ARGS</td>
1.273 wiz 13487: <td>PATCH_DEBUG</td>
1.156 leot 13488: </tr>
13489: <tr>
1.271 wiz 13490: <td>PATCH_DIST_ARGS</td>
1.273 wiz 13491: <td>PATCH_DIST_CAT</td>
1.156 leot 13492: </tr>
13493: <tr>
1.271 wiz 13494: <td>PATCH_DIST_STRIP</td>
1.273 wiz 13495: <td>PATCH_FUZZ_FACTOR</td>
1.156 leot 13496: </tr>
13497: <tr>
1.271 wiz 13498: <td>PATCH_STRIP</td>
1.273 wiz 13499: <td>PATH</td>
1.156 leot 13500: </tr>
13501: <tr>
1.271 wiz 13502: <td>PCCBASE</td>
1.273 wiz 13503: <td>PEAR</td>
1.254 wiz 13504: </tr>
13505: <tr>
1.271 wiz 13506: <td>PEAR_CHANNEL</td>
1.273 wiz 13507: <td>PEAR_CHANNEL_ALIAS</td>
1.263 wiz 13508: </tr>
13509: <tr>
1.271 wiz 13510: <td>PEAR_CHANNEL_VERSION</td>
1.273 wiz 13511: <td>PEAR_CMD</td>
1.263 wiz 13512: </tr>
13513: <tr>
1.271 wiz 13514: <td>PEAR_LIB</td>
1.273 wiz 13515: <td>PEAR_PACKAGE_XML</td>
1.258 wiz 13516: </tr>
13517: <tr>
1.271 wiz 13518: <td>PEP-518</td>
1.273 wiz 13519: <td>PERL5</td>
1.227 wiz 13520: </tr>
13521: <tr>
1.271 wiz 13522: <td>PERL5_CONFIGURE</td>
1.273 wiz 13523: <td>PERL5_CONFIGURE_DIRS</td>
1.156 leot 13524: </tr>
13525: <tr>
1.271 wiz 13526: <td>PERL5_LDFLAGS</td>
1.273 wiz 13527: <td>PERL5_LICENSE</td>
1.217 rillig 13528: </tr>
13529: <tr>
1.271 wiz 13530: <td>PERL5_MODULE_TYPE</td>
1.273 wiz 13531: <td>PERL5_PACKLIST</td>
1.205 wiz 13532: </tr>
13533: <tr>
1.271 wiz 13534: <td>PERL5_PACKLIST_DIR</td>
1.273 wiz 13535: <td>PERL5_PERLBASE</td>
1.177 leot 13536: </tr>
13537: <tr>
1.271 wiz 13538: <td>PERL5_SITEBASE</td>
1.273 wiz 13539: <td>PERL5_USE_PACKLIST</td>
1.161 leot 13540: </tr>
13541: <tr>
1.271 wiz 13542: <td>PERL5_VENDORBASE</td>
1.273 wiz 13543: <td>PFCTL</td>
1.161 leot 13544: </tr>
13545: <tr>
1.271 wiz 13546: <td>PFVAR_H</td>
1.273 wiz 13547: <td>PF_VERSION</td>
1.156 leot 13548: </tr>
13549: <tr>
1.271 wiz 13550: <td>PGGROUP</td>
1.273 wiz 13551: <td>PGHOME</td>
1.156 leot 13552: </tr>
13553: <tr>
1.271 wiz 13554: <td>PGPKGSRCDIR</td>
1.273 wiz 13555: <td>PGSQL_TYPE</td>
1.156 leot 13556: </tr>
13557: <tr>
1.271 wiz 13558: <td>PGSQL_VERSION</td>
1.273 wiz 13559: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.156 leot 13560: </tr>
13561: <tr>
1.271 wiz 13562: <td>PGSQL_VERSION_DEFAULT</td>
1.273 wiz 13563: <td>PGUSER</td>
1.156 leot 13564: </tr>
13565: <tr>
1.271 wiz 13566: <td>PG_LIB_EXT</td>
1.273 wiz 13567: <td>PHP</td>
1.156 leot 13568: </tr>
13569: <tr>
1.271 wiz 13570: <td>PHPCOMMON_MK</td>
1.273 wiz 13571: <td>PHPPKGSRCDIR</td>
1.260 wiz 13572: </tr>
13573: <tr>
1.271 wiz 13574: <td>PHP_BASE_VERS</td>
1.273 wiz 13575: <td>PHP_EGDIR</td>
1.156 leot 13576: </tr>
13577: <tr>
1.271 wiz 13578: <td>PHP_EXTENSION_DIR</td>
1.273 wiz 13579: <td>PHP_INCDIR</td>
1.156 leot 13580: </tr>
13581: <tr>
1.271 wiz 13582: <td>PHP_LIBDIR</td>
1.273 wiz 13583: <td>PHP_MAJOR_VERS</td>
1.260 wiz 13584: </tr>
13585: <tr>
1.271 wiz 13586: <td>PHP_MINIMUM_TEENY</td>
1.273 wiz 13587: <td>PHP_MINOR_VERS</td>
1.260 wiz 13588: </tr>
13589: <tr>
1.271 wiz 13590: <td>PHP_PKG_PREFIX</td>
1.273 wiz 13591: <td>PHP_SHAREDIR</td>
1.156 leot 13592: </tr>
13593: <tr>
1.271 wiz 13594: <td>PHP_VER</td>
1.273 wiz 13595: <td>PHP_VERSION</td>
1.156 leot 13596: </tr>
13597: <tr>
1.271 wiz 13598: <td>PHP_VERSIONS_ACCEPTED</td>
1.273 wiz 13599: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.156 leot 13600: </tr>
13601: <tr>
1.271 wiz 13602: <td>PHP_VERSION_DEFAULT</td>
1.273 wiz 13603: <td>PHP_VERSION_REQD</td>
1.156 leot 13604: </tr>
13605: <tr>
1.271 wiz 13606: <td>PILRC_USE_GTK</td>
1.273 wiz 13607: <td>PKGCONFIG_BASE</td>
1.156 leot 13608: </tr>
13609: <tr>
1.271 wiz 13610: <td>PKGCONFIG_FILE</td>
1.273 wiz 13611: <td>PKGCONFIG_OVERRIDE</td>
1.156 leot 13612: </tr>
13613: <tr>
1.271 wiz 13614: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.273 wiz 13615: <td>PKGDIR</td>
1.156 leot 13616: </tr>
13617: <tr>
1.271 wiz 13618: <td>PKGGNUDIR</td>
1.273 wiz 13619: <td>PKGINFODIR</td>
1.156 leot 13620: </tr>
13621: <tr>
1.271 wiz 13622: <td>PKGLOCALEDIR</td>
1.273 wiz 13623: <td>PKGMANDIR</td>
1.156 leot 13624: </tr>
13625: <tr>
1.271 wiz 13626: <td>PKGNAME</td>
1.273 wiz 13627: <td>PKGNAME_REQD</td>
1.156 leot 13628: </tr>
13629: <tr>
1.271 wiz 13630: <td>PKGPATH</td>
1.273 wiz 13631: <td>PKGREVISION</td>
1.156 leot 13632: </tr>
13633: <tr>
1.271 wiz 13634: <td>PKGSRC_BLAS_TYPES</td>
1.273 wiz 13635: <td>PKGSRC_CHANGES</td>
1.156 leot 13636: </tr>
13637: <tr>
1.271 wiz 13638: <td>PKGSRC_COMPILER</td>
1.273 wiz 13639: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.156 leot 13640: </tr>
13641: <tr>
1.271 wiz 13642: <td>PKGSRC_LOCKTYPE</td>
1.273 wiz 13643: <td>PKGSRC_MAKE_ENV</td>
1.156 leot 13644: </tr>
13645: <tr>
1.271 wiz 13646: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.273 wiz 13647: <td>PKGSRC_MKPIE</td>
1.156 leot 13648: </tr>
13649: <tr>
1.271 wiz 13650: <td>PKGSRC_MKREPRO</td>
1.273 wiz 13651: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.156 leot 13652: </tr>
13653: <tr>
1.271 wiz 13654: <td>PKGSRC_RUN_TEST</td>
1.273 wiz 13655: <td>PKGSRC_SETENV</td>
1.177 leot 13656: </tr>
13657: <tr>
1.271 wiz 13658: <td>PKGSRC_SLEEPSECS</td>
1.273 wiz 13659: <td>PKGSRC_TODO</td>
1.156 leot 13660: </tr>
13661: <tr>
1.271 wiz 13662: <td>PKGSRC_USE_CTF</td>
1.273 wiz 13663: <td>PKGSRC_USE_FORTIFY</td>
1.159 rillig 13664: </tr>
13665: <tr>
1.271 wiz 13666: <td>PKGSRC_USE_MKTOOLS</td>
1.273 wiz 13667: <td>PKGSRC_USE_RELRO</td>
1.156 leot 13668: </tr>
13669: <tr>
1.271 wiz 13670: <td>PKGSRC_USE_SSP</td>
1.273 wiz 13671: <td>PKGSRC_USE_STACK_CHECK</td>
1.156 leot 13672: </tr>
13673: <tr>
1.271 wiz 13674: <td>PKGTASKS_DATAFILE</td>
1.273 wiz 13675: <td>PKGTOOLS_ARGS</td>
1.156 leot 13676: </tr>
13677: <tr>
1.271 wiz 13678: <td>PKGTOOLS_ENV</td>
1.273 wiz 13679: <td>PKG_ALTERNATIVES</td>
1.156 leot 13680: </tr>
13681: <tr>
1.271 wiz 13682: <td>PKG_APACHE</td>
1.273 wiz 13683: <td>PKG_APACHE_ACCEPTED</td>
1.156 leot 13684: </tr>
13685: <tr>
1.271 wiz 13686: <td>PKG_APACHE_DEFAULT</td>
1.273 wiz 13687: <td>PKG_BEST_EXISTS</td>
1.156 leot 13688: </tr>
13689: <tr>
1.271 wiz 13690: <td>PKG_BUILD_OPTIONS</td>
1.273 wiz 13691: <td>PKG_COMPRESSION</td>
1.156 leot 13692: </tr>
13693: <tr>
1.271 wiz 13694: <td>PKG_CONFIG</td>
1.273 wiz 13695: <td>PKG_CONFIG_PERMS</td>
1.156 leot 13696: </tr>
13697: <tr>
1.271 wiz 13698: <td>PKG_CREATE_USERGROUP</td>
1.273 wiz 13699: <td>PKG_DBDIR</td>
1.156 leot 13700: </tr>
13701: <tr>
1.271 wiz 13702: <td>PKG_DB_TMPDIR</td>
1.273 wiz 13703: <td>PKG_DEBUG_LEVEL</td>
1.156 leot 13704: </tr>
13705: <tr>
1.271 wiz 13706: <td>PKG_DEFAULT_OPTIONS</td>
1.273 wiz 13707: <td>PKG_DESTDIR_SUPPORT</td>
1.156 leot 13708: </tr>
13709: <tr>
1.271 wiz 13710: <td>PKG_DEVELOPER</td>
1.273 wiz 13711: <td>PKG_DISABLED_OPTIONS</td>
1.156 leot 13712: </tr>
13713: <tr>
1.271 wiz 13714: <td>PKG_FATAL_ERRORS</td>
1.273 wiz 13715: <td>PKG_FC</td>
1.233 wiz 13716: </tr>
13717: <tr>
1.271 wiz 13718: <td>PKG_FILELIST_CMD</td>
1.273 wiz 13719: <td>PKG_GECOS</td>
1.246 leot 13720: </tr>
13721: <tr>
1.271 wiz 13722: <td>PKG_GID</td>
1.273 wiz 13723: <td>PKG_GROUPS</td>
1.156 leot 13724: </tr>
13725: <tr>
1.271 wiz 13726: <td>PKG_GROUPS_VARS</td>
1.273 wiz 13727: <td>PKG_HOME</td>
1.156 leot 13728: </tr>
13729: <tr>
1.271 wiz 13730: <td>PKG_INIT_SCRIPTS</td>
1.273 wiz 13731: <td>PKG_JAVA_HOME</td>
1.156 leot 13732: </tr>
13733: <tr>
1.271 wiz 13734: <td>PKG_JVM</td>
1.273 wiz 13735: <td>PKG_JVMS_ACCEPTED</td>
1.156 leot 13736: </tr>
13737: <tr>
1.271 wiz 13738: <td>PKG_JVM_DEFAULT</td>
1.273 wiz 13739: <td>PKG_LEGACY_OPTIONS</td>
1.156 leot 13740: </tr>
13741: <tr>
1.271 wiz 13742: <td>PKG_LIBTOOL</td>
1.273 wiz 13743: <td>PKG_MKSYMLINKS</td>
1.156 leot 13744: </tr>
13745: <tr>
1.271 wiz 13746: <td>PKG_OPTIONS</td>
1.273 wiz 13747: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.156 leot 13748: </tr>
13749: <tr>
1.271 wiz 13750: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.273 wiz 13751: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.156 leot 13752: </tr>
13753: <tr>
1.271 wiz 13754: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.273 wiz 13755: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.156 leot 13756: </tr>
13757: <tr>
1.271 wiz 13758: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.273 wiz 13759: <td>PKG_OPTIONS_VAR</td>
1.226 gutterid 13760: </tr>
13761: <tr>
1.271 wiz 13762: <td>PKG_RCD_SCRIPTS</td>
1.273 wiz 13763: <td>PKG_REFCOUNT_DBDIR</td>
1.156 leot 13764: </tr>
13765: <tr>
1.271 wiz 13766: <td>PKG_REGISTER_SHELLS</td>
1.273 wiz 13767: <td>PKG_RESUME_TRANSFERS</td>
1.156 leot 13768: </tr>
13769: <tr>
1.271 wiz 13770: <td>PKG_SHELL</td>
1.273 wiz 13771: <td>PKG_SUGGESTED_OPTIONS</td>
1.156 leot 13772: </tr>
13773: <tr>
1.271 wiz 13774: <td>PKG_SUPPORTED_OPTIONS</td>
1.273 wiz 13775: <td>PKG_SYSCONFBASE</td>
1.156 leot 13776: </tr>
13777: <tr>
1.271 wiz 13778: <td>PKG_SYSCONFBASEDIR</td>
1.273 wiz 13779: <td>PKG_SYSCONFDIR</td>
1.156 leot 13780: </tr>
13781: <tr>
1.271 wiz 13782: <td>PKG_SYSCONFDIR_PERMS</td>
1.273 wiz 13783: <td>PKG_SYSCONFSUBDIR</td>
1.156 leot 13784: </tr>
13785: <tr>
1.271 wiz 13786: <td>PKG_SYSCONFVAR</td>
1.273 wiz 13787: <td>PKG_TOOLS_BIN</td>
1.156 leot 13788: </tr>
13789: <tr>
1.271 wiz 13790: <td>PKG_UID</td>
1.273 wiz 13791: <td>PKG_UPDATE_FONTS_DB</td>
1.156 leot 13792: </tr>
13793: <tr>
1.271 wiz 13794: <td>PKG_USERS</td>
1.273 wiz 13795: <td>PKG_USERS_VARS</td>
1.156 leot 13796: </tr>
13797: <tr>
1.271 wiz 13798: <td>PKG_VERBOSE</td>
1.273 wiz 13799: <td>PLEASE</td>
1.156 leot 13800: </tr>
13801: <tr>
1.271 wiz 13802: <td>PLIST</td>
1.273 wiz 13803: <td>PLIST_AWK</td>
1.156 leot 13804: </tr>
13805: <tr>
1.271 wiz 13806: <td>PLIST_AWK_ENV</td>
1.273 wiz 13807: <td>PLIST_SRC</td>
1.156 leot 13808: </tr>
13809: <tr>
1.271 wiz 13810: <td>PLIST_SUBST</td>
1.273 wiz 13811: <td>PLIST_TYPE</td>
1.156 leot 13812: </tr>
13813: <tr>
1.271 wiz 13814: <td>PLIST_VARS</td>
1.273 wiz 13815: <td>POPTOP_USE_MPPE</td>
1.156 leot 13816: </tr>
13817: <tr>
1.271 wiz 13818: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.273 wiz 13819: <td>POST_FETCH_HOOK</td>
1.156 leot 13820: </tr>
13821: <tr>
1.271 wiz 13822: <td>PREFER</td>
1.273 wiz 13823: <td>PREFER_NATIVE</td>
1.156 leot 13824: </tr>
13825: <tr>
1.271 wiz 13826: <td>PREFER_NATIVE_PTHREADS</td>
1.273 wiz 13827: <td>PREFER_PKGSRC</td>
1.156 leot 13828: </tr>
13829: <tr>
1.271 wiz 13830: <td>PREFIX</td>
1.273 wiz 13831: <td>PREPEND_PATH</td>
1.156 leot 13832: </tr>
13833: <tr>
1.271 wiz 13834: <td>PRE_ROOT_CMD</td>
1.273 wiz 13835: <td>PRIVILEGED_STAGES</td>
1.156 leot 13836: </tr>
13837: <tr>
1.271 wiz 13838: <td>PS</td>
1.273 wiz 13839: <td>PTHREAD_AUTO_VARS</td>
1.156 leot 13840: </tr>
13841: <tr>
1.271 wiz 13842: <td>PTHREAD_CFLAGS</td>
1.273 wiz 13843: <td>PTHREAD_LDFLAGS</td>
1.156 leot 13844: </tr>
13845: <tr>
1.271 wiz 13846: <td>PTHREAD_LIBS</td>
1.273 wiz 13847: <td>PTHREAD_OPTS</td>
1.156 leot 13848: </tr>
13849: <tr>
1.271 wiz 13850: <td>PTHREAD_TYPE</td>
1.273 wiz 13851: <td>PVM_SSH</td>
1.156 leot 13852: </tr>
13853: <tr>
1.271 wiz 13854: <td>PYPKGPREFIX</td>
1.273 wiz 13855: <td>PYSOABISUFFIX</td>
1.156 leot 13856: </tr>
13857: <tr>
1.271 wiz 13858: <td>PYTHON_27_ACCEPTED</td>
1.273 wiz 13859: <td>PYTHON_FOR_BUILD_ONLY</td>
1.265 leot 13860: </tr>
13861: <tr>
1.271 wiz 13862: <td>PYTHON_SELF_CONFLICT</td>
1.273 wiz 13863: <td>PYTHON_VERSION</td>
1.156 leot 13864: </tr>
13865: <tr>
1.271 wiz 13866: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.273 wiz 13867: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.156 leot 13868: </tr>
13869: <tr>
1.271 wiz 13870: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.273 wiz 13871: <td>PYTHON_VERSION_DEFAULT</td>
1.156 leot 13872: </tr>
13873: <tr>
1.271 wiz 13874: <td>PYTHON_VERSION_REQD</td>
1.273 wiz 13875: <td>PYVERSSUFFIX</td>
1.156 leot 13876: </tr>
13877: <tr>
1.271 wiz 13878: <td>QMAILDIR</td>
1.273 wiz 13879: <td>QMAIL_ALIAS_USER</td>
1.156 leot 13880: </tr>
13881: <tr>
1.271 wiz 13882: <td>QMAIL_DAEMON_USER</td>
1.273 wiz 13883: <td>QMAIL_LOG_USER</td>
1.156 leot 13884: </tr>
13885: <tr>
1.271 wiz 13886: <td>QMAIL_NOFILES_GROUP</td>
1.273 wiz 13887: <td>QMAIL_PASSWD_USER</td>
1.156 leot 13888: </tr>
13889: <tr>
1.271 wiz 13890: <td>QMAIL_QMAIL_GROUP</td>
1.273 wiz 13891: <td>QMAIL_QUEUE_DIR</td>
1.156 leot 13892: </tr>
13893: <tr>
1.271 wiz 13894: <td>QMAIL_QUEUE_EXTRA</td>
1.273 wiz 13895: <td>QMAIL_QUEUE_USER</td>
1.156 leot 13896: </tr>
13897: <tr>
1.271 wiz 13898: <td>QMAIL_REMOTE_USER</td>
1.273 wiz 13899: <td>QMAIL_ROOT_USER</td>
1.156 leot 13900: </tr>
13901: <tr>
1.271 wiz 13902: <td>QMAIL_SEND_USER</td>
1.273 wiz 13903: <td>QORE_LATEST_MODULE_API</td>
1.156 leot 13904: </tr>
13905: <tr>
1.271 wiz 13906: <td>QORE_MODULE_API</td>
1.273 wiz 13907: <td>QORE_MODULE_DIR</td>
1.156 leot 13908: </tr>
13909: <tr>
1.271 wiz 13910: <td>QORE_USER_MODULE_DIR</td>
1.273 wiz 13911: <td>QORE_VERSION</td>
1.156 leot 13912: </tr>
13913: <tr>
1.271 wiz 13914: <td>QPOPPER_FAC</td>
1.273 wiz 13915: <td>QPOPPER_SPOOL_DIR</td>
1.156 leot 13916: </tr>
13917: <tr>
1.271 wiz 13918: <td>QPOPPER_USER</td>
1.273 wiz 13919: <td>RAKE_NAME</td>
1.156 leot 13920: </tr>
13921: <tr>
1.271 wiz 13922: <td>RASMOL_DEPTH</td>
1.273 wiz 13923: <td>RCD_DIR</td>
1.156 leot 13924: </tr>
13925: <tr>
1.271 wiz 13926: <td>RCD_ORDER</td>
1.273 wiz 13927: <td>RCD_SCRIPTS</td>
1.263 wiz 13928: </tr>
13929: <tr>
1.271 wiz 13930: <td>RCD_SCRIPTS_DIR</td>
1.273 wiz 13931: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.258 wiz 13932: </tr>
13933: <tr>
1.271 wiz 13934: <td>RCD_SCRIPTS_MODE</td>
1.273 wiz 13935: <td>RCD_SCRIPTS_SHELL</td>
1.218 nia 13936: </tr>
13937: <tr>
1.271 wiz 13938: <td>RCD_SCRIPT_SRC</td>
1.273 wiz 13939: <td>RCD_SUBR</td>
1.241 rillig 13940: </tr>
13941: <tr>
1.271 wiz 13942: <td>RDOC</td>
1.273 wiz 13943: <td>READLINE_DEFAULT</td>
1.214 leot 13944: </tr>
13945: <tr>
1.271 wiz 13946: <td>READLINE_TYPE</td>
1.273 wiz 13947: <td>REAL_ROOT_GROUP</td>
1.205 wiz 13948: </tr>
13949: <tr>
1.271 wiz 13950: <td>REAL_ROOT_USER</td>
1.273 wiz 13951: <td>RECURSIVE_MAKE</td>
1.223 nia 13952: </tr>
13953: <tr>
1.271 wiz 13954: <td>RELAY_CTRL_DIR</td>
1.273 wiz 13955: <td>RELRO_SUPPORTED</td>
1.177 leot 13956: </tr>
13957: <tr>
1.271 wiz 13958: <td>REPLACE_AWK</td>
1.273 wiz 13959: <td>REPLACE_BASH</td>
1.214 leot 13960: </tr>
13961: <tr>
1.271 wiz 13962: <td>REPLACE_CSH</td>
1.273 wiz 13963: <td>REPLACE_KSH</td>
1.212 wiz 13964: </tr>
13965: <tr>
1.271 wiz 13966: <td>REPLACE_LUA</td>
1.273 wiz 13967: <td>REPLACE_NODEJS</td>
1.156 leot 13968: </tr>
13969: <tr>
1.271 wiz 13970: <td>REPLACE_OCTAVE</td>
1.273 wiz 13971: <td>REPLACE_PERL</td>
1.205 wiz 13972: </tr>
13973: <tr>
1.271 wiz 13974: <td>REPLACE_PERL6</td>
1.273 wiz 13975: <td>REPLACE_PHP</td>
1.197 leot 13976: </tr>
13977: <tr>
1.271 wiz 13978: <td>REPLACE_PYTHON</td>
1.273 wiz 13979: <td>REPLACE_QORE</td>
1.156 leot 13980: </tr>
13981: <tr>
1.271 wiz 13982: <td>REPLACE_R</td>
1.273 wiz 13983: <td>REPLACE_RUBY</td>
1.218 nia 13984: </tr>
13985: <tr>
1.271 wiz 13986: <td>REPLACE_RUBY_DIRS</td>
1.273 wiz 13987: <td>REPLACE_RUBY_PAT</td>
1.161 leot 13988: </tr>
13989: <tr>
1.271 wiz 13990: <td>REPLACE_SH</td>
1.273 wiz 13991: <td>REPLACE_TEXLUA</td>
1.254 wiz 13992: </tr>
13993: <tr>
1.271 wiz 13994: <td>REPLACE_TOOL_PYTHON</td>
1.273 wiz 13995: <td>REPLACE_WISH</td>
1.216 gutterid 13996: </tr>
13997: <tr>
1.271 wiz 13998: <td>REQD_DIRS</td>
1.273 wiz 13999: <td>REQD_DIRS_PERMS</td>
1.156 leot 14000: </tr>
14001: <tr>
1.271 wiz 14002: <td>REQD_FILES</td>
1.273 wiz 14003: <td>REQD_FILES_MODE</td>
1.218 nia 14004: </tr>
14005: <tr>
1.271 wiz 14006: <td>REQD_FILES_PERMS</td>
1.273 wiz 14007: <td>RESOLV_AUTO_VARS</td>
1.156 leot 14008: </tr>
14009: <tr>
1.271 wiz 14010: <td>RESOLV_LDFLAGS</td>
1.273 wiz 14011: <td>RESOLV_LIBS</td>
1.254 wiz 14012: </tr>
14013: <tr>
1.271 wiz 14014: <td>RM</td>
1.273 wiz 14015: <td>ROCKSPEC_NAME</td>
1.258 wiz 14016: </tr>
14017: <tr>
1.271 wiz 14018: <td>ROCKSPEC_SPECFILE</td>
1.273 wiz 14019: <td>ROOT_CMD</td>
1.263 wiz 14020: </tr>
14021: <tr>
1.271 wiz 14022: <td>ROOT_GROUP</td>
1.273 wiz 14023: <td>ROOT_USER</td>
1.238 wiz 14024: </tr>
14025: <tr>
1.271 wiz 14026: <td>RPCGEN</td>
1.273 wiz 14027: <td>RPM</td>
1.156 leot 14028: </tr>
14029: <tr>
1.271 wiz 14030: <td>RPM2PKG_PLIST</td>
1.273 wiz 14031: <td>RPM2PKG_PREFIX</td>
1.156 leot 14032: </tr>
14033: <tr>
1.271 wiz 14034: <td>RPM2PKG_STAGE</td>
1.273 wiz 14035: <td>RPM2PKG_STRIP</td>
1.205 wiz 14036: </tr>
14037: <tr>
1.271 wiz 14038: <td>RPM2PKG_SUBPREFIX</td>
1.273 wiz 14039: <td>RPMFILES</td>
1.217 rillig 14040: </tr>
14041: <tr>
1.271 wiz 14042: <td>RPMIGNOREPATH</td>
1.273 wiz 14043: <td>RPM_DB_PREFIX</td>
1.214 leot 14044: </tr>
14045: <tr>
1.271 wiz 14046: <td>RSSH_CVS_PATH</td>
1.273 wiz 14047: <td>RSSH_RDIST_PATH</td>
1.212 wiz 14048: </tr>
14049: <tr>
1.271 wiz 14050: <td>RSSH_RSYNC_PATH</td>
1.273 wiz 14051: <td>RSSH_SCP_PATH</td>
1.156 leot 14052: </tr>
14053: <tr>
1.271 wiz 14054: <td>RSSH_SFTP_SERVER_PATH</td>
1.273 wiz 14055: <td>RUBY</td>
1.197 leot 14056: </tr>
14057: <tr>
1.271 wiz 14058: <td>RUBYGEM</td>
1.273 wiz 14059: <td>RUBYGEM_MANPAGES</td>
1.156 leot 14060: </tr>
14061: <tr>
1.271 wiz 14062: <td>RUBYGEM_NAME</td>
1.273 wiz 14063: <td>RUBYGEM_OPTIONS</td>
1.156 leot 14064: </tr>
14065: <tr>
1.271 wiz 14066: <td>RUBYGEM_USE_MANPAGES</td>
1.273 wiz 14067: <td>RUBYGEM_VERBOSE</td>
1.156 leot 14068: </tr>
14069: <tr>
1.271 wiz 14070: <td>RUBY_ABI_VERSION</td>
1.273 wiz 14071: <td>RUBY_ALLOW_HAS_RDOC</td>
1.231 jnemeth 14072: </tr>
14073: <tr>
1.266 martin 14074: <td>RUBY_ARCH</td>
1.271 wiz 14075: <td>RUBY_ARCHINC</td>
1.156 leot 14076: </tr>
14077: <tr>
1.266 martin 14078: <td>RUBY_ARCHLIB</td>
1.271 wiz 14079: <td>RUBY_BASE</td>
1.156 leot 14080: </tr>
14081: <tr>
1.266 martin 14082: <td>RUBY_BASERIDIR</td>
1.271 wiz 14083: <td>RUBY_BUILD_DOCUMENT</td>
1.156 leot 14084: </tr>
14085: <tr>
1.266 martin 14086: <td>RUBY_DLEXT</td>
1.271 wiz 14087: <td>RUBY_DOC</td>
1.156 leot 14088: </tr>
14089: <tr>
1.266 martin 14090: <td>RUBY_DYNAMIC_DIRS</td>
1.271 wiz 14091: <td>RUBY_EG</td>
1.156 leot 14092: </tr>
14093: <tr>
1.271 wiz 14094: <td>RUBY_EXTCONF</td>
1.273 wiz 14095: <td>RUBY_EXTCONF_CHECK</td>
1.156 leot 14096: </tr>
14097: <tr>
1.271 wiz 14098: <td>RUBY_EXTCONF_DEBUG</td>
1.273 wiz 14099: <td>RUBY_EXTCONF_MAKEFILE</td>
1.156 leot 14100: </tr>
14101: <tr>
1.271 wiz 14102: <td>RUBY_GEM_ARCH</td>
1.273 wiz 14103: <td>RUBY_GEM_BASE</td>
1.198 leot 14104: </tr>
14105: <tr>
1.271 wiz 14106: <td>RUBY_INC</td>
1.273 wiz 14107: <td>RUBY_LIB</td>
1.156 leot 14108: </tr>
14109: <tr>
1.271 wiz 14110: <td>RUBY_LIB_BASE</td>
1.273 wiz 14111: <td>RUBY_NAME</td>
1.156 leot 14112: </tr>
14113: <tr>
1.271 wiz 14114: <td>RUBY_NOVERSION</td>
1.273 wiz 14115: <td>RUBY_PKGPREFIX</td>
1.156 leot 14116: </tr>
14117: <tr>
1.271 wiz 14118: <td>RUBY_RAILS</td>
1.273 wiz 14119: <td>RUBY_RAILS61_VERSION</td>
1.156 leot 14120: </tr>
14121: <tr>
1.271 wiz 14122: <td>RUBY_RAILS72_VERSION</td>
1.273 wiz 14123: <td>RUBY_RAILS80_VERSION</td>
1.156 leot 14124: </tr>
14125: <tr>
1.271 wiz 14126: <td>RUBY_RAILS_ACCEPTED</td>
1.273 wiz 14127: <td>RUBY_RAILS_DEFAULT</td>
1.259 leot 14128: </tr>
14129: <tr>
1.271 wiz 14130: <td>RUBY_RAILS_REQD</td>
1.273 wiz 14131: <td>RUBY_RAILS_STRICT_DEP</td>
1.156 leot 14132: </tr>
14133: <tr>
1.271 wiz 14134: <td>RUBY_RIDIR</td>
1.273 wiz 14135: <td>RUBY_SETUP</td>
1.156 leot 14136: </tr>
14137: <tr>
1.271 wiz 14138: <td>RUBY_SHLIB</td>
1.273 wiz 14139: <td>RUBY_SHLIBALIAS</td>
1.156 leot 14140: </tr>
14141: <tr>
1.271 wiz 14142: <td>RUBY_SHLIBVER</td>
1.273 wiz 14143: <td>RUBY_SIMPLE_INSTALL</td>
1.156 leot 14144: </tr>
14145: <tr>
1.271 wiz 14146: <td>RUBY_SITEARCHLIB</td>
1.273 wiz 14147: <td>RUBY_SITELIB</td>
1.156 leot 14148: </tr>
14149: <tr>
1.271 wiz 14150: <td>RUBY_SITELIB_BASE</td>
1.273 wiz 14151: <td>RUBY_SITERIDIR</td>
1.156 leot 14152: </tr>
14153: <tr>
1.271 wiz 14154: <td>RUBY_SLEXT</td>
1.273 wiz 14155: <td>RUBY_SRCDIR</td>
1.156 leot 14156: </tr>
14157: <tr>
1.271 wiz 14158: <td>RUBY_STATICLIB</td>
1.273 wiz 14159: <td>RUBY_SUFFIX</td>
1.156 leot 14160: </tr>
14161: <tr>
1.271 wiz 14162: <td>RUBY_SYSRIDIR</td>
1.273 wiz 14163: <td>RUBY_USE_PTHREAD</td>
1.174 leot 14164: </tr>
14165: <tr>
1.271 wiz 14166: <td>RUBY_VENDORARCHLIB</td>
1.273 wiz 14167: <td>RUBY_VENDORLIB</td>
1.156 leot 14168: </tr>
14169: <tr>
1.271 wiz 14170: <td>RUBY_VENDORLIB_BASE</td>
1.273 wiz 14171: <td>RUBY_VER</td>
1.156 leot 14172: </tr>
14173: <tr>
1.271 wiz 14174: <td>RUBY_VERSION</td>
1.273 wiz 14175: <td>RUBY_VERSIONS_ACCEPTED</td>
1.156 leot 14176: </tr>
14177: <tr>
1.271 wiz 14178: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.273 wiz 14179: <td>RUBY_VERSION_DEFAULT</td>
1.156 leot 14180: </tr>
14181: <tr>
1.271 wiz 14182: <td>RUBY_VERSION_REQD</td>
1.273 wiz 14183: <td>RUBY_VER_DIR</td>
1.156 leot 14184: </tr>
14185: <tr>
1.271 wiz 14186: <td>RUN</td>
1.273 wiz 14187: <td>RUN_LDCONFIG</td>
1.156 leot 14188: </tr>
14189: <tr>
1.271 wiz 14190: <td>RUST_TYPE</td>
1.273 wiz 14191: <td>SCO</td>
1.156 leot 14192: </tr>
14193: <tr>
1.271 wiz 14194: <td>SCREWS_GROUP</td>
1.273 wiz 14195: <td>SCREWS_USER</td>
1.156 leot 14196: </tr>
14197: <tr>
1.271 wiz 14198: <td>SCRIPTS_ENV</td>
1.273 wiz 14199: <td>SCROLLKEEPER_DATADIR</td>
1.156 leot 14200: </tr>
14201: <tr>
1.271 wiz 14202: <td>SCROLLKEEPER_REBUILDDB</td>
1.273 wiz 14203: <td>SCROLLKEEPER_UPDATEDB</td>
1.156 leot 14204: </tr>
14205: <tr>
1.271 wiz 14206: <td>SDIST_PAWD</td>
1.273 wiz 14207: <td>SDL12_TYPE</td>
1.156 leot 14208: </tr>
14209: <tr>
1.271 wiz 14210: <td>SERIAL_DEVICES</td>
1.273 wiz 14211: <td>SETGIDGAME</td>
1.156 leot 14212: </tr>
14213: <tr>
1.271 wiz 14214: <td>SETGID_GAMES_PERMS</td>
1.273 wiz 14215: <td>SETUID_ROOT_PERMS</td>
1.156 leot 14216: </tr>
14217: <tr>
1.271 wiz 14218: <td>SH</td>
1.273 wiz 14219: <td>SHAIRPORT_GROUP</td>
1.156 leot 14220: </tr>
14221: <tr>
1.271 wiz 14222: <td>SHAIRPORT_USER</td>
1.273 wiz 14223: <td>SHLIB_EXT</td>
1.267 leot 14224: </tr>
14225: <tr>
1.271 wiz 14226: <td>SHORTNAME</td>
1.273 wiz 14227: <td>SIGN_PACKAGES</td>
1.263 wiz 14228: </tr>
14229: <tr>
1.271 wiz 14230: <td>SILC_CLIENT_WITH_PERL</td>
1.273 wiz 14231: <td>SITE_SPECIFIC_PKGS</td>
1.258 wiz 14232: </tr>
14233: <tr>
1.271 wiz 14234: <td>SKIP_DEPENDS</td>
1.273 wiz 14235: <td>SMF_INSTANCES</td>
1.156 leot 14236: </tr>
14237: <tr>
1.271 wiz 14238: <td>SMF_MANIFEST</td>
1.273 wiz 14239: <td>SMF_METHODS</td>
1.227 wiz 14240: </tr>
14241: <tr>
1.271 wiz 14242: <td>SMF_METHOD_SHELL</td>
1.273 wiz 14243: <td>SMF_METHOD_SRC</td>
1.156 leot 14244: </tr>
14245: <tr>
1.271 wiz 14246: <td>SMF_NAME</td>
1.273 wiz 14247: <td>SMF_PREFIX</td>
1.156 leot 14248: </tr>
14249: <tr>
1.271 wiz 14250: <td>SMF_SRCDIR</td>
1.273 wiz 14251: <td>SNIPROXY_GROUP</td>
1.177 leot 14252: </tr>
14253: <tr>
1.271 wiz 14254: <td>SNIPROXY_USER</td>
1.273 wiz 14255: <td>SOURCE_BUFFSIZE</td>
1.156 leot 14256: </tr>
14257: <tr>
1.271 wiz 14258: <td>SPECIAL_PERMS</td>
1.273 wiz 14259: <td>SPECIFIC_PKGS</td>
1.217 rillig 14260: </tr>
14261: <tr>
1.271 wiz 14262: <td>SSH_SUID</td>
1.273 wiz 14263: <td>SSLCERTBUNDLE</td>
1.156 leot 14264: </tr>
14265: <tr>
1.271 wiz 14266: <td>SSLCERTS</td>
1.273 wiz 14267: <td>SSLDIR</td>
1.259 leot 14268: </tr>
14269: <tr>
1.271 wiz 14270: <td>SSLKEYS</td>
1.273 wiz 14271: <td>SSP_SUPPORTED</td>
1.259 leot 14272: </tr>
14273: <tr>
1.271 wiz 14274: <td>SSYNC_PAWD</td>
1.273 wiz 14275: <td>STEP_MSG</td>
1.159 rillig 14276: </tr>
14277: <tr>
1.271 wiz 14278: <td>STRIP</td>
1.273 wiz 14279: <td>STRIP_DBG</td>
1.156 leot 14280: </tr>
14281: <tr>
1.271 wiz 14282: <td>STRIP_DEBUG</td>
1.273 wiz 14283: <td>STRIP_DEBUG_SUPPORTED</td>
1.156 leot 14284: </tr>
14285: <tr>
1.271 wiz 14286: <td>STRIP_FILES_SKIP</td>
1.266 martin 14287: <td>SU</td>
1.156 leot 14288: </tr>
14289: <tr>
1.273 wiz 14290: <td>SUBDIR</td>
1.266 martin 14291: <td>SUBST</td>
1.156 leot 14292: </tr>
14293: <tr>
1.273 wiz 14294: <td>SUBST_CLASSES</td>
1.266 martin 14295: <td>SUBST_FILES</td>
1.156 leot 14296: </tr>
14297: <tr>
1.273 wiz 14298: <td>SUBST_FILTER_CMD</td>
1.266 martin 14299: <td>SUBST_MESSAGE</td>
1.156 leot 14300: </tr>
14301: <tr>
1.273 wiz 14302: <td>SUBST_NOOP_OK</td>
1.266 martin 14303: <td>SUBST_SED</td>
1.156 leot 14304: </tr>
14305: <tr>
1.273 wiz 14306: <td>SUBST_SHOW_DIFF</td>
1.266 martin 14307: <td>SUBST_SKIP_TEXT_CHECK</td>
1.156 leot 14308: </tr>
14309: <tr>
1.273 wiz 14310: <td>SUBST_STAGE</td>
1.266 martin 14311: <td>SUBST_VARS</td>
1.156 leot 14312: </tr>
14313: <tr>
1.273 wiz 14314: <td>SUNWSPROBASE</td>
1.266 martin 14315: <td>SUSE_PREFER</td>
1.263 wiz 14316: </tr>
14317: <tr>
1.273 wiz 14318: <td>SU_CMD</td>
1.266 martin 14319: <td>SVN_EXTRACTDIR</td>
1.263 wiz 14320: </tr>
14321: <tr>
1.273 wiz 14322: <td>SVN_REPO</td>
1.266 martin 14323: <td>SVN_REPOSITORIES</td>
1.246 leot 14324: </tr>
14325: <tr>
1.273 wiz 14326: <td>SVN_REVISION</td>
1.266 martin 14327: <td>SYSCONFBASE</td>
1.258 wiz 14328: </tr>
14329: <tr>
1.273 wiz 14330: <td>TARGET_MACHINE_ARCH</td>
1.266 martin 14331: <td>TBL</td>
1.255 wiz 14332: </tr>
14333: <tr>
1.273 wiz 14334: <td>TERMCAP_TYPE</td>
1.266 martin 14335: <td>TERMINFO_DEFAULT</td>
1.156 leot 14336: </tr>
14337: <tr>
1.273 wiz 14338: <td>TERMINFO_TYPE</td>
1.266 martin 14339: <td>TEST</td>
1.227 wiz 14340: </tr>
14341: <tr>
1.273 wiz 14342: <td>TEST_DEPENDS</td>
1.266 martin 14343: <td>TEST_DIRS</td>
1.156 leot 14344: </tr>
14345: <tr>
1.273 wiz 14346: <td>TEST_ENV</td>
1.266 martin 14347: <td>TEST_ENV_SHELL</td>
1.217 rillig 14348: </tr>
14349: <tr>
1.273 wiz 14350: <td>TEST_MAKE_CMD</td>
1.266 martin 14351: <td>TEST_MAKE_FLAGS</td>
1.212 wiz 14352: </tr>
14353: <tr>
1.273 wiz 14354: <td>TEST_TARGET</td>
1.266 martin 14355: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.217 rillig 14356: </tr>
14357: <tr>
1.273 wiz 14358: <td>TEXLIVE_REV</td>
1.266 martin 14359: <td>TEXLIVE_UNVERSIONED</td>
1.205 wiz 14360: </tr>
14361: <tr>
1.273 wiz 14362: <td>TEXMFSITE</td>
1.266 martin 14363: <td>TEX_FORMATS</td>
1.189 bacon 14364: </tr>
14365: <tr>
1.273 wiz 14366: <td>TEX_HYPHEN_DAT</td>
1.266 martin 14367: <td>TEX_HYPHEN_DEF</td>
1.161 leot 14368: </tr>
14369: <tr>
1.273 wiz 14370: <td>TEX_TEXMF_DIRS</td>
1.266 martin 14371: <td>THTTPD_LOG_FACILITY</td>
1.159 rillig 14372: </tr>
14373: <tr>
1.273 wiz 14374: <td>TINYDYN_USER</td>
1.266 martin 14375: <td>TLS</td>
1.259 leot 14376: </tr>
14377: <tr>
1.273 wiz 14378: <td>TLSWRAPPER_CHROOT</td>
1.266 martin 14379: <td>TO</td>
1.156 leot 14380: </tr>
14381: <tr>
1.273 wiz 14382: <td>TOOLDIR</td>
1.266 martin 14383: <td>TOOLS_ALIASES</td>
1.156 leot 14384: </tr>
14385: <tr>
1.273 wiz 14386: <td>TOOLS_ALWAYS_WRAP</td>
1.266 martin 14387: <td>TOOLS_ARGS</td>
1.156 leot 14388: </tr>
14389: <tr>
1.273 wiz 14390: <td>TOOLS_BROKEN</td>
1.266 martin 14391: <td>TOOLS_CMD</td>
1.156 leot 14392: </tr>
14393: <tr>
1.273 wiz 14394: <td>TOOLS_CMDLINE_SED</td>
1.266 martin 14395: <td>TOOLS_CREATE</td>
1.156 leot 14396: </tr>
14397: <tr>
1.273 wiz 14398: <td>TOOLS_CROSS_DESTDIR</td>
1.266 martin 14399: <td>TOOLS_DIR</td>
1.156 leot 14400: </tr>
14401: <tr>
1.273 wiz 14402: <td>TOOLS_FAIL</td>
1.266 martin 14403: <td>TOOLS_GNU_MISSING</td>
1.156 leot 14404: </tr>
14405: <tr>
1.273 wiz 14406: <td>TOOLS_LDCONFIG</td>
1.266 martin 14407: <td>TOOLS_NOOP</td>
1.156 leot 14408: </tr>
14409: <tr>
1.273 wiz 14410: <td>TOOLS_PATH</td>
1.266 martin 14411: <td>TOOLS_SCRIPT</td>
1.156 leot 14412: </tr>
14413: <tr>
1.273 wiz 14414: <td>TOOLS_USE_CROSS_COMPILE</td>
1.266 martin 14415: <td>TOOL_DEPENDS</td>
1.156 leot 14416: </tr>
14417: <tr>
1.273 wiz 14418: <td>TTF_FONTDIR</td>
1.266 martin 14419: <td>TTF_FONTS_DIR</td>
1.254 wiz 14420: </tr>
14421: <tr>
1.273 wiz 14422: <td>TYPE</td>
1.266 martin 14423: <td>UAC_REQD_EXECS</td>
1.241 rillig 14424: </tr>
14425: <tr>
1.273 wiz 14426: <td>UCSPI_SSL_GROUP</td>
1.266 martin 14427: <td>UCSPI_SSL_USER</td>
1.238 wiz 14428: </tr>
14429: <tr>
1.273 wiz 14430: <td>UNBOUND_GROUP</td>
1.266 martin 14431: <td>UNBOUND_LOG_FACILITY</td>
1.260 wiz 14432: </tr>
14433: <tr>
1.273 wiz 14434: <td>UNBOUND_USER</td>
1.266 martin 14435: <td>UNLIMIT_RESOURCES</td>
1.260 wiz 14436: </tr>
14437: <tr>
1.273 wiz 14438: <td>UNPRIVILEGED</td>
1.266 martin 14439: <td>UNPRIVILEGED_GROUP</td>
1.156 leot 14440: </tr>
14441: <tr>
1.273 wiz 14442: <td>UNPRIVILEGED_GROUPS</td>
1.266 martin 14443: <td>UNPRIVILEGED_USER</td>
1.223 nia 14444: </tr>
14445: <tr>
1.273 wiz 14446: <td>UNWRAP_FILES</td>
1.266 martin 14447: <td>UNWRAP_PATTERNS</td>
1.156 leot 14448: </tr>
14449: <tr>
1.273 wiz 14450: <td>UPDATE_GEMSPEC</td>
1.266 martin 14451: <td>UPDATE_TARGET</td>
1.212 wiz 14452: </tr>
14453: <tr>
1.273 wiz 14454: <td>URI</td>
1.266 martin 14455: <td>USERGROUP_PHASE</td>
1.156 leot 14456: </tr>
14457: <tr>
1.273 wiz 14458: <td>USERPPP_GROUP</td>
1.266 martin 14459: <td>USER_SPECIFIC_PKGS</td>
1.156 leot 14460: </tr>
14461: <tr>
1.273 wiz 14462: <td>USE_ABI_DEPENDS</td>
1.266 martin 14463: <td>USE_ADA_FEATURES</td>
1.156 leot 14464: </tr>
14465: <tr>
1.273 wiz 14466: <td>USE_APR</td>
1.266 martin 14467: <td>USE_BSD_MAKEFILE</td>
1.156 leot 14468: </tr>
14469: <tr>
1.273 wiz 14470: <td>USE_BUILTIN</td>
1.266 martin 14471: <td>USE_CC_FEATURES</td>
1.156 leot 14472: </tr>
14473: <tr>
1.273 wiz 14474: <td>USE_CROSS_COMPILE</td>
1.266 martin 14475: <td>USE_CURSES</td>
1.243 gutterid 14476: </tr>
14477: <tr>
1.273 wiz 14478: <td>USE_CWRAPPERS</td>
1.266 martin 14479: <td>USE_CXX_FEATURES</td>
1.156 leot 14480: </tr>
14481: <tr>
1.273 wiz 14482: <td>USE_DB185</td>
1.266 martin 14483: <td>USE_FEATURES</td>
1.156 leot 14484: </tr>
14485: <tr>
1.273 wiz 14486: <td>USE_GAMESGROUP</td>
1.266 martin 14487: <td>USE_GCC_RUNTIME</td>
1.156 leot 14488: </tr>
14489: <tr>
1.273 wiz 14490: <td>USE_IMAKE</td>
1.266 martin 14491: <td>USE_INDIRECT_DEPENDS</td>
1.205 wiz 14492: </tr>
14493: <tr>
1.273 wiz 14494: <td>USE_JAVA</td>
1.266 martin 14495: <td>USE_JAVA2</td>
1.156 leot 14496: </tr>
14497: <tr>
1.273 wiz 14498: <td>USE_LANGUAGES</td>
1.266 martin 14499: <td>USE_LIBTOOL</td>
1.156 leot 14500: </tr>
14501: <tr>
1.273 wiz 14502: <td>USE_NATIVE_GCC</td>
1.266 martin 14503: <td>USE_NETBSD_REPO</td>
1.156 leot 14504: </tr>
14505: <tr>
1.273 wiz 14506: <td>USE_PKGSRC_GCC</td>
1.266 martin 14507: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.156 leot 14508: </tr>
14509: <tr>
1.273 wiz 14510: <td>USE_PKGTASKS</td>
1.266 martin 14511: <td>USE_PKG_ADMIN_DIGEST</td>
1.156 leot 14512: </tr>
14513: <tr>
1.273 wiz 14514: <td>USE_RUBY_EXTCONF</td>
1.266 martin 14515: <td>USE_RUBY_INSTALL</td>
1.156 leot 14516: </tr>
14517: <tr>
1.273 wiz 14518: <td>USE_RUBY_SETUP</td>
1.266 martin 14519: <td>USE_RUBY_SETUP_PKG</td>
1.258 wiz 14520: </tr>
14521: <tr>
1.273 wiz 14522: <td>USE_TMPFILES</td>
1.266 martin 14523: <td>USE_TOOLS</td>
1.156 leot 14524: </tr>
14525: <tr>
1.273 wiz 14526: <td>UUCP_GROUP</td>
1.266 martin 14527: <td>UUCP_USER</td>
1.156 leot 14528: </tr>
14529: <tr>
1.273 wiz 14530: <td>VARBASE</td>
1.266 martin 14531: <td>VARNAME</td>
1.156 leot 14532: </tr>
14533: <tr>
1.273 wiz 14534: <td>VIM_EXTRA_OPTS</td>
1.266 martin 14535: <td>WARNING_MSG</td>
1.156 leot 14536: </tr>
14537: <tr>
1.273 wiz 14538: <td>WCALC_CGIDIR</td>
1.266 martin 14539: <td>WCALC_CGIPATH</td>
1.156 leot 14540: </tr>
14541: <tr>
1.273 wiz 14542: <td>WCALC_HTMLDIR</td>
1.266 martin 14543: <td>WCALC_HTMLPATH</td>
1.156 leot 14544: </tr>
14545: <tr>
1.273 wiz 14546: <td>WDM_MANAGERS</td>
1.266 martin 14547: <td>WRAPPER_CC</td>
1.156 leot 14548: </tr>
14549: <tr>
1.273 wiz 14550: <td>WRAPPER_REORDER_CMDS</td>
1.266 martin 14551: <td>WRKDIR</td>
1.156 leot 14552: </tr>
14553: <tr>
1.273 wiz 14554: <td>WRKDIR_BASENAME</td>
1.266 martin 14555: <td>WRKDIR_LOCKTYPE</td>
1.156 leot 14556: </tr>
14557: <tr>
1.273 wiz 14558: <td>WRKLOG</td>
1.266 martin 14559: <td>WRKOBJDIR</td>
1.156 leot 14560: </tr>
14561: <tr>
1.273 wiz 14562: <td>WRKSRC</td>
1.266 martin 14563: <td>X10_PORT</td>
1.156 leot 14564: </tr>
14565: <tr>
1.273 wiz 14566: <td>X11</td>
1.266 martin 14567: <td>X11BASE</td>
1.156 leot 14568: </tr>
14569: <tr>
1.273 wiz 14570: <td>X11_PKGSRCDIR</td>
1.266 martin 14571: <td>X11_TYPE</td>
1.156 leot 14572: </tr>
14573: <tr>
1.273 wiz 14574: <td>X509_CERTIFICATE</td>
1.266 martin 14575: <td>X509_KEY</td>
1.189 bacon 14576: </tr>
14577: <tr>
1.273 wiz 14578: <td>XAW_TYPE</td>
1.266 martin 14579: <td>XLOCK_DEFAULT_MODE</td>
1.156 leot 14580: </tr>
14581: <tr>
1.273 wiz 14582: <td>XMKMF</td>
1.266 martin 14583: <td>XMKMF_FLAGS</td>
1.263 wiz 14584: </tr>
14585: <tr>
1.273 wiz 14586: <td>XXX</td>
1.266 martin 14587: <td>XXXX</td>
1.156 leot 14588: </tr>
14589: <tr>
1.273 wiz 14590: <td>YES</td>
1.266 martin 14591: <td>ZSH_STATIC</td>
1.246 leot 14592: </tr>
14593: <tr>
1.273 wiz 14594: <td>__stdc__</td>
1.266 martin 14595: <td>_vargroups</td>
1.233 wiz 14596: </tr>
14597: <tr>
1.273 wiz 14598: <td>accept</td>
1.266 martin 14599: <td>acquire-localbase-lock</td>
1.156 leot 14600: </tr>
14601: <tr>
1.273 wiz 14602: <td>acquire-lock</td>
1.266 martin 14603: <td>add</td>
1.227 wiz 14604: </tr>
14605: <tr>
1.273 wiz 14606: <td>added</td>
1.266 martin 14607: <td>administrator</td>
1.156 leot 14608: </tr>
14609: <tr>
1.273 wiz 14610: <td>alloca</td>
1.266 martin 14611: <td>alternatives</td>
1.159 rillig 14612: </tr>
14613: <tr>
1.273 wiz 14614: <td>aslr</td>
1.266 martin 14615: <td>asprintf</td>
1.217 rillig 14616: </tr>
14617: <tr>
1.273 wiz 14618: <td>atlas</td>
1.266 martin 14619: <td>autoconf</td>
1.156 leot 14620: </tr>
14621: <tr>
1.273 wiz 14622: <td>automake</td>
1.266 martin 14623: <td>autoreconf</td>
1.265 leot 14624: </tr>
14625: <tr>
1.273 wiz 14626: <td>awk</td>
1.266 martin 14627: <td>barrier</td>
1.201 cirnatda 14628: </tr>
14629: <tr>
1.273 wiz 14630: <td>bash</td>
1.266 martin 14631: <td>big-endian</td>
1.174 leot 14632: </tr>
14633: <tr>
1.273 wiz 14634: <td>bin-install</td>
1.266 martin 14635: <td>bind</td>
1.156 leot 14636: </tr>
14637: <tr>
1.273 wiz 14638: <td>binpkg-list</td>
1.266 martin 14639: <td>blas</td>
1.156 leot 14640: </tr>
14641: <tr>
1.273 wiz 14642: <td>bootstrap-depends</td>
1.266 martin 14643: <td>broken</td>
1.174 leot 14644: </tr>
14645: <tr>
1.273 wiz 14646: <td>broken_on_platform</td>
1.266 martin 14647: <td>bsd</td>
1.156 leot 14648: </tr>
14649: <tr>
1.273 wiz 14650: <td>bsd.prog.mk</td>
1.266 martin 14651: <td>build</td>
1.161 leot 14652: </tr>
14653: <tr>
1.273 wiz 14654: <td>build-env</td>
1.266 martin 14655: <td>buildlink-directories</td>
1.156 leot 14656: </tr>
14657: <tr>
1.273 wiz 14658: <td>buildlink-oss-soundcard-h</td>
1.266 martin 14659: <td>built-in</td>
1.156 leot 14660: </tr>
14661: <tr>
1.273 wiz 14662: <td>builtin</td>
1.266 martin 14663: <td>c</td>
1.156 leot 14664: </tr>
14665: <tr>
1.273 wiz 14666: <td>c++</td>
1.266 martin 14667: <td>ccache</td>
1.242 gutterid 14668: </tr>
14669: <tr>
1.273 wiz 14670: <td>cce</td>
1.266 martin 14671: <td>cdefs</td>
1.177 leot 14672: </tr>
14673: <tr>
1.273 wiz 14674: <td>ceil</td>
1.266 martin 14675: <td>changes</td>
1.159 rillig 14676: </tr>
14677: <tr>
1.273 wiz 14678: <td>changes-entry</td>
1.266 martin 14679: <td>changes-entry-noupdate</td>
1.156 leot 14680: </tr>
14681: <tr>
1.273 wiz 14682: <td>check</td>
1.266 martin 14683: <td>check-clean</td>
1.174 leot 14684: </tr>
14685: <tr>
1.273 wiz 14686: <td>check-files</td>
1.266 martin 14687: <td>check-files-clean</td>
1.156 leot 14688: </tr>
14689: <tr>
1.273 wiz 14690: <td>check-hackage</td>
1.266 martin 14691: <td>check-vulnerable</td>
1.156 leot 14692: </tr>
14693: <tr>
1.273 wiz 14694: <td>checksum</td>
1.266 martin 14695: <td>checksum-phase</td>
1.255 wiz 14696: </tr>
14697: <tr>
1.273 wiz 14698: <td>clean</td>
1.266 martin 14699: <td>clean-depends</td>
1.156 leot 14700: </tr>
14701: <tr>
1.273 wiz 14702: <td>cleandir</td>
1.266 martin 14703: <td>commit</td>
1.156 leot 14704: </tr>
14705: <tr>
1.273 wiz 14706: <td>commit-changes-entry</td>
1.266 martin 14707: <td>compact</td>
1.174 leot 14708: </tr>
14709: <tr>
1.273 wiz 14710: <td>compiler</td>
1.266 martin 14711: <td>conf</td>
1.156 leot 14712: </tr>
14713: <tr>
1.273 wiz 14714: <td>config.guess</td>
1.266 martin 14715: <td>config.sub</td>
1.156 leot 14716: </tr>
14717: <tr>
1.273 wiz 14718: <td>configuration</td>
1.266 martin 14719: <td>configure</td>
1.156 leot 14720: </tr>
14721: <tr>
1.273 wiz 14722: <td>configure-env</td>
1.266 martin 14723: <td>configure-help</td>
1.156 leot 14724: </tr>
14725: <tr>
1.273 wiz 14726: <td>configure_args</td>
1.266 martin 14727: <td>connect</td>
1.156 leot 14728: </tr>
14729: <tr>
1.273 wiz 14730: <td>cos</td>
1.266 martin 14731: <td>cpe</td>
1.156 leot 14732: </tr>
14733: <tr>
1.273 wiz 14734: <td>cputime</td>
1.266 martin 14735: <td>create-usergroup</td>
1.156 leot 14736: </tr>
14737: <tr>
1.273 wiz 14738: <td>csh</td>
1.266 martin 14739: <td>ctf</td>
1.156 leot 14740: </tr>
14741: <tr>
1.273 wiz 14742: <td>cvs</td>
1.266 martin 14743: <td>debug</td>
1.254 wiz 14744: </tr>
14745: <tr>
1.273 wiz 14746: <td>debug-barrier</td>
1.266 martin 14747: <td>declaration</td>
1.258 wiz 14748: </tr>
14749: <tr>
1.273 wiz 14750: <td>declare</td>
1.266 martin 14751: <td>defined</td>
1.241 rillig 14752: </tr>
14753: <tr>
1.273 wiz 14754: <td>depend</td>
1.266 martin 14755: <td>dependencies</td>
1.238 wiz 14756: </tr>
14757: <tr>
1.273 wiz 14758: <td>depends</td>
1.266 martin 14759: <td>depends-checksum</td>
1.223 nia 14760: </tr>
14761: <tr>
1.273 wiz 14762: <td>depends-fetch</td>
1.260 wiz 14763: <td>describe</td>
1.174 leot 14764: </tr>
14765: <tr>
1.273 wiz 14766: <td>destdir</td>
1.260 wiz 14767: <td>disable</td>
1.214 leot 14768: </tr>
14769: <tr>
1.273 wiz 14770: <td>distclean</td>
1.260 wiz 14771: <td>distfiles</td>
1.205 wiz 14772: </tr>
14773: <tr>
1.273 wiz 14774: <td>distinfo</td>
1.259 leot 14775: <td>dl</td>
1.161 leot 14776: </tr>
14777: <tr>
1.273 wiz 14778: <td>dlopen</td>
1.259 leot 14779: <td>do-buildlink</td>
1.197 leot 14780: </tr>
14781: <tr>
1.273 wiz 14782: <td>do-clean</td>
1.259 leot 14783: <td>do-configure</td>
1.156 leot 14784: </tr>
14785: <tr>
1.273 wiz 14786: <td>do-configure-post-hook</td>
1.259 leot 14787: <td>do-extract</td>
1.156 leot 14788: </tr>
14789: <tr>
1.273 wiz 14790: <td>do-fetch</td>
1.263 wiz 14791: <td>do-install</td>
14792: </tr>
14793: <tr>
1.273 wiz 14794: <td>download</td>
1.259 leot 14795: <td>emul</td>
1.156 leot 14796: </tr>
14797: <tr>
1.273 wiz 14798: <td>emul-distinfo</td>
1.259 leot 14799: <td>emul-fetch</td>
1.156 leot 14800: </tr>
14801: <tr>
1.273 wiz 14802: <td>emulation</td>
1.259 leot 14803: <td>emulator</td>
1.162 rillig 14804: </tr>
14805: <tr>
1.273 wiz 14806: <td>enable</td>
1.259 leot 14807: <td>endian</td>
1.156 leot 14808: </tr>
14809: <tr>
1.273 wiz 14810: <td>endif</td>
1.259 leot 14811: <td>enomem</td>
1.258 wiz 14812: </tr>
14813: <tr>
1.273 wiz 14814: <td>ensurepip</td>
1.259 leot 14815: <td>err</td>
1.233 wiz 14816: </tr>
14817: <tr>
1.273 wiz 14818: <td>errx</td>
1.259 leot 14819: <td>etc</td>
1.156 leot 14820: </tr>
14821: <tr>
1.273 wiz 14822: <td>exp</td>
1.259 leot 14823: <td>extract-rpm</td>
1.227 wiz 14824: </tr>
14825: <tr>
1.273 wiz 14826: <td>fabs</td>
1.259 leot 14827: <td>feature</td>
1.214 leot 14828: </tr>
14829: <tr>
1.273 wiz 14830: <td>features</td>
1.259 leot 14831: <td>fetch</td>
1.156 leot 14832: </tr>
14833: <tr>
1.273 wiz 14834: <td>fetch-list</td>
1.259 leot 14835: <td>follows</td>
1.205 wiz 14836: </tr>
14837: <tr>
1.273 wiz 14838: <td>forbids</td>
1.259 leot 14839: <td>form</td>
1.197 leot 14840: </tr>
14841: <tr>
1.273 wiz 14842: <td>format</td>
1.259 leot 14843: <td>fortify</td>
1.238 wiz 14844: </tr>
14845: <tr>
1.273 wiz 14846: <td>fortify_source</td>
1.263 wiz 14847: <td>fossil</td>
14848: </tr>
14849: <tr>
1.273 wiz 14850: <td>friend</td>
1.259 leot 14851: <td>fts</td>
1.254 wiz 14852: </tr>
14853: <tr>
1.273 wiz 14854: <td>fts_close</td>
1.259 leot 14855: <td>fts_open</td>
1.241 rillig 14856: </tr>
14857: <tr>
1.273 wiz 14858: <td>fts_read</td>
1.259 leot 14859: <td>fts_set</td>
1.217 rillig 14860: </tr>
14861: <tr>
1.273 wiz 14862: <td>gcc</td>
1.259 leot 14863: <td>gethostbyaddr</td>
1.223 nia 14864: </tr>
14865: <tr>
1.273 wiz 14866: <td>gethostbyname</td>
1.259 leot 14867: <td>gethostbyname2</td>
1.156 leot 14868: </tr>
14869: <tr>
1.273 wiz 14870: <td>getopt_long</td>
1.259 leot 14871: <td>getprogname</td>
1.156 leot 14872: </tr>
14873: <tr>
1.273 wiz 14874: <td>getservbyname</td>
1.259 leot 14875: <td>getservbyport</td>
1.156 leot 14876: </tr>
14877: <tr>
1.273 wiz 14878: <td>getservent</td>
1.259 leot 14879: <td>gettext</td>
1.156 leot 14880: </tr>
14881: <tr>
1.273 wiz 14882: <td>git</td>
1.259 leot 14883: <td>github</td>
1.258 wiz 14884: </tr>
14885: <tr>
1.273 wiz 14886: <td>gitlab</td>
1.259 leot 14887: <td>glob</td>
1.233 wiz 14888: </tr>
14889: <tr>
1.273 wiz 14890: <td>gnu</td>
1.259 leot 14891: <td>gnu_configure_strict</td>
1.227 wiz 14892: </tr>
14893: <tr>
1.273 wiz 14894: <td>go</td>
1.266 martin 14895: <td>golang</td>
1.223 nia 14896: </tr>
14897: <tr>
1.273 wiz 14898: <td>guess-license</td>
1.266 martin 14899: <td>hashbang</td>
1.238 wiz 14900: </tr>
14901: <tr>
1.273 wiz 14902: <td>heimdal</td>
1.266 martin 14903: <td>help</td>
1.263 wiz 14904: </tr>
14905: <tr>
1.273 wiz 14906: <td>hg</td>
1.266 martin 14907: <td>imake</td>
1.254 wiz 14908: </tr>
14909: <tr>
1.273 wiz 14910: <td>in-tree</td>
1.266 martin 14911: <td>increment</td>
1.241 rillig 14912: </tr>
14913: <tr>
1.273 wiz 14914: <td>indirect</td>
1.266 martin 14915: <td>inet_aton</td>
1.260 wiz 14916: </tr>
14917: <tr>
1.273 wiz 14918: <td>install</td>
1.266 martin 14919: <td>install-env</td>
1.156 leot 14920: </tr>
14921: <tr>
1.273 wiz 14922: <td>interp</td>
1.266 martin 14923: <td>interpreter</td>
1.214 leot 14924: </tr>
14925: <tr>
1.273 wiz 14926: <td>intl</td>
1.266 martin 14927: <td>ip4</td>
1.156 leot 14928: </tr>
14929: <tr>
1.273 wiz 14930: <td>ip6</td>
1.266 martin 14931: <td>ipv4</td>
1.205 wiz 14932: </tr>
14933: <tr>
1.273 wiz 14934: <td>ipv6</td>
1.266 martin 14935: <td>iso</td>
1.197 leot 14936: </tr>
14937: <tr>
1.273 wiz 14938: <td>kerberos</td>
1.266 martin 14939: <td>krb</td>
1.161 leot 14940: </tr>
14941: <tr>
1.273 wiz 14942: <td>krb5</td>
1.266 martin 14943: <td>ksh</td>
1.156 leot 14944: </tr>
14945: <tr>
1.273 wiz 14946: <td>lapack</td>
1.266 martin 14947: <td>latex</td>
1.156 leot 14948: </tr>
14949: <tr>
1.273 wiz 14950: <td>libiconv</td>
1.266 martin 14951: <td>libintl_bindtextdomain</td>
1.156 leot 14952: </tr>
14953: <tr>
1.273 wiz 14954: <td>libintl_gettext</td>
1.266 martin 14955: <td>libintl_textdomain</td>
1.189 bacon 14956: </tr>
14957: <tr>
1.273 wiz 14958: <td>libnbcompat</td>
1.266 martin 14959: <td>libs</td>
1.189 bacon 14960: </tr>
14961: <tr>
1.273 wiz 14962: <td>libtool</td>
1.266 martin 14963: <td>licence</td>
1.156 leot 14964: </tr>
14965: <tr>
1.273 wiz 14966: <td>license</td>
1.266 martin 14967: <td>lintl</td>
1.177 leot 14968: </tr>
14969: <tr>
1.273 wiz 14970: <td>little-endian</td>
1.266 martin 14971: <td>lock</td>
1.156 leot 14972: </tr>
14973: <tr>
1.273 wiz 14974: <td>locking</td>
1.266 martin 14975: <td>lua</td>
1.174 leot 14976: </tr>
14977: <tr>
1.273 wiz 14978: <td>lvalue</td>
1.266 martin 14979: <td>machine_endian</td>
1.159 rillig 14980: </tr>
14981: <tr>
1.273 wiz 14982: <td>make</td>
1.266 martin 14983: <td>makedistinfo</td>
1.259 leot 14984: </tr>
14985: <tr>
1.273 wiz 14986: <td>makepatchsum</td>
1.266 martin 14987: <td>makesum</td>
1.246 leot 14988: </tr>
14989: <tr>
1.273 wiz 14990: <td>mdi</td>
1.266 martin 14991: <td>memory</td>
1.258 wiz 14992: </tr>
14993: <tr>
1.273 wiz 14994: <td>mercurial</td>
1.266 martin 14995: <td>meta</td>
1.156 leot 14996: </tr>
14997: <tr>
1.273 wiz 14998: <td>meta-package</td>
1.266 martin 14999: <td>meta_package</td>
1.233 wiz 15000: </tr>
15001: <tr>
1.273 wiz 15002: <td>mit-krb5</td>
1.266 martin 15003: <td>mk.conf</td>
1.227 wiz 15004: </tr>
15005: <tr>
1.273 wiz 15006: <td>mkl</td>
1.266 martin 15007: <td>mount</td>
1.156 leot 15008: </tr>
15009: <tr>
1.273 wiz 15010: <td>move</td>
1.266 martin 15011: <td>moved</td>
1.259 leot 15012: </tr>
15013: <tr>
1.273 wiz 15014: <td>mprotect</td>
1.266 martin 15015: <td>mps</td>
1.156 leot 15016: </tr>
15017: <tr>
1.273 wiz 15018: <td>mremap</td>
1.266 martin 15019: <td>native</td>
1.177 leot 15020: </tr>
15021: <tr>
1.273 wiz 15022: <td>nb</td>
1.266 martin 15023: <td>nbcompat</td>
1.159 rillig 15024: </tr>
15025: <tr>
1.273 wiz 15026: <td>netlib</td>
1.266 martin 15027: <td>network</td>
1.255 wiz 15028: </tr>
15029: <tr>
1.273 wiz 15030: <td>node</td>
1.266 martin 15031: <td>node.js</td>
1.226 gutterid 15032: </tr>
15033: <tr>
1.273 wiz 15034: <td>nodejs</td>
1.266 martin 15035: <td>obstack</td>
1.156 leot 15036: </tr>
15037: <tr>
1.273 wiz 15038: <td>obstack_ptr_grow</td>
1.266 martin 15039: <td>occurs</td>
1.156 leot 15040: </tr>
15041: <tr>
1.273 wiz 15042: <td>only</td>
1.266 martin 15043: <td>openblas</td>
1.218 nia 15044: </tr>
15045: <tr>
1.273 wiz 15046: <td>options</td>
1.266 martin 15047: <td>options.mk</td>
1.218 nia 15048: </tr>
15049: <tr>
1.273 wiz 15050: <td>order</td>
1.266 martin 15051: <td>override</td>
1.205 wiz 15052: </tr>
15053: <tr>
1.273 wiz 15054: <td>override-intltool</td>
1.266 martin 15055: <td>override-message-intltool</td>
1.156 leot 15056: </tr>
15057: <tr>
1.273 wiz 15058: <td>package</td>
1.266 martin 15059: <td>parallel</td>
1.161 leot 15060: </tr>
15061: <tr>
1.273 wiz 15062: <td>path</td>
1.266 martin 15063: <td>pax</td>
1.156 leot 15064: </tr>
15065: <tr>
1.273 wiz 15066: <td>paxctl</td>
1.266 martin 15067: <td>pbulk-index</td>
1.156 leot 15068: </tr>
15069: <tr>
1.273 wiz 15070: <td>pc</td>
1.266 martin 15071: <td>perl</td>
1.156 leot 15072: </tr>
15073: <tr>
1.273 wiz 15074: <td>perl5</td>
1.266 martin 15075: <td>perms</td>
1.156 leot 15076: </tr>
15077: <tr>
1.273 wiz 15078: <td>php</td>
1.266 martin 15079: <td>pkg-build-options</td>
1.156 leot 15080: </tr>
15081: <tr>
1.273 wiz 15082: <td>pkg-config</td>
1.266 martin 15083: <td>pkg_build_options</td>
1.156 leot 15084: </tr>
15085: <tr>
1.273 wiz 15086: <td>pkgsrc</td>
1.266 martin 15087: <td>platform</td>
1.156 leot 15088: </tr>
15089: <tr>
1.273 wiz 15090: <td>plist</td>
1.266 martin 15091: <td>post-extract</td>
1.156 leot 15092: </tr>
15093: <tr>
1.273 wiz 15094: <td>post-fetch</td>
1.266 martin 15095: <td>post-wrapper</td>
1.156 leot 15096: </tr>
15097: <tr>
1.273 wiz 15098: <td>pre-build-checks-hook</td>
1.266 martin 15099: <td>pre-configure-checks-hook</td>
1.156 leot 15100: </tr>
15101: <tr>
1.273 wiz 15102: <td>pre-extract</td>
1.266 martin 15103: <td>pre-fetch</td>
1.156 leot 15104: </tr>
15105: <tr>
1.273 wiz 15106: <td>print-plist</td>
1.258 wiz 15107: <td>print-summary-data</td>
1.156 leot 15108: </tr>
15109: <tr>
1.273 wiz 15110: <td>privileged-install-hook</td>
1.258 wiz 15111: <td>pypi</td>
1.156 leot 15112: </tr>
15113: <tr>
1.273 wiz 15114: <td>python</td>
1.258 wiz 15115: <td>r</td>
1.174 leot 15116: </tr>
15117: <tr>
1.273 wiz 15118: <td>readme-all</td>
1.258 wiz 15119: <td>recursive</td>
1.156 leot 15120: </tr>
15121: <tr>
1.273 wiz 15122: <td>recv</td>
1.258 wiz 15123: <td>recvfrom</td>
1.156 leot 15124: </tr>
15125: <tr>
1.273 wiz 15126: <td>regcomp</td>
1.258 wiz 15127: <td>release-localbase-lock</td>
1.156 leot 15128: </tr>
15129: <tr>
1.273 wiz 15130: <td>release-lock</td>
1.258 wiz 15131: <td>relro</td>
1.156 leot 15132: </tr>
15133: <tr>
1.273 wiz 15134: <td>remove</td>
1.258 wiz 15135: <td>removed</td>
1.156 leot 15136: </tr>
15137: <tr>
1.273 wiz 15138: <td>rename</td>
1.258 wiz 15139: <td>renamed</td>
1.174 leot 15140: </tr>
15141: <tr>
1.273 wiz 15142: <td>reorder</td>
1.258 wiz 15143: <td>replace</td>
1.174 leot 15144: </tr>
15145: <tr>
1.273 wiz 15146: <td>replace_interpreter</td>
1.258 wiz 15147: <td>reproducible</td>
1.156 leot 15148: </tr>
15149: <tr>
1.273 wiz 15150: <td>resolv</td>
1.258 wiz 15151: <td>root</td>
1.226 gutterid 15152: </tr>
15153: <tr>
1.273 wiz 15154: <td>ruby</td>
1.258 wiz 15155: <td>send</td>
1.226 gutterid 15156: </tr>
15157: <tr>
1.273 wiz 15158: <td>sendfile</td>
1.258 wiz 15159: <td>sendto</td>
1.156 leot 15160: </tr>
15161: <tr>
1.273 wiz 15162: <td>setenv</td>
1.258 wiz 15163: <td>setgid</td>
1.156 leot 15164: </tr>
15165: <tr>
1.273 wiz 15166: <td>setprogname</td>
1.258 wiz 15167: <td>setuid</td>
1.156 leot 15168: </tr>
15169: <tr>
1.273 wiz 15170: <td>sh</td>
1.258 wiz 15171: <td>shebang</td>
1.174 leot 15172: </tr>
15173: <tr>
1.273 wiz 15174: <td>show</td>
1.258 wiz 15175: <td>show-all</td>
1.156 leot 15176: </tr>
15177: <tr>
1.273 wiz 15178: <td>show-build-defs</td>
1.258 wiz 15179: <td>show-depends</td>
1.156 leot 15180: </tr>
15181: <tr>
1.273 wiz 15182: <td>show-depends-dirs</td>
1.258 wiz 15183: <td>show-depends-pkgpaths</td>
1.156 leot 15184: </tr>
15185: <tr>
1.273 wiz 15186: <td>show-depends-recursive</td>
1.258 wiz 15187: <td>show-deps</td>
1.156 leot 15188: </tr>
15189: <tr>
1.273 wiz 15190: <td>show-distfiles</td>
1.258 wiz 15191: <td>show-downlevel</td>
1.181 rillig 15192: </tr>
15193: <tr>
1.273 wiz 15194: <td>show-subdir-var</td>
1.258 wiz 15195: <td>show-tools</td>
1.156 leot 15196: </tr>
15197: <tr>
1.273 wiz 15198: <td>show-var</td>
1.258 wiz 15199: <td>show-vars</td>
1.222 gutterid 15200: </tr>
15201: <tr>
1.273 wiz 15202: <td>snprintf</td>
1.258 wiz 15203: <td>socket</td>
1.223 nia 15204: </tr>
15205: <tr>
1.273 wiz 15206: <td>ssp</td>
1.258 wiz 15207: <td>st_mode</td>
1.156 leot 15208: </tr>
15209: <tr>
1.273 wiz 15210: <td>stage-install</td>
1.258 wiz 15211: <td>strcasestr</td>
1.156 leot 15212: </tr>
15213: <tr>
1.273 wiz 15214: <td>strict</td>
1.258 wiz 15215: <td>strip</td>
1.156 leot 15216: </tr>
15217: <tr>
1.273 wiz 15218: <td>strndup</td>
1.258 wiz 15219: <td>strnlen</td>
1.156 leot 15220: </tr>
15221: <tr>
1.273 wiz 15222: <td>strsep</td>
1.258 wiz 15223: <td>subst</td>
1.254 wiz 15224: </tr>
15225: <tr>
1.273 wiz 15226: <td>substitutions</td>
1.263 wiz 15227: <td>subversion</td>
15228: </tr>
15229: <tr>
1.273 wiz 15230: <td>sun</td>
1.254 wiz 15231: <td>sunpro</td>
1.241 rillig 15232: </tr>
15233: <tr>
1.273 wiz 15234: <td>sunwspro</td>
1.263 wiz 15235: <td>svn</td>
1.214 leot 15236: </tr>
15237: <tr>
1.273 wiz 15238: <td>symlink</td>
1.242 gutterid 15239: <td>test</td>
1.212 wiz 15240: </tr>
15241: <tr>
1.273 wiz 15242: <td>test-env</td>
1.242 gutterid 15243: <td>tex</td>
1.227 wiz 15244: </tr>
15245: <tr>
1.273 wiz 15246: <td>texlive</td>
1.242 gutterid 15247: <td>tmp</td>
1.223 nia 15248: </tr>
15249: <tr>
1.273 wiz 15250: <td>todo</td>
1.242 gutterid 15251: <td>tool</td>
1.161 leot 15252: </tr>
15253: <tr>
1.273 wiz 15254: <td>tools</td>
1.242 gutterid 15255: <td>tools-libtool-m4-override</td>
1.156 leot 15256: </tr>
15257: <tr>
1.273 wiz 15258: <td>transitive</td>
1.242 gutterid 15259: <td>type</td>
1.156 leot 15260: </tr>
15261: <tr>
1.273 wiz 15262: <td>ulimit</td>
1.242 gutterid 15263: <td>undefined</td>
1.156 leot 15264: </tr>
15265: <tr>
1.273 wiz 15266: <td>undo-replace</td>
1.242 gutterid 15267: <td>unlimit</td>
1.156 leot 15268: </tr>
15269: <tr>
1.273 wiz 15270: <td>unprivileged</td>
1.242 gutterid 15271: <td>unprivileged-install-hook</td>
1.156 leot 15272: </tr>
15273: <tr>
1.273 wiz 15274: <td>unstripped</td>
1.242 gutterid 15275: <td>update</td>
1.156 leot 15276: </tr>
15277: <tr>
1.273 wiz 15278: <td>updated</td>
1.242 gutterid 15279: <td>upload</td>
1.156 leot 15280: </tr>
15281: <tr>
1.273 wiz 15282: <td>upload-distfiles</td>
1.242 gutterid 15283: <td>use_tools</td>
1.156 leot 15284: </tr>
15285: <tr>
1.273 wiz 15286: <td>user</td>
1.242 gutterid 15287: <td>utimes</td>
1.156 leot 15288: </tr>
15289: <tr>
1.273 wiz 15290: <td>vasprintf</td>
1.242 gutterid 15291: <td>verbose</td>
1.156 leot 15292: </tr>
15293: <tr>
1.273 wiz 15294: <td>vsnprintf</td>
1.242 gutterid 15295: <td>warn</td>
1.156 leot 15296: </tr>
15297: <tr>
1.273 wiz 15298: <td>warning</td>
1.242 gutterid 15299: <td>warnings</td>
1.156 leot 15300: </tr>
15301: <tr>
1.273 wiz 15302: <td>warnx</td>
1.242 gutterid 15303: <td>wattr_off</td>
1.156 leot 15304: </tr>
15305: <tr>
1.273 wiz 15306: <td>wattr_on</td>
1.242 gutterid 15307: <td>work</td>
1.156 leot 15308: </tr>
15309: <tr>
1.273 wiz 15310: <td>wrapper</td>
1.174 leot 15311: <td>wrkdir</td>
1.156 leot 15312: </tr>
15313: </table>
1.154 rillig 15314: </div>
15315: <div class="appendix">
15316: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 15317: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 15318: <div class="toc">
15319: <p><b>Table of Contents</b></p>
1.100 leot 15320: <dl class="toc">
1.207 leot 15321: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
15322: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 15323: </dl>
15324: </div>
15325: <p>This section contains information on editing the pkgsrc
15326: guide itself.</p>
1.41 asau 15327: <div class="sect1">
1.1 dsieger 15328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 15329: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.1 dsieger 15330: <p>The pkgsrc guide's source code is stored in
15331: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
15332: are created from it:</p>
1.41 asau 15333: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 15334: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
15335: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.174 leot 15336: <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>
15337: <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 15338: The PDF version of the pkgsrc guide.</p></li>
1.174 leot 15339: <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 15340: PostScript version of the pkgsrc guide.</p></li>
15341: </ul></div>
15342: </div>
1.41 asau 15343: <div class="sect1">
1.1 dsieger 15344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 15345: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.1 dsieger 15346: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 15347: <div class="procedure"><ol class="procedure" type="1">
1.190 bacon 15348: <li class="step"><p>Make sure you have checked out the htdocs repository
15349: into a sibling directory of your pkgsrc directory. You will need
15350: the ability to commit from both pkgsrc and htdocs.</p></li>
1.41 asau 15351: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 15352: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 15353: documentation) installed. These are automatically installed when
1.207 leot 15354: 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 15355: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 15356: right directory. All further steps will take place
15357: here.</p></li>
1.41 asau 15358: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 15359: <code class="filename">files/</code>.</p></li>
1.41 asau 15360: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 15361: guide for valid XML and to build the final output files. If you
15362: get any errors at this stage, you can just edit the files, as
15363: there are only symbolic links in the working directory, pointing
15364: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 15365: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 15366: commit)</strong></span></p></li>
1.41 asau 15367: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 15368: regenerate the output files with the proper RCS
15369: Ids.</p></li>
1.41 asau 15370: <li class="step">
1.10 hubertf 15371: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 15372: commit the files in both <code class="filename">pkgsrc/doc</code> and
15373: <code class="filename">htdocs</code>.</p>
1.41 asau 15374: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 15375: <h3 class="title">Note</h3>
15376: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 15377: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
15378: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 15379: directory.</p>
15380: </div>
15381: </li>
15382: </ol></div>
15383: </div>
15384: </div>
15385: </div></body>
15386: </html>
CVSweb <webmaster@jp.NetBSD.org>