Annotation of pkgsrc/doc/pkgsrc.html, revision 1.349
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.132 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
1.148 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75 rillig 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.110 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.75 rillig 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.110 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.75 rillig 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.346 jnemeth 33: <div><p class="copyright">Copyright © 1994-2023 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.42 2023/01/02 05:45:23 jnemeth Exp $</p></div>
1.148 asau 35: <div><div class="abstract">
1.75 rillig 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.210 leot 48: <dl class="toc">
1.75 rillig 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
1.75 rillig 56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
1.267 rillig 63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75 rillig 65: <dd><dl>
1.267 rillig 66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 67: <dd><dl>
1.267 rillig 68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 70: </dl></dd>
1.267 rillig 71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 72: <dd><dl>
1.267 rillig 73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 75: </dl></dd>
76: </dl></dd>
1.267 rillig 77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75 rillig 78: <dd><dl>
1.267 rillig 79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 81: </dl></dd>
1.267 rillig 82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75 rillig 83: <dd><dl>
1.267 rillig 84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 85: <dd><dl>
1.267 rillig 86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317 nia 88: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
89: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
90: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
91: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
92: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
93: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75 rillig 94: </dl></dd>
1.267 rillig 95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75 rillig 96: <dd><dl>
1.267 rillig 97: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
98: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
99: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75 rillig 100: </dl></dd>
101: </dl></dd>
1.267 rillig 102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75 rillig 103: <dd><dl>
1.267 rillig 104: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
105: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
106: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
107: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 108: <dd><dl>
1.267 rillig 109: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
110: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
111: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 112: </dl></dd>
1.267 rillig 113: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
114: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75 rillig 115: </dl></dd>
1.267 rillig 116: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75 rillig 117: <dd><dl>
1.267 rillig 118: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
119: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 120: </dl></dd>
1.267 rillig 121: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 122: builds)</a></span></dt>
1.75 rillig 123: <dd><dl>
1.267 rillig 124: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 125: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 126: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
127: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 128: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
129: <dd><dl>
1.294 rillig 130: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
131: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296 rillig 132: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
133: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
134: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
135: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
136: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
137: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
138: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
139: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 140: </dl></dd>
141: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
142: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267 rillig 143: </dl></dd>
144: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
145: <dd><dl>
146: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
147: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
148: </dl></dd>
149: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
150: <dd><dl>
151: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
152: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
153: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
154: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
155: <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>
156: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
157: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
158: <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>
159: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
160: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 161: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.336 nia 163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267 rillig 164: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
165: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
166: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
167: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
168: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 169: </dl></dd>
170: </dl></dd>
171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
172: <dd><dl>
1.267 rillig 173: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299 rillig 174: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91 rillig 175: <dd><dl>
1.299 rillig 176: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
177: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
178: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91 rillig 179: <dd><dl>
1.299 rillig 180: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
181: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
182: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
183: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
184: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91 rillig 185: </dl></dd>
1.299 rillig 186: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
187: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
188: <dd><dl>
189: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
190: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
191: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
192: </dl></dd>
193: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
194: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 195: </dl></dd>
1.299 rillig 196: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106 rillig 197: <dd><dl>
1.299 rillig 198: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
199: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
200: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
201: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
202: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 203: <dd><dl>
1.299 rillig 204: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
205: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106 rillig 206: </dl></dd>
1.299 rillig 207: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
208: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
209: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
210: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
211: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
212: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
213: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
214: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
215: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
216: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
217: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
218: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
219: </dl></dd>
220: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
221: <dd><dl>
222: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106 rillig 223: <dd><dl>
1.334 nia 224: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
225: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
226: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106 rillig 227: </dl></dd>
1.299 rillig 228: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
229: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106 rillig 230: </dl></dd>
1.299 rillig 231: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 232: <dd><dl>
1.299 rillig 233: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
234: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
235: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
236: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106 rillig 237: <dd><dl>
1.299 rillig 238: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
239: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
240: <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>
241: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344 gutterid 242: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.106 rillig 243: </dl></dd>
244: </dl></dd>
1.299 rillig 245: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106 rillig 246: <dd><dl>
1.299 rillig 247: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
248: <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>
249: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
250: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 251: </dl></dd>
1.299 rillig 252: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106 rillig 253: <dd><dl>
1.299 rillig 254: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
255: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
256: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
257: </dl></dd>
258: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
259: <dd><dl>
260: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
261: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 262: <dd><dl>
1.299 rillig 263: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
264: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133 wiz 265: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
266: and
267: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
268: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 269: </dl></dd>
1.299 rillig 270: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
271: <dd><dl>
272: <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>
273: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
274: </dl></dd>
275: </dl></dd>
276: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106 rillig 277: <dd><dl>
1.299 rillig 278: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
279: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
280: <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>
281: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
282: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
283: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
284: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
285: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
286: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106 rillig 287: </dl></dd>
1.299 rillig 288: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
289: <dd><dl>
290: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
291: <dd><dl>
292: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
293: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106 rillig 294: </dl></dd>
1.299 rillig 295: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106 rillig 296: <dd><dl>
1.299 rillig 297: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
298: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
299: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
300: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
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.267 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.338 nia 337: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.267 rillig 338: </dl></dd>
339: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
340: <dd><dl>
341: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
342: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 343: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338 nia 344: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
345: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
346: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
347: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267 rillig 348: </dl></dd>
349: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
350: <dd><dl>
351: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
352: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 353: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
354: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
355: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 356: </dl></dd>
357: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
358: <dd><dl>
359: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
360: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
361: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
362: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
363: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 364: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 365: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
366: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 367: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
368: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
369: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
370: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
371: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
372: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
373: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 374: emulation</a></span></dt>
1.318 nia 375: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
376: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.77 rillig 377: </dl></dd>
1.267 rillig 378: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 379: </dl></dd>
1.299 rillig 380: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
381: <dd><dl>
382: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
383: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
384: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
385: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
386: </dl></dd>
1.267 rillig 387: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 388: <dd><dl>
1.267 rillig 389: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
390: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
391: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
392: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
393: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
394: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
395: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
396: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
397: </dl></dd>
398: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75 rillig 399: </dl></dd>
400: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
401: <dd><dl>
1.299 rillig 402: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 403: <dd><dl>
1.299 rillig 404: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
405: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
406: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81 rillig 407: <dd><dl>
1.299 rillig 408: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
409: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81 rillig 410: </dl></dd>
1.299 rillig 411: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
412: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 413: <dd><dl>
1.299 rillig 414: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
415: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 416: </dl></dd>
1.299 rillig 417: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 418: <dd><dl>
1.299 rillig 419: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
420: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 421: </dl></dd>
422: </dl></dd>
1.299 rillig 423: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 424: <dd><dl>
1.299 rillig 425: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
426: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 427: <dd><dl>
1.299 rillig 428: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
429: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 430: </dl></dd>
431: </dl></dd>
1.299 rillig 432: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
433: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75 rillig 434: </dl></dd>
435: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
436: <dd><dl>
437: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
438: <dd><dl>
439: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
440: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
441: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287 rillig 442: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 443: </dl></dd>
444: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
445: </dl></dd>
1.322 leot 446: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.75 rillig 447: <dd><dl>
1.322 leot 448: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
449: <dd><dl>
450: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
451: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
452: </dl></dd>
453: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
454: <dd><dl>
455: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
456: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
457: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
458: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
459: </dl></dd>
460: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
461: <dd><dl>
462: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
463: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
464: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
465: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
466: </dl></dd>
467: </dl></dd>
468: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
469: <dd><dl>
470: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
471: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.75 rillig 472: </dl></dd>
1.322 leot 473: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.76 rillig 474: <dd><dl>
1.322 leot 475: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
476: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
477: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
478: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
479: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.261 leot 480: <code class="filename">stable</code>,
1.128 wiz 481: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 482: source packages</a></span></dt>
483: </dl></dd>
1.322 leot 484: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
485: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75 rillig 486: <dd><dl>
1.322 leot 487: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
488: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75 rillig 489: </dl></dd>
490: </dl>
491: </div>
1.82 rillig 492: <div class="list-of-tables">
493: <p><b>List of Tables</b></p>
494: <dl>
495: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
496: </dt>
1.299 rillig 497: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 498: </dt>
1.299 rillig 499: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 500: </dt>
1.82 rillig 501: </dl>
502: </div>
1.148 asau 503: <div class="chapter">
504: <div class="titlepage"><div><div><h1 class="title">
505: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 506: <div class="toc">
507: <p><b>Table of Contents</b></p>
1.210 leot 508: <dl class="toc">
1.75 rillig 509: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 510: <dd><dl>
511: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
512: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
513: </dl></dd>
1.75 rillig 514: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
515: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 516: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 517: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
518: </dl>
519: </div>
1.148 asau 520: <div class="sect1">
1.75 rillig 521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
522: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 523: <p>There is a lot of software freely available for Unix-based
524: systems, which is usually available in form of the source code. Before
525: such software can be used, it needs to be configured to the local
526: system, compiled and installed, and this is exactly what The NetBSD
527: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
528: to handle binary packages, so that not every user has to build the
529: packages for himself, which is a time-costly task.</p>
1.75 rillig 530: <p>pkgsrc currently contains several thousand packages,
531: including:</p>
1.148 asau 532: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 533: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.75 rillig 534: web server</p></li>
1.322 leot 535: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75 rillig 536: web browser</p></li>
1.322 leot 537: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75 rillig 538: Desktop Environment</p></li>
1.322 leot 539: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.75 rillig 540: Desktop Environment</p></li>
541: </ul></div>
1.219 rillig 542: <p>… just to name a few.</p>
1.75 rillig 543: <p>pkgsrc has built-in support for handling varying dependencies,
544: such as pthreads and X11, and extended features such as IPv6 support on
545: a range of platforms.</p>
1.148 asau 546: <div class="sect2">
1.82 rillig 547: <div class="titlepage"><div><div><h3 class="title">
548: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
549: <p>
550: pkgsrc provides the following key features:
551: </p>
1.148 asau 552: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 553: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 554: and installation of binary packages. The source and latest
555: patches are retrieved from a master or mirror download site, checksum
556: verified, then built on your system. Support for binary-only
557: distributions is available for both native platforms and NetBSD
558: emulated platforms.</p></li>
1.128 wiz 559: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 560: including binaries, libraries, man pages and other
561: documentation.</p></li>
1.214 sevan 562: <li class="listitem"><p>Tracking of package dependencies automatically, including when
563: performing updates, to ensure required packages are installed. The
564: configuration files of various packages are handled automatically during
565: updates, so local changes are preserved.</p></li>
1.128 wiz 566: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 567: consists of highly portable code. This allows the greatest speed of
1.132 spz 568: development when porting to a new platform. This portability also
1.82 rillig 569: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
570: platforms</em></span>.</p></li>
1.128 wiz 571: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 572: international encryption requirements and build-time options for a
573: large number of packages are all set in a simple, central
574: configuration file.</p></li>
1.128 wiz 575: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 576: freely available under a BSD license, so you may extend and adapt
577: pkgsrc to your needs. Support for local packages and patches is
578: available right out of the box, so you can configure it specifically
579: for your environment.</p></li>
580: </ul></div>
1.91 rillig 581: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 582: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 583: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 584: — That means, if a package contains bugs, it's better to find
1.91 rillig 585: them and to complain about them rather than to just install the package
586: and hope that it works. There are numerous checks in pkgsrc that try to
1.322 leot 587: find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91 rillig 588: of shell scripts), and post-installation checks (installed files,
589: references to shared libraries, script interpreters).</p></li>
1.128 wiz 590: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 591: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 592: pkgsrc has been ported to many operating systems. Care is taken that
593: packages behave the same on all platforms.</p></li>
594: </ul></div>
1.82 rillig 595: </div>
1.148 asau 596: <div class="sect2">
1.82 rillig 597: <div class="titlepage"><div><div><h3 class="title">
598: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
599: <p>pkgsrc consists of both a source distribution and a binary
600: distribution for these operating systems. After retrieving the required
601: source or binaries, you can be up and running with pkgsrc in just
602: minutes!</p>
1.75 rillig 603: <p>pkgsrc was derived from FreeBSD's ports system, and
604: initially developed for NetBSD only. Since then, pkgsrc has
605: grown a lot, and now supports the following platforms:</p>
1.82 rillig 606: <div class="table">
607: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216 tnn 608: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 609: <colgroup>
610: <col>
611: <col>
1.202 sevan 612: <col>
1.82 rillig 613: </colgroup>
614: <thead><tr>
615: <th>Platform</th>
616: <th>Date Support Added</th>
1.202 sevan 617: <th>Notes</th>
1.82 rillig 618: </tr></thead>
619: <tbody>
620: <tr>
1.289 leot 621: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 622: <td align="center">Aug 1997</td>
1.202 sevan 623: <td class="auto-generated"> </td>
1.82 rillig 624: </tr>
625: <tr>
1.110 hubertf 626: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 627: <td align="center">Mar 1999</td>
1.264 sevan 628: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.82 rillig 629: </tr>
630: <tr>
1.289 leot 631: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 632: <td align="center">Jun 1999</td>
1.264 sevan 633: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.82 rillig 634: </tr>
635: <tr>
636: <td>
1.230 sevan 637: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82 rillig 638: </td>
639: <td align="center">Oct 2001</td>
1.305 bacon 640: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.82 rillig 641: </tr>
642: <tr>
1.289 leot 643: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 644: <td align="center">Nov 2002</td>
1.264 sevan 645: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.82 rillig 646: </tr>
647: <tr>
1.289 leot 648: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 649: <td align="center">Nov 2002</td>
1.264 sevan 650: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.82 rillig 651: </tr>
652: <tr>
1.289 leot 653: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 654: <td align="center">Dec 2002</td>
1.202 sevan 655: <td>
1.264 sevan 656: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.202 sevan 657: </td>
1.82 rillig 658: </tr>
659: <tr>
660: <td>BSD/OS</td>
661: <td align="center">Dec 2003</td>
1.202 sevan 662: <td class="auto-generated"> </td>
1.82 rillig 663: </tr>
664: <tr>
1.289 leot 665: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 666: <td align="center">Dec 2003</td>
1.264 sevan 667: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.82 rillig 668: </tr>
669: <tr>
670: <td>
1.289 leot 671: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 672: (Microsoft Windows Services for Unix)
673: </td>
674: <td align="center">Mar 2004</td>
1.264 sevan 675: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.82 rillig 676: </tr>
677: <tr>
1.289 leot 678: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 679: <td align="center">Oct 2004</td>
1.202 sevan 680: <td class="auto-generated"> </td>
1.82 rillig 681: </tr>
682: <tr>
1.110 hubertf 683: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 684: <td align="center">Nov 2004</td>
1.264 sevan 685: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.82 rillig 686: </tr>
1.98 wiz 687: <tr>
1.289 leot 688: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 689: <td align="center">Apr 2007</td>
1.264 sevan 690: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.98 wiz 691: </tr>
1.128 wiz 692: <tr>
1.289 leot 693: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128 wiz 694: <td align="center">Sep 2010</td>
1.264 sevan 695: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.128 wiz 696: </tr>
1.151 obache 697: <tr>
1.289 leot 698: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 699: <td align="center">Jan 2011</td>
1.202 sevan 700: <td class="auto-generated"> </td>
1.151 obache 701: </tr>
702: <tr>
1.289 leot 703: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151 obache 704: <td align="center">Nov 2011</td>
1.264 sevan 705: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.151 obache 706: </tr>
707: <tr>
1.289 leot 708: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151 obache 709: <td align="center">Mar 2013</td>
1.264 sevan 710: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.151 obache 711: </tr>
1.166 jnemeth 712: <tr>
1.289 leot 713: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166 jnemeth 714: <td align="center">Jul 2013</td>
1.264 sevan 715: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.166 jnemeth 716: </tr>
1.214 sevan 717: <tr>
1.289 leot 718: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214 sevan 719: <td align="center">Jun 2014</td>
1.344 gutterid 720: <td>Removed from pkgsrc Sep 2022</td>
1.214 sevan 721: </tr>
1.82 rillig 722: </tbody>
1.91 rillig 723: </table></div>
1.82 rillig 724: </div>
1.91 rillig 725: <br class="table-break">
1.82 rillig 726: </div>
1.75 rillig 727: </div>
1.148 asau 728: <div class="sect1">
1.75 rillig 729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
730: <a name="overview"></a>1.2. Overview</h2></div></div></div>
731: <p>This document is divided into three parts. The first,
1.110 hubertf 732: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 733: describes how one can use one of the packages in the Package
734: Collection, either by installing a precompiled binary package,
1.93 rillig 735: or by building one's own copy using the NetBSD package system.
1.110 hubertf 736: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75 rillig 737: package so it can be easily built by other NetBSD users without
738: knowing about the package's building details. The third part,
1.110 hubertf 739: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 740: is intended for those who want to understand how pkgsrc is
741: implemented.</p>
742: <p>This document is available in various formats:
1.110 hubertf 743: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75 rillig 744: </div>
1.148 asau 745: <div class="sect1">
1.75 rillig 746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
747: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 748: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
749: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 750: terminology used within this document.</p>
1.148 asau 751: <div class="variablelist"><dl class="variablelist">
1.75 rillig 752: <dt><span class="term">Package</span></dt>
753: <dd><p>A set of files and building instructions
754: that describe what's necessary
755: to build a certain piece of software using
756: pkgsrc. Packages are traditionally stored under
1.236 wiz 757: <code class="filename">/usr/pkgsrc</code>,
758: but may be stored in any location,
759: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75 rillig 760: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 761: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 762: is part of the NetBSD operating system and can be bootstrapped
763: to run on non-NetBSD operating systems as well. It handles
764: building (compiling), installing, and removing of
765: packages.</p></dd>
1.75 rillig 766: <dt><span class="term">Distfile</span></dt>
767: <dd><p>This term describes the file or files that are
768: provided by the author of the piece of software to
769: distribute his work. All the changes necessary to build on
770: NetBSD are reflected in the corresponding package. Usually
771: the distfile is in the form of a compressed tar-archive,
772: but other types are possible, too. Distfiles are usually
773: stored below
1.76 rillig 774: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 775: <dt><span class="term">Port</span></dt>
776: <dd><p>This is the term used by FreeBSD and OpenBSD people
777: for what we call a package.
1.128 wiz 778: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 779: architecture.</p></dd>
780: <dt><span class="term">Precompiled/binary package</span></dt>
781: <dd>
782: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 783: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 784: file so it can be installed on machines of the same
785: machine architecture without the need to
786: recompile. Packages are usually generated in
1.76 rillig 787: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 788: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 789: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 790: especially in the context of precompiled packages.</p>
791: </dd>
792: <dt><span class="term">Program</span></dt>
1.88 wiz 793: <dd><p>The piece of software to be installed which will be
794: constructed from all the files in the distfile by the
795: actions defined in the corresponding package.</p></dd>
1.75 rillig 796: </dl></div>
1.148 asau 797: <div class="sect2">
1.75 rillig 798: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 799: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 800: <div class="variablelist"><dl class="variablelist">
1.75 rillig 801: <dt><span class="term">pkgsrc users</span></dt>
802: <dd>
803: <p>The
804: pkgsrc users are people who use the packages provided by pkgsrc.
805: Typically they are system administrators. The people using the
1.128 wiz 806: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
807: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 808: <p>There are two kinds of pkgsrc users: Some only want to
809: install pre-built binary packages. Others build the pkgsrc
810: packages from source, either for installing them directly or for
1.110 hubertf 811: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.75 rillig 812: documentation.</p>
813: </dd>
814: <dt><span class="term">package maintainers</span></dt>
815: <dd><p>A
1.110 hubertf 816: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.75 rillig 817: <dt><span class="term">infrastructure developers</span></dt>
818: <dd><p>These people are involved in all those files
1.76 rillig 819: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 820: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.75 rillig 821: too.</p></dd>
822: </dl></div>
823: </div>
824: </div>
1.148 asau 825: <div class="sect1">
1.75 rillig 826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
827: <a name="typography"></a>1.4. Typography</h2></div></div></div>
828: <p>When giving examples for commands, shell prompts are used to
829: show if the command should/can be issued as root, or if
1.128 wiz 830: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.226 sevan 831: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
832: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.344 gutterid 833: Bourne shell and derivatives.</p>
1.75 rillig 834: </div>
835: </div>
1.148 asau 836: <div class="part">
1.75 rillig 837: <div class="titlepage"><div><div><h1 class="title">
838: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
839: <div class="toc">
840: <p><b>Table of Contents</b></p>
1.210 leot 841: <dl class="toc">
1.267 rillig 842: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
843: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75 rillig 844: <dd><dl>
1.267 rillig 845: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 846: <dd><dl>
1.267 rillig 847: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
848: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 849: </dl></dd>
1.267 rillig 850: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 851: <dd><dl>
1.267 rillig 852: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
853: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 854: </dl></dd>
855: </dl></dd>
1.267 rillig 856: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75 rillig 857: <dd><dl>
1.267 rillig 858: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
859: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 860: </dl></dd>
1.267 rillig 861: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75 rillig 862: <dd><dl>
1.267 rillig 863: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 864: <dd><dl>
1.267 rillig 865: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
866: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317 nia 867: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
868: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
869: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
870: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
871: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
872: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75 rillig 873: </dl></dd>
1.267 rillig 874: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75 rillig 875: <dd><dl>
1.267 rillig 876: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
877: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
878: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75 rillig 879: </dl></dd>
880: </dl></dd>
1.267 rillig 881: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75 rillig 882: <dd><dl>
1.267 rillig 883: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
884: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
885: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
886: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 887: <dd><dl>
1.267 rillig 888: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
889: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
890: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 891: </dl></dd>
1.267 rillig 892: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
893: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75 rillig 894: </dl></dd>
1.267 rillig 895: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75 rillig 896: <dd><dl>
1.267 rillig 897: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
898: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 899: </dl></dd>
1.267 rillig 900: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 901: builds)</a></span></dt>
1.75 rillig 902: <dd><dl>
1.267 rillig 903: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 904: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 905: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
906: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 907: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
908: <dd><dl>
1.294 rillig 909: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
910: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296 rillig 911: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
912: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
913: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
914: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
915: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
916: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
917: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
918: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 919: </dl></dd>
920: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
921: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267 rillig 922: </dl></dd>
923: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
924: <dd><dl>
925: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
926: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
927: </dl></dd>
928: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
929: <dd><dl>
930: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
931: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
932: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
933: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
934: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
935: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
936: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
937: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
938: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
939: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 940: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 941: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.336 nia 942: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267 rillig 943: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
944: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
945: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
946: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
947: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 948: </dl></dd>
949: </dl>
950: </div>
1.148 asau 951: <div class="chapter">
1.75 rillig 952: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 953: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
954: <p>
955: To get help when using pkgsrc, the definitive source is this
956: document, the pkgsrc guide. If you don't find anything here,
957: there are alternatives:
958: </p>
959: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
960: <li class="listitem">
961: <p>
962: The built-in pkgsrc help, which is available after bootstrapping
963: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
964: help for any topic, such as a variable name like
965: <code class="varname">BUILD_DEFS</code>, a make target like
966: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
967: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322 leot 968: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.267 rillig 969: </li>
970: <li class="listitem"><p>
1.278 rillig 971: To see the value of a single variable, run <span class="command"><strong>bmake
972: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
973: </p></li>
974: <li class="listitem"><p>
975: To see the values of the most common variables, run
976: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
977: topic. To see the variables for a single topic, run
978: <span class="command"><strong>bmake
979: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
980: <span class="command"><strong>bmake show-all-fetch</strong></span>.
981: </p></li>
982: <li class="listitem"><p>
1.267 rillig 983: The pkgsrc-users mailing list, to which
984: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
985: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
986: questions</a>.</p></li>
987: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
988: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
989: or by using a specialized chat program such as
990: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
991: Pick any user name and join the channel #pkgsrc.</p></li>
992: </ul></div>
993: </div>
994: <div class="chapter">
995: <div class="titlepage"><div><div><h2 class="title">
996: <a name="getting"></a>Chapter 3. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
1.75 rillig 997: <div class="toc">
998: <p><b>Table of Contents</b></p>
1.210 leot 999: <dl class="toc">
1.267 rillig 1000: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 1001: <dd><dl>
1.267 rillig 1002: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
1003: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 1004: </dl></dd>
1.267 rillig 1005: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 1006: <dd><dl>
1.267 rillig 1007: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
1008: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 1009: </dl></dd>
1010: </dl>
1011: </div>
1.91 rillig 1012: <p>Before you download and extract the files, you need to decide
1013: where you want to extract them. When using pkgsrc as root user, pkgsrc
1014: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
1015: free to install the sources and binary packages wherever you want in
1016: your filesystem, provided that the pathname does not contain white-space
1017: or other characters that are interpreted specially by the shell and some
1018: other programs. A safe bet is to use only letters, digits, underscores
1019: and dashes.</p>
1.148 asau 1020: <div class="sect1">
1.75 rillig 1021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1022: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75 rillig 1023: <p>Before you download any pkgsrc files, you should decide
1024: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1025: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1026: quarterly basis from the current branch and only gets modified
1027: for security updates. The names of the stable branches are built
1028: from the year and the quarter, for example
1.329 leot 1029: <code class="literal">2021Q4</code>.</p>
1.75 rillig 1030: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 1031: want to download pkgsrc. You can get it as a tar file or via CVS.
1032: Both ways are described here.</p>
1.157 asau 1033: <p>Note that tar archive contains CVS working copy.
1034: Thus you can switch to using CVS at any later time.</p>
1.148 asau 1035: <div class="sect2">
1.75 rillig 1036: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1037: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75 rillig 1038: <p>The primary download location for all pkgsrc files is
1.264 sevan 1039: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157 asau 1040: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1041: (it points to the same location).
1042: There are a number of subdirectories for different purposes,
1.322 leot 1043: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix D. Directory layout of the pkgsrc FTP server">Appendix D, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.157 asau 1044: <p>The tar archive for the current branch is in the directory
1.264 sevan 1045: <code class="filename">current</code> and is called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.230 sevan 1046: It is autogenerated weekly.</p>
1.157 asau 1047: <p>To save download time we provide bzip2- and
1048: xz-compressed archives which are published at
1.264 sevan 1049: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
1.157 asau 1050: and
1.264 sevan 1051: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
1.157 asau 1052: respectively.
1053: </p>
1054: <p>You can fetch the same files using FTP.</p>
1.329 leot 1055: <p>The tar file for the stable branch 2021Q4 is in the
1056: directory <code class="filename">pkgsrc-2021Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249 leot 1057: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112 weinem 1058: <pre class="screen">
1.329 leot 1059: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q4/pkgsrc.tar.gz</code></strong></pre>
1.188 snj 1060: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 1061: or your web browser.</p>
1.112 weinem 1062: <p>Then, extract it with:</p>
1.188 snj 1063: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 weinem 1064: <p>This will create the directory <code class="filename">pkgsrc/</code>
1065: in <code class="filename">/usr/</code> and all the package source will be
1066: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1067: <p>To download pkgsrc-current, run:</p>
1068: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75 rillig 1069: </div>
1.148 asau 1070: <div class="sect2">
1.75 rillig 1071: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1072: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128 wiz 1073: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.329 leot 1074: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2021Q4 -P pkgsrc</code></strong>
1.128 wiz 1075: </pre>
1076: <p>This will create the directory <code class="filename">pkgsrc/</code>
1077: in your <code class="filename">/usr/</code> directory and all the package source
1078: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1079: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 1080: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 grant 1081: </pre>
1.289 leot 1082: <p>Refer to the <a class="ulink" href="https://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128 wiz 1083: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.146 wiz 1084: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.128 wiz 1085: </pre>
1086: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1087: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1088: or better globally in <code class="filename">/etc/profile</code>:</p>
1089: <pre class="programlisting">
1090: # set CVS remote shell command
1091: CVS_RSH=ssh
1092: export CVS_RSH
1093: </pre>
1094: <p>By default, CVS doesn't do things like most people would expect it to do.
1095: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1096: in your home directory and saving the following lines to it.
1097: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1098: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1099: <pre class="programlisting">
1100: # recommended CVS configuration file from the pkgsrc guide
1.268 sevan 1101: cvs -q
1.101 rillig 1102: checkout -P
1.103 wiz 1103: update -dP
1104: diff -upN
1.101 rillig 1105: rdiff -u
1.128 wiz 1106: release -d
1.101 rillig 1107: </pre>
1.75 rillig 1108: </div>
1109: </div>
1.148 asau 1110: <div class="sect1">
1.75 rillig 1111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1112: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75 rillig 1113: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1114: (which also works if you have first installed it via a tar
1115: file). It saves bandwidth and hard disk activity, compared to
1116: downloading the tar file again.</p>
1.148 asau 1117: <div class="sect2">
1.75 rillig 1118: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1119: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148 asau 1120: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1121: <h3 class="title">Warning</h3>
1.77 rillig 1122: <p>When updating from a tar file, you first need to
1123: completely remove the old pkgsrc directory. Otherwise those
1124: files that have been removed from pkgsrc in the mean time will
1125: not be removed on your local disk, resulting in inconsistencies.
1126: When removing the old files, any changes that you have done to
1127: the pkgsrc files will be lost after updating. Therefore updating
1128: via CVS is strongly recommended.</p>
1.75 rillig 1129: </div>
1.82 rillig 1130: <p>Note that by default the distfiles and the binary packages
1131: are saved in the pkgsrc tree, so don't forget to rescue them
1.188 snj 1132: before updating. You can also configure pkgsrc to store distfiles
1133: and packages in directories outside the pkgsrc tree by setting the
1.82 rillig 1134: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267 rillig 1135: variables. See <a class="xref" href="#configuring" title="Chapter 6. Configuring pkgsrc">Chapter 6, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 1136: <p>To update pkgsrc from a tar file, download the tar file as
1137: explained above. Then, make sure that you have not made any
1138: changes to the files in the pkgsrc directory. Remove the pkgsrc
1139: directory and extract the new tar file. Done.</p>
1140: </div>
1.148 asau 1141: <div class="sect2">
1.75 rillig 1142: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1143: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132 spz 1144: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1145: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1146: </pre>
1147: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
1148: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1149: </pre>
1.148 asau 1150: <div class="sect3">
1.75 rillig 1151: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1152: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75 rillig 1153: <p>When updating pkgsrc, the CVS program keeps track of the
1154: branch you selected. But if you, for whatever reason, want to
1155: switch from the stable branch to the current one, you can do it
1.128 wiz 1156: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1157: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1158: back to the stable branch, add the
1.329 leot 1159: <span class="quote">“<span class="quote">-rpkgsrc-2021Q4</span>”</span> option.</p>
1.75 rillig 1160: </div>
1.148 asau 1161: <div class="sect3">
1.75 rillig 1162: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1163: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75 rillig 1164: <p>When you update pkgsrc, the CVS program will only touch
1165: those files that are registered in the CVS repository. That
1166: means that any packages that you created on your own will stay
1167: unmodified. If you change files that are managed by CVS, later
1168: updates will try to merge your changes with those that have been
1169: done by others. See the CVS manual, chapter
1.128 wiz 1170: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1171: </div>
1172: </div>
1173: </div>
1174: </div>
1.148 asau 1175: <div class="chapter">
1.75 rillig 1176: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1177: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75 rillig 1178: <div class="toc">
1179: <p><b>Table of Contents</b></p>
1.210 leot 1180: <dl class="toc">
1.267 rillig 1181: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1182: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 1183: </dl>
1184: </div>
1.148 asau 1185: <div class="sect1">
1.75 rillig 1186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1187: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1188: <p>See <a class="xref" href="#using-pkg" title="5.1. Using binary packages">Section 5.1, “Using binary packages”</a>.</p>
1.82 rillig 1189: </div>
1.148 asau 1190: <div class="sect1">
1.82 rillig 1191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1192: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1193: <p>pkgsrc can be bootstrapped for use in two different modes:
1194: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1195: to privileged one all programs are installed under one particular user
1.149 asau 1196: and cannot utilise privileged operations (packages don't create
1197: special users and all special file permissions like setuid are ignored).
1198: </p>
1.82 rillig 1199: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1200: <pre class="screen">
1.167 asau 1201: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.75 rillig 1202: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1203: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1204: </pre>
1.149 asau 1205: <p>To bootstrap in unprivileged mode pass <span class="quote">“<span class="quote">--unprivileged</span>”</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
1206: <p>By default, in privileged mode pkgsrc uses
1207: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1208: where programs will be installed in,
1.230 sevan 1209: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149 asau 1210: directory where pkgsrc will do its internal bookkeeping,
1211: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1212: where packages install their persistent data.
1213: In unprivileged mode pkgsrc uses
1214: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230 sevan 1215: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149 asau 1216: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1217: </p>
1218: <p>You can change default layout using command-line arguments.
1219: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1220: </p>
1.148 asau 1221: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1222: <h3 class="title">Note</h3>
1.110 hubertf 1223: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1224: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1225: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1226: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1227: </div>
1.149 asau 1228: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1229: <h3 class="title">Note</h3>
1230: <p>It is possible to bootstrap multiple instances of pkgsrc
1231: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1232: corresponding to the installation you're working with to build
1233: and install packages.
1234: </p>
1235: </div>
1.75 rillig 1236: </div>
1237: </div>
1.148 asau 1238: <div class="chapter">
1.75 rillig 1239: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1240: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75 rillig 1241: <div class="toc">
1242: <p><b>Table of Contents</b></p>
1.210 leot 1243: <dl class="toc">
1.267 rillig 1244: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 1245: <dd><dl>
1.267 rillig 1246: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1247: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317 nia 1248: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1249: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1250: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1251: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1252: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
1253: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.267 rillig 1254: </dl></dd>
1255: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1256: <dd><dl>
1257: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1258: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1259: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75 rillig 1260: </dl></dd>
1261: </dl>
1262: </div>
1263: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1264: is to only install the package tools and to use binary packages
1.128 wiz 1265: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1266: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1267: of pkgsrc, too. Then you are able to build your own packages,
1268: and you can still use binary packages from someone else.</p>
1.148 asau 1269: <div class="sect1">
1.75 rillig 1270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1271: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.317 nia 1272: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264 sevan 1273: site and mirrors, there are collections of binary packages,
1.109 rillig 1274: ready to be installed. These binary packages have been built using the
1275: default settings for the directories, that is:</p>
1.148 asau 1276: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1277: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1278: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1279: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.109 rillig 1280: </ul></div>
1281: <p>If you cannot use these directories for whatever reasons (maybe
1282: because you're not root), you cannot use these binary packages, but
1.267 rillig 1283: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="4.2. Bootstrapping pkgsrc">Section 4.2, “Bootstrapping pkgsrc”</a>.</p>
1.148 asau 1284: <div class="sect2">
1.75 rillig 1285: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1286: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1287: <p>To install binary packages, you first need to know from where
1288: to get them. The first place where you should look is on the main
1.317 nia 1289: pkgsrc CDN in the directory <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105 weinem 1290: <p>This directory contains binary packages for multiple
1.341 gutterid 1291: platforms. First, select your operating system. Then, select your
1292: hardware architecture, and in the third step, the OS version and
1293: the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1294: <p>In this directory, you may find a file called
1.109 rillig 1295: <code class="filename">bootstrap.tar.gz</code> which contains the package
1296: management tools. If the file is missing, it is likely that your
1297: operating system already provides those tools. Download the file and
1298: extract it in the <code class="filename">/</code> directory. It will create
1299: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230 sevan 1300: for managing binary packages and the database of installed packages).</p>
1.75 rillig 1301: </div>
1.148 asau 1302: <div class="sect2">
1.75 rillig 1303: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1304: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1305: <p>In the directory from the last section, there is a
1.196 wiz 1306: subdirectory called <code class="filename">All/</code>, which contains all the
1.109 rillig 1307: binary packages that are available for the platform, excluding those
1.317 nia 1308: that may not be distributed via HTTP or FTP.</p>
1.109 rillig 1309: <p>To install packages directly from an FTP or HTTP server, run
1310: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1311: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1312: <pre class="screen">
1.317 nia 1313: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1314: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284 rillig 1315: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="$PKG_PATH/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.109 rillig 1316: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.317 nia 1317: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.109 rillig 1318: </pre>
1319: <p>Instead of URLs, you can also use local paths, for example if
1320: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1321: repository. If you want to install packages from multiple sources,
1322: you can separate them by a semicolon in
1323: <code class="varname">PKG_PATH</code>.</p>
1324: <p>After these preparations, installing a package is very
1325: easy:</p>
1326: <pre class="screen">
1.317 nia 1327: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1328: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1329: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1330: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1331: </pre>
1332: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1333: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1334: <p>Any prerequisite packages needed to run the
1.88 wiz 1335: package in question will be installed, too, assuming they are
1.317 nia 1336: present in the repository.</p>
1.75 rillig 1337: <p>After you've installed packages, be sure to have
1.88 wiz 1338: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1339: <code class="varname">PATH</code> so you can actually start the just
1340: installed program.</p>
1.75 rillig 1341: </div>
1.148 asau 1342: <div class="sect2">
1.75 rillig 1343: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1344: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1345: <p>To update binary packages, it is recommended that you use
1346: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1347: package repository to your locally installed packages and safely
1348: replace any older packages.</p>
1349: <p>Note that pkgsrc is released as quarterly branches.
1350: If you are updating to a newer quarterly branch of pkgsrc, you may
1351: need to adjust the repository in
1352: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1353: </div>
1354: <div class="sect2">
1355: <div class="titlepage"><div><div><h3 class="title">
1356: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.82 rillig 1357: <p>To deinstall a package, it does not matter whether it was
1.317 nia 1358: installed from source code or from a binary package. Neither the
1359: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1360: command need to know.</p>
1361: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.88 wiz 1362: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.317 nia 1363: name can be given with or without version number.</p>
1.82 rillig 1364: </div>
1.148 asau 1365: <div class="sect2">
1.82 rillig 1366: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1367: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1368: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.317 nia 1369: installed packages or binary package files.
1370: As with other management tools, it works with packages installed
1371: from source or binaries.</p>
1.82 rillig 1372: </div>
1.148 asau 1373: <div class="sect2">
1.82 rillig 1374: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1375: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82 rillig 1376: <p>
1.279 leot 1377: The pkgsrc Security Team and Packages Groups maintain a list of
1.317 nia 1378: known vulnerabilities to packages which are (or have been)
1.88 wiz 1379: included in pkgsrc. The list is available from the NetBSD
1.317 nia 1380: CDN at <a class="ulink" href="https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
1381: </p>
1382: <p>
1383: Please note that not every "vulnerability" with a CVE assignment is
1384: exploitable in every configuration.
1385: Some bugs are marked as active simply because an fix was not
1386: marked as such.
1387: Operating system specific hardening and mitigation features may also
1388: reduce the impact of bugs.
1.88 wiz 1389: </p>
1.82 rillig 1390: <p>
1.125 wiz 1391: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1392: this list can be downloaded
1393: automatically, and a security audit of all packages installed on a system
1394: can take place.
1395: </p>
1.82 rillig 1396: <p>
1.125 wiz 1397: There are two components to auditing. The first
1398: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1399: is for downloading
1.88 wiz 1400: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1401: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1402: installed packages are vulnerable. If a package is vulnerable, you
1403: will see output similar to the following:
1404: </p>
1.82 rillig 1405: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289 leot 1406: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1407: <p>
1.125 wiz 1408: You may wish to have the
1.317 nia 1409: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1410: file downloaded daily so that
1411: it remains current. This may be done by adding an appropriate entry
1.322 leot 1412: to the root users <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.125 wiz 1413: </p>
1414: <pre class="screen">
1.233 sevan 1415: # Download vulnerabilities file
1.230 sevan 1416: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.233 sevan 1417: # Audit the installed packages and email results to root
1418: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1419: root >/dev/null 2>&1
1.125 wiz 1420: </pre>
1421: <p>
1.230 sevan 1422: will update the vulnerability list every day at 3AM, followed by an audit
1423: at 3:09AM. The result of the audit are then emailed to root.
1.125 wiz 1424:
1.230 sevan 1425: On NetBSD this may be accomplished instead by adding the following
1426: line to <code class="filename">/etc/daily.conf</code>:
1427: </p>
1428: <pre class="screen">
1429: fetch_pkg_vulnerabilities=YES
1430: </pre>
1431: <p>
1432: to fetch the vulnerability list from the daily security script. The system
1433: is set to audit the packages by default but can be set explicitly, if
1.235 yyamano 1434: desired (not required), by adding the following line to
1.230 sevan 1435: <code class="filename">/etc/security.conf</code>:
1.125 wiz 1436: </p>
1437: <pre class="screen">
1.230 sevan 1438: check_pkg_vulnerabilities=YES
1.125 wiz 1439: </pre>
1440: <p>
1.322 leot 1441: see <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88 wiz 1442: </p>
1.82 rillig 1443: </div>
1.148 asau 1444: <div class="sect2">
1.82 rillig 1445: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1446: <a name="pkg_versions"></a>5.1.7. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.82 rillig 1447: <p>
1.322 leot 1448: Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128 wiz 1449: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.317 nia 1450: argument to check if any packages are stale, e.g.
1.88 wiz 1451: </p>
1452: <pre class="screen">
1453: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1454: ...
1.88 wiz 1455: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1456: </pre>
1.82 rillig 1457: </div>
1.148 asau 1458: <div class="sect2">
1.82 rillig 1459: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1460: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.110 hubertf 1461: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1462: administrative functions on the package system.</p>
1.82 rillig 1463: </div>
1.75 rillig 1464: </div>
1.148 asau 1465: <div class="sect1">
1.75 rillig 1466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1467: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88 wiz 1468: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1469: directory now contains a set of packages, organized into
1470: categories. You can browse the online index of packages, or run
1.110 hubertf 1471: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1472: directory to build local <code class="filename">README.html</code> files for
1.322 leot 1473: all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/index.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88 wiz 1474: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1475: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1476: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1477: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1478: different <code class="varname">LOCALBASE</code> definitions on the same
1479: system (inside a chroot is an exception). </p>
1480: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1481: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.88 wiz 1482: instructions how to create your own packages.</p>
1.148 asau 1483: <div class="sect2">
1.75 rillig 1484: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1485: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82 rillig 1486: <p>To build packages from source, you need a working C
1.88 wiz 1487: compiler. On NetBSD, you need to install the
1.128 wiz 1488: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1489: sets. If you want to build X11-related packages, the
1.128 wiz 1490: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1491: sets are required, too.</p>
1.75 rillig 1492: </div>
1.148 asau 1493: <div class="sect2">
1.75 rillig 1494: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1495: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75 rillig 1496: <p>The first step for building a package is downloading the
1.88 wiz 1497: distfiles (i.e. the unmodified source). If they have not yet been
1498: downloaded, pkgsrc will fetch them automatically.</p>
1499: <p>If you have all files that you need in the
1500: <code class="filename">distfiles</code> directory,
1501: you don't need to connect. If the distfiles are on CD-ROM, you can
1502: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1503: </p>
1.82 rillig 1504: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1505: <p>
1.110 hubertf 1506: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1507: <p>By default a list of distribution sites will be randomly
1508: intermixed to prevent huge load on servers which holding popular
1509: packages (for example, SourceForge.net mirrors). Thus, every
1510: time when you need to fetch yet another distfile all the mirrors
1511: will be tried in new (random) order. You can turn this feature
1512: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1513: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1514: <p>You can overwrite some of the major distribution sites to
1515: fit to sites that are close to your own. By setting one or two
1516: variables you can modify the order in which the master sites are
1517: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1518: delimited list of domain suffixes.
1519: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1520: contains a whitespace delimited list of regular expressions. It
1521: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1522: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1523: some examples. This may save some of your bandwidth and
1524: time.</p>
1.75 rillig 1525: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1526: if you want to keep the settings, by editing the
1.110 hubertf 1527: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1528: and adding the definitions there.</p>
1.82 rillig 1529: <p>
1.88 wiz 1530: If a package depends on many other packages (such as
1.322 leot 1531: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.88 wiz 1532: alternate between periods of
1533: downloading source, and compiling. To ensure you have all the source
1534: downloaded initially you can run the command:
1535: </p>
1.82 rillig 1536: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1537: <p>
1.88 wiz 1538: which will output and run a set of shell commands to fetch the
1539: necessary files into the <code class="filename">distfiles</code> directory. You can
1540: also choose to download the files manually.
1541: </p>
1.75 rillig 1542: </div>
1.148 asau 1543: <div class="sect2">
1.75 rillig 1544: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1545: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1546: <p>
1.88 wiz 1547: Once the software has downloaded, any patches will be applied, then it
1548: will be compiled for you. This may take some time depending on your
1549: computer, and how many other packages the software depends on and their
1550: compile time.
1551: </p>
1.148 asau 1552: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1553: <h3 class="title">Note</h3>
1554: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1555: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1556: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1557: </div>
1.87 wiz 1558: <p>For example, type</p>
1.88 wiz 1559: <pre class="screen">
1560: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1561: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1562: </pre>
1.75 rillig 1563: <p>at the shell prompt to build the various components of the
1.88 wiz 1564: package.</p>
1.82 rillig 1565: <p>The next stage is to actually install the newly compiled
1.88 wiz 1566: program onto your system. Do this by entering:
1.82 rillig 1567:
1.88 wiz 1568: </p>
1.82 rillig 1569: <pre class="screen">
1.88 wiz 1570: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1571: </pre>
1.82 rillig 1572: <p>
1573:
1.88 wiz 1574: while you are still in the directory for whatever package you
1575: are installing.</p>
1.82 rillig 1576: <p>Installing the package on your system may require you to
1.88 wiz 1577: be root. However, pkgsrc has a
1578: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1579: to only become root for the actual installation step.</p>
1.82 rillig 1580: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1581: You can now enter:
1.82 rillig 1582:
1.88 wiz 1583: </p>
1.82 rillig 1584: <pre class="screen">
1.88 wiz 1585: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1586: </pre>
1.82 rillig 1587: <p>
1588:
1.88 wiz 1589: to remove the compiled files in the work directory, as you shouldn't need
1590: them any more. If other packages were also added to your system
1591: (dependencies) to allow your program to compile, you can tidy these up
1592: also with the command:</p>
1.82 rillig 1593: <pre class="screen">
1.88 wiz 1594: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1595: </pre>
1.75 rillig 1596: <p>Taking the figlet utility as an example, we can install it on our
1.322 leot 1597: system by building as shown in <a class="xref" href="#logs" title="Appendix C. Build logs">Appendix C, <i>Build logs</i></a>.</p>
1.88 wiz 1598: <p>The program is installed under the default root of the
1599: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1600: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1601: variable in your environment, and it will use that value as the
1602: root of your packages tree. So, to use
1603: <code class="filename">/usr/local</code>, set
1604: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1605: Please note that you should use a directory which is dedicated to
1606: packages and not shared with other programs (i.e., do not try and
1607: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1608: to add any of your own files or directories (such as
1609: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1610: <code class="filename">pkgsrc/</code>) below the
1611: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1612: conflicts between programs and other files installed by the
1613: package system and whatever else may have been installed
1614: there.</p>
1.110 hubertf 1615: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1616: alter some configuration options at build time. Have a look at
1617: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1618: of what will be set there by default. Environment variables such
1619: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1620: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1621: set them each time you want to use pkgsrc.</p>
1.128 wiz 1622: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1623: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 1624: or being installed. This may be for debugging purposes, or out of
1625: simple curiosity. A number of utility values have been added to
1626: help with this.</p>
1.128 wiz 1627: <div class="orderedlist"><ol class="orderedlist" type="1">
1628: <li class="listitem">
1.322 leot 1629: <p>If you invoke the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88 wiz 1630: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1631: information will be displayed. For example,</p>
1.75 rillig 1632: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1633: <p>will show all the commands that are invoked, up to and
1.128 wiz 1634: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1635: </li>
1.128 wiz 1636: <li class="listitem">
1.322 leot 1637: <p>If you want to know the value of a certain <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1638: definition, then the <code class="varname">VARNAME</code> definition
1639: should be used, in conjunction with the show-var
1.322 leot 1640: target. e.g. to show the expansion of the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1641: variable <code class="varname">LOCALBASE</code>:</p>
1642: <pre class="screen">
1643: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 1644: /usr/pkg
1645: <code class="prompt">%</code>
1.88 wiz 1646: </pre>
1.75 rillig 1647: </li>
1648: </ol></div>
1649: <p>If you want to install a binary package that you've either
1.88 wiz 1650: created yourself (see next section), that you put into
1651: pkgsrc/packages manually or that is located on a remote FTP
1652: server, you can use the "bin-install" target. This target will
1.322 leot 1653: install a binary package - if available - via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110 hubertf 1654: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1655: sites searched is kept in the variable
1656: <code class="varname">BINPKG_SITES</code>, which defaults to
1.322 leot 1657: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88 wiz 1658: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1659: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1660: details.</p>
1661: <p>A final word of warning: If you set up a system that has a
1662: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1663: set that before any packages are installed, as you cannot use
1664: several directories for the same purpose. Doing so will result in
1665: pkgsrc not being able to properly detect your installed packages,
1666: and fail miserably. Note also that precompiled binary packages are
1667: usually built with the default <code class="varname">LOCALBASE</code> of
1668: <code class="filename">/usr/pkg</code>, and that you should
1669: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1670: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 1671: </div>
1672: </div>
1673: </div>
1.148 asau 1674: <div class="chapter">
1.75 rillig 1675: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1676: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75 rillig 1677: <div class="toc">
1678: <p><b>Table of Contents</b></p>
1.210 leot 1679: <dl class="toc">
1.267 rillig 1680: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1681: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1682: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
1683: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1684: <dd><dl>
1685: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
1686: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1687: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 1688: </dl></dd>
1.267 rillig 1689: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
1690: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75 rillig 1691: </dl>
1692: </div>
1.104 rillig 1693: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 1694: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1695: that file depends on the installation. On NetBSD, when you use
1.322 leot 1696: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89 rillig 1697: <code class="filename">/etc/</code>. In all other cases the default location is
1698: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1699: bootstrap program to install the binary packages.</p>
1700: <p>The format of the configuration file is that of the usual
1701: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1702: is done by setting variables in this file. Note that you can define all
1703: kinds of variables, and no special error checking (for example for
1.223 rillig 1704: spelling mistakes) takes place.</p>
1.148 asau 1705: <div class="sect1">
1.75 rillig 1706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1707: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223 rillig 1708: <p>The following variables apply to all
1.89 rillig 1709: pkgsrc packages. A complete list of the variables that can be
1710: configured by the user is available in
1711: <code class="filename">mk/defaults/mk.conf</code>, together with some
1712: comments that describe each variable's intent.</p>
1.148 asau 1713: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1714: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 1715: packages will be installed. The default is
1.76 rillig 1716: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 1717: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 1718: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1719: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 1720: installed. The default is
1.76 rillig 1721: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 1722: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 1723: X11 is installed on the system. The default is
1.194 bsiegert 1724: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 1725: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 1726: downloaded copies of the original source distributions used
1727: for building pkgsrc packages. The default is
1.76 rillig 1728: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 1729: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 1730: database about installed packages is stored. The default is
1.230 sevan 1731: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128 wiz 1732: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 1733: If set, override the packages'
1734: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 1735: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 1736: Backup location(s) for distribution files and patch files
1737: if not found locally or in
1.76 rillig 1738: <code class="filename">${MASTER_SITES}</code> or
1739: <code class="filename">${PATCH_SITES}</code> respectively.
1.230 sevan 1740: The defaults is
1741: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 1742: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 1743: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1744: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 1745: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1746: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1747: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 1748: List of acceptable licenses. License names are case-sensitive.
1749: Whenever you try to build a package whose license is not in this
1750: list, you will get an error message. If the license condition is
1751: simple enough, the error message will include specific
1752: instructions on how to change this variable.</p></li>
1.75 rillig 1753: </ul></div>
1754: </div>
1.148 asau 1755: <div class="sect1">
1.75 rillig 1756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1757: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219 rillig 1758: <p>
1.75 rillig 1759: </p>
1.148 asau 1760: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1761: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 1762: directory for the binary packages. The default is
1.76 rillig 1763: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 1764: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 1765: The top level directory where, if defined, the separate
1766: working directories will get created, and symbolically
1.76 rillig 1767: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 1768: This is useful for building packages on several
1.76 rillig 1769: architectures, then <code class="filename">${PKGSRCDIR}</code>
1770: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 1771: is local to every architecture. (It should be noted that
1772: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 1773: — it is an internal definition which refers to the
1.75 rillig 1774: root of the pkgsrc tree. It is possible to have many
1775: pkgsrc tree instances.)</p></li>
1.128 wiz 1776: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 1777: Directory for local patches that aren't part of pkgsrc.
1.299 rillig 1778: See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> for more
1.93 rillig 1779: information.</p></li>
1.128 wiz 1780: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 1781: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 1782: BSD-style Makefile. If this is not set,
1783: <code class="varname">MAKECONF</code> is set to
1.76 rillig 1784: <code class="filename">/dev/null</code> to avoid picking up
1785: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75 rillig 1786: </ul></div>
1787: </div>
1.148 asau 1788: <div class="sect1">
1.75 rillig 1789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1790: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.312 gdt 1791: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
1.256 maya 1792: By default, binary packages of built packages are
1.263 leot 1793: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256 maya 1794: this variable to "no" prevents this.</p></li></ul></div>
1.217 jnemeth 1795: <p>Packages have to support installation into a
1.103 wiz 1796: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1797: to be built, before the actual filesystem is touched. DESTDIR
1798: support exists in two variations:</p>
1.148 asau 1799: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1800: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 1801: installation and packaging is still run as root.</p></li>
1802: <li class="listitem"><p>Full DESTDIR support can run the complete
1803: build, installation and packaging as normal user. Root
1804: privileges are only needed to add packages.</p></li>
1805: </ul></div>
1.103 wiz 1806: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1807: clean</code></strong> needs to be run as root.</p>
1.118 imil 1808: <p>Considering the <code class="filename">foo/bar</code> package,
1809: DESTDIR full support can be tested using the following commands
1810:
1811: </p>
1812: <pre class="programlisting">
1813: <code class="prompt">$</code> id
1814: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1815: <code class="prompt">$</code> mkdir $HOME/packages
1816: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1817: </pre>
1818: <p>
1819:
1820: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1821: should be needed
1822:
1823: </p>
1824: <pre class="programlisting">
1.174 asau 1825: <code class="prompt">$</code> make stage-install
1.118 imil 1826: </pre>
1827: <p>
1828:
1829: Create a package without root privileges
1830:
1831: </p>
1832: <pre class="programlisting">
1.174 asau 1833: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 1834: </pre>
1835: <p>
1836:
1837: For the following command, you must be able to gain root
1.322 leot 1838: privileges using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118 imil 1839:
1840: </p>
1841: <pre class="programlisting">
1.174 asau 1842: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 1843: </pre>
1844: <p>
1845:
1846: Then, as a simple user
1847:
1848: </p>
1849: <pre class="programlisting">
1850: <code class="prompt">$</code> make clean
1851: </pre>
1852: <p>
1853:
1854: </p>
1.103 wiz 1855: </div>
1.148 asau 1856: <div class="sect1">
1.103 wiz 1857: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1858: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 1859: <div class="sect2">
1.78 rillig 1860: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1861: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 1862: <p>By default, pkgsrc will use GCC to build packages. This may be
1863: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 1864: <div class="variablelist"><dl class="variablelist">
1.89 rillig 1865: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1866: <dd>
1867: <p>This is a list of values specifying the chain of
1868: compilers to invoke when building packages. Valid values
1869: are:</p>
1.148 asau 1870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 1871: <li class="listitem"><p><code class="varname">ccc</code>:
1872: Compaq C Compilers (Tru64)</p></li>
1873: <li class="listitem"><p><code class="varname">ccache</code>:
1874: compiler cache (chainable)</p></li>
1875: <li class="listitem"><p><code class="varname">clang</code>:
1876: Clang C and Objective-C compiler</p></li>
1.128 wiz 1877: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 1878: distributed C/C++ (chainable)</p></li>
1.174 asau 1879: <li class="listitem"><p><code class="varname">f2c</code>:
1880: Fortran 77 to C compiler (chainable)</p></li>
1881: <li class="listitem"><p><code class="varname">icc</code>:
1882: Intel C++ Compiler (Linux)</p></li>
1883: <li class="listitem"><p><code class="varname">ido</code>:
1884: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 1885: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 1886: GNU C/C++ Compiler</p></li>
1.174 asau 1887: <li class="listitem"><p><code class="varname">hp</code>:
1888: HP-UX C/aC++ compilers</p></li>
1.128 wiz 1889: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 1890: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 1891: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 1892: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 1893: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 1894: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 1895: <li class="listitem"><p><code class="varname">xlc</code>:
1.230 sevan 1896: IBM's XL C/C++ compiler suite</p></li>
1.89 rillig 1897: </ul></div>
1898: <p>The default is
1.128 wiz 1899: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 1900: <code class="varname">ccache</code> and/or
1901: <code class="varname">distcc</code> with an appropriate
1902: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 1903: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 1904: variable should always be terminated with a value for
1905: a real compiler. Note that only one real compiler
1.128 wiz 1906: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 1907: is not allowed).</p>
1.89 rillig 1908: </dd>
1909: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1910: <dd><p>This specifies the minimum version of GCC to use
1911: when building packages. If the system GCC doesn't
1912: satisfy this requirement, then pkgsrc will build and
1913: install one of the GCC packages to use instead.</p></dd>
1.266 leot 1914: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225 maya 1915: <dd><p>Specifies which version of python to use when several
1916: options are available.</p></dd>
1917: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291 gutterid 1918: <dd><p>Specifies the Fortran compiler to use.
1919: The default is <code class="varname">gfortran</code>.</p></dd>
1.225 maya 1920: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1921: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1922: <code class="varname">gfortran</code> is used, this option specifies which
1923: version to use.</p></dd>
1.89 rillig 1924: </dl></div>
1925: </div>
1.148 asau 1926: <div class="sect2">
1.89 rillig 1927: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1928: <a name="conf.cflags"></a>6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78 rillig 1929: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1930: please make sure to use the <code class="literal">+=</code> operator
1931: instead of the <code class="literal">=</code> operator:</p>
1932: <pre class="programlisting">
1.100 rillig 1933: CFLAGS+= -your -flags
1.78 rillig 1934: </pre>
1935: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 1936: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 1937: need to add their own flags. You may want to take a look
1.322 leot 1938: at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128 wiz 1939: package if you're interested in optimization specifically
1940: for the current CPU. </p>
1.78 rillig 1941: </div>
1.148 asau 1942: <div class="sect2">
1.88 wiz 1943: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1944: <a name="conf.ldflags"></a>6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88 wiz 1945: <p>If you want to pass flags to the linker, both in the configure
1946: step and the build step, you can do this in two ways. Either set
1947: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1948: between the two is that <code class="varname">LIBS</code> will be appended to
1949: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1950: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1951: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1952: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1953: <code class="varname">CFLAGS</code>, if you do not wish to override these
1954: settings, use the <code class="literal">+=</code> operator:</p>
1955: <pre class="programlisting">
1.100 rillig 1956: LDFLAGS+= -your -linkerflags
1.88 wiz 1957: </pre>
1958: </div>
1.78 rillig 1959: </div>
1.148 asau 1960: <div class="sect1">
1.78 rillig 1961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1962: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 1963: <p>
1.75 rillig 1964: </p>
1.148 asau 1965: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1966: <li class="listitem">
1.75 rillig 1967: <p><code class="varname">PKG_DEVELOPER</code>:
1.347 gutterid 1968: Run some sanity checks that package developers want:
1969: </p>
1.148 asau 1970: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 1971: <li class="listitem"><p>make sure patches apply with zero
1.347 gutterid 1972: fuzz</p></li>
1.128 wiz 1973: <li class="listitem"><p>run check-shlibs to see that all
1.347 gutterid 1974: binaries will find their shared libs.</p></li>
1.75 rillig 1975: </ul></div>
1976: </li>
1.347 gutterid 1977: <li class="listitem"><p><code class="varname">CHECK_FILES_STRICT</code>:
1978: Also check <code class="varname">VARBASE</code> and <code class="varname">PKG_SYSCONFDIR
1979: </code> values in PLIST entries.
1980: </p></li>
1.128 wiz 1981: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.347 gutterid 1982: of debugging output which is displayed whilst making and
1983: installing the package. The default value for this is 0,
1984: which will not display the commands as they are executed
1985: (normal, default, quiet operation); the value 1 will display
1986: all shell commands before their invocation, and the value 2
1987: will display both the shell commands before their invocation,
1988: as well as their actual execution progress with <span class="command"><strong>set
1989: -x</strong></span>.</p></li>
1.75 rillig 1990: </ul></div>
1991: <p>
1992: </p>
1993: </div>
1.148 asau 1994: <div class="sect1">
1.75 rillig 1995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1996: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 1997: <p>Some packages have build time options, usually to select
1998: between different dependencies, enable optional support for big
1999: dependencies or enable experimental features.</p>
1.75 rillig 2000: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2001: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2002: show-options</strong></span>, for example:</p>
1.75 rillig 2003: <pre class="programlisting">
2004: The following options are supported by this package:
2005: ssl Enable SSL support.
2006: Exactly one of the following gecko options is required:
2007: firefox Use firefox as gecko rendering engine.
2008: mozilla Use mozilla as gecko rendering engine.
2009: At most one of the following database options may be selected:
2010: mysql Enable support for MySQL database.
2011: pgsql Enable support for PostgreSQL database.
1.1 grant 2012:
1.75 rillig 2013: These options are enabled by default: firefox
2014: These options are currently enabled: mozilla ssl
1.1 grant 2015: </pre>
1.75 rillig 2016: <p>The following variables can be defined in
1.110 hubertf 2017: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2018: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2019: which can be used to select or disable options for all packages
2020: that support them, and
2021: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2022: which can be used to select or disable options specifically for
2023: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2024: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2025: are disabled. A few examples:</p>
1.75 rillig 2026: <pre class="screen">
1.110 hubertf 2027: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75 rillig 2028: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2029: PKG_OPTIONS.kdebase= debug -sasl
2030: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2031: <p>It is important to note that options that were specifically
1.120 snj 2032: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2033: you do not wish to include the option. If you are unsure you can view
2034: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2035: <p>The following settings are consulted in the order given, and
2036: the last setting that selects or disables an option is
2037: used:</p>
1.128 wiz 2038: <div class="orderedlist"><ol class="orderedlist" type="1">
2039: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2040: maintainer</p></li>
1.128 wiz 2041: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2042: variables (see below)</p></li>
1.128 wiz 2043: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2044: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2045: </ol></div>
2046: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2047: selected is used, all others are automatically disabled. If an
2048: option of the group is explicitly disabled, the previously
2049: selected option, if any, is used. It is an error if no option
2050: from a required group of options is selected, and building the
2051: package will fail.</p>
2052: <p>Before the options framework was introduced, build options
2053: were selected by setting a variable (often named
2054: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2055: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2056: transition to the options framework for the user, these legacy
2057: variables are converted to the appropriate options setting
2058: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2059: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2060: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2061: directly. Support for the legacy variables will be removed
2062: eventually.</p>
1.75 rillig 2063: </div>
2064: </div>
1.148 asau 2065: <div class="chapter">
1.75 rillig 2066: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2067: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75 rillig 2068: <div class="toc">
2069: <p><b>Table of Contents</b></p>
1.210 leot 2070: <dl class="toc">
1.267 rillig 2071: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2072: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.75 rillig 2073: </dl>
2074: </div>
1.148 asau 2075: <div class="sect1">
1.75 rillig 2076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2077: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2078: <p>Once you have built and installed a package, you can create
2079: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.322 leot 2080: another system with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87 wiz 2081: the same package on a group of hosts and wasting CPU time. It also
2082: provides a simple means for others to install your package, should
2083: you distribute it.</p>
2084: <p>To create a binary package, change into the appropriate
1.110 hubertf 2085: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2086: package</strong></span>:</p>
2087: <pre class="screen">
1.223 rillig 2088: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2089: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2090: </pre>
1.87 wiz 2091: <p>This will build and install your package (if not already done),
2092: and then build a binary package from what was installed. You can
1.110 hubertf 2093: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2094: it. Binary packages are created by default in
2095: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.322 leot 2096: gzipped tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a
2097: continuation of 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> example.</p>
1.267 rillig 2098: <p>See <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a> for information on how to submit
1.87 wiz 2099: such a binary package.</p>
1.75 rillig 2100: </div>
1.148 asau 2101: <div class="sect1">
1.75 rillig 2102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2103: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.299 rillig 2104: <p>See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a>.</p>
1.106 rillig 2105: </div>
2106: </div>
1.148 asau 2107: <div class="chapter">
1.106 rillig 2108: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2109: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 2110: builds)</h2></div></div></div>
2111: <div class="toc">
2112: <p><b>Table of Contents</b></p>
1.210 leot 2113: <dl class="toc">
1.267 rillig 2114: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 2115: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 2116: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2117: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 2118: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2119: <dd><dl>
1.294 rillig 2120: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2121: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296 rillig 2122: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
2123: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
2124: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
2125: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
2126: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
2127: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
2128: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
2129: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 2130: </dl></dd>
2131: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2132: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2133: </dl>
2134: </div>
1.290 gutterid 2135: <p>For a number of reasons, you may want to build binary packages
2136: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180 wiz 2137: For instance, when you have multiple machines that should run the same software,
2138: it is wasted time if they all build their packages themselves from source.
2139: Or you may want to build a list of packages you want and check them before
1.290 gutterid 2140: deploying onto production systems.
1.180 wiz 2141: There is a way of getting a set of binary packages:
1.290 gutterid 2142: the bulk build system, or pbulk ("p" stands for "parallel").
1.223 rillig 2143: This chapter describes how to set it up.</p>
1.148 asau 2144: <div class="sect1">
1.106 rillig 2145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2146: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180 wiz 2147: <p>First of all, you have to decide whether you build all packages
2148: or a limited set of them. Full bulk builds usually consume a lot more resources,
2149: both space and time, than builds for some practical sets of packages.
1.290 gutterid 2150: A number of particularly heavy packages exist that are not actually
2151: interesting to a wide audience. (The approximate resource consumption for a
2152: full bulk build is given in section <a class="xref" href="#bulk.req" title="8.3. Requirements of a full bulk build">Section 8.3, “Requirements of a full bulk build”</a>.)
2153: For limited bulk builds you need to make a list of packages you want to build.
1.223 rillig 2154: Note that all their dependencies will be built, so you don't need to track them manually.
1.180 wiz 2155: </p>
2156: <p>During bulk builds various packages are installed and deinstalled
2157: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2158: so make sure that you don't need any package during the builds.
1.223 rillig 2159: Essentially, you should provide a fresh system, either a chroot environment
1.180 wiz 2160: or something even more restrictive, depending on what the operating system provides,
2161: or dedicate the whole physical machine.
2162: As a useful side effect this makes sure that bulk builds cannot
2163: break anything in your system. There have been numerous cases where
1.106 rillig 2164: certain packages tried to install files outside the
2165: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2166: <code class="filename">/etc</code>.
2167: </p>
1.106 rillig 2168: </div>
1.148 asau 2169: <div class="sect1">
1.106 rillig 2170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.295 rillig 2171: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
2172: <p>Running a bulk build works roughly as follows:</p>
1.148 asau 2173: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2174: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2175: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2176: </ul></div>
1.148 asau 2177: <div class="sect2">
1.116 rillig 2178: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 2179: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223 rillig 2180: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178 asau 2181: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2182: Configure network access to fetch distribution files.
1.223 rillig 2183: Create a user with name "pbulk".</p>
1.178 asau 2184: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2185: <pre class="screen">
1.264 sevan 2186: <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>
2187: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
1.181 wiz 2188: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.178 asau 2189: </pre>
2190: <p>Or any other way that fits (e.g., curl, wget).</p>
2191: <p>Deploy and configure pbulk tools, e.g.:</p>
2192: <pre class="screen">
1.230 sevan 2193: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.178 asau 2194: <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>
2195: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2196: </pre>
2197: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2198: <h3 class="title">Note</h3>
2199: <p><code class="filename">mk.conf.frag</code> is a fragment of
2200: <code class="filename">mk.conf</code> that contains settings you want to
2201: apply to packages you build. For instance,</p>
2202: <pre class="programlisting">
1.223 rillig 2203: PKG_DEVELOPER= yes # perform more checks
2204: X11_TYPE= modular # use pkgsrc X11
2205: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2206: # when building all packages)
1.178 asau 2207: </pre>
2208: </div>
2209: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223 rillig 2210: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178 asau 2211: <pre class="programlisting">
2212: www/firefox
2213: mail/thunderbird
2214: misc/libreoffice4
2215: </pre>
1.179 asau 2216: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2217: and make final amendments, if wanted.</p>
1.178 asau 2218: <p>Start it:</p>
2219: <pre class="screen">
2220: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2221: </pre>
2222: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2223: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2224: </p>
2225: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2226: <h3 class="title">Note</h3>
2227: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2228: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2229: The script is kept small enough for better understanding.</p>
2230: </div>
2231: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2232: <h3 class="title">Note</h3>
2233: <p>The <code class="filename">pbulk.sh</code> script supports running
1.320 wiz 2234: unprivileged bulk build and helps configuring distributed bulk builds.
2235: Distributed bulk builds support either building in worker chroots
2236: (each node is a path to a different chroot)
2237: that replicate the target system, including the pbulk prefix,
2238: or remote machines (each node is
2239: an IP address that must be accessible over SSH without a password).</p>
1.178 asau 2240: </div>
1.106 rillig 2241: </div>
2242: </div>
1.148 asau 2243: <div class="sect1">
1.106 rillig 2244: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2245: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180 wiz 2246: <p>A complete bulk build requires lots of disk space. Some of the
2247: disk space can be read-only, some other must be writable. Some can be on
2248: remote filesystems (such as NFS) and some should be local. Some can be
2249: temporary filesystems, others must survive a sudden reboot.</p>
2250: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.320 wiz 2251: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2252: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.180 wiz 2253: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2254: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2255: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2256: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2257: </ul></div>
2258: </div>
2259: <div class="sect1">
2260: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.293 rillig 2261: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2262: <p>To ensure that pkgsrc packages work in different configurations, it
2263: makes sense to run non-default bulk builds from time to time. This
2264: section lists some ideas for bulk builds that intentionally let packages
2265: fail if they don't follow the pkgsrc style.</p>
2266: <div class="sect2">
2267: <div class="titlepage"><div><div><h3 class="title">
1.294 rillig 2268: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.293 rillig 2269: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2270: <pre class="programlisting">
2271: GNU_CONFIGURE_STRICT= yes
2272: </pre>
2273: <p>When a package fails this additional check, the most common cause
2274: is that the configure option was valid for an older version of the
2275: package but does not apply anymore. In that case, just remove it.</p>
2276: </div>
2277: <div class="sect2">
2278: <div class="titlepage"><div><div><h3 class="title">
1.294 rillig 2279: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293 rillig 2280: <p>The job of a compiler is not restricted to producing executable
1.294 rillig 2281: code, most compilers also detect typical programming mistakes. The pkgsrc
2282: compiler wrappers make it easy to force compiler options when the package
2283: is built. This can be used to find typical bugs across all packages that
2284: are in pkgsrc. By reporting these bugs upstream, the packages will be
2285: more reliable with the next updates.</p>
2286: <p>Add some of the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.293 rillig 2287: <pre class="programlisting">
2288: CFLAGS+= -Werror=char-subscripts
1.294 rillig 2289: CFLAGS+= -Werror=implicit-function-declaration
1.293 rillig 2290: </pre>
1.294 rillig 2291: <p>When a package fails to build using these stricter compiler
2292: options, document the circumstances in which the compiler produced the
2293: error message. This includes:</p>
1.293 rillig 2294: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2295: <li class="listitem"><p>The platform
2296: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2297: <li class="listitem"><p>The source file</p></li>
2298: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2299: part of the diagnostic.</p></li>
1.294 rillig 2300: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293 rillig 2301: </ul></div>
2302: <p>If a package produces these error messages, but the package is
1.294 rillig 2303: 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
2304: in the next builds:</p>
1.293 rillig 2305: <pre class="programlisting">
1.294 rillig 2306: .if ${PKGPATH} == category/package
1.293 rillig 2307: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2308: # error message
2309: # code
1.294 rillig 2310: # Reason why the code does not need to be fixed.
1.293 rillig 2311: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.294 rillig 2312: .endif
1.293 rillig 2313: </pre>
2314: <p>If the error messages from the compiler are valid and the code
1.294 rillig 2315: needs to be fixed, prepare a local patch (see
2316: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2317: authors of the package, providing them with the information you collected
2318: above.</p>
2319: <p>Patches that are not essential for the package to work should only
2320: be reported upstream but not committed to pkgsrc, to make future updates
2321: easier.</p>
1.293 rillig 2322: </div>
2323: <div class="sect2">
2324: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2325: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
2326: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2327: these apply to all phases of the package build process. Especially in the
2328: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2329: decisions. The GNU configure scripts feed many small test programs to the
2330: C compiler to see whether certain headers are available, functions are
2331: defined in a library and programs can be run. In many cases these
2332: programs would not survive a strict compiler run with <code class="literal">-Wall
2333: -Wextra -Werror</code>.</p>
2334: <p>The pkgsrc infrastructure is flexible enough to support compiler
2335: options being added between the <code class="literal">configure</code> and
2336: <code class="literal">build</code> phases. It's a little more complicated than the
2337: other examples in this section but still easy enough.</p>
2338: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2339: desired compiler options. The compiler wrapper's original task is to hide
2340: unwanted directories of include files and to normalize compiler options.
2341: It does this by wrapping the compiler command and rewriting the command
2342: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2343: package directory and examine the
2344: <code class="filename">work/.cwrappers/config</code> directory. It contains
2345: individual configurations for the C compiler and the related tools. The
2346: plan is to find a hook between the configure and build phases, and to
2347: modify these configuration files at that point.</p>
2348: <p>To find this hook, have a look at
2349: <code class="filename">mk/build/build.mk</code>, which contains among others the
2350: <code class="literal">pre-build-checks-hook</code>. The word
2351: <code class="literal">checks</code> doesn't quite fit, but the
2352: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2353: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2354: <pre class="programlisting">
2355: # Just a few example options.
2356: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2357:
2358: .if ${BUILD_ONLY_CFLAGS:U:M*}
2359: pre-build-checks-hook: add-build-only-cflags
2360:
2361: add-build-only-cflags: .PHONY
2362: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2363: ${TEST} ! -f ${.TARGET} || exit 0; \
2364: for flag in ${BUILD_ONLY_CFLAGS}; do \
2365: ${ECHO} "append=$$flag" >> cc; \
2366: done; \
2367: > ${.TARGET}
2368: .endif
2369: </pre>
2370: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2371: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2372: not with spaces.)</p>
2373: <p>The condition in the <code class="literal">.if</code> statement contains the
2374: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2375: should be undefined, possibly because it is only defined for a subset of
2376: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2377: at least one compiler option, to prevent a syntax error in the shell
2378: parser.</p>
2379: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2380: that the additional compiler options are only appended once, even if
2381: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2382: creates a marker file.</p>
2383: <p>To verify that this setup works, run <span class="command"><strong>bmake
2384: configure</strong></span> in a package directory. Up to now, everything works
2385: as usual. Examine the directory
2386: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2387: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2388: the file <code class="filename">cc</code>. Examine the tail of the
2389: <code class="filename">work/.work.log</code> file to see that the normal compiler
2390: options are used.</p>
2391: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2392: options to the file <code class="filename">cc</code> and will create the marker
2393: file in the same directory. After that, the build starts as usual, but
2394: with the added compiler options. Examine the tail of the file
2395: <code class="filename">work/.work.log</code> to see that the lines starting with
2396: <code class="literal">[*]</code> don't contain the compiler options, but the
2397: corresponding lines starting with <code class="literal"><.></code> do end
2398: with these options.</p>
2399: <p>Building packages using this setup variant and fixing the resulting
2400: bugs is the same as in <a class="xref" href="#bulk.var.comperr" title="8.4.2. Detect classes of bugs by forcing compiler warnings">Section 8.4.2, “Detect classes of bugs by forcing compiler warnings”</a>.</p>
2401: </div>
2402: <div class="sect2">
2403: <div class="titlepage"><div><div><h3 class="title">
2404: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.293 rillig 2405: <p>Some directories like <code class="varname">PREFIX</code>,
2406: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2407: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2408: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2409: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2410: <pre class="programlisting">
2411: PREFIX= /a-random-uuid
2412: PKG_SYSCONFDIR= /a-random-uuid
2413: VARBASE= /a-random-uuid
2414: PKGMANDIR= a-random-uuid
2415: PKG_INFODIR= a-random-uuid
2416: </pre>
2417: </div>
2418: <div class="sect2">
2419: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2420: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.293 rillig 2421: <p>When building a package, warnings are typically ignored since they
2422: just flow by and do not cause the build to fail immediately. To find
2423: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2424: <pre class="programlisting">
2425: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2426: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2427: </pre>
2428: <p>(There are many more classes of warnings in pkgsrc, and most of
2429: them can be redefined with a simple definition like above.</p>
1.294 rillig 2430: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293 rillig 2431: the package Makefile, research whether the package actually needs Perl.
2432: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2433: Makefile, and if it doesn't, add
2434: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2435: </div>
2436: <div class="sect2">
2437: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2438: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293 rillig 2439: <p>Using pkglint as part of the regular build process is mostly a
2440: waste of time. If you want to fix some of the warnings, just run pkglint
2441: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2442: 10), which is much faster than a complete bulk build.</p>
2443: </div>
2444: <div class="sect2">
2445: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2446: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293 rillig 2447: <p>To ensure that the binary packages don't contain references to the
2448: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2449: that variable includes the item <code class="literal">extra</code>, it is
2450: possible to define additional patterns that must not appear in any
2451: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2452: <pre class="programlisting">
2453: CHECK_WRKREF= extra
2454: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2455: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2456: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2457: </pre>
2458: <p>The above patterns will probably generate many false positives,
2459: therefore the results need to be taken with a grain of salt.</p>
2460: </div>
2461: <div class="sect2">
2462: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2463: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.293 rillig 2464: <p>To run the test suites that come with each package, add this line
2465: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2466: <pre class="programlisting">
2467: PKGSRC_RUN_TEST= yes
2468: </pre>
2469: <p>Be prepared that even the most basic packages fail this test. When
2470: doing a bulk build with this, it will often abort in the early phase
2471: where the packages are scanned for their dependencies since there are
2472: cyclic dependencies. There is still a lot to do in this area.</p>
2473: </div>
2474: <div class="sect2">
2475: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2476: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293 rillig 2477: <p>To catch typos in the shell snippets from the Makefile fragments,
2478: add the <code class="literal">-u</code> flag to most of the commands by adding this
2479: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2480: <pre class="programlisting">
2481: RUN= @set -eu;
2482: </pre>
1.296 rillig 2483: <p>After that, ensure that none of the bulk build log files (even
2484: those for successfully built packages) contains the string
2485: <code class="literal">parameter not set</code> or whatever error message the
2486: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293 rillig 2487: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2488: definition.</p>
2489: </div>
2490: <div class="sect2">
2491: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2492: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.293 rillig 2493: <p>The build logs of a package are often quite long. This allows error
2494: messages or other interesting details to hide between the noise. To make
2495: the actual error message stand out more, add these lines to
2496: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2497: <pre class="programlisting">
2498: GNU_CONFIGURE_QUIET= yes
2499: MAKE_FLAGS+= -s
2500: </pre>
2501: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2502: Make. On exotic platforms with their own make, it may be a little
2503: different.</p>
2504: </div>
2505: </div>
2506: <div class="sect1">
2507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2508: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2509: <p>After your pkgsrc bulk-build has completed, you may wish to
2510: create a CD-ROM set of the resulting binary packages to assist
2511: in installing packages on other machines. The
1.322 leot 2512: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/index.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87 wiz 2513: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2514: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2515: way that keeps all the dependencies for a given package on the same
2516: CD as that package.</p>
1.148 asau 2517: <div class="sect2">
1.75 rillig 2518: <div class="titlepage"><div><div><h3 class="title">
1.293 rillig 2519: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2520: <p>Complete documentation for cdpack is found in the cdpack(1)
2521: man page. The following short example assumes that the binary
2522: packages are left in
2523: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2524: sufficient disk space exists in <code class="filename">/u2</code> to
2525: hold the ISO 9660 images.</p>
2526: <pre class="screen">
2527: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2528: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2529: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2530: </pre>
2531: <p>If you wish to include a common set of files
2532: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2533: etc.) on each CD in the collection, then you need to create a
1.290 gutterid 2534: directory which contains these files, e.g.:</p>
1.87 wiz 2535: <pre class="screen">
2536: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2537: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2538: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2539: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2540: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2541: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2542: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2543: </pre>
1.75 rillig 2544: <p>Now create the images:</p>
2545: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76 rillig 2546: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2547: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2548: in their root directories.</p>
1.75 rillig 2549: </div>
2550: </div>
2551: </div>
1.148 asau 2552: <div class="chapter">
1.75 rillig 2553: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2554: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2555: <div class="toc">
2556: <p><b>Table of Contents</b></p>
1.210 leot 2557: <dl class="toc">
1.267 rillig 2558: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2559: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90 rillig 2560: </dl>
2561: </div>
2562: <p>The files that are installed by pkgsrc are organized in a way that
2563: is similar to what you find in the <code class="filename">/usr</code> directory
2564: of the base system. But some details are different. This is because
2565: pkgsrc initially came from FreeBSD and had adopted its file system
2566: hierarchy. Later it was largely influenced by NetBSD. But no matter
2567: which operating system you are using pkgsrc with, you can expect the
2568: same layout for pkgsrc.</p>
1.91 rillig 2569: <p>There are mainly four root directories for pkgsrc, which are all
2570: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2571: When pkgsrc has been installed as root, the default locations
2572: are:</p>
2573: <pre class="programlisting">
1.100 rillig 2574: LOCALBASE= /usr/pkg
2575: PKG_SYSCONFBASE= /usr/pkg/etc
2576: VARBASE= /var
1.231 sevan 2577: PKG_DBDIR= /usr/pkg/pkgdb
1.91 rillig 2578: </pre>
2579: <p>In unprivileged mode (when pkgsrc has been installed as any other
2580: user), the default locations are:</p>
2581: <pre class="programlisting">
1.100 rillig 2582: LOCALBASE= ${HOME}/pkg
2583: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2584: VARBASE= ${HOME}/pkg/var
1.231 sevan 2585: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.91 rillig 2586: </pre>
2587: <p>What these four directories are for, and what they look like is
2588: explained below.</p>
1.148 asau 2589: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2590: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2591: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2592: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2593: the well-known subdirectories like <code class="filename">bin</code>,
2594: <code class="filename">include</code>, <code class="filename">lib</code>,
2595: <code class="filename">share</code> and
2596: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2597: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2598: <code class="filename">/var</code> in the base system. Some programs (especially
2599: games, network daemons) need write access to it during normal
2600: operation.</p></li>
1.128 wiz 2601: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2602: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2603: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90 rillig 2604: itself.</p></li>
2605: </ul></div>
1.148 asau 2606: <div class="sect1">
1.90 rillig 2607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2608: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2609: </h2></div></div></div>
1.90 rillig 2610: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2611: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2612: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2613: <dt><span class="term"><code class="filename">bin</code></span></dt>
2614: <dd><p>Contains executable programs that are intended to be
2615: directly used by the end user.</p></dd>
2616: <dt><span class="term"><code class="filename">emul</code></span></dt>
2617: <dd><p>Contains files for the emulation layers of various other
2618: operating systems, especially for
2619: NetBSD.</p></dd>
2620: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2621: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2622: <dd><p>Contains
2623: the configuration files.</p></dd>
2624: <dt><span class="term"><code class="filename">include</code></span></dt>
2625: <dd><p>Contains headers for the C and C++ programming
2626: languages.</p></dd>
2627: <dt><span class="term"><code class="filename">info</code></span></dt>
2628: <dd><p>Contains GNU info files of various
2629: packages.</p></dd>
2630: <dt><span class="term"><code class="filename">lib</code></span></dt>
2631: <dd><p>Contains shared and static
2632: libraries.</p></dd>
2633: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2634: <dd><p>Contains data files that don't change after
2635: installation. Other data files belong into
2636: <code class="filename">${VARBASE}</code>.</p></dd>
2637: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2638: <dd><p>Contains programs that are not intended to be used by
2639: end users, such as helper programs or network
2640: daemons.</p></dd>
2641: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2642: <dd><p>Contains programs that are intended to be executed as
2643: CGI scripts by a web server.</p></dd>
2644: <dt><span class="term"><code class="filename">man</code> (the usual value of
2645: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2646: <dd><p>Contains brief
2647: documentation in form of manual pages.</p></dd>
2648: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2649: <dd><p>Contains programs that are intended to be used only by
2650: the super-user.</p></dd>
2651: <dt><span class="term"><code class="filename">share</code></span></dt>
2652: <dd><p>Contains platform-independent data files that don't
2653: change after installation.</p></dd>
2654: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2655: <dd><p>Contains documentation files provided by the
2656: packages.</p></dd>
2657: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2658: <dd><p>Contains example files provided by the packages. Among
2659: others, the original configuration files are saved here and copied to
2660: <code class="filename">${PKG_SYSCONFDIR}</code> during
2661: installation.</p></dd>
2662: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2663: <dd><p>Contains the original files for rc.d
2664: scripts.</p></dd>
2665: <dt><span class="term"><code class="filename">var</code> (the usual location of
2666: <code class="filename">${VARBASE}</code>)</span></dt>
2667: <dd><p>Contains files
2668: that may be modified after
2669: installation.</p></dd>
2670: </dl></div>
2671: </div>
1.148 asau 2672: <div class="sect1">
1.90 rillig 2673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2674: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2675: </h2></div></div></div>
1.148 asau 2676: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2677: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2678: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2679: <dd><p>Contains
2680: information about the currently installed
2681: packages.</p></dd>
2682: <dt><span class="term"><code class="filename">games</code></span></dt>
2683: <dd><p>Contains highscore
2684: files.</p></dd>
2685: <dt><span class="term"><code class="filename">log</code></span></dt>
2686: <dd><p>Contains log files.</p></dd>
2687: <dt><span class="term"><code class="filename">run</code></span></dt>
2688: <dd><p>Contains informational files about daemons that are
2689: currently running.</p></dd>
2690: </dl></div>
2691: </div>
2692: </div>
1.148 asau 2693: <div class="chapter">
1.90 rillig 2694: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2695: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2696: <div class="toc">
2697: <p><b>Table of Contents</b></p>
1.210 leot 2698: <dl class="toc">
1.267 rillig 2699: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2700: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2701: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2702: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2703: <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>
2704: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2705: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2706: <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>
2707: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2708: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 2709: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 2710: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.336 nia 2711: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267 rillig 2712: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2713: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2714: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2715: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2716: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 2717: </dl>
2718: </div>
2719: <p>This section contains hints, tips & tricks on special things in
2720: pkgsrc that we didn't find a better place for in the previous chapters, and
2721: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2722: <div class="sect1">
1.75 rillig 2723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2724: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2725: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2726: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2727: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 2728: This is a general purpose list for most issues regarding
2729: pkgsrc, regardless of platform, e.g. soliciting user help
2730: for pkgsrc configuration, unexpected build failures, using
2731: particular packages, upgrading pkgsrc installations,
2732: questions regarding the pkgsrc release branches, etc. General announcements or
2733: proposals for changes that impact the pkgsrc user community,
2734: e.g. major infrastructure changes, new features, package
2735: removals, etc., may also be posted.</p></li>
1.289 leot 2736: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 2737: A list where the results of pkgsrc bulk builds are sent and
2738: discussed.</p></li>
1.289 leot 2739: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 2740: This list is for those who are interested in getting a
2741: commit message for every change committed to pkgsrc. It is
2742: also available in digest form, meaning one daily message
2743: containing all commit messages for changes to the package
2744: source tree in that 24 hour period.</p></li>
2745: </ul></div>
2746: <p>To subscribe, do:</p>
2747: <pre class="programlisting">
1.100 rillig 2748: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2749: </pre>
2750: <p>Archives for all these mailing lists are available from
1.289 leot 2751: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2752: </div>
1.148 asau 2753: <div class="sect1">
1.75 rillig 2754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2755: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2756: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2757: a number of useful utilities for both users and developers of pkgsrc. This
1.233 sevan 2758: section attempts only to make the reader aware of some of the utilities and when
1.75 rillig 2759: they might be useful, and not to duplicate the documentation that comes
2760: with each package.</p>
2761: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.322 leot 2762: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/index.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75 rillig 2763: Symlinks for use by buildlink.</p></li></ul></div>
2764: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2765: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2766: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/index.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233 sevan 2767: Calculates various kinds of checksums (including SHA3).</p></li>
1.322 leot 2768: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/index.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75 rillig 2769: Compatibility library for pkgsrc tools.</p></li>
1.322 leot 2770: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/index.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87 wiz 2771: non-BSD systems due to lack of native mtree.</p></li>
1.322 leot 2772: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75 rillig 2773: Up-to-date replacement for
1.76 rillig 2774: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2775: systems where pkg_install is not present.</p></li>
2776: </ul></div>
2777: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2778: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2779: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75 rillig 2780: Create a binary package from an
1.110 hubertf 2781: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2782: save the old package.</p></li>
1.322 leot 2783: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/index.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75 rillig 2784: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2785: from multiple locations. It currently supports the following
2786: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.322 leot 2787: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117 jnemeth 2788: the best compiler flags to optimise code for your current
1.128 wiz 2789: CPU and compiler. </p></li>
1.75 rillig 2790: </ul></div>
2791: <p>Utilities for keeping track of installed packages, being up to date,
2792: etc:</p>
1.148 asau 2793: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2794: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/index.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173 wiz 2795: update tool similar to apt(1). Download, install, and upgrade
2796: binary packages easily.</p></li>
1.322 leot 2797: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75 rillig 2798: packages whose installed versions do not match the latest pkgsrc
2799: entries.</p></li>
1.322 leot 2800: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75 rillig 2801: dependency graphs of packages, to aid in choosing a strategy for
2802: updating.</p></li>
1.322 leot 2803: <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
2804: 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>
2805: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112 weinem 2806: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.322 leot 2807: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75 rillig 2808: does various checks on the complete pkgsrc system.</p></li>
1.322 leot 2809: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/index.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75 rillig 2810: packages you have installed.</p></li>
2811: </ul></div>
2812: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2813: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2814: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75 rillig 2815: making and maintaining patches for a package (includes pkgdiff,
2816: pkgvi, mkpatches, etc.).</p></li>
1.322 leot 2817: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/index.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75 rillig 2818: converting to pkgsrc.</p></li>
2819: </ul></div>
2820: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2821: utilities)</p>
1.148 asau 2822: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2823: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/index.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75 rillig 2824: packages in a chrooted area.</p></li>
1.322 leot 2825: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/index.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75 rillig 2826: kernel version for chrooted cross builds.</p></li>
2827: </ul></div>
2828: </div>
1.148 asau 2829: <div class="sect1">
1.75 rillig 2830: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2831: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219 rillig 2832: <p>To install packages from source as a non-root user, download
1.267 rillig 2833: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 3. Where to get pkgsrc and how to keep it up-to-date">Chapter 3, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
1.219 rillig 2834: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2835: --unprivileged</strong></span>.</p>
2836: <p>This will install the binary part of pkgsrc to
2837: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2838: into <code class="filename">~/pkg/etc</code>.</p>
2839: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75 rillig 2840: </div>
1.148 asau 2841: <div class="sect1">
1.75 rillig 2842: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2843: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 2844: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2845: enable this feature by adding the option
2846: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 2847: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 2848: distfile is found, pkgsrc will try to resume it.</p>
2849: <p>You can also
1.168 wiz 2850: use a different program than the platform default program by changing the
1.117 jnemeth 2851: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2852: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2853: by using the value manual. A value of custom disables the system defaults
2854: and dependency tracking for the fetch program. In that case you have to
2855: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2856: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2857: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 2858: <p>For example, if you want to use
1.117 jnemeth 2859: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 2860: like:</p>
2861: <pre class="programlisting">
1.223 rillig 2862: FETCH_USING= wget
1.1 grant 2863: </pre>
1.75 rillig 2864: </div>
1.148 asau 2865: <div class="sect1">
1.75 rillig 2866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2867: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103 wiz 2868: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 2869: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 2870: you will have to add the following line into
1.110 hubertf 2871: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 2872: <pre class="programlisting">
1.103 wiz 2873: X11_TYPE=modular
1.1 grant 2874: </pre>
1.75 rillig 2875: </div>
1.148 asau 2876: <div class="sect1">
1.75 rillig 2877: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2878: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 2879: <p>If you are sitting behind a firewall which does not allow direct
2880: connections to Internet hosts (i.e. non-NAT), you may specify the
2881: relevant proxy hosts. This is done using an environment variable in the
2882: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 2883: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 2884: port 80 as the proxy port number. So the proxy environment variables
2885: are:</p>
2886: <pre class="programlisting">
1.100 rillig 2887: ftp_proxy=ftp://orpheus.amdahl.com:80/
2888: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 2889: </pre>
1.75 rillig 2890: </div>
1.148 asau 2891: <div class="sect1">
1.75 rillig 2892: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2893: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 wiz 2894: <p>Some fetch tools are not prepared to support HTTPS by default
2895: (for example, the one in NetBSD 6.0), or the one installed by the
2896: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2897: dependency graph).</p>
2898: <p>Usually you won't notice, because distribution files are
2899: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2900: be often enough if you are following pkgsrc-current. In that case, set
2901: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2902: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2903: with HTTPS support by default. Of course, these tools need to be
2904: installed before you can use them this way.</p>
2905: </div>
2906: <div class="sect1">
2907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2908: <a name="passive-ftp"></a>10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75 rillig 2909: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 2910: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 2911: the first available command from the following list:</p>
1.148 asau 2912: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2913: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2914: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 2915: </ul></div>
2916: <p>On a default NetBSD installation, this will be
1.76 rillig 2917: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 2918: connections first, and falls back to active connections if the server
2919: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 2920: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 2921: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2922: <p>Having that option present will prevent
1.76 rillig 2923: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 2924: transfers.</p>
2925: </div>
1.148 asau 2926: <div class="sect1">
1.75 rillig 2927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2928: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 2929: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 2930: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 2931: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75 rillig 2932: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 2933: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 2934: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 2935: resulting list to your machine at work/school and use it there. If you
1.322 leot 2936: don't have a NetBSD-compatible <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75 rillig 2937: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2938: URL:</p>
2939: <p>At home:</p>
2940: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2941: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2942: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2943: <p>At work:</p>
2944: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 2945: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 2946: home.</p>
2947: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 2948: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2949: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 2950: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 2951: directly by running:</p>
1.75 rillig 2952: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2953: <p>If you even decide to ignore
2954: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2955: by running:</p>
2956: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2957: </div>
1.148 asau 2958: <div class="sect1">
1.75 rillig 2959: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2960: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 2961: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.322 leot 2962: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75 rillig 2963: package, you get the error from make that it doesn't know how to make
1.76 rillig 2964: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 2965: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 2966: the NetBSD base distribution on your machine. It is recommended to do
2967: that to format man pages.</p>
1.322 leot 2968: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75 rillig 2969: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 2970: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 2971: </div>
1.148 asau 2972: <div class="sect1">
1.75 rillig 2973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2974: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.87 wiz 2975: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 2976: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 2977: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 2978: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2979: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 2980: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 2981: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 2982: -r</strong></span>).</p>
2983: </div>
1.148 asau 2984: <div class="sect1">
1.75 rillig 2985: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.336 nia 2986: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.75 rillig 2987: <p>When installing packages as non-root user and using the just-in-time
1.322 leot 2988: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75 rillig 2989: password for each required package installed. To avoid this, the sudo
2990: package can be used, which does password caching over a limited time. To
1.336 nia 2991: use it, install <span class="command"><strong>sudo</strong></span> or
2992: <span class="command"><strong>priv</strong></span> (either as binary package, from
2993: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/priv/index.html" target="_top"><code class="filename">security/priv</code></a>, or
1.322 leot 2994: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/index.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110 hubertf 2995: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 2996: <span class="emphasis"><em>after</em></span> the definition of the
2997: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 2998: <pre class="programlisting">
1.100 rillig 2999: .if exists(${LOCALBASE}/bin/sudo)
3000: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3001: .endif
1.1 grant 3002: </pre>
1.75 rillig 3003: </div>
1.148 asau 3004: <div class="sect1">
1.75 rillig 3005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3006: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3007: <p>As the system administrator, you can choose where configuration files
3008: are installed. The default settings make all these files go into
1.76 rillig 3009: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3010: be suboptimal depending on your expectations (e.g., a read-only,
3011: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3012: configuration of the provided packages).</p>
3013: <p>In order to change the defaults, you can modify the
3014: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3015: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3016: directory; some common examples include <code class="filename">/etc</code> or
3017: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3018: <p>Furthermore, you can change this value on a per-package basis by
3019: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3020: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3021: package you would like to modify, that is, the contents of
3022: <code class="varname">PKGBASE</code>.</p>
3023: <p>Note that after changing these settings, you must rebuild and
3024: reinstall any affected packages.</p>
3025: </div>
1.148 asau 3026: <div class="sect1">
1.75 rillig 3027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3028: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75 rillig 3029: <p>Please be aware that there can often be bugs in third-party software,
3030: and some of these bugs can leave a machine vulnerable to exploitation by
3031: attackers. In an effort to lessen the exposure, the NetBSD packages team
3032: maintains a database of known-exploits to packages which have at one time
3033: been included in pkgsrc. The database can be downloaded automatically, and
3034: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3035: do this, refer to the following two tools (installed as part of the
1.322 leot 3036: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128 wiz 3037: <div class="orderedlist"><ol class="orderedlist" type="1">
3038: <li class="listitem">
1.122 reed 3039: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3040: download a list of the security vulnerabilities information. This list
1.132 spz 3041: is kept up to date by the pkgsrc security team, and is distributed
3042: from the NetBSD ftp server:</p>
1.292 leot 3043: <p><a class="ulink" href="https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a></p>
1.75 rillig 3044: </li>
1.128 wiz 3045: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3046: current machine, checking each known vulnerability. If a
1.75 rillig 3047: vulnerable package is installed, it will be shown by output to stdout,
3048: including a description of the type of vulnerability, and a URL
3049: containing more information.</p></li>
3050: </ol></div>
1.233 sevan 3051: <p>Use of these tools is strongly recommended!
1.317 nia 3052: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, “Checking for security vulnerabilities in installed packages”</a> for instructions on how to automate checking and
1.233 sevan 3053: reporting.</p>
3054: <p>If this database is installed, pkgsrc builds will use it to
3055: perform a security check before building any package.</p>
1.75 rillig 3056: </div>
1.148 asau 3057: <div class="sect1">
1.75 rillig 3058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3059: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 3060: <p>When you add your own preferences to the
3061: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3062: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3063: environment variables to the <code class="filename">./configure</code>
1.322 leot 3064: scripts and to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75 rillig 3065: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3066: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3067: package.</p>
3068: <p>Currently there is no solution to this problem. If you
3069: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3070: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3071: directory and then inspect any <code class="filename">Makefile</code> and
3072: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3073: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3074: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3075: programmers write so bad code that it only works for the
3076: specific combination of <code class="varname">CFLAGS</code> they have
3077: chosen.</p>
1.287 rillig 3078: <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>
3079: <pre class="programlisting">
3080: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3081: CFLAGS+= -Dpkgsrc___CFLAGS
3082: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3083: </pre>
3084: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3085: to see whether the above flags are passed to the actual build
3086: commands in general.</p>
3087: <p>To find out whether the flags are passed to individual compiler
3088: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3089: most cases, the flags from the original command lines (the lines starting
3090: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3091: (the lines starting with <code class="literal"><.></code>). If the flag is
3092: missing from the actual compiler command, it must have been removed by
1.299 rillig 3093: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75 rillig 3094: </div>
1.148 asau 3095: <div class="sect1">
1.80 rillig 3096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3097: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3098: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3099: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3100: case that occurs often is that people only update pkgsrc in
3101: parts, because of performance reasons. Since pkgsrc is one large
3102: system, not a collection of many small systems, there are
3103: sometimes changes that only work when the whole pkgsrc tree is
3104: updated.</p></li>
1.148 asau 3105: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3106: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3107: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3108: files.</p></li>
1.148 asau 3109: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3110: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3111: verify this.</p></li>
1.218 rillig 3112: <li class="step"><p>If you are a package developer who wants to invest
1.267 rillig 3113: some work, have a look at <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.148 asau 3114: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3115: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3116: </ol></div>
3117: </div>
1.148 asau 3118: <div class="sect1">
1.88 wiz 3119: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3120: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.89 rillig 3121: <p>You have modified a file from pkgsrc, and someone else has
3122: modified that same file afterwards in the CVS repository. Both changes
3123: are in the same region of the file, so when you updated pkgsrc, the
3124: <code class="literal">cvs</code> command marked the conflicting changes in the
3125: file. Because of these markers, the file is no longer a valid
3126: <code class="filename">Makefile</code>.</p>
3127: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3128: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3129: -dP</strong></span> in that directory to download the current version.</p>
3130: </div>
1.75 rillig 3131: </div>
3132: </div>
1.148 asau 3133: <div class="part">
1.75 rillig 3134: <div class="titlepage"><div><div><h1 class="title">
3135: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3136: <div class="partintro">
1.77 rillig 3137: <div></div>
3138: <p>This part of the book deals with creating and
1.128 wiz 3139: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3140: guide on creating a new package. The remaining chapters are more
3141: like a reference manual for pkgsrc.</p>
1.75 rillig 3142: <div class="toc">
3143: <p><b>Table of Contents</b></p>
1.210 leot 3144: <dl class="toc">
1.267 rillig 3145: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299 rillig 3146: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91 rillig 3147: <dd><dl>
1.299 rillig 3148: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3149: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3150: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91 rillig 3151: <dd><dl>
1.299 rillig 3152: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3153: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3154: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3155: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3156: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91 rillig 3157: </dl></dd>
1.299 rillig 3158: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3159: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3160: <dd><dl>
3161: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3162: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3163: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3164: </dl></dd>
3165: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3166: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3167: </dl></dd>
1.299 rillig 3168: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106 rillig 3169: <dd><dl>
1.299 rillig 3170: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3171: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3172: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3173: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3174: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 3175: <dd><dl>
1.299 rillig 3176: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3177: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106 rillig 3178: </dl></dd>
1.299 rillig 3179: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3180: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3181: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3182: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3183: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3184: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3185: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3186: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3187: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3188: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3189: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3190: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3191: </dl></dd>
3192: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3193: <dd><dl>
3194: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106 rillig 3195: <dd><dl>
1.334 nia 3196: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
3197: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
3198: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106 rillig 3199: </dl></dd>
1.299 rillig 3200: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3201: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106 rillig 3202: </dl></dd>
1.299 rillig 3203: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3204: <dd><dl>
1.299 rillig 3205: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3206: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3207: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3208: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106 rillig 3209: <dd><dl>
1.299 rillig 3210: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3211: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3212: <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>
3213: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344 gutterid 3214: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.106 rillig 3215: </dl></dd>
3216: </dl></dd>
1.299 rillig 3217: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106 rillig 3218: <dd><dl>
1.299 rillig 3219: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3220: <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>
3221: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3222: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3223: </dl></dd>
1.299 rillig 3224: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106 rillig 3225: <dd><dl>
1.299 rillig 3226: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3227: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3228: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3229: </dl></dd>
3230: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3231: <dd><dl>
3232: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3233: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3234: <dd><dl>
1.299 rillig 3235: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3236: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133 wiz 3237: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3238: and
3239: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3240: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3241: </dl></dd>
1.299 rillig 3242: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3243: <dd><dl>
3244: <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>
3245: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3246: </dl></dd>
3247: </dl></dd>
3248: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106 rillig 3249: <dd><dl>
1.299 rillig 3250: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3251: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3252: <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>
3253: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3254: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3255: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3256: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3257: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3258: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106 rillig 3259: </dl></dd>
1.299 rillig 3260: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3261: <dd><dl>
3262: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3263: <dd><dl>
3264: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3265: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106 rillig 3266: </dl></dd>
1.299 rillig 3267: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106 rillig 3268: <dd><dl>
1.299 rillig 3269: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3270: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
3271: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
3272: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
3273: </dl></dd>
3274: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3275: <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>
3276: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3277: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3278: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3279: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3280: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.267 rillig 3281: </dl></dd>
3282: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3283: <dd><dl>
3284: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3285: <dd><dl>
3286: <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>
3287: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3288: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3289: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3290: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3291: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3292: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3293: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3294: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3295: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3296: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3297: </dl></dd>
3298: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3299: <dd><dl>
3300: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3301: <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>
3302: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3303: </dl></dd>
3304: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3305: <dd><dl>
3306: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3307: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3308: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338 nia 3309: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.267 rillig 3310: </dl></dd>
3311: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3312: <dd><dl>
3313: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3314: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 3315: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338 nia 3316: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
3317: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
3318: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
3319: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267 rillig 3320: </dl></dd>
3321: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3322: <dd><dl>
3323: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3324: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 3325: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3326: <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>
3327: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 3328: </dl></dd>
3329: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3330: <dd><dl>
3331: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3332: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3333: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3334: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3335: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 3336: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 3337: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
3338: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 3339: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
3340: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
3341: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
3342: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
3343: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
3344: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
3345: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 3346: emulation</a></span></dt>
1.318 nia 3347: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
3348: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.77 rillig 3349: </dl></dd>
1.267 rillig 3350: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3351: </dl></dd>
1.299 rillig 3352: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3353: <dd><dl>
3354: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3355: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3356: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3357: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3358: </dl></dd>
1.267 rillig 3359: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 3360: <dd><dl>
1.267 rillig 3361: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3362: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3363: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3364: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3365: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3366: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3367: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3368: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3369: </dl></dd>
3370: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75 rillig 3371: </dl>
3372: </div>
1.77 rillig 3373: </div>
1.148 asau 3374: <div class="chapter">
1.77 rillig 3375: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 3376: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3377: <p>
3378: To get help when developing pkgsrc, the definitive source is this
3379: document, the pkgsrc guide. If you don't find anything here,
3380: there are alternatives:
3381: </p>
3382: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3383: <li class="listitem">
3384: <p>
3385: The built-in pkgsrc help, which is available after bootstrapping
3386: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3387: help for any topic, such as a variable name like
3388: <code class="varname">BUILD_DEFS</code>, a make target like
3389: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3390: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322 leot 3391: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.267 rillig 3392: </li>
3393: <li class="listitem"><p>
1.278 rillig 3394: To see the value of a single variable, run <span class="command"><strong>bmake
3395: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3396: </p></li>
3397: <li class="listitem"><p>
3398: To see the values of the most common variables, run
3399: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3400: topic. To see the variables for a single topic, run
3401: <span class="command"><strong>bmake
3402: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3403: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3404: </p></li>
3405: <li class="listitem"><p>
1.267 rillig 3406: The tech-pkg mailing list, to which
3407: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3408: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3409: questions</a>.</p></li>
3410: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3411: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3412: or by using a specialized chat program such as
3413: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3414: Pick any user name and join the channel #pkgsrc.</p></li>
3415: </ul></div>
3416: </div>
3417: <div class="chapter">
3418: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 3419: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91 rillig 3420: <div class="toc">
3421: <p><b>Table of Contents</b></p>
1.210 leot 3422: <dl class="toc">
1.299 rillig 3423: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3424: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3425: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3426: <dd><dl>
3427: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3428: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3429: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3430: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3431: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3432: </dl></dd>
3433: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3434: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3435: <dd><dl>
3436: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3437: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3438: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91 rillig 3439: </dl></dd>
1.299 rillig 3440: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3441: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91 rillig 3442: </dl>
3443: </div>
1.299 rillig 3444: <p>Whenever you're preparing a package, there are a number of
3445: files involved which are described in the following
3446: sections.</p>
3447: <div class="sect1">
3448: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3449: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3450: </h2></div></div></div>
3451: <p>Building, installation and creation of a binary package are all
3452: controlled by the package's <code class="filename">Makefile</code>.
3453: The <code class="filename">Makefile</code> describes various things about
3454: a package, for example from where to get it, how to configure,
3455: build, and install it.</p>
3456: <p>A package <code class="filename">Makefile</code> contains several
3457: sections that describe the package.</p>
3458: <p>In the first section there are the following variables, which
3459: should appear exactly in the order given here. The order and
3460: grouping of the variables is mostly historical and has no further
3461: meaning.</p>
3462: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3463: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3464: distribution file to be downloaded from the package's
3465: website.</p></li>
3466: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3467: package, as used by pkgsrc. You need to provide it if
3468: <code class="varname">DISTNAME</code> (which is the default) is not a good
3469: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3470: provided (no distribution file is required). Usually it is the pkgsrc
3471: directory name together with the version number. It must match the
3472: regular expression
3473: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3474: starts with a letter or digit, and contains only letters, digits,
1.319 nia 3475: dashes, underscores, dots and plus signs.
3476: New packages should have entirely lower-case names, with the exception
3477: of some that must follow pre-existing conventions
3478: (e.g. R packages begin with <code class="varname">R-</code>).
3479: You can use the <code class="code">:tl</code> variable modifier to lower-case
3480: the package name.</p></li>
1.299 rillig 3481: <li class="listitem">
3482: <p><code class="varname">CATEGORIES</code> is a list of categories
3483: which the package fits in. You can choose any of the top-level
3484: directories of pkgsrc for it.</p>
3485: <p>Currently the following values are available for
3486: <code class="varname">CATEGORIES</code>. If more than
3487: one is used, they need to be separated by spaces:</p>
1.77 rillig 3488: <pre class="programlisting">
1.299 rillig 3489: archivers cross geography meta-pkgs security
3490: audio databases graphics misc shells
3491: benchmarks devel ham multimedia sysutils
3492: biology editors inputmethod net textproc
3493: cad emulators lang news time
3494: chat finance mail parallel wm
3495: comms fonts math pkgtools www
3496: converters games mbone print x11
1.77 rillig 3497: </pre>
3498: </li>
1.299 rillig 3499: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3500: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3501: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3502: and <code class="varname">DISTFILES</code> are discussed in detail in
3503: <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>
3504: </ul></div>
3505: <p>The second section contains information about separately
3506: downloaded patches, if any.
3507: </p>
3508: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3509: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3510: Name(s) of additional files that contain distribution patches.
3511: There is no default. pkgsrc will look for them at
3512: <code class="varname">PATCH_SITES</code>.
3513: They will automatically be uncompressed before patching if
3514: the names end with <code class="filename">.gz</code> or
3515: <code class="filename">.Z</code>.</p></li>
3516: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3517: Primary location(s) for distribution patch files (see
3518: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3519: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.322 leot 3520: an argument to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.299 rillig 3521: help find the correct files to patch. It defaults to
3522: <span class="command"><strong>-p0</strong></span>.</p></li>
3523: </ul></div>
3524: <p>The third section contains the following variables.
3525: </p>
3526: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3527: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
3528: address of the person who feels responsible for this package,
3529: and who is most likely to look at problems or questions regarding
1.322 leot 3530: this package which have been reported with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.299 rillig 3531: Other developers may contact the <code class="varname">MAINTAINER</code>
3532: before making changes to the package, but are not required to
3533: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3534: to yourself. If you really can't maintain the package for future
3535: updates, set it to
3536: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
3537: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
3538: of <code class="varname">MAINTAINER</code> when you do not want other
3539: developers to update or change the package without contacting
3540: you first. A package Makefile should contain one of
3541: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3542: not both. </p></li>
3543: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3544: find more information about the package.</p></li>
3545: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3546: description of the package (should not include the package
3547: name).</p></li>
3548: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3549: 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>
3550: </ul></div>
3551: <p>Other variables that affect the build:
3552: </p>
3553: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3554: <p><code class="varname">WRKSRC</code>: The directory where the
3555: interesting distribution files of the package are found. The
3556: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3557: works for most packages.</p>
3558: <p>If a package doesn't create a subdirectory for itself
3559: (most GNU software does, for instance), but extracts itself in
3560: the current directory, you should set
3561: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3562: <p>If a package doesn't create a subdirectory with the
3563: name of <code class="varname">DISTNAME</code> but some different name,
3564: set <code class="varname">WRKSRC</code> to point to the proper name in
3565: <code class="filename">${WRKDIR}</code>, for example
3566: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.322 leot 3567: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/index.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/index.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.299 rillig 3568: <p>The name of the working directory created by pkgsrc is
3569: taken from the <code class="varname">WRKDIR_BASENAME</code>
3570: variable. By default, its value is
3571: <code class="filename">work</code>. If you want to use the same
3572: pkgsrc tree for building different kinds of binary packages,
3573: you can change the variable according to your needs. Two
3574: other variables handle common cases of setting
3575: <code class="varname">WRKDIR_BASENAME</code> individually. If
3576: <code class="varname">OBJHOSTNAME</code> is defined in
3577: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3578: the host's name is attached to the directory name. If
3579: <code class="varname">OBJMACHINE</code> is defined, the platform name
3580: is attached, which might look like
3581: <code class="filename">work.i386</code> or
3582: <code class="filename">work.sparc</code>.</p>
3583: </li></ul></div>
3584: <p>Please pay attention to the following gotchas:</p>
3585: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3586: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3587: installed in compressed form by the package. For packages using
3588: BSD-style makefiles which honor MANZ, there is
3589: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3590: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3591: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3592: below).</p></li>
3593: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.7. Packages installing info files">Section 21.6.7, “Packages installing info files”</a>.</p></li>
3594: </ul></div>
3595: </div>
1.148 asau 3596: <div class="sect1">
1.91 rillig 3597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 3598: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3599: </h2></div></div></div>
3600: <p>The <code class="filename">distinfo</code> file contains the message
3601: digest, or checksum, of each distfile needed for the package. This
3602: ensures that the distfiles retrieved from the Internet have not been
3603: corrupted during transfer or altered by a malign force to introduce
3604: a security hole. To provide maximum security, all distfiles are
3605: protected using three different message digest algorithms (SHA1,
3606: RMD160, SHA512), as well as the file size.</p>
3607: <p>The <code class="filename">distinfo</code> file also contains the
3608: checksums for all the patches found in the
3609: <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
3610: are only applied intentionally and that they don't accidentally change,
3611: e.g. when merging different changes together. They also make sure that
3612: new patches are actually added to CVS and old ones are removed.
3613: Too see whether the patches and the <code class="filename">distinfo</code> file
3614: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3615: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3616: <span class="command"><strong>make distinfo</strong></span> command.</p>
3617: <p>Some packages have different sets of distfiles depending on
1.322 leot 3618: the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk8/index.html" target="_top"><code class="filename">lang/openjdk8</code></a>. These are kept in the same
1.299 rillig 3619: <code class="filename">distinfo</code> file and care should be taken when
3620: upgrading such a package to ensure distfile information is not
3621: lost.</p>
3622: </div>
3623: <div class="sect1">
3624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3625: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3626: </h2></div></div></div>
3627: <p>Some packages don't work out-of-the box on the various
3628: platforms that are supported by pkgsrc. These packages need
3629: to be patched to make them work. The patch files can be
3630: found in the <code class="filename">patches/</code> directory.</p>
3631: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3632: applied to the files in <code class="varname">WRKSRC</code> directory after
3633: extracting them, in alphabetic order.</p>
1.148 asau 3634: <div class="sect2">
1.91 rillig 3635: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3636: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3637: <p>The <code class="filename">patch-*</code> files should be in
3638: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3639: problems. (To force patches to apply with fuzz you can set
3640: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3641: should contain only changes for a single file, and no file should be
3642: patched by more than one patch file. This helps to keep future
3643: modifications simple.</p>
3644: <p>Each patch file is structured as follows: In the first line,
3645: there is the RCS Id of the patch itself. The second line should be
3646: empty for aesthetic reasons. After that, there should be a comment for
3647: each change that the patch does. There are a number of standard
3648: cases:</p>
3649: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3650: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3651: mention the vulnerability ID (CAN, CVE).</p></li>
3652: <li class="listitem"><p>Patches that change source code should mention the
3653: platform and other environment (for example, the compiler) that the
3654: patch is needed for.</p></li>
3655: </ul></div>
3656: <p>The patch should be commented so that any
3657: developer who knows the code of the application can make some use of
3658: the patch. Special care should be taken for the upstream developers,
3659: since we generally want that they accept our patches, so we have less
3660: work in the future.</p>
1.91 rillig 3661: </div>
1.148 asau 3662: <div class="sect2">
1.91 rillig 3663: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3664: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3665: <p>One important thing to mention is to pay attention that no RCS
3666: IDs get stored in the patch files, as these will cause problems when
3667: later checked into the NetBSD CVS tree. Use the
1.322 leot 3668: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.299 rillig 3669: problems.</p>
3670: <p>For even more automation, we recommend using
3671: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.337 gutterid 3672: whole set of patches. You just have to back up files before you
3673: edit them to <code class="filename">filename.orig</code>, e.g., with
1.299 rillig 3674: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3675: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3676: you upgrade a package this way, you can easily compare the new
3677: set of patches with the previously existing one with
3678: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3679: are replaced by new files, so carefully check if you want to take all
3680: the changes.</p>
3681: <p>When you have finished a package, remember to generate
3682: the checksums for the patch files by using the <span class="command"><strong>make
3683: 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>
3684: <p>When adding a patch that corrects a problem in the
3685: distfile (rather than e.g. enforcing pkgsrc's view of where
3686: man pages should go), send the patch as a bug report to the
3687: maintainer. This benefits non-pkgsrc users of the package,
3688: and usually makes it possible to remove the patch in future
3689: version.</p>
3690: <p>The file names of the patch files are usually of the form
3691: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3692: Many packages still use the previous convention
3693: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3694: but new patches should be of the form containing the filename.
1.322 leot 3695: <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.299 rillig 3696: automatically.</p>
1.337 gutterid 3697: <p>When updating pre-existing patch files, if a file uses the old
3698: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
3699: convention, it's best not to change it to the new form, as that will
3700: just cause churn that makes it harder to track changes to patching
3701: over time. Similarly, if a patch now applies at different line offsets,
3702: but still applies cleanly as-is, there's no need to update it, as that
3703: also unnecessarily complicates the patch history.</p>
1.118 imil 3704: </div>
1.275 brook 3705: <div class="sect2">
3706: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3707: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3708: <p>If you want to share patches between multiple packages
3709: in pkgsrc, e.g. because they use the same distfiles, set
3710: <code class="varname">PATCHDIR</code> to the path where the patch files
3711: can be found, e.g.:</p>
3712: <pre class="programlisting">
3713: PATCHDIR= ../../editors/xemacs/patches
3714: </pre>
3715: <p>Patch files that are distributed by the author or other
3716: maintainers can be listed in
3717: <code class="varname">PATCHFILES</code>.</p>
3718: <p>If it is desired to store any patches that should not be
3719: committed into pkgsrc, they can be kept outside the pkgsrc
3720: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3721: directory tree there is expected to have the same
3722: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3723: patches are expected to be stored inside these dirs (also
3724: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3725: example, if you want to keep a private patch for
3726: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3727: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3728: files in the named directory are expected to be patch files,
3729: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3730: applied</em></span>.</p>
1.275 brook 3731: </div>
3732: <div class="sect2">
3733: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3734: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3735: <p>When fixing a portability issue in the code do not use
3736: preprocessor magic to check for the current operating system nor
3737: platform. Doing so hurts portability to other platforms because
3738: the OS-specific details are not abstracted appropriately.</p>
3739: <p>The general rule to follow is: instead of checking for the
3740: operating system the application is being built on, check for the
3741: specific <span class="emphasis"><em>features</em></span> you need. For example,
3742: instead of assuming that kqueue is available under NetBSD and
3743: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3744: kqueue support, add a check that detects kqueue itself —
3745: yes, this generally involves patching the
3746: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3747: that prevents some OSes from adopting interfaces from other OSes
3748: (e.g. Linux implementing kqueue), something that the above checks
3749: cannot take into account.</p>
3750: <p>Of course, checking for features generally involves more
3751: work on the developer's side, but the resulting changes are
3752: cleaner and there are chances they will work on many other
3753: platforms. Not to mention that there are higher chances of being
3754: later integrated into the mainstream sources. Remember:
3755: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3756: <p>Some typical examples:</p>
3757: <div class="table">
3758: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3759: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3760: <colgroup>
3761: <col>
3762: <col>
3763: <col>
3764: </colgroup>
3765: <thead><tr>
3766: <th>Where</th>
3767: <th>Incorrect</th>
3768: <th>Correct</th>
3769: </tr></thead>
3770: <tbody>
3771: <tr>
3772: <td>configure script</td>
3773: <td>
1.275 brook 3774: <pre class="programlisting">
1.299 rillig 3775: case ${target_os} in
3776: netbsd*) have_kvm=yes ;;
3777: *) have_kvm=no ;;
3778: esac
1.275 brook 3779: </pre>
1.299 rillig 3780: </td>
3781: <td>
1.275 brook 3782: <pre class="programlisting">
1.299 rillig 3783: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275 brook 3784: </pre>
1.299 rillig 3785: </td>
3786: </tr>
3787: <tr>
3788: <td>C source file</td>
3789: <td>
1.91 rillig 3790: <pre class="programlisting">
1.299 rillig 3791: #if defined(__NetBSD__)
3792: # include <sys/event.h>
3793: #endif
1.91 rillig 3794: </pre>
1.299 rillig 3795: </td>
3796: <td>
1.91 rillig 3797: <pre class="programlisting">
1.299 rillig 3798: #if defined(HAVE_SYS_EVENT_H)
3799: # include <sys/event.h>
3800: #endif
1.91 rillig 3801: </pre>
1.299 rillig 3802: </td>
3803: </tr>
3804: <tr>
3805: <td>C source file</td>
3806: <td>
1.91 rillig 3807: <pre class="programlisting">
1.299 rillig 3808: int
3809: monitor_file(...)
3810: {
3811: #if defined(__NetBSD__)
3812: int fd = kqueue();
3813: ...
3814: #else
3815: ...
3816: #endif
3817: }
1.91 rillig 3818: </pre>
1.299 rillig 3819: </td>
3820: <td>
1.91 rillig 3821: <pre class="programlisting">
1.299 rillig 3822: int
3823: monitor_file(...)
3824: {
3825: #if defined(HAVE_KQUEUE)
3826: int fd = kqueue();
3827: ...
3828: #else
3829: ...
3830: #endif
3831: }
1.91 rillig 3832: </pre>
1.299 rillig 3833: </td>
3834: </tr>
3835: </tbody>
3836: </table></div>
3837: </div>
3838: <br class="table-break">
3839: </div>
3840: <div class="sect2">
3841: <div class="titlepage"><div><div><h3 class="title">
3842: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3843: <p>Always, always, <span class="strong"><strong>always</strong></span>
3844: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3845: improvements you do to a package to the mainstream developers.
3846: This is the only way to get their attention on portability issues
3847: and to ensure that future versions can be built out-of-the box on
3848: NetBSD. Furthermore, any user that gets newer distfiles will get
3849: the fixes straight from the packaged code.</p>
3850: <p>This generally involves cleaning up the patches
3851: (because sometimes the patches that are
3852: added to pkgsrc are quick hacks), filing bug reports in the
3853: appropriate trackers for the projects and working with the
3854: mainstream authors to accept your changes. It is
3855: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3856: the packages in pkgsrc are kept simple and thus further changes
3857: can be done without much hassle.</p>
3858: <p>When you have done this, please add a URL to the upstream
3859: bug report to the patch comment.</p>
3860: <p>Support the idea of free software!</p>
3861: </div>
1.91 rillig 3862: </div>
1.299 rillig 3863: <div class="sect1">
3864: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3865: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3866: <div class="variablelist"><dl class="variablelist">
3867: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3868: <dd><p>A multi-line description of the piece of software. This should include
3869: any credits where they are due. Please bear in mind that others do not
3870: share your sense of humour (or spelling idiosyncrasies), and that others
3871: will read everything that you write here.</p></dd>
3872: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3873: <dd><p>This file governs the files that are installed on your
3874: system: all the binaries, manual pages, etc. There are other
3875: directives which may be entered in this file, to control the
3876: creation and deletion of directories, and the location of
3877: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3878: information.</p></dd>
3879: </dl></div>
3880: </div>
3881: <div class="sect1">
3882: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3883: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3884: <div class="sect2">
3885: <div class="titlepage"><div><div><h3 class="title">
3886: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3887: <div class="variablelist"><dl class="variablelist">
3888: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3889: <dd>
1.322 leot 3890: <p>This shell script is invoked twice by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.299 rillig 3891: First time after package extraction and before files are
3892: moved in place, the second time after the files to install
3893: are moved in place. This can be used to do any custom
3894: procedures not possible with @exec commands in
1.322 leot 3895: <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
3896: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information. See also <a class="xref" href="#files-and-dirs-outside-prefix" title="20.1. Files and directories outside the installation prefix">Section 20.1, “Files and directories outside the installation prefix”</a>.
1.299 rillig 3897: Please note that you can modify variables in it easily by using
3898: <code class="varname">FILES_SUBST</code> in the package's
3899: <code class="filename">Makefile</code>:</p>
1.91 rillig 3900: <pre class="programlisting">
1.299 rillig 3901: FILES_SUBST+= SOMEVAR="somevalue"
1.91 rillig 3902: </pre>
1.299 rillig 3903: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3904: <code class="filename">INSTALL</code>. By default, substitution is
3905: performed for <code class="varname">PREFIX</code>,
3906: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3907: <code class="varname">VARBASE</code>, and a few others, type
3908: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3909: complete list.</p>
3910: </dd>
3911: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3912: <dd><p>This script is executed before and after any files are removed. It is
3913: this script's responsibility to clean up any additional messy details
3914: around the package's installation, since all pkg_delete knows is how to
3915: delete the files created in the original distribution.
1.322 leot 3916: See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
3917: and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.299 rillig 3918: The same methods to replace variables can be used as for
3919: the <code class="filename">INSTALL</code> file.</p></dd>
3920: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3921: <dd>
3922: <p>This file is displayed after installation of the package.
1.312 gdt 3923: While this was used often in the past, it has two
3924: problems: the display will be missed if many packages are
3925: intalled at once, and the person installing the package
3926: and the one using or configuring it may be different. It
3927: should therefore be used only in exceptional circumstances
3928: where lasting negative consequences would result from
3929: someone not reading it.</p>
3930: <p>MESSAGE should not be used for:</p>
3931: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3932: <li class="listitem"><p>exhortations to read the documentation</p></li>
3933: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
3934: <li class="listitem"><p>anything that should be explained in the
3935: installation/configuration documentation that should
3936: come with the package</p></li>
3937: </ul></div>
3938: <p>If the documentation provided by upstream needs
1.313 leot 3939: enhancing, create e.g. files/README.pkgsrc and install it
3940: in the package's documentation directory.
1.312 gdt 3941: </p>
3942: <p>Note that MESSAGE is shown for all operating
3943: systems and all init systems. If a MESSAGE is necessary,
1.313 leot 3944: it should be narrowed to only those operating systems and
1.312 gdt 3945: init systems to which it applies.</p>
3946: <p>Note that you can modify variables in it easily by using
1.299 rillig 3947: <code class="varname">MESSAGE_SUBST</code> in the package's
3948: <code class="filename">Makefile</code>:</p>
1.91 rillig 3949: <pre class="programlisting">
1.299 rillig 3950: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.91 rillig 3951: </pre>
1.299 rillig 3952: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
3953: <code class="filename">MESSAGE</code>. By default, substitution is
3954: performed for <code class="varname">PKGNAME</code>,
3955: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
3956: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3957: <code class="varname">PKG_SYSCONFDIR</code>,
3958: <code class="varname">ROOT_GROUP</code>, and
3959: <code class="varname">ROOT_USER</code>.</p>
3960: <p>You can display a different or additional files by
3961: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3962: default is <code class="filename">MESSAGE</code>, if the file
3963: exists.</p>
3964: </dd>
3965: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
3966: <dd>
3967: <p>This file is used by the alternatives framework.
3968: It creates, configures, and destroys generic wrappers used to
3969: run programs with similar interfaces.
3970: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3971: for more information.</p>
3972: <p>Each line of the file contains two filenames, first
3973: the wrapper and then the alternative provided by the package.
3974: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3975: </dd>
3976: </dl></div>
3977: </div>
3978: <div class="sect2">
3979: <div class="titlepage"><div><div><h3 class="title">
3980: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
3981: <div class="variablelist"><dl class="variablelist">
3982: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3983: <dd><p>This file contains arbitrary things that could
3984: also go into a <code class="filename">Makefile</code>, but its purpose is
3985: to be used by more than one package. This file should only be
3986: used when the packages that will use the file are known in
3987: advance. For other purposes it is often better to write a
3988: <code class="filename">*.mk</code> file and give it a good name that
3989: describes what it does.</p></dd>
3990: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3991: <dd><p>This file contains the dependency information
3992: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
3993: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3994: <dd><p>This file contains workarounds for compiler bugs
3995: and similar things. It is included automatically by the pkgsrc
3996: infrastructure, so you don't need an extra
3997: <code class="literal">.include</code> line for
3998: it.</p></dd>
3999: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4000: <dd><p>This file contains the code for the
4001: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
4002: selected by the user. If a package has only one or two options,
4003: it is equally acceptable to put the code directly into the
4004: <code class="filename">Makefile</code>.</p></dd>
4005: </dl></div>
4006: </div>
4007: <div class="sect2">
4008: <div class="titlepage"><div><div><h3 class="title">
4009: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
4010: <div class="variablelist"><dl class="variablelist">
4011: <dt><span class="term"><code class="filename">README*</code></span></dt>
4012: <dd><p>These files do not take place in the creation of
4013: a package and thus are purely informative to the package
4014: developer.</p></dd>
4015: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4016: <dd><p>This file contains things that need to be done
4017: to make the package even
4018: better.</p></dd>
4019: </dl></div>
4020: </div>
4021: </div>
4022: <div class="sect1">
4023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4024: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
4025: </h2></div></div></div>
4026: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4027: unpacked into the directory denoted by
4028: <code class="varname">WRKDIR</code>. It can be removed by running
4029: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4030: directory is also used to keep various timestamp files.
4031: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4032: The default is <code class="filename">${.CURDIR}/work</code>
4033: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4034: if <code class="varname">OBJMACHINE</code> is set.</p>
1.91 rillig 4035: </div>
1.299 rillig 4036: <div class="sect1">
4037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4038: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
4039: </h2></div></div></div>
4040: <p>If you have any files that you wish to be placed in the package
4041: prior to configuration or building, you can place these files here
4042: and use a <span class="command"><strong>${CP}</strong></span> command in the
4043: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4044: <p>If you want to share files in this way with other
4045: packages, set the <code class="varname">FILESDIR</code> variable to point
4046: to the other package's <code class="filename">files</code> directory,
4047: e.g.:</p>
1.91 rillig 4048: <pre class="programlisting">
1.299 rillig 4049: FILESDIR= ../../editors/xemacs/files
1.91 rillig 4050: </pre>
4051: </div>
4052: </div>
1.148 asau 4053: <div class="chapter">
1.75 rillig 4054: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 4055: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75 rillig 4056: <div class="toc">
4057: <p><b>Table of Contents</b></p>
1.210 leot 4058: <dl class="toc">
1.299 rillig 4059: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4060: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4061: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4062: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4063: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4064: <dd><dl>
4065: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4066: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4067: </dl></dd>
4068: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4069: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4070: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4071: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4072: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4073: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4074: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4075: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4076: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4077: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4078: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4079: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75 rillig 4080: </dl>
4081: </div>
1.148 asau 4082: <div class="sect1">
1.75 rillig 4083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4084: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4085: <p>This chapter gives a detailed description on how a package is
4086: built. Building a package is separated into different
4087: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4088: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4089: described in the following sections. Each phase is split into
4090: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4091: containing phase, prefixed by one of <code class="varname">pre-</code>,
4092: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4093: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4094: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4095: <p>Never override the regular targets (like
4096: <code class="varname">fetch</code>), if you have to, override the
4097: <code class="varname">do-*</code> ones instead.</p>
4098: <p>The basic steps for building a program are always the same. First
4099: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4100: the local system and then extracted. After any pkgsrc-specific patches
4101: to compile properly are applied, the software can be configured, then
4102: built (usually by compiling), and finally the generated binaries, etc.
4103: can be put into place on the system.</p>
4104: <p>To get more details about what is happening at each step,
4105: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4106: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4107: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4108: </div>
4109: <div class="sect1">
4110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4111: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4112: <p>Before outlining the process performed by the NetBSD package system in
4113: the next section, here's a brief discussion on where programs are
4114: installed, and which variables influence this.</p>
4115: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4116: where all files of the final program shall be installed. It is
4117: usually set to <code class="varname">LOCALBASE</code>
4118: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4119: for pkgs in the <code class="filename">cross</code> category. The value of
4120: <code class="varname">PREFIX</code> needs to be put
4121: into the various places in the program's source where paths to
4122: 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>
4123: <p>When choosing which of these variables to use,
4124: follow the following rules:</p>
1.148 asau 4125: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 4126: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4127: where the current pkg will be installed. When referring to a
4128: pkg's own installation path, use
4129: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
1.338 nia 4130: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.299 rillig 4131: are installed. If you need to construct a -I or -L argument
4132: to the compiler to find includes and libraries installed by
1.338 nia 4133: another pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.299 rillig 4134: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4135: installed all packages in <code class="filename">/usr/local</code>. As
4136: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4137: administrator, this variable is a misnomer.</p></li>
4138: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4139: distribution (from xsrc, etc.) is installed. When looking for
4140: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4141: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4142: <li class="listitem"><p>X11-based packages using imake must set
4143: <code class="varname">USE_IMAKE</code> to be installed correctly under
4144: <code class="varname">LOCALBASE</code>.</p></li>
4145: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.322 leot 4146: install files according to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.299 rillig 4147: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4148: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4149: </ul></div>
4150: </div>
4151: <div class="sect1">
4152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4153: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4154: <p>When building a package, various directories are used to store
4155: source files, temporary files, pkgsrc-internal files, and so on. These
4156: directories are explained here.</p>
4157: <p>Some of the directory variables contain relative pathnames. There
4158: are two common base directories for these relative directories:
4159: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4160: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4161: inside the package itself.</p>
4162: <div class="variablelist"><dl class="variablelist">
4163: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4164: <dd><p>This is an absolute pathname that points to the pkgsrc
4165: root directory. Generally, you don't need
4166: it.</p></dd>
4167: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4168: <dd><p>This is an absolute pathname that points to the
4169: current package.</p></dd>
4170: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.343 gutterid 4171: <dd>
4172: <p>This is a pathname relative to
4173: <code class="varname">PKGSRCDIR</code> that points to the current package.
4174: It is defined after including <code class="filename">bsd.prefs.mk</code>
4175: and can be used in makefile fragments that are used by several
4176: packages to distinguish between these packages. Other variables
4177: that would serve the same purpose are <code class="varname">PKGBASE</code>
4178: and <code class="varname">PKGNAME</code>, but these are only defined after
4179: including <code class="filename">bsd.pkg.mk</code>, which is too
4180: late.</p>
4181: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
4182: <code class="varname">PKGPATH</code> to tweak variables like
4183: <code class="varname">MAKE_JOBS</code> and
4184: <code class="varname">CFLAGS</code>.</p>
4185: </dd>
1.299 rillig 4186: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4187: <dd><p>This is an absolute pathname pointing to the directory
4188: where all work takes place. The distfiles are extracted to this
4189: directory. It also contains temporary directories and log files used by
4190: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4191: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4192: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4193: <dd><p>This is an absolute pathname pointing to the directory
4194: where the distfiles are extracted. It is usually a direct subdirectory
4195: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4196: that isn't hidden. This variable may be changed by a package
4197: <code class="filename">Makefile</code>.</p></dd>
4198: </dl></div>
4199: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4200: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4201: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4202: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4203: If users would like to have their pkgsrc trees behave in a
4204: read-only manner, then the value of
4205: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4206: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 4207: </div>
1.148 asau 4208: <div class="sect1">
1.75 rillig 4209: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4210: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4211: <p>You can run a particular phase by typing <span class="command"><strong>make
1.343 gutterid 4212: <em class="replaceable"><code>phase</code></em></strong></span>, where
4213: <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
4214: automatically run all phases that are required for this phase. The
4215: default phase is <code class="varname">build</code>, that is, when you run
4216: <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.299 rillig 4217: the package will be built, but not installed.</p>
1.75 rillig 4218: </div>
1.148 asau 4219: <div class="sect1">
1.75 rillig 4220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4221: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4222: <p>The first step in building a package is to fetch the
4223: distribution files (distfiles) from the sites that are providing
4224: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4225: phase.</p>
1.148 asau 4226: <div class="sect2">
1.93 rillig 4227: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 4228: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4229: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4230: defines all URLs from where the distfile, whose name is
4231: derived from the <code class="varname">DISTNAME</code> variable, is
4232: fetched. The more complicated cases are described
4233: below.</p>
4234: <p>The variable <code class="varname">DISTFILES</code> specifies
4235: the list of distfiles that have to be fetched. Its value
4236: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4237: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4238: so that most packages don't need to define it at all.
4239: <code class="varname">EXTRACT_SUFX</code> is
4240: <code class="literal">.tar.gz</code> by default, but can be changed
4241: freely. Note that if your package requires additional
4242: distfiles to the default one, you cannot just append the
4243: additional filenames using the <code class="literal">+=</code>
4244: operator, but you have write for example:</p>
4245: <pre class="programlisting">
4246: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4247: </pre>
4248: <p>Each distfile is fetched from a list of sites, usually
4249: <code class="varname">MASTER_SITES</code>. If the package has multiple
4250: <code class="varname">DISTFILES</code> or multiple
4251: <code class="varname">PATCHFILES</code> from different sites, you can
4252: set
4253: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4254: to the list of URLs where the file
4255: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4256: (including the suffix) can be found.</p>
4257: <pre class="programlisting">
4258: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4259: DISTFILES+= foo-file.tar.gz
4260: SITES.foo-file.tar.gz= \
4261: https://www.somewhere.com/somehow/ \
4262: https://www.somewhereelse.com/mirror/somehow/
4263: </pre>
4264: <p>When actually fetching the distfiles, each item from
4265: <code class="varname">MASTER_SITES</code> or
4266: <code class="varname">SITES.*</code> gets the name of each distfile
4267: appended to it, without an intermediate slash. Therefore,
4268: all site values have to end with a slash or other separator
4269: character. This allows for example to set
4270: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4271: that gets the name of the distfile as a parameter. In this
4272: case, the definition would look like:</p>
4273: <pre class="programlisting">
4274: MASTER_SITES= https://www.example.com/download.cgi?file=
4275: </pre>
4276: <p> The exception to this rule are URLs starting with a dash.
4277: In that case the URL is taken as is, fetched and the result
4278: stored under the name of the distfile. You can use this style
4279: for the case when the download URL style does not match the
4280: above common case. For example, if permanent download URL is a
4281: redirector to the real download URL, or the download file name
4282: is offered by an HTTP Content-Disposition header. In the
4283: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4284: created instead of the default
4285: <code class="filename">v1.0.0.tar.gz</code>.</p>
4286: <pre class="programlisting">
4287: DISTNAME= foo-1.0.0
4288: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4289: </pre>
4290: <p>There are some predefined values for
4291: <code class="varname">MASTER_SITES</code>, which can be used in
4292: packages. The names of the variables should speak for
4293: themselves.</p>
4294: <table border="0" summary="Simple list" class="simplelist">
4295: <tr>
4296: <td>MASTER_SITE_APACHE</td>
4297: <td>MASTER_SITE_BACKUP</td>
4298: </tr>
4299: <tr>
4300: <td>MASTER_SITE_CRATESIO</td>
4301: <td>MASTER_SITE_CYGWIN</td>
4302: </tr>
4303: <tr>
4304: <td>MASTER_SITE_DEBIAN</td>
4305: <td>MASTER_SITE_FREEBSD</td>
4306: </tr>
4307: <tr>
4308: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4309: <td>MASTER_SITE_GENTOO</td>
4310: </tr>
4311: <tr>
4312: <td>MASTER_SITE_GITHUB</td>
1.340 gutterid 4313: <td>MASTER_SITE_GITLAB</td>
4314: </tr>
4315: <tr>
1.299 rillig 4316: <td>MASTER_SITE_GNOME</td>
1.340 gutterid 4317: <td>MASTER_SITE_GNU</td>
1.299 rillig 4318: </tr>
4319: <tr>
4320: <td>MASTER_SITE_GNUSTEP</td>
1.340 gutterid 4321: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.299 rillig 4322: </tr>
4323: <tr>
4324: <td>MASTER_SITE_IFARCHIVE</td>
1.340 gutterid 4325: <td>MASTER_SITE_KDE</td>
1.299 rillig 4326: </tr>
4327: <tr>
4328: <td>MASTER_SITE_MOZILLA</td>
1.340 gutterid 4329: <td>MASTER_SITE_MOZILLA_ALL</td>
1.299 rillig 4330: </tr>
4331: <tr>
4332: <td>MASTER_SITE_MYSQL</td>
1.340 gutterid 4333: <td>MASTER_SITE_NETLIB</td>
1.299 rillig 4334: </tr>
4335: <tr>
4336: <td>MASTER_SITE_OPENBSD</td>
1.340 gutterid 4337: <td>MASTER_SITE_OPENOFFICE</td>
1.299 rillig 4338: </tr>
4339: <tr>
4340: <td>MASTER_SITE_OSDN</td>
1.340 gutterid 4341: <td>MASTER_SITE_PERL_CPAN</td>
1.299 rillig 4342: </tr>
4343: <tr>
4344: <td>MASTER_SITE_PGSQL</td>
1.340 gutterid 4345: <td>MASTER_SITE_PYPI</td>
1.299 rillig 4346: </tr>
4347: <tr>
4348: <td>MASTER_SITE_RUBYGEMS</td>
1.340 gutterid 4349: <td>MASTER_SITE_R_CRAN</td>
1.299 rillig 4350: </tr>
4351: <tr>
4352: <td>MASTER_SITE_SOURCEFORGE</td>
1.340 gutterid 4353: <td>MASTER_SITE_SUNSITE</td>
1.299 rillig 4354: </tr>
1.85 jmmv 4355: <tr>
1.299 rillig 4356: <td>MASTER_SITE_SUSE</td>
1.340 gutterid 4357: <td>MASTER_SITE_TEX_CTAN</td>
1.85 jmmv 4358: </tr>
4359: <tr>
1.299 rillig 4360: <td>MASTER_SITE_XCONTRIB</td>
1.340 gutterid 4361: <td>MASTER_SITE_XEMACS</td>
1.85 jmmv 4362: </tr>
4363: <tr>
1.299 rillig 4364: <td>MASTER_SITE_XORG</td>
1.340 gutterid 4365: <td> </td>
1.299 rillig 4366: </tr>
4367: </table>
4368: <p>Some explanations for the less self-explaining ones:
4369: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
4370: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
4371: 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>
4372: <p>If you choose one of these predefined sites, you may
4373: want to specify a subdirectory of that site. Since these
4374: macros may expand to more than one actual site, you
4375: <span class="emphasis"><em>must</em></span> use the following construct to
4376: specify a subdirectory:</p>
1.100 rillig 4377: <pre class="programlisting">
1.299 rillig 4378: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4379: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100 rillig 4380: </pre>
1.299 rillig 4381: <p>Note the trailing slash after the subdirectory
4382: name.</p>
4383: </div>
4384: <div class="sect2">
4385: <div class="titlepage"><div><div><h3 class="title">
4386: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4387: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4388: all the distfiles exist in a local directory
4389: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4390: user). If the files do not exist, they are fetched using
4391: commands of the form</p>
1.100 rillig 4392: <pre class="programlisting">
1.299 rillig 4393: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4394: </pre>
4395: <p>where <code class="literal">${site}</code> varies through
4396: several possibilities in turn: first,
4397: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4398: sites specified in either <code class="varname">SITES.file</code> if
4399: defined, else <code class="varname">MASTER_SITES</code> or
4400: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4401: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4402: all except the first and the last can be optionally sorted
4403: by the user, via setting either
4404: <code class="varname">MASTER_SORT_RANDOM</code>, and
4405: <code class="varname">MASTER_SORT_AWK</code> or
4406: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4407: <p> The specific command and arguments used depend on the
4408: <code class="varname">FETCH_USING</code> parameter. The example above is
4409: for <code class="literal">FETCH_USING=custom</code>.</p>
4410: <p>The distfiles mirror run by the NetBSD Foundation uses the
4411: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4412: distfiles, if they are freely distributable. Packages setting
4413: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4414: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4415: mirrored.</p>
1.85 jmmv 4416: </div>
4417: </div>
1.299 rillig 4418: <div class="sect1">
4419: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4420: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4421: <p>After the distfile(s) are fetched, their checksum is
4422: generated and compared with the checksums stored in the
4423: distinfo file. If the checksums don't match, the build is
4424: aborted. This is to ensure the same distfile is used for
4425: building, and that the distfile wasn't changed, e.g. by some
4426: malign force, deliberately changed distfiles on the master
4427: distribution site or network lossage.</p>
1.75 rillig 4428: </div>
1.148 asau 4429: <div class="sect1">
1.75 rillig 4430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4431: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4432: <p>When the distfiles are present on the local system, they
4433: need to be extracted, as they usually come in the form of some
4434: compressed archive format.</p>
4435: <p>By default, all <code class="varname">DISTFILES</code> are
4436: extracted. If you only need some of them, you can set the
4437: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4438: files.</p>
4439: <p>Extracting the files is usually done by a little
4440: program, <code class="filename">mk/extract/extract</code>, which
4441: already knows how to extract various archive formats, so most
4442: likely you will not need to change anything here. But if you
4443: need, the following variables may help you:</p>
1.148 asau 4444: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4445: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4446: <dd><p>Use these variables to override the default
4447: options for an extract command, which are defined in
4448: <code class="filename">mk/extract/extract</code>.</p></dd>
4449: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4450: <dd><p>This variable can be set to
4451: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4452: (which is the default value), <code class="literal">pax</code>, or an
4453: absolute pathname pointing to the command with which tar
4454: archives should be extracted. It is preferred to choose bsdtar over gtar
4455: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 4456: </dl></div>
1.299 rillig 4457: <p>If the <code class="filename">extract</code> program doesn't
4458: serve your needs, you can also override the
4459: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4460: command used for extracting the files. This command is
4461: executed in the <code class="filename">${WRKSRC}</code>
4462: directory. During execution of this command, the shell
4463: variable <code class="varname">extract_file</code> holds the absolute
4464: pathname of the file that is going to be extracted.</p>
4465: <p>And if that still does not suffice, you can override the
4466: <code class="varname">do-extract</code> target in the package
4467: Makefile.</p>
1.75 rillig 4468: </div>
1.148 asau 4469: <div class="sect1">
1.75 rillig 4470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4471: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4472: <p>After extraction, all the patches named by the
4473: <code class="varname">PATCHFILES</code>, those present in the patches
4474: subdirectory of the package as well as in
4475: $LOCALPATCHES/$PKGPATH (e.g.
4476: <code class="filename">/usr/local/patches/graphics/png</code>) are
4477: applied. Patchfiles ending in <code class="filename">.Z</code> or
4478: <code class="filename">.gz</code> are uncompressed before they are
4479: applied, files ending in <code class="filename">.orig</code> or
4480: <code class="filename">.rej</code> are ignored. Any special options to
1.322 leot 4481: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.299 rillig 4482: <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.322 leot 4483: <p>By default <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.299 rillig 4484: fail if the expected text from the patch context is not found in the
4485: patched file. If that happens, fix the patch file by comparing it
4486: with the actual text in the file to be patched.</p>
1.78 rillig 4487: </div>
1.148 asau 4488: <div class="sect1">
1.75 rillig 4489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4490: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4491: <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>.
4492: </p>
1.75 rillig 4493: </div>
1.148 asau 4494: <div class="sect1">
1.75 rillig 4495: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4496: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4497: <p>This phase creates wrapper programs for the compilers and
4498: linkers. The following variables can be used to tweak the
4499: wrappers.</p>
4500: <div class="variablelist"><dl class="variablelist">
4501: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4502: <dd><p>The command used to print progress
4503: messages. Does nothing by default. Set to
4504: <code class="literal">${ECHO}</code> to see the progress
4505: messages.</p></dd>
4506: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4507: <dd><p>This variable can be set to
4508: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4509: depending on whether you want additional information in the
4510: wrapper log file.</p></dd>
4511: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4512: <dd><p>This variable can be set to
4513: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4514: on whether the wrapper should use its cache, which will
4515: improve the speed. The default value is
4516: <code class="literal">yes</code>, but is forced to
4517: <code class="literal">no</code> if the platform does not support
4518: it.</p></dd>
4519: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4520: <dd><p>A list of reordering commands. A reordering
4521: command has the form
4522: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4523: It ensures that that
4524: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4525: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4526: </p></dd>
4527: </dl></div>
4528: </div>
4529: <div class="sect1">
4530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4531: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4532: <p>Most pieces of software need information on the header
4533: files, system calls, and library routines which are available
4534: on the platform they run on. The process of determining this
4535: information is known as configuration, and is usually
4536: automated. In most cases, a script is supplied with the
4537: distfiles, and its invocation results in generation of header
4538: files, Makefiles, etc.</p>
4539: <p>If the package contains a configure script, this can be
4540: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4541: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4542: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.301 rillig 4543: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4544: <p>In the <code class="literal">do-configure</code> stage, a rough
4545: equivalent of the following command is run. See
4546: <code class="filename">mk/configure/configure.mk</code>, target
4547: <code class="literal">do-configure-script</code> for the exact
4548: definition.</p>
4549: <pre class="programlisting">
4550: .for dir in ${CONFIGURE_DIRS}
4551: cd ${WRKSRC} && cd ${dir} \
4552: && env ${CONFIGURE_ENV} \
4553: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299 rillig 4554: .endfor
1.100 rillig 4555: </pre>
1.299 rillig 4556: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4557: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4558: <code class="varname">WRKSRC</code>. In each of these directories, the
4559: configure script is run with the environment
4560: <code class="varname">CONFIGURE_ENV</code> and arguments
4561: <code class="varname">CONFIGURE_ARGS</code>. The variables
4562: <code class="varname">CONFIGURE_ENV</code>,
4563: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4564: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4565: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4566: package.</p>
4567: <p>If the program uses the Perl way of configuration (mainly Perl
4568: modules, but not only), i.e. a file called
4569: <code class="filename">Makefile.PL</code>, it should include
4570: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4571: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4572: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4573: <p>If the program uses an <code class="filename">Imakefile</code>
4574: for configuration, the appropriate steps can be invoked by
4575: setting <code class="varname">USE_IMAKE</code> to
4576: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4577: You can add variables to xmkmf's environment by adding them to the
4578: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4579: <p>If the program uses <code class="filename">cmake</code>
4580: for configuration, the appropriate steps can be invoked by
1.348 wiz 4581: including <code class="filename">../../devel/cmake/build.mk</code>.
1.299 rillig 4582: You can add variables to cmake's environment by adding them to the
4583: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
4584: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
1.348 wiz 4585: If you want to add arguments only for particular stages, you can use the
4586: <code class="varname">CMAKE_CONFIGURE_ARGS</code>,
4587: <code class="varname">CMAKE_BUILD_ARGS</code>, and
4588: <code class="varname">CMAKE_INSTALL_ARGS</code> variables.
4589: You can set the <code class="varname">CONFIGURE_DIRS</code> variable to the
4590: directories in which CMake should be run, relative to
4591: <code class="varname">WRKSRC</code>. This defaults to to <span class="quote">“<span class="quote">.</span>”</span>.
4592: </p>
1.299 rillig 4593: <p>If there is no configure step at all, set
4594: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 4595: </div>
1.148 asau 4596: <div class="sect1">
1.75 rillig 4597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4598: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301 rillig 4599: <p>For building a package, a rough equivalent of the following
4600: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4601: <code class="literal">do-build</code> for the exact definition.</p>
1.97 rillig 4602: <pre class="programlisting">
1.301 rillig 4603: .for dir in ${BUILD_DIRS}
4604: cd ${WRKSRC} && cd ${dir} \
1.299 rillig 4605: && env ${MAKE_ENV} \
1.301 rillig 4606: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299 rillig 4607: -f ${MAKE_FILE} \
4608: ${BUILD_TARGET}
4609: .endfor
1.97 rillig 4610: </pre>
1.299 rillig 4611: <p><code class="varname">BUILD_DIRS</code> (default:
4612: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4613: <code class="varname">WRKSRC</code>. In each of these directories,
4614: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4615: <code class="varname">MAKE_ENV</code> and arguments
4616: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4617: <code class="varname">MAKE_ENV</code>,
4618: <code class="varname">BUILD_MAKE_FLAGS</code>,
4619: <code class="varname">MAKE_FILE</code> and
4620: <code class="varname">BUILD_TARGET</code> may all be changed by the
4621: package.</p>
4622: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4623: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4624: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4625: default value of <code class="varname">MAKE_FILE</code> is
4626: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4627: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4628: <p>If there is no build step at all, set
4629: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.97 rillig 4630: </div>
1.148 asau 4631: <div class="sect1">
1.97 rillig 4632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4633: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4634: <p>[TODO]</p>
1.75 rillig 4635: </div>
1.148 asau 4636: <div class="sect1">
1.75 rillig 4637: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4638: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4639: <p>Once the build stage has completed, the final step is to
4640: install the software in public directories, so users can
4641: access the programs and files.</p>
1.301 rillig 4642: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4643: of the following code is executed; see
4644: <code class="filename">mk/install/install.mk</code>, target
4645: <code class="literal">do-install</code> for the exact definition. Additionally,
4646: before and after this code, several consistency checks are run
4647: against the files-to-be-installed, see
4648: <code class="filename">mk/check/*.mk</code> for details.</p>
4649: <pre class="programlisting">
4650: .for dir in ${INSTALL_DIRS}
4651: cd ${WRKSRC} && cd ${dir} \
4652: && env ${INSTALL_ENV} ${MAKE_ENV} \
4653: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4654: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299 rillig 4655: .endfor
1.220 wiz 4656: </pre>
1.299 rillig 4657: <p>The variable's meanings are analogous to the ones in the
4658: <span class="emphasis"><em>build</em></span> phase.
4659: <code class="varname">INSTALL_DIRS</code> defaults to
4660: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4661: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4662: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4663: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4664: defined.</p>
4665: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4666: variables are useful. They are all variations of the
1.322 leot 4667: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.299 rillig 4668: permissions preset. <code class="varname">INSTALL</code> is the plain
4669: install command. The specialized variants, together with their
4670: intended use, are:</p>
4671: <div class="variablelist"><dl class="variablelist">
4672: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4673: <dd><p>directories that contain
4674: binaries</p></dd>
4675: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4676: <dd><p>directories that contain
4677: scripts</p></dd>
4678: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4679: <dd><p>directories that contain shared and static
4680: libraries</p></dd>
4681: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4682: <dd><p>directories that contain data
4683: files</p></dd>
4684: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4685: <dd><p>directories that contain man
4686: pages</p></dd>
4687: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4688: <dd><p>directories that contain data files for games
4689: </p></dd>
4690: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4691: <dd><p>binaries that can be stripped from debugging
4692: symbols</p></dd>
4693: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4694: <dd><p>binaries that cannot be
4695: stripped</p></dd>
4696: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4697: <dd><p>game
4698: binaries</p></dd>
4699: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4700: <dd><p>shared and static
4701: libraries</p></dd>
4702: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4703: <dd><p>data files</p></dd>
4704: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4705: <dd><p>data files for
4706: games</p></dd>
4707: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4708: <dd><p>man pages</p></dd>
4709: </dl></div>
4710: <p>Some other variables are:</p>
4711: <div class="variablelist"><dl class="variablelist">
4712: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.322 leot 4713: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.299 rillig 4714: when installing binaries. Any debugging sections and symbols present in
4715: binaries will be preserved.
4716: </p></dd>
4717: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4718: <dd><p>A list of directories relative to
4719: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4720: beginning of the <span class="emphasis"><em>install</em></span> phase.
4721: The package is supposed to create all needed directories itself
4722: before installing files to it and list all other directories here.
4723: </p></dd>
4724: </dl></div>
4725: <p>In the rare cases that a package shouldn't install anything,
4726: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4727: mostly relevant for packages in the <code class="filename">regress</code>
4728: category.</p>
1.75 rillig 4729: </div>
1.148 asau 4730: <div class="sect1">
1.75 rillig 4731: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4732: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4733: <p>Once the install stage has completed, a binary package of
4734: the installed files can be built. These binary packages can be
4735: used for quick installation without previous compilation, e.g. by
4736: the <span class="command"><strong>make bin-install</strong></span> or by using
4737: <span class="command"><strong>pkg_add</strong></span>.</p>
4738: <p>By default, the binary packages are created in
4739: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4740: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4741: one for each category in the <code class="varname">CATEGORIES</code>
4742: variable. <code class="varname">PACKAGES</code> defaults to
4743: <code class="filename">pkgsrc/packages</code>.</p>
1.75 rillig 4744: </div>
1.148 asau 4745: <div class="sect1">
1.75 rillig 4746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4747: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4748: <p>Once you're finished with a package, you can clean the work
4749: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4750: to clean the work directories of all dependencies too, use
4751: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 4752: </div>
1.148 asau 4753: <div class="sect1">
1.75 rillig 4754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4755: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148 asau 4756: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4757: <dt><span class="term">pre/post-*</span></dt>
4758: <dd>
4759: <p>For any of the main targets described in the previous
4760: section (configure, build, install, etc.), two auxiliary
4761: targets exist with
4762: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4763: prefix for the main target's name. These targets are
4764: invoked before and after the main target is called,
4765: allowing extra configuration or installation steps be
4766: performed from a package's Makefile, for example, which
4767: a program's configure script or install target
4768: omitted.</p>
4769: <p>About 5% of the pkgsrc packages define their custom
4770: post-extract target, another 5% define pre-configure, and 10%
4771: define post-install. The other pre/post-* targets are defined
4772: even less often.</p>
4773: </dd>
4774: <dt><span class="term">do-*</span></dt>
1.75 rillig 4775: <dd>
1.299 rillig 4776: <p>Should one of the main targets do the wrong thing,
4777: and should there be no variable to fix this, you can
4778: redefine it with the do-* target. (Note that redefining
4779: the target itself instead of the do-* target is a bad
4780: idea, as the pre-* and post-* targets won't be called
4781: anymore, etc.)</p>
4782: <p>About 15% of the pkgsrc packages override the default
4783: do-install, the other do-* targets are overridden even less
4784: often.</p>
1.75 rillig 4785: </dd>
1.299 rillig 4786: <dt><span class="term">reinstall</span></dt>
1.75 rillig 4787: <dd>
1.299 rillig 4788: <p>If you did a <span class="command"><strong>make install</strong></span> and
4789: you noticed some file was not installed properly, you
4790: can repeat the installation with this target, which will
4791: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4792: <p>This is the default value of
4793: <code class="varname">DEPENDS_TARGET</code> except in the case of
4794: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4795: package</strong></span>, where the defaults are
4796: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4797: respectively.</p>
1.75 rillig 4798: </dd>
1.299 rillig 4799: <dt><span class="term">deinstall</span></dt>
4800: <dd>
1.322 leot 4801: <p>This target does a <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.299 rillig 4802: current directory, effectively de-installing the
4803: package. The following variables can be used to tune the
4804: behaviour:</p>
4805: <div class="variablelist"><dl class="variablelist">
4806: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.322 leot 4807: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.299 rillig 4808: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4809: <dd><p>Remove all packages that require (depend on)
4810: the given package. This can be used to remove any
4811: packages that may have been pulled in by a given
4812: package, e.g. if <span class="command"><strong>make deinstall
4813: DEINSTALLDEPENDS=1</strong></span> is done in
4814: <code class="filename">pkgsrc/x11/kde</code>, this is
4815: likely to remove whole KDE. Works by adding
1.322 leot 4816: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.299 rillig 4817: command line.</p></dd>
4818: </dl></div>
4819: </dd>
4820: <dt><span class="term">bin-install</span></dt>
4821: <dd><p>Install a binary package from local disk and via FTP
4822: from a list of sites (see the
4823: <code class="varname">BINPKG_SITES</code> variable), and do a
4824: <span class="command"><strong>make package</strong></span> if no binary package is
4825: available anywhere. The arguments given to
4826: <span class="command"><strong>pkg_add</strong></span> can be set via
4827: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4828: operation, etc.</p></dd>
4829: <dt><span class="term">install-clean</span></dt>
4830: <dd><p>This target removes the state files for the "install" and later
4831: phases so that the "install" target may be re-invoked. This can be
4832: used after editing the PLIST to install the package without
4833: rebuilding it.</p></dd>
4834: <dt><span class="term">build-clean</span></dt>
4835: <dd><p>This target removes the state files for the "build" and later
4836: phases so that the "build" target may be re-invoked.</p></dd>
4837: <dt><span class="term">update</span></dt>
4838: <dd>
4839: <p>This target causes the current package to be
4840: updated to the latest version. The package and all
4841: depending packages first get de-installed, then current
4842: versions of the corresponding packages get compiled and
4843: installed. This is similar to manually noting which
4844: packages are currently installed, then performing a
4845: series of <span class="command"><strong>make deinstall</strong></span> and
4846: <span class="command"><strong>make install</strong></span> (or whatever
4847: <code class="varname">UPDATE_TARGET</code> is set to) for these
4848: packages.</p>
4849: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4850: resume package updating in case a previous <span class="command"><strong>make
4851: update</strong></span> was interrupted for some reason.
4852: However, in this case, make sure you don't call
4853: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4854: list of dependent packages in <code class="varname">WRKDIR</code>.
4855: Otherwise, you lose the ability to automatically update
4856: the current package along with the dependent packages
4857: you have installed.</p>
4858: <p>Resuming an interrupted <span class="command"><strong>make
4859: update</strong></span> will only work as long as the package
4860: tree remains unchanged. If the source code for one of
4861: the packages to be updated has been changed, resuming
4862: <span class="command"><strong>make update</strong></span> will most certainly
4863: fail!</p>
4864: <p>The following variables can be used either on the
4865: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4866: alter the behaviour of <span class="command"><strong>make
4867: update</strong></span>:</p>
4868: <div class="variablelist"><dl class="variablelist">
4869: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4870: <dd><p>Install target to recursively use for the
4871: updated package and the dependent packages.
4872: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4873: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4874: <span class="command"><strong>make update</strong></span>. Other good
4875: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4876: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4877: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4878: endless loop!</p></dd>
4879: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4880: <dd><p>Don't clean up after updating. Useful if
4881: you want to leave the work sources of the updated
4882: packages around for inspection or other purposes.
4883: Be sure you eventually clean up the source tree
4884: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4885: or you may run into troubles with old source code
4886: still lying around on your next
4887: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4888: update</strong></span>.</p></dd>
4889: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4890: <dd><p>Deinstall each package before installing
4891: (making <code class="varname">DEPENDS_TARGET</code>). This
4892: may be necessary if the
4893: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4894: called after interrupting a running <span class="command"><strong>make
4895: update</strong></span>.</p></dd>
4896: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4897: <dd><p>Allows you to disable recursion and hardcode
4898: the target for packages. The default is
4899: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4900: facilitating a recursive update of prerequisite
4901: packages. Only set
4902: <code class="varname">DEPENDS_TARGET</code> if you want to
4903: disable recursive updates. Use
4904: <code class="varname">UPDATE_TARGET</code> instead to just
4905: set a specific target for each package to be
4906: installed during <span class="command"><strong>make update</strong></span>
4907: (see above).</p></dd>
4908: </dl></div>
4909: </dd>
4910: <dt><span class="term">clean-update</span></dt>
4911: <dd>
4912: <p>Clean the source tree for all packages that would
4913: get updated if <span class="command"><strong>make update</strong></span> was called
4914: from the current directory. This target should not be
4915: used if the current package (or any of its depending
4916: packages) have already been de-installed (e.g., after
4917: calling <span class="command"><strong>make update</strong></span>) or you may lose
4918: some packages you intended to update. As a rule of
4919: thumb: only use this target <span class="emphasis"><em>before</em></span>
4920: the first time you run <span class="command"><strong>make update</strong></span>
4921: and only if you have a dirty package tree (e.g., if you
4922: used <code class="varname">NOCLEAN</code>).</p>
4923: <p>If you are unsure about whether your tree is
4924: clean, you can either perform a <span class="command"><strong>make
4925: clean</strong></span> at the top of the tree, or use the
4926: following sequence of commands from the directory of the
4927: package you want to update (<span class="emphasis"><em>before</em></span>
4928: running <span class="command"><strong>make update</strong></span> for the first
4929: time, otherwise you lose all the packages you wanted to
4930: update!):</p>
4931: <pre class="screen">
4932: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
4933: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
4934: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
4935: </pre>
4936: <p>The following variables can be used either on the
4937: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
4938: <span class="command"><strong>make clean-update</strong></span>:</p>
4939: <div class="variablelist"><dl class="variablelist">
4940: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
4941: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
4942: reconstruct the list of directories to update for
4943: this package. Only use this if <span class="command"><strong>make
4944: update</strong></span> successfully installed all
4945: packages you wanted to update. Normally, this is
4946: done automatically on <span class="command"><strong>make
4947: update</strong></span>, but may have been suppressed by
4948: the <code class="varname">NOCLEAN</code> variable (see
4949: above).</p></dd>
4950: </dl></div>
4951: </dd>
4952: <dt><span class="term">replace</span></dt>
4953: <dd>
4954: <p>Update the installation of the current package. This
4955: differs from update in that it does not replace dependent
1.322 leot 4956: packages. You will need to install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.299 rillig 4957: target to work.</p>
4958: <p><span class="emphasis"><em>Be careful when using this
4959: target!</em></span> There are no guarantees that dependent
4960: packages will still work, in particular they will most
4961: certainly break if you <span class="command"><strong>make replace</strong></span> a
4962: library package whose shared library major version changed
4963: between your installed version and the new one. For this
4964: reason, this target is not officially supported and only
4965: recommended for advanced users.</p>
4966: </dd>
4967: <dt><span class="term">info</span></dt>
1.322 leot 4968: <dd><p>This target invokes <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.299 rillig 4969: package. You can use this to check which version of a
4970: package is installed.</p></dd>
4971: <dt><span class="term">index</span></dt>
4972: <dd>
4973: <p>This is a top-level command, i.e. it should be used in
4974: the <code class="filename">pkgsrc</code> directory. It creates a
4975: database of all packages in the local pkgsrc tree, including
4976: dependencies, comment, maintainer, and some other useful
4977: information. Individual entries are created by running
4978: <span class="command"><strong>make describe</strong></span> in the packages'
4979: directories. This index file is saved as
4980: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
4981: verbose format by running <span class="command"><strong>make
4982: print-index</strong></span>. You can search in it with
4983: <span class="command"><strong>make search
4984: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
4985: extract a list of all packages that depend on a particular
4986: one by running <span class="command"><strong>make show-deps
4987: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
4988: <p>Running this command takes a very long time, some
4989: hours even on fast machines!</p>
4990: </dd>
4991: <dt><span class="term">readme</span></dt>
4992: <dd>
4993: <p>This target generates a
1.314 nia 4994: <code class="filename">index.html</code> file, which can be
1.322 leot 4995: viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/index.html" target="_top"><code class="filename">www/links</code></a>. The generated files
1.299 rillig 4996: contain references to any packages which are in the
4997: <code class="varname">PACKAGES</code> directory on the local
4998: host. The generated files can be made to refer to URLs
4999: based on <code class="varname">FTP_PKG_URL_HOST</code> and
5000: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314 nia 5001: wanted to generate <code class="filename">index.html</code>
1.299 rillig 5002: files which pointed to binary packages on the local
5003: machine, in the directory
5004: <code class="filename">/usr/packages</code>, set
5005: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
5006: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
5007: <code class="varname">${PACKAGES}</code> directory and its
5008: subdirectories will be searched for all the binary
5009: packages.</p>
5010: <p>The target can be run at the toplevel or in category
5011: directories, in which case it descends recursively.</p>
5012: </dd>
5013: <dt><span class="term">readme-all</span></dt>
5014: <dd><p>This is a top-level command, run it in
5015: <code class="filename">pkgsrc</code>. Use this target to create a
5016: file <code class="filename">README-all.html</code> which contains a
5017: list of all packages currently available in the NetBSD
5018: Packages Collection, together with the category they belong
5019: to and a short description. This file is compiled from the
1.314 nia 5020: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299 rillig 5021: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
5022: readme</strong></span>.</p></dd>
5023: <dt><span class="term">cdrom-readme</span></dt>
5024: <dd><p>This is very much the same as the
5025: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
5026: used when generating a pkgsrc tree to be written to a
5027: CD-ROM. This target also produces
1.314 nia 5028: <code class="filename">index.html</code> files, and can be made
1.299 rillig 5029: to refer to URLs based on
5030: <code class="varname">CDROM_PKG_URL_HOST</code> and
5031: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
5032: <dt><span class="term">show-distfiles</span></dt>
5033: <dd><p>This target shows which distfiles and patchfiles
5034: are needed to build the package
5035: (<code class="varname">ALLFILES</code>, which contains all
5036: <code class="varname">DISTFILES</code> and
5037: <code class="varname">PATCHFILES</code>, but not
5038: <code class="filename">patches/*</code>).</p></dd>
5039: <dt><span class="term">show-downlevel</span></dt>
5040: <dd><p>This target shows nothing if the package is not
5041: installed. If a version of this package is installed,
5042: but is not the version provided in this version of
5043: pkgsrc, then a warning message is displayed. This target
5044: can be used to show which of your installed packages are
5045: downlevel, and so the old versions can be deleted, and
5046: the current ones added.</p></dd>
5047: <dt><span class="term">show-pkgsrc-dir</span></dt>
5048: <dd><p>This target shows the directory in the pkgsrc
5049: hierarchy from which the package can be built and
5050: installed. This may not be the same directory as the one
5051: from which the package was installed. This target is
5052: intended to be used by people who may wish to upgrade
5053: many packages on a single host, and can be invoked from
5054: the top-level pkgsrc Makefile by using the
5055: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
5056: <dt><span class="term">show-installed-depends</span></dt>
5057: <dd><p>This target shows which installed packages match
5058: the current package's <code class="varname">DEPENDS</code>. Useful
5059: if out of date dependencies are causing build
5060: problems.</p></dd>
5061: <dt><span class="term">print-build-depends-list</span></dt>
5062: <dd><p>This target shows the list of packages that the current package
5063: depends on for building.</p></dd>
5064: <dt><span class="term">print-run-depends-list</span></dt>
5065: <dd><p>This target shows the list of packages that the current package
5066: depends on for running.</p></dd>
5067: <dt><span class="term">check-shlibs</span></dt>
5068: <dd><p>After a package is installed, check all its
5069: binaries and (on ELF platforms) shared libraries to see
5070: if they find the shared libs they need. Run by default
5071: 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>
5072: <dt><span class="term">print-PLIST</span></dt>
5073: <dd>
5074: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5075: upgraded pkg, this prints out an attempt to generate a
5076: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5077: -newer work/.extract_done</strong></span>. An attempt is made
5078: to care for shared libs etc., but it is
5079: <span class="emphasis"><em>strongly</em></span> recommended to review the
5080: result before putting it into
5081: <code class="filename">PLIST</code>. On upgrades, it's useful to
5082: diff the output of this command against an already
5083: existing <code class="filename">PLIST</code> file.</p>
1.322 leot 5084: <p>If the package installs files via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.299 rillig 5085: other methods that don't update file access times, be
5086: sure to add these files manually to your
5087: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5088: -newer</span>”</span> command used by this target won't catch
5089: them!</p>
5090: <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
5091: information on this target.</p>
5092: </dd>
5093: </dl></div>
5094: </div>
5095: </div>
5096: <div class="chapter">
5097: <div class="titlepage"><div><div><h2 class="title">
5098: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5099: <div class="toc">
5100: <p><b>Table of Contents</b></p>
5101: <dl class="toc">
5102: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5103: <dd><dl>
1.334 nia 5104: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
5105: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
5106: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.299 rillig 5107: </dl></dd>
5108: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5109: <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>
5110: </dl>
5111: </div>
5112: <p>When you find a package that is not yet in pkgsrc, you
5113: most likely have a URL from where you can download the source
5114: code. Starting with this URL, creating a package involves only a
5115: few steps.</p>
5116: <div class="procedure"><ol class="procedure" type="1">
5117: <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
5118: enable the basic quality checks.</p></li>
5119: <li class="step">
1.322 leot 5120: <p>Install the package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkg_developer/index.html" target="_top"><code class="filename">meta-pkgs/pkg_developer</code></a>, which among others will
1.299 rillig 5121: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5122: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5123: <span class="command"><strong>mkpatches</strong></span>:</p>
5124: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5125: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5126: </li>
5127: <li class="step">
5128: <p>Choose one of the top-level directories as the category in
5129: which you want to place your package. You can also create a directory of
1.334 nia 5130: your own (maybe called <code class="filename">local</code>). Change into that
5131: category directory:</p>
5132: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em></code></strong></pre>
1.299 rillig 5133: </li>
5134: <li class="step">
1.334 nia 5135: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
5136: argument the URL of the distribution file (in most cases a
5137: <code class="filename">.tar.gz</code> file). This will download the distribution
5138: file and create the necessary files of the package, based on what's in
5139: the distribution file:</p>
1.299 rillig 5140: <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>
5141: </li>
5142: <li class="step">
5143: <p>Examine the extracted files to determine the dependencies of
5144: your package. Ideally, this is mentioned in some
5145: <code class="filename">README</code> file, but things may differ. For each of
5146: these dependencies, look where it exists in pkgsrc, and if there is a
5147: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5148: line to your package <code class="filename">Makefile</code> which includes that
5149: file just before the last line. If the
5150: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5151: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5152: that the package's include files and libraries are provided.</p>
1.334 nia 5153: <p>If you just need binaries from a dependent package, add a
1.299 rillig 5154: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5155: version of the dependency and where it can be found in pkgsrc. This line
5156: should be placed in the third paragraph. If the dependency is only
5157: needed for building the package, but not when using it, use
5158: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5159: instead of <code class="varname">DEPENDS</code>.
5160: The difference between <code class="varname">TOOL_DEPENDS</code> and
5161: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5162: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.334 nia 5163: packages, i.e. packages for the platform where the package is built;
1.299 rillig 5164: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.334 nia 5165: packages, i.e. packages for the platform for which the package
5166: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
5167: specifies a dependency used only for testing the resulting package
5168: built, using the upstream project's included test suite, on the native
5169: platform.
1.299 rillig 5170: Your package may then look like this:</p>
5171: <pre class="programlisting">
5172: [...]
5173:
5174: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5175: DEPENDS+= screen-[0-9]*:../../misc/screen
5176: DEPENDS+= screen>=4.0:../../misc/screen
5177:
5178: [...]
5179:
5180: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5181: .include "../../devel/glib2/buildlink3.mk"
5182: .include "../../mk/bsd.pkg.mk"
5183: </pre>
5184: </li>
5185: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5186: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5187: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5188: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5189: additional explanations.</p></li>
5190: <li class="step"><p>In many cases the package is not yet ready to build. You can
5191: 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
5192: over there, you can hopefully continue here.</p></li>
5193: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5194: directory from the extracted files. Besides these files, a lot of cache
1.334 nia 5195: files and other system information have been saved in the working
5196: directory, which may have become outdated after you edited the
1.299 rillig 5197: <code class="filename">Makefile</code>.</p></li>
5198: <li class="step">
5199: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5200: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p>
1.334 nia 5201: <p>If the extracted files from the package need to be fixed, run
5202: multiple rounds of these commands:</p>
5203: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.299 rillig 5204: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5205: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.334 nia 5206: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
5207: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.299 rillig 5208: </li>
5209: <li class="step"><p>When the package builds fine, the next step is to install
5210: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5211: everything works.</p></li>
5212: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5213: contains a list of the files that are installed by the package, is
5214: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5215: >PLIST</strong></span> to generate a probably correct list. Check
5216: the file using your preferred text editor to see if the list of
5217: files looks plausible.</p></li>
5218: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5219: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5220: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5221: had been registered in the database of installed files, but with an
5222: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5223: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5224: registered with the list of files from
5225: <code class="filename">PLIST</code>.</p></li>
5226: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5227: from above again in a single step, making sure that the PLIST is correct
5228: and the whole package is created as intended.</p></li>
1.334 nia 5229: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
5230: left to do.</p></li>
1.299 rillig 5231: <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>
5232: </ol></div>
5233: <div class="sect1">
5234: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5235: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5236: <div class="sect2">
5237: <div class="titlepage"><div><div><h3 class="title">
1.334 nia 5238: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.299 rillig 5239: <p>Python modules and programs packages are easily created using a
5240: set of predefined variables.</p>
5241: <p>
5242: If some Python versions are not supported by the software, set the
5243: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5244: that are not supported, e.g.
5245: </p>
5246: <pre class="programlisting">
5247: PYTHON_VERSIONS_INCOMPATIBLE= 27
5248: </pre>
5249: <p>
5250: If the packaged software is a Python module, include one of
1.330 wiz 5251: <code class="filename">../../lang/python/egg.mk</code> or
1.299 rillig 5252: <code class="filename">../../lang/python/extension.mk</code>.</p>
1.330 wiz 5253: <p>Most Python packages use setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
1.299 rillig 5254: If the packaged software is using setuptools, you only need
5255: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
1.330 wiz 5256: </p>
1.299 rillig 5257: <p>Either way, the package directory should be called
5258: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5259: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5260: </p>
5261: <pre class="programlisting">
5262: DISTNAME= foopymodule-1.2.10
5263: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5264: </pre>
1.341 gutterid 5265: <p>
5266: For software in PyPi, the name should match what PyPi specifies for
5267: "pip install software".
5268: </p>
1.299 rillig 5269: <p>If it is an application, include
5270: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5271: In order to correctly set the path to the Python interpreter, use the
5272: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5273: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5274: For example:
5275: </p>
5276: <pre class="programlisting">
5277: REPLACE_PYTHON= *.py
5278: </pre>
5279: <p>Some Python modules have separate distributions for Python-2.x
5280: and Python-3.x support. In pkgsrc this is handled by the
5281: <code class="filename">versioned_dependencies.mk</code> file. Set
5282: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
5283: packages that should be depended upon and include
5284: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
5285: then the pkgsrc infrastructure will depend on the appropriate package
5286: version. For example:
5287: </p>
5288: <pre class="programlisting">
5289: PYTHON_VERSIONED_DEPENDENCIES=dialog
5290: </pre>
5291: <p>
5292: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
5293: of supported packages.</p>
5294: </div>
5295: <div class="sect2">
5296: <div class="titlepage"><div><div><h3 class="title">
1.334 nia 5297: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.299 rillig 5298: <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>
5299: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.322 leot 5300: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/index.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
1.299 rillig 5301: Individual packages (and optionally their dependencies) may be created
5302: and updated. R packages generally follow the same form, and most of
5303: the relevant information needed is contained in a
5304: <code class="filename">DESCRIPTION</code> file as part of each R package on
5305: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5306: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5307: creates or updates a package in the canonical form. The resulting
5308: package should be reviewed for correctness.</p>
5309: </div>
5310: <div class="sect2">
5311: <div class="titlepage"><div><div><h3 class="title">
1.334 nia 5312: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.299 rillig 5313: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.322 leot 5314: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/index.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
1.299 rillig 5315: <p>If the TeXlive package name is not known, it may be useful to
5316: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5317: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5318: 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
5319: archive</a>.</p>
5320: <p>If the TeXlive package name is known, download the files from
5321: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5322: archive</a>. For package <code class="filename">foo</code>, you will need
5323: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5324: also have associated documentation packages, so download
5325: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5326: should be placed in the appropriate category directory, which is often
5327: but not always <code class="filename">print</code>. Then run the following
5328: command in the category directory.</p>
5329: <pre class="programlisting">
5330: texlive2pkg foo.tar.xz foo.doc.tar.xz
5331: </pre>
5332: <p>This will create two packages, <code class="filename">tex-foo</code> and
5333: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5334: are correct.</p>
5335: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5336: currently does not include version information in package filenames
5337: and changes their contents periodically when updates occur.
5338: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5339: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5340: main one and the corresponding documentation, upload the distfiles
5341: with the following command in each package directory.</p>
5342: <pre class="programlisting">
5343: make upload-distfiles
5344: </pre>
5345: </div>
5346: </div>
5347: <div class="sect1">
5348: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5349: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5350: <div class="sect2">
5351: <div class="titlepage"><div><div><h3 class="title">
5352: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5353: <div class="sect3">
5354: <div class="titlepage"><div><div><h4 class="title">
5355: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5356: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5357: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5358: pkgsrc. As the description says it has to do with the web, the obvious
5359: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5360: <pre class="programlisting">
5361: <code class="prompt">$</code> mkdir www/nvu
5362: <code class="prompt">$</code> cd www/nvu
5363: </pre>
5364: <p>The web site says that the sources are available as a tar file, so
5365: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5366: <pre class="programlisting">
5367: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5368: </pre>
5369: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5370: below the <code class="varname">DISTNAME</code> line, as the package name should
5371: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5372: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5373: <code class="varname">COMMENT</code> fields. Then the package
5374: <code class="filename">Makefile</code> looked like that:</p>
5375: <pre class="programlisting">
5376: # $NetBSD $
5377: #
5378:
5379: DISTNAME= nvu-1.0-sources
5380: PKGNAME= nvu-1.0
5381: CATEGORIES= www
5382: MASTER_SITES= http://cvs.nvu.com/download/
5383: EXTRACT_SUFX= .tar.bz2
5384:
5385: MAINTAINER= rillig@NetBSD.org
5386: HOMEPAGE= http://cvs.nvu.com/
5387: COMMENT= Web Authoring System
5388:
5389: # url2pkg-marker (please do not remove this line.)
5390: .include "../../mk/bsd.pkg.mk"
5391: </pre>
5392: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5393: this is a workaround to prevent CVS expanding to the filename of the
5394: guide.</p>
5395: <p>Then, I quit the editor and watched pkgsrc downloading a large
5396: source archive:</p>
5397: <pre class="programlisting">
5398: url2pkg> Running "make makesum" ...
5399: => Required installed package digest>=20010302: digest-20060826 found
5400: => Fetching nvu-1.0-sources.tar.bz2
5401: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5402: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5403: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5404: url2pkg> Running "make extract" ...
5405: => Required installed package digest>=20010302: digest-20060826 found
5406: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5407: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5408: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5409: ===> Installing dependencies for nvu-1.0
5410: ===> Overriding tools for nvu-1.0
5411: ===> Extracting for nvu-1.0
5412: url2pkg> Adjusting the Makefile.
5413:
5414: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5415:
5416: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5417: </pre>
5418: </div>
5419: <div class="sect3">
5420: <div class="titlepage"><div><div><h4 class="title">
5421: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5422: <p>Now that the package has been extracted, let's see what's inside
5423: it. The package has a <code class="filename">README.txt</code>, but that only
5424: says something about mozilla, so it's probably useless for seeing what
5425: dependencies this package has. But since there is a GNU configure script
5426: in the package, let's hope that it will complain about everything it
5427: needs.</p>
5428: <pre class="programlisting">
5429: <code class="prompt">$</code> bmake
5430: => Required installed package digest>=20010302: digest-20060826 found
5431: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5432: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5433: ===> Patching for nvu-1.0
5434: ===> Creating toolchain wrappers for nvu-1.0
5435: ===> Configuring for nvu-1.0
5436: [...]
5437: configure: error: Perl 5.004 or higher is required.
5438: [...]
5439: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5440: [...]
5441: </pre>
5442: <p>That worked quite well. So I opened the package Makefile in my
5443: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5444: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5445: package have changed now, and since a perl wrapper is automatically
5446: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5447: from scratch.</p>
5448: <pre class="programlisting">
5449: <code class="prompt">$</code> bmake clean
5450: ===> Cleaning for nvu-1.0
5451: <code class="prompt">$</code> bmake
5452: [...]
5453: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5454: GNU Make. You will not be able to build Mozilla without GNU Make.
5455: [...]
5456: </pre>
5457: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5458: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5459: <pre class="programlisting">
5460: [...]
5461: checking for GTK - version >= 1.2.0... no
5462: *** Could not run GTK test program, checking why...
5463: [...]
5464: </pre>
5465: <p>Now to the other dependencies. The first question is: Where is the
5466: GTK package hidden in pkgsrc?</p>
5467: <pre class="programlisting">
5468: <code class="prompt">$</code> echo ../../*/gtk*
5469: [many packages ...]
5470: <code class="prompt">$</code> echo ../../*/gtk
5471: ../../x11/gtk
5472: <code class="prompt">$</code> echo ../../*/gtk2
5473: ../../x11/gtk2
5474: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5475: ../../x11/gtk2/buildlink3.mk
5476: </pre>
5477: <p>The first try was definitely too broad. The second one had exactly
5478: one result, which is very good. But there is one pitfall with GNOME
5479: packages. Before GNOME 2 had been released, there were already many
5480: GNOME 1 packages in pkgsrc. To be able to continue to use these
5481: packages, the GNOME 2 packages were imported as separate packages, and
5482: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5483: whether this was the case here, and indeed it was.</p>
5484: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5485: file, adding the dependency is very easy. I just inserted an
5486: <code class="literal">.include</code> line before the last line of the package
5487: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5488: <pre class="programlisting">
5489: [...]
5490: .include "../../x11/gtk2/buildlink3.mk"
5491: .include "../../mk/bsd.pkg.mk
5492: </pre>
5493: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5494: was:</p>
1.75 rillig 5495: <pre class="programlisting">
1.299 rillig 5496: [...]
5497: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5498: checking for GTK - version >= 1.2.0... no
5499: *** Could not run GTK test program, checking why...
5500: *** The test program failed to compile or link. See the file config.log for the
5501: *** exact error that occured. This usually means GTK was incorrectly installed
5502: *** or that you have moved GTK since it was installed. In the latter case, you
5503: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5504: configure: error: Test for GTK failed.
5505: [...]
1.222 sevan 5506: </pre>
1.299 rillig 5507: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5508: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5509: told me that this package really wanted to have the GNOME 1 version of
5510: GTK. If the package had looked for GTK2, it would have looked for
5511: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5512: So I changed the <code class="literal">x11/gtk2</code> to
5513: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5514: and tried again.</p>
1.119 mishka 5515: <pre class="programlisting">
1.299 rillig 5516: [...]
5517: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5518: In file included from xpidl.c:42:
5519: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5520: In file included from xpidl.c:42:
5521: xpidl.h:132: error: parse error before "IDL_ns"
5522: [...]
1.222 sevan 5523: </pre>
1.299 rillig 5524: <p>The package still does not find all of its dependencies. Now the
5525: question is: Which package provides the
5526: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119 mishka 5527: <pre class="programlisting">
1.299 rillig 5528: <code class="prompt">$</code> echo ../../*/*idl*
5529: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5530: <code class="prompt">$</code> echo ../../*/*IDL*
5531: ../../net/libIDL
1.222 sevan 5532: </pre>
1.299 rillig 5533: <p>Let's take the one from the second try. So I included the
5534: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5535: again. But the error didn't change. After digging through some of the
5536: code, I concluded that the build process of the package was broken and
5537: couldn't have ever worked, but since the Mozilla source tree is quite
5538: large, I didn't want to fix it. So I added the following to the package
5539: <code class="filename">Makefile</code> and tried again:</p>
1.197 wiz 5540: <pre class="programlisting">
1.299 rillig 5541: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5542: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.222 sevan 5543: </pre>
1.299 rillig 5544: <p>The latter line is needed because the package expects the library
5545: <code class="filename">libIDL.so</code>, but only
5546: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5547: wrapper to rewrite that on the fly.</p>
5548: <p>The next problem was related to a recent change of the FreeType
1.322 leot 5549: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/index.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.299 rillig 5550: which patch files were relevant for this issue and copied them to the
5551: <code class="filename">patches</code> directory. Then I retried, fixed the
5552: patches so that they applied cleanly and retried again. This time,
5553: everything worked.</p>
1.197 wiz 5554: </div>
1.299 rillig 5555: <div class="sect3">
5556: <div class="titlepage"><div><div><h4 class="title">
5557: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87 wiz 5558: <pre class="programlisting">
1.299 rillig 5559: <code class="prompt">$</code> bmake CHECK_FILES=no install
5560: [...]
5561: <code class="prompt">$</code> bmake print-PLIST >PLIST
5562: <code class="prompt">$</code> bmake deinstall
5563: <code class="prompt">$</code> bmake install
1.222 sevan 5564: </pre>
1.299 rillig 5565: </div>
5566: </div>
1.75 rillig 5567: </div>
5568: </div>
1.148 asau 5569: <div class="chapter">
1.75 rillig 5570: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 5571: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 5572: <div class="toc">
5573: <p><b>Table of Contents</b></p>
1.210 leot 5574: <dl class="toc">
1.299 rillig 5575: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5576: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5577: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5578: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5579: <dd><dl>
5580: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5581: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5582: <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>
5583: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.344 gutterid 5584: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.75 rillig 5585: </dl></dd>
5586: </dl>
5587: </div>
1.299 rillig 5588: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5589: each of which forms a well-defined part of the pkgsrc system. Using
1.322 leot 5590: the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.299 rillig 5591: like pkgsrc requires some discipline to keep the code correct and
5592: understandable.</p>
5593: <p>The basic ingredients for <code class="filename">Makefile</code>
5594: programming are variables and shell
5595: commands. Among these shell commands may even be more complex ones
1.322 leot 5596: like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/awk.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.299 rillig 5597: as intended it is necessary to quote all variables correctly when they
5598: are used.</p>
5599: <p>This chapter describes some patterns that appear quite often in
5600: <code class="filename">Makefile</code>s, including the pitfalls that come along
5601: with them.</p>
1.148 asau 5602: <div class="sect1">
1.75 rillig 5603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5604: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5605: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5606: <p>When you are creating a file as a
5607: target of a rule, always write the data to a temporary file first
5608: and finally rename that file. Otherwise there might occur an error
5609: in the middle of generating the file, and when the user runs
1.322 leot 5610: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.299 rillig 5611: regenerated properly. Example:</p>
1.75 rillig 5612: <pre class="programlisting">
1.299 rillig 5613: wrong:
5614: @echo "line 1" > ${.TARGET}
5615: @echo "line 2" >> ${.TARGET}
5616: @false
5617:
5618: correct:
5619: @echo "line 1" > ${.TARGET}.tmp
5620: @echo "line 2" >> ${.TARGET}.tmp
5621: @false
5622: @mv ${.TARGET}.tmp ${.TARGET}
1.100 rillig 5623: </pre>
1.299 rillig 5624: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5625: <code class="filename">wrong</code> will exist, although there was an error
5626: message in the first run. On the other hand, running <span class="command"><strong>make
5627: correct</strong></span> gives an error message twice, as expected.</p>
1.322 leot 5628: <p>You might remember that <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.299 rillig 5629: <code class="literal">${.TARGET}</code> in case of error, but this only
5630: happens when it is interrupted, for example by pressing
5631: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.322 leot 5632: when one of the commands fails (like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.299 rillig 5633: </li></ul></div>
5634: </div>
5635: <div class="sect1">
5636: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5637: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5638: <p><code class="filename">Makefile</code> variables contain strings that
5639: can be processed using the five operators <code class="code">=</code>,
5640: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.322 leot 5641: <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.299 rillig 5642: page.</p>
5643: <p>When a variable's value is parsed from a
5644: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5645: the backslash character <code class="code">\</code> are handled specially. If a
5646: backslash is the last character in a line, that backslash is removed
5647: from the line and the line continues with the next line of the file.</p>
5648: <p>The <code class="code">#</code> character starts a comment that reaches
5649: until the end of the line. To get an actual <code class="code">#</code> character,
5650: such as in a URL, write <code class="code">\#</code> instead.</p>
5651: <p>The evaluation of variables either happens immediately or lazy.
5652: It happens immediately when the variable occurs on the right-hand
5653: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5654: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5655: In the other cases, it is evaluated lazily.</p>
5656: <p>Some of the modifiers split the string into words and then
5657: operate on the words, others operate on the string as a whole. When a
5658: string is split into words, double quotes and single quotes are
1.322 leot 5659: interpreted as delimiters, just like in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.299 rillig 5660: <div class="sect2">
5661: <div class="titlepage"><div><div><h3 class="title">
5662: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5663: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5664: <li class="listitem"><p>All variable names starting with an underscore
5665: are reserved for use by the pkgsrc infrastructure. They shall
5666: not be used by packages.</p></li>
5667: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5668: lowercase variable names for the iteration
5669: variables.</p></li>
5670: <li class="listitem"><p>All list variables should have a plural name,
5671: such as <code class="varname">PKG_OPTIONS</code> or
5672: <code class="varname">DISTFILES</code>.</p></li>
5673: </ul></div>
5674: </div>
5675: </div>
5676: <div class="sect1">
5677: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5678: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5679: <div class="sect2">
5680: <div class="titlepage"><div><div><h3 class="title">
5681: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5682: <p>When adding a string that possibly contains whitespace or quotes to
5683: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5684: modifier.</p>
5685: <p>When adding another list to a list (example 2), it must not be
5686: quoted, since its elements are already quoted.</p>
1.75 rillig 5687: <pre class="programlisting">
1.299 rillig 5688: STRING= foo * bar `date`
5689: LIST= # empty
5690: ANOTHER_LIST= a=b c=d
5691:
5692: LIST+= ${STRING:Q} # 1
5693: LIST+= ${ANOTHER_LIST} # 2
1.100 rillig 5694: </pre>
1.299 rillig 5695: </div>
5696: <div class="sect2">
5697: <div class="titlepage"><div><div><h3 class="title">
5698: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5699: <p>Echoing a string containing special characters needs special
5700: work.</p>
1.75 rillig 5701: <pre class="programlisting">
1.299 rillig 5702: STRING= foo bar < > * `date` $$HOME ' "
5703: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5704:
5705: all:
5706: echo ${STRING} # 1
5707: echo ${STRING:Q} # 2
5708: printf '%s\n' ${STRING:Q}'' # 3
5709: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.100 rillig 5710: </pre>
1.299 rillig 5711: <p>Example 1 leads to a syntax error in the shell, as the characters
5712: are just copied.</p>
5713: <p>Example 2 quotes the string so that the shell interprets it
5714: correctly. But the echo command may additionally interpret strings with a
5715: leading dash or those containing backslashes.</p>
1.322 leot 5716: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.299 rillig 5717: interprets the format string, but not the next argument. The trailing
5718: single quotes handle the case when the string is empty. In that case, the
5719: :Q modifier would result in an empty string too, which would then be
1.322 leot 5720: skipped by the shell. For <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.299 rillig 5721: but other programs may care.</p>
5722: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5723: need to be quoted because the quoting has already been done
5724: when adding elements to the list.</p>
1.75 rillig 5725: </div>
1.148 asau 5726: <div class="sect2">
1.75 rillig 5727: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 5728: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5729: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5730: GNU-style configure script (especially those that call other configure
5731: scripts), it must not have leading or trailing whitespace, since
5732: otherwise the configure script gets confused. To trim leading and
5733: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5734: following example:</p>
1.75 rillig 5735: <pre class="programlisting">
1.299 rillig 5736: CPPFLAGS= # empty
5737: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5738: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 grant 5739:
1.299 rillig 5740: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 grant 5741:
1.299 rillig 5742: all:
5743: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5744: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5745: </pre>
5746: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5747: trailing whitespace because the <code class="code">+=</code> operator always adds a
5748: space.</p>
5749: </div>
5750: <div class="sect2">
5751: <div class="titlepage"><div><div><h3 class="title">
5752: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5753: <p>When a possibly empty variable is used in a shell program, it may
5754: lead to a syntax error.</p>
5755: <pre class="programlisting">
5756: EGFILES= # empty
1.87 wiz 5757:
1.299 rillig 5758: install-examples: # produces a syntax error in the shell
5759: for egfile in ${EGFILES}; do \
5760: echo "Installing $$egfile"; \
5761: done
5762: </pre>
5763: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.322 leot 5764: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.299 rillig 5765: To fix this syntax error, use one of the snippets below.</p>
5766: <pre class="programlisting">
1.344 gutterid 5767: EGFILES= # empty
1.87 wiz 5768:
1.299 rillig 5769: install-examples:
5770: for egfile in ${EGFILES} ""; do \
5771: [ -n "$$egfile" ] || continue; \
5772: echo "Installing $$egfile"; \
5773: done
5774: </pre>
5775: <p>In this case, an empty string is appended to the iteration list (to
5776: prevent the syntax error) and filtered out later.</p>
5777: <pre class="programlisting">
5778: EGFILES= # empty
1.87 wiz 5779:
1.299 rillig 5780: install-examples:
5781: .for egfile in ${EGFILES}
5782: echo "Installing ${egfile}"
5783: .endfor
1.100 rillig 5784: </pre>
1.299 rillig 5785: <p>If one of the filenames contains special characters, it should be
5786: enclosed in single or double quotes.</p>
5787: <p>To have a shell command test whether a make variable is empty, use
5788: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5789: </div>
1.344 gutterid 5790: <div class="sect2">
5791: <div class="titlepage"><div><div><h3 class="title">
5792: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
5793: <p>When a variable can have the values <code class="literal">yes</code> or
5794: <code class="literal">no</code>, use the following pattern to test the variable:</p>
5795: <pre class="programlisting">
5796: .if ${VAR:U:tl} == "yes"
5797: # do something
5798: .endif
5799: </pre>
5800: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
5801: can be undefined. If the variable is guaranteed to be defined, the
5802: <code class="literal">:U</code> can be omitted.</p>
5803: <p>The <code class="literal">:tl</code> modifier converts the variable value to
5804: lowercase, allowing for the values <code class="literal">yes</code>,
5805: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
5806: </div>
1.299 rillig 5807: </div>
5808: </div>
5809: <div class="chapter">
5810: <div class="titlepage"><div><div><h2 class="title">
5811: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5812: <div class="toc">
5813: <p><b>Table of Contents</b></p>
5814: <dl class="toc">
5815: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5816: <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>
5817: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5818: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5819: </dl>
1.75 rillig 5820: </div>
1.299 rillig 5821: <p>Many packages have the ability to be built to support different
5822: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5823: in pkgsrc that provides generic handling of those options that
5824: determine different ways in which the packages can be built. It's
5825: possible for the user to specify exactly which sets of options will be
5826: built into a package or to allow a set of global default options
5827: apply.</p>
5828: <p>There are two broad classes of behaviors that one might want to
5829: control via options. One is whether some particular feature is
5830: enabled in a program that will be built anyway, often by including or
5831: not including a dependency on some other package. The other is
5832: whether or not an additional program will be built as part of the
5833: package. Generally, it is better to make a split package for such
5834: additional programs instead of using options, because it enables
5835: binary packages to be built which can then be added separately. For
5836: example, the foo package might have minimal dependencies (those
5837: packages without which foo doesn't make sense), and then the foo-gfoo
5838: package might include the GTK frontend program gfoo. This is better
5839: than including a gtk option to foo that adds gfoo, because either that
5840: option is default, in which case binary users can't get foo without
5841: gfoo, or not default, in which case they can't get gfoo. With split
5842: packages, they can install foo without having GTK, and later decide to
5843: install gfoo (pulling in GTK at that time). This is an advantage to
5844: source users too, avoiding the need for rebuilds.</p>
5845: <p>Plugins with widely varying dependencies should usually be split
5846: instead of options.</p>
5847: <p>It is often more work to maintain split packages, especially if
5848: the upstream package does not support this. The decision of split
5849: vs. option should be made based on the likelihood that users will want
5850: or object to the various pieces, the size of the dependencies that are
5851: included, and the amount of work.</p>
5852: <p>A further consideration is licensing. Non-free parts, or parts
5853: that depend on non-free dependencies (especially plugins) should
5854: almost always be split if feasible.</p>
5855: <div class="sect1">
5856: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5857: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5858: <p>Global default options are listed in
5859: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5860: that should be built into every package if that option is supported.
5861: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 5862: </div>
1.148 asau 5863: <div class="sect1">
1.75 rillig 5864: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5865: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5866: </h2></div></div></div>
5867: <p>The following example shows how
5868: <code class="filename">bsd.options.mk</code> should be used
5869: by the hypothetical ``wibble'' package, either in the package
5870: <code class="filename">Makefile</code>, or in a file,
5871: e.g. <code class="filename">options.mk</code>, that is included by the
5872: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 5873: <pre class="programlisting">
1.299 rillig 5874: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5875: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5876: PKG_OPTIONS_OPTIONAL_GROUPS= database
5877: PKG_OPTIONS_GROUP.database= mysql pgsql
5878: PKG_SUGGESTED_OPTIONS= wibble-foo
5879: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5880: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5881:
5882: .include "../../mk/bsd.prefs.mk"
5883:
5884: # this package was previously named wibble2
5885: .if defined(PKG_OPTIONS.wibble2)
5886: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5887: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5888: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5889: .endif
5890:
5891: .include "../../mk/bsd.options.mk"
5892:
5893: # Package-specific option-handling
1.100 rillig 5894:
1.299 rillig 5895: ###
5896: ### FOO support
5897: ###
5898: .if !empty(PKG_OPTIONS:Mwibble-foo)
5899: CONFIGURE_ARGS+= --enable-foo
5900: .endif
1.100 rillig 5901:
1.299 rillig 5902: ###
5903: ### LDAP support
5904: ###
5905: .if !empty(PKG_OPTIONS:Mldap)
5906: . include "../../databases/openldap-client/buildlink3.mk"
5907: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5908: .endif
1.100 rillig 5909:
1.299 rillig 5910: ###
5911: ### database support
5912: ###
5913: .if !empty(PKG_OPTIONS:Mmysql)
5914: . include "../../mk/mysql.buildlink3.mk"
5915: .endif
5916: .if !empty(PKG_OPTIONS:Mpgsql)
5917: . include "../../mk/pgsql.buildlink3.mk"
5918: .endif
5919: </pre>
5920: <p>The first section contains the information about which build
5921: options are supported by the package, and any default options settings
5922: if needed.</p>
5923: <div class="orderedlist"><ol class="orderedlist" type="1">
5924: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.322 leot 5925: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.299 rillig 5926: options. It should be set to
5927: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5928: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5929: at the point where the options are processed.</p></li>
5930: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
5931: build options supported by the package.</p></li>
5932: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
5933: list of names of groups of mutually exclusive options. The options in
5934: each group are listed in
5935: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5936: The most specific setting of any option from the group takes
5937: precedence over all other options in the group. Options from the
5938: groups will be automatically added to
5939: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
5940: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
5941: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5942: packages will fail if no option from the group is
5943: selected.</p></li>
5944: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
5945: of names of sets of options. At least one option from each set must
5946: be selected. The options in each set are listed in
5947: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5948: Options from the sets will be automatically added to
5949: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5950: fail if no option from the set is selected.</p></li>
5951: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
5952: build options which are enabled by default.</p></li>
5953: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
5954: of
5955: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
5956: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
5957: their option counterparts. Pairs should be added with
5958: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
5959: warning will be issued if the user uses a legacy
5960: variable.</p></li>
5961: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
5962: of
5963: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
5964: pairs that map options that have been renamed to their new
5965: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
5966: the listing of global legacy options. A warning will be issued if
5967: the user uses a legacy option.</p></li>
5968: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
5969: options implied by deprecated variables used. This can be used for
5970: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5971: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5972: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
5973: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
5974: a list of warnings about deprecated variables or options used, and
5975: what to use instead.</p></li>
5976: </ol></div>
5977: <p>A package should never modify
5978: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5979: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5980: To suggest a default set of options, use
5981: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5982: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5983: including <code class="filename">bsd.options.mk</code>. If none of
5984: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5985: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5986: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5987: happen with platform-specific options if none of them is supported on
5988: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5989: empty list and the package is otherwise treated as not using the
5990: options framework.</p>
5991: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5992: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5993: build options, properly filtered to remove unsupported and duplicate
5994: options.</p>
5995: <p>The remaining sections contain the logic that is specific to
5996: each option. The correct way to check for an option is to check
5997: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5998: <pre class="programlisting">
5999: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100 rillig 6000: </pre>
1.75 rillig 6001: </div>
1.299 rillig 6002: <div class="sect1">
6003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6004: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
6005: <p>Options that enable similar features in different packages (like
6006: optional support for a library) should use a common name in all
6007: packages that support it (like the name of the library). If another
6008: package already has an option with the same meaning, use the same
6009: name.</p>
6010: <p>Options that enable features specific to one package, where it's
6011: unlikely that another (unrelated) package has the same (or a similar)
6012: optional feature, should use a name prefixed with
6013: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6014: <p>If a group of related packages share an optional feature
6015: specific to that group, prefix it with the name of the
6016: <span class="quote">“<span class="quote">main</span>”</span> package
6017: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6018: <p>For new options, add a line to
6019: <code class="filename">mk/defaults/options.description</code>. Lines have two
6020: fields, separated by tab. The first field is the option name, the
6021: second its description. The description should be a whole sentence
6022: (starting with an uppercase letter and ending with a period) that
6023: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6024: support.</span>”</span> The file is sorted by option names.</p>
6025: </div>
6026: <div class="sect1">
6027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6028: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
6029: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6030: different dependencies based on the options with which the package was
6031: built. For querying these options, the file
6032: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6033: typical example looks like this:</p>
1.87 wiz 6034: <pre class="programlisting">
1.299 rillig 6035: pkgbase := libpurple
6036: .include "../../mk/pkg-build-options.mk"
6037:
6038: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6039: ...
6040: .endif
1.229 sevan 6041: </pre>
1.299 rillig 6042: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6043: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6044: options of the libpurple package, which can then be queried like
6045: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6046: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6047: details.</p>
1.75 rillig 6048: </div>
6049: </div>
1.148 asau 6050: <div class="chapter">
1.75 rillig 6051: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 6052: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 6053: <div class="toc">
6054: <p><b>Table of Contents</b></p>
1.210 leot 6055: <dl class="toc">
1.299 rillig 6056: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
6057: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
6058: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75 rillig 6059: </dl>
6060: </div>
1.299 rillig 6061: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6062: by pkgsrc and also for individual packages to define what commands
6063: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6064: or for later run-time of an installed packaged (such as
6065: <code class="varname">DEPENDS</code>).
6066: If the native system provides an adequate tool, then in many cases, a pkgsrc
6067: package will not be used.</p>
6068: <p>When building a package, the replacement tools are
6069: made available in a directory (as symlinks or wrapper scripts)
6070: that is early in the executable search path. Just like the buildlink
6071: system, this helps with consistent builds.</p>
6072: <p>A tool may be needed to help build a specific package. For example,
6073: perl, GNU make (gmake) or yacc may be needed.</p>
6074: <p>Also a tool may be needed, for example, because the native system's supplied
6075: tool may be inefficient for building a package with pkgsrc.
6076: For example, a package may need GNU awk, bison (instead of
6077: yacc) or a better sed.</p>
6078: <p>The tools used by a package can be listed by running
6079: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 6080: <div class="sect1">
1.75 rillig 6081: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6082: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6083: <p>The default set of tools used by pkgsrc is defined in
6084: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6085: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6086: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6087: These can be seen by running:
6088: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6089: <p>If a package needs a specific program to build
6090: then the <code class="varname">USE_TOOLS</code> variable can be used
6091: to define the tools needed.</p>
1.75 rillig 6092: </div>
1.299 rillig 6093: <div class="sect1">
6094: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6095: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6096: <p>In the following examples, the :run means that it is needed at
6097: run-time (and becomes a DEPENDS).
6098: The default is a build dependency which can be set with
6099: :build. (So in this example, it is the same as gmake:build
6100: and pkg-config:build.)</p>
1.75 rillig 6101: <pre class="programlisting">
1.299 rillig 6102: USE_TOOLS+= gmake perl:run pkg-config
1.1 grant 6103: </pre>
1.299 rillig 6104: <p>When using the tools framework, a
6105: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6106: which contains the full path to the appropriate tool. For example,
6107: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6108: on Linux systems.</p>
6109: <p>If you always need a pkgsrc version of the
6110: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6111: </p>
1.75 rillig 6112: </div>
1.299 rillig 6113: <div class="sect1">
6114: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6115: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6116: <p>When improving or porting pkgsrc to a new platform, have a look
6117: at (or create) the corresponding platform specific make file fragment under
6118: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6119: the name of the common tools. For example:</p>
1.75 rillig 6120: <pre class="programlisting">
1.299 rillig 6121: .if exists(/usr/bin/bzcat)
6122: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6123: .elif exists(/usr/bin/bzip2)
6124: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6125: .endif
6126:
6127: TOOLS_PLATFORM.true?= true # shell builtin
1.1 grant 6128: </pre>
1.75 rillig 6129: </div>
6130: </div>
1.299 rillig 6131: <div class="chapter">
6132: <div class="titlepage"><div><div><h2 class="title">
6133: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6134: <div class="toc">
6135: <p><b>Table of Contents</b></p>
6136: <dl class="toc">
6137: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6138: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6139: <dd><dl>
6140: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6141: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6142: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6143: and
6144: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6145: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6146: </dl></dd>
6147: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
6148: <dd><dl>
6149: <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>
6150: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
6151: </dl></dd>
6152: </dl>
1.75 rillig 6153: </div>
1.299 rillig 6154: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6155: are seen by a package's configure and build processes. This is implemented
6156: in a two step process:</p>
6157: <div class="orderedlist"><ol class="orderedlist" type="1">
6158: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6159: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6160: of <code class="varname">WRKDIR</code>.</p></li>
6161: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6162: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6163: <code class="option">-L${LOCALBASE}/lib</code> into references to
6164: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6165: native compiler on some operating systems look like GCC, so that
6166: packages that expect GCC won't require modifications to build with
6167: those native compilers.</p></li>
6168: </ol></div>
6169: <p>This normalizes the environment in which a package is built so that the
6170: package may be built consistently despite what other software may be
6171: installed. Please note that the normal system header and library paths,
6172: e.g. <code class="filename">/usr/include</code>,
6173: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6174: designed to insulate the package build from non-system-supplied
6175: software.</p>
1.148 asau 6176: <div class="sect1">
1.75 rillig 6177: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6178: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6179: <p>The process of converting packages to use the buildlink3
6180: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6181: The things to keep in mind are:</p>
1.128 wiz 6182: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299 rillig 6183: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6184: instead of the actual toolchain. Some packages are tricky,
6185: and the only way to know for sure is the check
6186: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6187: wrappers are being invoked.</p></li>
6188: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6189: the package Makefile, e.g. Java VMs, standalone shells,
6190: etc., because the code to symlink files into
6191: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6192: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6193: </p></li>
6194: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6195: <code class="filename">buildlink3.mk</code> files that you list in a
6196: package's Makefile are added as dependencies for that package.
6197: </p></li>
6198: </ol></div>
6199: <p>If a dependency on a particular package is required for its libraries and
6200: headers, then we replace:</p>
6201: <pre class="programlisting">
6202: DEPENDS+= foo>=1.1.0:../../category/foo
6203: </pre>
6204: <p>with</p>
6205: <pre class="programlisting">
6206: .include "../../category/foo/buildlink3.mk"
6207: </pre>
6208: <p>The buildlink3.mk files usually define the required dependencies.
6209: If you need a newer version of the dependency when using buildlink3.mk
6210: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 6211: <pre class="programlisting">
1.299 rillig 6212: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6213: .include "../../category/foo/buildlink3.mk"
1.1 grant 6214: </pre>
1.299 rillig 6215: <p>There are several <code class="filename">buildlink3.mk</code>
6216: files in <code class="filename">pkgsrc/mk</code>
6217: that handle special package issues:</p>
6218: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6219: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6220: the native or a pkgsrc Berkeley DB implementation based on
6221: the values of <code class="varname">BDB_ACCEPTED</code> and
6222: <code class="varname">BDB_DEFAULT</code>.</p></li>
6223: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6224: comes with neither Curses nor NCurses, this will take care
1.322 leot 6225: to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/index.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.299 rillig 6226: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6227: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6228: adding a dependency on Heimdal or MIT-krb5 for packages that
6229: require a Kerberos 5 implementation.</p></li>
6230: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6231: system-provided Motif installation or adds a dependency on
1.322 leot 6232: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/index.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/index.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.299 rillig 6233: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6234: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6235: to choose which Motif version will be used.</p></li>
6236: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6237: system-provided GNU readline or editline (libedit) installation,
1.322 leot 6238: 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>,
6239: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/index.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.299 rillig 6240: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6241: If your package really needs GNU readline library, its Makefile
6242: should include <code class="filename">devel/readline/buildlink3.mk</code>
6243: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6244: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6245: variables that may be used by packages that use the
6246: Open Sound System (OSS) API.</p></li>
6247: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6248: any of the Postgres versions in the variable
6249: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6250: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6251: the file for more information.</p></li>
6252: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6253: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.322 leot 6254: a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/index.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.299 rillig 6255: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6256: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6257: library.</p></li>
6258: </ul></div>
6259: <p>The comments in those <code class="filename">buildlink3.mk</code>
6260: files provide a more complete
6261: description of how to use them properly.</p>
1.75 rillig 6262: </div>
1.148 asau 6263: <div class="sect1">
1.75 rillig 6264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6265: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6266: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6267: included by Makefiles to indicate the need to compile and link
6268: against header files and libraries provided by the package. A
6269: <code class="filename">buildlink3.mk</code> file should always provide
6270: enough information to add the correct type of dependency
6271: relationship and include any other
6272: <code class="filename">buildlink3.mk</code> files that it needs to find
6273: headers and libraries that it needs in turn.</p>
6274: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.322 leot 6275: file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/index.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.299 rillig 6276: package is highly recommended. For most packages, the following
6277: command will generate a good starting point for
6278: <code class="filename">buildlink3.mk</code> files:</p>
6279: <pre class="screen">
6280: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6281: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6282: </pre>
1.148 asau 6283: <div class="sect2">
1.75 rillig 6284: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6285: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6286: <p>The following real-life example
6287: <code class="filename">buildlink3.mk</code> is taken
6288: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 6289: <pre class="programlisting">
1.299 rillig 6290: BUILDLINK_TREE+= tiff
6291:
6292: .if !defined(TIFF_BUILDLINK3_MK)
6293: TIFF_BUILDLINK3_MK:=
6294:
6295: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6296: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6297: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6298:
6299: .include "../../devel/zlib/buildlink3.mk"
6300: .include "../../graphics/jpeg/buildlink3.mk"
6301: .endif # TIFF_BUILDLINK3_MK
6302:
6303: BUILDLINK_TREE+= -tiff
1.1 grant 6304: </pre>
1.299 rillig 6305: <p>The header and footer manipulate
6306: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6307: <code class="filename">buildlink3.mk</code> files and is used to track
6308: the dependency tree.</p>
6309: <p>The main section is protected from multiple inclusion
6310: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6311: added. Several important variables are set in the section:</p>
6312: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6313: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6314: is the dependency version recorded in the installed
1.299 rillig 6315: package; this should always be set using
6316: <span class="command"><strong>+=</strong></span> to ensure that
6317: we're appending to any pre-existing list of values. This
1.300 wiz 6318: variable should be set to the last version of the
1.299 rillig 6319: package that had an backwards-incompatible API change.
6320: </p></li>
6321: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6322: is the location of the <em class="replaceable"><code>pkg</code></em>
6323: pkgsrc directory.</p></li>
6324: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6325: (not shown above) controls whether we use
1.349 ! wiz 6326: <code class="varname">BUILD_DEPENDS</code>,
! 6327: <code class="varname">TEST_DEPENDS</code>, or
1.299 rillig 6328: <code class="varname">DEPENDS</code> to add the dependency on
6329: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6330: selected by setting
6331: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.349 ! wiz 6332: to <span class="quote">“<span class="quote">build</span>”</span>, while setting it to <span class="quote">“<span class="quote">test</span>”</span> causes
! 6333: it to become a test dependency. By default, the full dependency is
1.299 rillig 6334: used.</p></li>
6335: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6336: and
6337: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6338: (not shown above) are lists of subdirectories of
6339: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6340: to add to the header and library search paths. These
6341: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6342: respectively.</p></li>
6343: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6344: (not shown above) is the list of preprocessor flags to add
6345: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6346: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6347: should be avoided and instead be handled using
6348: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6349: above.</p></li>
6350: </ul></div>
6351: <p>The following variables are all optionally defined within
6352: this second section (protected against multiple inclusion) and
6353: control which package files are symlinked into
6354: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6355: transformed during the symlinking:</p>
6356: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6357: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6358: (not shown above) is a shell glob pattern relative to
6359: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6360: to be symlinked into
6361: <code class="filename">${BUILDLINK_DIR}</code>,
6362: e.g. <code class="filename">include/*.h</code>.</p></li>
6363: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6364: (not shown above) is a shell pipeline that
6365: outputs to stdout a list of files relative to
6366: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6367: The resulting files are to be symlinked
6368: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6369: this takes the <code class="filename">+CONTENTS</code> of a
6370: <em class="replaceable"><code>pkg</code></em> and filters it through
6371: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6372: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6373: (not shown above) is a filter command that filters
6374: <code class="filename">+CONTENTS</code> input into a list of files
6375: relative to
6376: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6377: on stdout. By default,
6378: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6379: outputs the contents of the <code class="filename">include</code>
6380: and <code class="filename">lib</code> directories in the package
6381: <code class="filename">+CONTENTS</code>.</p></li>
6382: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6383: (not shown above) is a list of sed arguments used to
6384: transform the name of the source filename into a
6385: destination filename, e.g. <span class="command"><strong>-e
6386: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6387: </ul></div>
6388: <p>This section can additionally include any
6389: <code class="filename">buildlink3.mk</code> needed for
6390: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6391: Including these <code class="filename">buildlink3.mk</code> files
6392: means that the headers and libraries for these
6393: dependencies are also symlinked into
6394: <code class="filename">${BUILDLINK_DIR}</code>
6395: whenever the <em class="replaceable"><code>pkg</code></em>
6396: <code class="filename">buildlink3.mk</code>
6397: file is included. Dependencies are only added for directly
6398: include <code class="filename">buildlink3.mk</code> files.</p>
6399: <p>When providing a <code class="filename">buildlink3.mk</code> and
6400: including other <code class="filename">buildlink3.mk</code> files in it,
6401: please only add necessary ones, i.e., those whose libraries or
6402: header files are automatically exposed when the package is
6403: use.</p>
6404: <p>In particular, if only an executable
6405: (<code class="filename">bin/foo</code>) is linked against a library, that
6406: library does not need to be propagated in the
6407: <code class="filename">buildlink3.mk</code> file.</p>
6408: <p>The following steps should help you decide if a
6409: <code class="filename">buildlink3.mk</code> file needs to be included:
6410: </p>
6411: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6412: <li class="listitem"><p>Look at the installed header files: What
6413: headers do they include? The packages providing these files
6414: must be buildlinked.</p></li>
6415: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6416: libraries and look against what other libraries they link.
6417: Some of the packages providing these probably need to be
6418: buildlinked; however, it's not automatic, since e.g. GTK on
6419: some systems pulls in the X libraries, so they will show up in
6420: the <code class="filename">ldd</code> output, while on others (like OS
6421: X) it won't. <code class="filename">ldd</code> output can thus only be
6422: used as a hint.</p></li>
6423: </ul></div>
6424: <p>
6425: </p>
6426: </div>
1.148 asau 6427: <div class="sect2">
1.75 rillig 6428: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6429: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6430: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6431: and
6432: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6433: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300 wiz 6434: <p>Both variables set lower bounds for a version of this package.
6435: The two variables differ in that one describes source
1.299 rillig 6436: compatibility (API) and the other binary compatibility (ABI).
6437: The difference is that a change in the API breaks compilation of
6438: programs while changes in the ABI stop compiled programs from
6439: running.</p>
1.300 wiz 6440: <p>The
6441: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6442: variable in a <code class="filename">buildlink3.mk</code> should be
6443: changed very rarely. (One possible scenario: If all packages
6444: using this package need a higher version than defined in the
6445: <code class="filename">buildlink3.mk</code>,
1.299 rillig 6446: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6447: could be updated to that higher version.)</p>
6448: <p>On the other hand, changes to
1.299 rillig 6449: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6450: are more common. The variable will need to be updated every
6451: time the major version of one of its shared libraries is changed,
6452: or any other change where a binary built against the previous
6453: version of the package will not run against the new version any
6454: longer.</p>
6455: <p>In such a case, the package's
1.299 rillig 6456: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6457: must be increased to require the new package version. Then the
6458: <code class="varname">PKGREVISION</code> of all packages
6459: <em class="replaceable"><code>foo</code></em> that depend on this package need
6460: to be increased, and if they have
6461: <code class="filename">buildlink3.mk</code> files,
6462: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6463: in their <code class="filename">buildlink3.mk</code> files must be
6464: increased to the new version as well. This is required so that a
6465: package will pull in the versions of the packages that use the
6466: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6467: uniquely identify the packages built against the new ABI. The
1.322 leot 6468: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/revbump/index.html" target="_top"><code class="filename">pkgtools/revbump</code></a> package can
1.300 wiz 6469: help with these updates.</p>
6470: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6471: about dependencies on other packages, including the
6472: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299 rillig 6473: <p>Please take careful consideration before adjusting
6474: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6475: or
6476: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6477: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6478: cause unneeded package deletions and rebuilds. In many cases,
6479: new versions of packages work just fine with older
6480: dependencies.</p>
1.326 gutterid 6481: <p>Also, it is not needed to set
1.299 rillig 6482: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6483: when it is identical to
1.326 gutterid 6484: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
6485: <p>Note there is also the distinction that users are able to disable
6486: enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
6487: variable, but there is no equivalent option for API dependencies.</p>
1.75 rillig 6488: </div>
6489: </div>
1.148 asau 6490: <div class="sect1">
1.75 rillig 6491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6492: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6493: <p>Some packages in pkgsrc install headers and libraries that
6494: coincide with headers and libraries present in the base system.
6495: Aside from a <code class="filename">buildlink3.mk</code> file, these
6496: packages should also include a <code class="filename">builtin.mk</code>
6497: file that includes the necessary checks to decide whether using
6498: the built-in software or the pkgsrc software is
6499: appropriate.</p>
6500: <p>The only requirements of a builtin.mk file for
6501: <em class="replaceable"><code>pkg</code></em> are:</p>
6502: <div class="orderedlist"><ol class="orderedlist" type="1">
6503: <li class="listitem"><p>It should set
6504: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6505: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6506: after it is included.</p></li>
6507: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6508: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6509: which is already set before the
6510: <code class="filename">builtin.mk</code> file is included.</p></li>
6511: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6512: is <span class="emphasis"><em>very</em></span> important and takes careful
6513: attention to <code class="filename">Makefile</code> coding.</p></li>
6514: </ol></div>
6515: <div class="sect2">
6516: <div class="titlepage"><div><div><h3 class="title">
6517: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6518: <p>The following is the recommended template for builtin.mk
6519: files:</p>
1.75 rillig 6520: <pre class="programlisting">
1.299 rillig 6521: .if !defined(IS_BUILTIN.foo)
6522: #
6523: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6524: # genuinely exists in the system or not.
6525: #
6526: IS_BUILTIN.foo?= no
1.100 rillig 6527:
1.299 rillig 6528: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6529: # version can be determined.
6530: #
6531: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6532: BUILTIN_PKG.foo?= foo-1.0
6533: . endif
6534: .endif # IS_BUILTIN.foo
1.100 rillig 6535:
1.299 rillig 6536: .if !defined(USE_BUILTIN.foo)
6537: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6538: . if defined(BUILTIN_PKG.foo)
6539: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6540: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6541: USE_BUILTIN.foo!= \
6542: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6543: && ${ECHO} "yes" || ${ECHO} "no"
6544: . endif
6545: . endfor
6546: . endif
6547: .endif # USE_BUILTIN.foo
1.100 rillig 6548:
1.299 rillig 6549: CHECK_BUILTIN.foo?= no
6550: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6551: #
6552: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6553: # "yes" or "no".
6554: #
6555: .endif # CHECK_BUILTIN.foo
1.75 rillig 6556: </pre>
1.299 rillig 6557: <p>The first section sets
6558: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6559: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6560: in the base system. This should not be a base system software
6561: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6562: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6563: included as part of the base system. This variable is only
6564: used internally within the <code class="filename">builtin.mk</code>
6565: file.</p>
6566: <p>The second section sets
6567: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6568: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6569: system if it exists (if
6570: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6571: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6572: within the <code class="filename">builtin.mk</code> file.</p>
6573: <p>The third section sets
6574: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6575: and is <span class="emphasis"><em>required</em></span> in all
6576: <code class="filename">builtin.mk</code> files. The code in this
6577: section must make the determination whether the built-in
6578: software is adequate to satisfy the dependencies listed in
6579: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6580: This is typically done by comparing
6581: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6582: against each of the dependencies in
6583: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6584: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6585: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6586: end of the <code class="filename">builtin.mk</code> file. Note that
6587: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6588: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6589: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6590: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6591: that the built-in version of the software is similar enough to
6592: be used as a replacement.</p>
6593: <p>The last section is guarded by
6594: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6595: and includes code that uses the value of
6596: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6597: set in the previous section. This typically includes, e.g.,
6598: adding additional dependency restrictions and listing additional
6599: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6600: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6601: </div>
6602: <div class="sect2">
6603: <div class="titlepage"><div><div><h3 class="title">
6604: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
6605: <p>When building packages, it's possible to choose whether to set
6606: a global preference for using either the built-in (native)
6607: version or the pkgsrc version of software to satisfy a
6608: dependency. This is controlled by setting
6609: <code class="varname">PREFER_PKGSRC</code> and
6610: <code class="varname">PREFER_NATIVE</code>. These variables take values
6611: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
6612: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
6613: use the pkgsrc versions of software, while
6614: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
6615: built-in versions. Preferences are determined by the most
6616: specific instance of the package in either
6617: <code class="varname">PREFER_PKGSRC</code> or
6618: <code class="varname">PREFER_NATIVE</code>. If a package is specified
6619: in neither or in both variables, then
6620: <code class="varname">PREFER_PKGSRC</code> has precedence over
6621: <code class="varname">PREFER_NATIVE</code>. For example, to require
6622: using pkgsrc versions of software for all but the most basic
6623: bits on a NetBSD system, you can set:</p>
1.75 rillig 6624: <pre class="programlisting">
1.299 rillig 6625: PREFER_PKGSRC= yes
6626: PREFER_NATIVE= getopt skey tcp_wrappers
6627: </pre>
6628: <p>A package <span class="emphasis"><em>must</em></span> have a
6629: <code class="filename">builtin.mk</code>
6630: file to be listed in <code class="varname">PREFER_NATIVE</code>,
6631: otherwise it is simply ignored in that list.</p>
1.305 bacon 6632: <p><code class="varname">PREFER_PKGSRC</code> and
6633: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
6634: to ensure that the bootstrap process does not use inapropriate
6635: native tools as dependencies for core packages.
6636:
6637: </p>
6638: <pre class="screen">
6639: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
6640: </pre>
6641: <p>
6642:
1.299 rillig 6643: Switching between settings globally at a later date can introduce
6644: complications with dependency resolution. This is caused by packages
1.305 bacon 6645: built with the opposite preference being installed alongside each
6646: other. Hence, any changes to these variables after bootstrap will
6647: necessitate rebuilding all packages depending on one whose preference
6648: has been changed. This is not trivial and should be avoided.</p>
6649: <p>When using pkgsrc on Linux systems, there is high risk of
6650: "leakage", where programs installed by pkgsrc may inadvertently use a
6651: command or library not installed by pkgsrc, e.g. those installed by
6652: yum or apt. Such foreign dependencies may be installed, removed, or
6653: upgraded to a version incompatible with the pkgsrc package at any
6654: time, causing pkgsrc packages to subsequently malfunction. Pkgsrc
6655: cannot prevent this, as it has no control over other package managers.
6656: Another potential problem is that under Redhat Enterprise and related
6657: Linux systems, yum packages are only patched and never upgraded, so
6658: eventually they may become too outdated for use by pkgsrc. Even
6659: intentionally using foreign dependencies, not considered leakage, can
6660: lead to these problems, so it is generally discouraged. In order to
6661: minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
6662: This ensures that pkgsrc is aware of any changes to dependency packages
6663: and can rebuild or upgrade the entire dependency tree as needed. This
6664: default can be overridden by setting --prefer-pkgsrc to "no" or a list of
6665: packages, or by setting --prefer-native to "yes".</p>
1.75 rillig 6666: </div>
1.107 rillig 6667: </div>
1.75 rillig 6668: </div>
1.148 asau 6669: <div class="chapter">
1.75 rillig 6670: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 6671: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75 rillig 6672: <div class="toc">
6673: <p><b>Table of Contents</b></p>
1.210 leot 6674: <dl class="toc">
1.299 rillig 6675: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6676: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6677: <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>
6678: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6679: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6680: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6681: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6682: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6683: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75 rillig 6684: </dl>
6685: </div>
1.299 rillig 6686: <p>The <code class="filename">PLIST</code> file contains a package's
6687: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6688: the package (relative to the <code class="filename">${PREFIX}</code>
6689: directory it's been installed in) plus some additional statements
1.322 leot 6690: - see the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.299 rillig 6691: This chapter addresses some issues that need attention when
6692: dealing with the <code class="filename">PLIST</code> file (or files, see
6693: below!).</p>
1.148 asau 6694: <div class="sect1">
1.75 rillig 6695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6696: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6697: <p>Be sure to add a RCS ID line as the first thing in any
6698: <code class="filename">PLIST</code> file you write:</p>
6699: <pre class="programlisting">
6700: @comment $NetBSD $
6701: </pre>
6702: <p>An artificial space has been added between NetBSD and $, this is a
6703: workaround here to prevent CVS expanding to the filename of the guide. When
6704: adding the RCS ID the space should be omitted.</p>
1.75 rillig 6705: </div>
1.148 asau 6706: <div class="sect1">
1.75 rillig 6707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6708: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6709: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6710: to output a PLIST that matches any new files since the package
6711: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6712: more information on this target.</p>
1.75 rillig 6713: </div>
1.148 asau 6714: <div class="sect1">
1.75 rillig 6715: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6716: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6717: </h2></div></div></div>
6718: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6719: of AWK patterns and actions that are used to filter the output of
6720: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6721: scripting you like to it, but be careful with quoting.</p>
6722: <p>For example, to get all files inside the
6723: <code class="filename">libdata/foo</code> directory removed from the
6724: resulting PLIST:</p>
1.88 wiz 6725: <pre class="programlisting">
1.299 rillig 6726: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.100 rillig 6727: </pre>
1.300 wiz 6728: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6729: evaluated after the file list and directory list are sorted.
6730: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6731: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6732: list and directory list are sorted.</p>
1.299 rillig 6733: </div>
6734: <div class="sect1">
6735: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6736: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6737: <p>A number of variables are substituted automatically in
6738: PLISTs when a package is installed on a system. This includes the
6739: following variables:</p>
6740: <div class="variablelist"><dl class="variablelist">
6741: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6742: <dd>
6743: <p>Some packages like emacs and perl embed information
6744: about which architecture they were built on into the
6745: pathnames where they install their files. To handle this
6746: case, PLIST will be preprocessed before actually used, and
6747: the symbol
6748: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6749: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6750: same is done if the string
6751: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6752: PLIST somewhere - use this on packages that have GNU
6753: autoconf-created configure scripts.</p>
6754: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6755: <h3 class="title">Legacy note</h3>
6756: <p>There used to be a symbol
6757: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6758: was replaced by the output of <span class="command"><strong>uname
6759: -m</strong></span>, but that's no longer supported and has
6760: been removed.</p>
6761: </div>
6762: </dd>
6763: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6764: <dd>
6765: <p>Some packages want to embed the OS name and version
6766: into some paths. To do this, use these variables in the
6767: <code class="filename">PLIST</code>:
6768: </p>
6769: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6770: <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>
6771: <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>
6772: <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>
6773: </ul></div>
6774: </dd>
6775: </dl></div>
6776: <p>For a list of values which are replaced by
6777: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6778: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6779: <code class="varname">PLIST_SUBST</code> should help.</p>
6780: <p>If you want to change other variables not listed above, you
6781: can add variables and their expansions to this variable in the
6782: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="12.5. Optional files">Section 12.5, “Optional files”</a>):</p>
1.81 rillig 6783: <pre class="programlisting">
1.299 rillig 6784: PLIST_SUBST+= SOMEVAR="somevalue"
1.100 rillig 6785: </pre>
1.299 rillig 6786: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6787: in the <code class="filename">PLIST</code> with
6788: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6789: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6790: the common case of conditionally including some
6791: <code class="filename">PLIST</code> entries. It can be done by adding
6792: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6793: setting the corresponding <code class="varname">PLIST.foo</code> variable
6794: to <code class="literal">yes</code> if the entry should be included.
6795: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6796: in the <code class="filename">PLIST</code> with either
6797: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6798: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6799: For example, in <code class="filename">Makefile</code>:</p>
1.174 asau 6800: <pre class="programlisting">
1.299 rillig 6801: PLIST_VARS+= foo
6802: .if <em class="replaceable"><code>condition</code></em>
6803: PLIST.foo= yes
6804: .else
1.174 asau 6805: </pre>
1.299 rillig 6806: <p>And then in <code class="filename">PLIST</code>:</p>
1.81 rillig 6807: <pre class="programlisting">
1.299 rillig 6808: @comment $NetBSD $
6809: bin/bar
6810: man/man1/bar.1
6811: ${PLIST.foo}bin/foo
6812: ${PLIST.foo}man/man1/foo.1
6813: ${PLIST.foo}share/bar/foo.data
1.100 rillig 6814: </pre>
1.299 rillig 6815: <p>An artificial space has been added between NetBSD and $, this is a
6816: workaround here to prevent CVS expanding to the filename of the guide. When
1.309 gutterid 6817: adding the RCS ID the space should be omitted.</p>
1.81 rillig 6818: </div>
1.299 rillig 6819: <div class="sect1">
6820: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6821: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6822: <p>Man pages should be installed in compressed form if
6823: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6824: and uncompressed otherwise. To handle this in the
6825: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6826: appended/removed automatically for man pages according to
6827: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6828: or not, see above for details. This modification of the
6829: <code class="filename">PLIST</code> file is done on a copy of it, not
6830: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 6831: </div>
1.148 asau 6832: <div class="sect1">
1.75 rillig 6833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6834: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6835: </h2></div></div></div>
6836: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6837: in generating the binary package, set the variable
6838: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.322 leot 6839: The files are later concatenated using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.299 rillig 6840: important. The default for <code class="varname">PLIST_SRC</code> is
6841: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 6842: </div>
1.148 asau 6843: <div class="sect1">
1.75 rillig 6844: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6845: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6846: <p>Some packages decide to install a different set of files based on
6847: the operating system being used. These differences can be
6848: automatically handled by using the following files:</p>
6849: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6850: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6851: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6852: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6853: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6854: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6855: </ul></div>
1.75 rillig 6856: </div>
1.148 asau 6857: <div class="sect1">
1.75 rillig 6858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6859: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6860: <p>Some packages decide to generate hard-to-guess file names
6861: during installation that are hard to wire down.</p>
6862: <p>In such cases, you can set the
6863: <code class="varname">GENERATE_PLIST</code> variable to shell code
6864: terminated (with a semicolon) that will output PLIST entries which
6865: will be appended to the PLIST</p>
6866: <p>You can find one example in editors/xemacs:</p>
6867: <pre class="programlisting">
6868: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6869: </pre>
6870: <p>which will append something like
6871: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6872: <code class="filename">PLIST</code>.
6873: </p>
1.75 rillig 6874: </div>
1.148 asau 6875: <div class="sect1">
1.75 rillig 6876: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6877: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6878: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6879: multiple (and unrelated) packages install files. These
6880: directories were problematic because you had to add special
6881: tricks in the PLIST to conditionally remove them, or have some
6882: centralized package handle them.</p>
6883: <p>In pkgsrc, it is now easy: Each package should create
6884: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6885: will remove any directories left empty after uninstalling a
6886: package.</p>
6887: <p>If a package needs an empty directory to work, create
6888: the directory during installation as usual, and also add an
6889: entry to the PLIST:
6890:
6891: </p>
6892: <pre class="programlisting">
6893: @pkgdir path/to/empty/directory
6894: </pre>
6895: <p>
6896:
6897: or take a look at <code class="varname">MAKE_DIRS</code> and
6898: <code class="varname">OWN_DIRS</code>.
1.88 wiz 6899: </p>
1.75 rillig 6900: </div>
1.299 rillig 6901: </div>
6902: <div class="chapter">
6903: <div class="titlepage"><div><div><h2 class="title">
6904: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6905: <div class="toc">
6906: <p><b>Table of Contents</b></p>
6907: <dl class="toc">
6908: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6909: <dd><dl>
6910: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6911: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6912: </dl></dd>
6913: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6914: <dd><dl>
6915: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6916: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
6917: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
6918: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
6919: </dl></dd>
6920: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6921: <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>
6922: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6923: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6924: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6925: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6926: <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>
6927: </dl>
6928: </div>
6929: <p>This chapter describes the framework known as
6930: <code class="literal">pkginstall</code>, whose key features are:</p>
6931: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6932: <li class="listitem"><p>Generic installation and manipulation of directories and files
6933: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6934: <li class="listitem"><p>Automatic handling of configuration files during installation,
6935: provided that packages are correctly designed.</p></li>
6936: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6937: <li class="listitem"><p>Registration of system users and groups.</p></li>
6938: <li class="listitem"><p>Registration of system shells.</p></li>
6939: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6940: </ul></div>
6941: <p>The following sections inspect each of the above points in detail.</p>
6942: <p>You may be thinking that many of the things described here could be
6943: easily done with simple code in the package's post-installation target
6944: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6945: as the code in them is only executed when building from source. Machines
6946: using binary packages could not benefit from it at all (as the code itself
6947: could be unavailable). Therefore, the only way to achieve any of the items
6948: described above is by means of the installation scripts, which are
6949: automatically generated by pkginstall.</p>
1.148 asau 6950: <div class="sect1">
1.75 rillig 6951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6952: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6953: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6954: of files and directories that belong to a package. The names used in it
6955: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6956: which means that it cannot register files outside this directory (absolute
6957: path names are not allowed). Despite this restriction, some packages need
6958: to install files outside this location; e.g., under
6959: <code class="filename">${VARBASE}</code> or
6960: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6961: is to create such files during installation time by using
6962: installation scripts.</p>
6963: <p>The generic installation scripts are shell scripts that can
6964: contain arbitrary code. The list of scripts to execute is taken from
6965: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6966: <code class="filename">INSTALL</code>. A similar variable exists for package
6967: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6968: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6969: commands, so they have the potential to create and manage files
6970: anywhere in the file system.</p>
6971: <p>Using these general installation files is not recommended, but
6972: may be needed in some special cases. One reason for avoiding them is
6973: that the user has to trust the packager that there is no unwanted or
6974: simply erroneous code included in the installation script. Also,
6975: previously there were many similar scripts for the same functionality,
6976: and fixing a common error involved finding and changing all of
6977: them.</p>
6978: <p>The pkginstall framework offers another, standardized way. It
6979: provides generic scripts to abstract the manipulation of such files
6980: and directories based on variables set in the package's
6981: <code class="filename">Makefile</code>. The rest of this section describes
6982: these variables.</p>
6983: <div class="sect2">
6984: <div class="titlepage"><div><div><h3 class="title">
6985: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
6986: <p>The following variables can be set to request the creation of
6987: directories anywhere in the file system:</p>
6988: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6989: <li class="listitem">
6990: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
6991: contain a list of directories that should be created and should attempt
6992: to be destroyed by the installation scripts. The difference between
6993: the two is that the latter prompts the administrator to remove any
6994: directories that may be left after deinstallation (because they were
6995: not empty), while the former does not. Example:</p>
6996: <pre class="programlisting">
6997: MAKE_DIRS+= ${VARBASE}/foo/private
6998: </pre>
6999: </li>
7000: <li class="listitem">
7001: <p><code class="varname">MAKE_DIRS_PERMS</code> and
7002: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
7003: which directories should be created and should attempt to be destroyed
7004: by the installation scripts. Each tuple holds the following values,
7005: separated by spaces: the directory name, its owner, its group and its
7006: numerical mode. For example:</p>
7007: <pre class="programlisting">
7008: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
7009: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
7010: </pre>
7011: <p>The difference between the two is exactly the same as their
7012: non-<code class="varname">PERMS</code> counterparts.</p>
7013: </li>
7014: </ul></div>
1.75 rillig 7015: </div>
1.299 rillig 7016: <div class="sect2">
7017: <div class="titlepage"><div><div><h3 class="title">
7018: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
7019: <p>Creating non-empty files outside the installation prefix is tricky
7020: because the <code class="filename">PLIST</code> forces all files to be inside it.
7021: To overcome this problem, the only solution is to extract the file in the
7022: known place (i.e., inside the installation prefix) and copy it to the
7023: appropriate location during installation (done by the installation scripts
7024: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
7025: file</em></span> in the following paragraphs, which describe the variables
7026: that can be used to automatically and consistently handle files outside the
7027: installation prefix:</p>
7028: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7029: <li class="listitem">
7030: <p><code class="varname">CONF_FILES</code> and
7031: <code class="varname">REQD_FILES</code> are pairs of master and target files.
7032: During installation time, the master file is copied to the target one
7033: if and only if the latter does not exist. Upon deinstallation, the
7034: target file is removed provided that it was not modified by the
7035: installation.</p>
7036: <p>The difference between the two is that the latter prompts the
7037: administrator to remove any files that may be left after
7038: deinstallation (because they were not empty), while the former does
7039: not.</p>
7040: </li>
7041: <li class="listitem">
7042: <p><code class="varname">CONF_FILES_PERMS</code> and
7043: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
7044: files as well as their target locations. For each of them, it also
7045: specifies their owner, their group and their numeric permissions, in
7046: this order. For example:</p>
1.88 wiz 7047: <pre class="programlisting">
1.299 rillig 7048: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
7049: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100 rillig 7050: </pre>
1.299 rillig 7051: <p>The difference between the two is exactly the same as their
7052: non-<code class="varname">PERMS</code> counterparts.</p>
7053: </li>
7054: </ul></div>
7055: </div>
1.75 rillig 7056: </div>
1.148 asau 7057: <div class="sect1">
1.75 rillig 7058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7059: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
7060: <p>Configuration files are special in the sense that they are installed
7061: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
7062: need special treatment during installation (most of which is automated by
7063: pkginstall). The main concept you must bear in mind is that files marked
7064: as configuration files are automatically copied to the right place (somewhere
7065: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
7066: and only if</em></span> they didn't exist before. Similarly, they will not
7067: be removed if they have local modifications. This ensures that
7068: administrators never lose any custom changes they may have made.</p>
7069: <div class="sect2">
7070: <div class="titlepage"><div><div><h3 class="title">
7071: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7072: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7073: specifies where configuration files shall be installed. Its contents are
7074: set based upon the following variables:</p>
7075: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7076: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7077: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
7078: be overridden by the user to point to his preferred location (e.g.,
7079: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7080: Packages must not use it directly.</p></li>
7081: <li class="listitem">
7082: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7083: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7084: for the package being built shall be installed. The definition of this
7085: variable only makes sense in the package's
7086: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7087: <p>As an example, consider the Apache package,
1.322 leot 7088: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.299 rillig 7089: configuration files under the
7090: <code class="filename">httpd/</code> subdirectory of
7091: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7092: Makefile.</p>
7093: </li>
7094: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7095: variable that holds this package's configuration directory (if
7096: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7097: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7098: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7099: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7100: directory where the configuration files for the package identified by
7101: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7102: </ul></div>
7103: <p>Based on the above variables, pkginstall determines the value of
7104: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
7105: variable that can be used within a package to refer to its configuration
7106: directory. The algorithm used to set its value is basically the
7107: following:</p>
7108: <div class="orderedlist"><ol class="orderedlist" type="1">
7109: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7110: its value is used.</p></li>
7111: <li class="listitem"><p>If the previous variable is not defined but
7112: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7113: <code class="filename">Makefile</code>, the resulting value is
7114: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7115: <li class="listitem"><p>Otherwise, it is set to
7116: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7117: </ol></div>
7118: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
7119: automatically added to <code class="filename">OWN_DIRS</code>. See <a class="xref" href="#dirs-outside-prefix" title="20.1.1. Directory manipulation">Section 20.1.1, “Directory manipulation”</a> what this means. This does not apply to
7120: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
7121: be created with OWN_DIRS or MAKE_DIRS.</p>
7122: </div>
7123: <div class="sect2">
7124: <div class="titlepage"><div><div><h3 class="title">
7125: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7126: <p>Given that pkgsrc (and users!) expect configuration files to be in a
7127: known place, you need to teach each package where it shall install its
7128: files. In some cases you will have to patch the package Makefiles to
7129: achieve it. If you are lucky, though, it may be as easy as passing an
7130: extra flag to the configuration script; this is the case of GNU Autoconf-
7131: generated files:</p>
1.75 rillig 7132: <pre class="programlisting">
1.299 rillig 7133: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100 rillig 7134: </pre>
1.299 rillig 7135: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
7136: for</em></span> its configuration files, not where they will be originally
7137: installed (although the difference is never explicit,
7138: unfortunately).</p>
1.75 rillig 7139: </div>
1.299 rillig 7140: <div class="sect2">
7141: <div class="titlepage"><div><div><h3 class="title">
7142: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
7143: <p>As said before, pkginstall automatically handles configuration files.
7144: This means that <span class="strong"><strong>the packages themselves must not
7145: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7146: directly</strong></span>. Bad news is that many software installation scripts
7147: will, out of the box, mess with the contents of that directory. So what is
7148: the correct procedure to fix this issue?</p>
7149: <p>You must teach the package (usually by manually patching it) to
7150: install any configuration files under the examples hierarchy,
7151: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7152: <code class="filename">PLIST</code> registers them and the administrator always
7153: has the original copies available.</p>
7154: <p>Once the required configuration files are in place (i.e., under the
7155: examples hierarchy), the pkginstall framework can use them as master copies
7156: during the package installation to update what is in
7157: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7158: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
7159: used. Check out <a class="xref" href="#files-outside-prefix" title="20.1.2. File manipulation">Section 20.1.2, “File manipulation”</a> for information
7160: about their syntax and their purpose. Here is an example, taken from the
1.322 leot 7161: <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>
1.88 wiz 7162: <pre class="programlisting">
1.299 rillig 7163: EGDIR= ${PREFIX}/share/doc/mutt/samples
7164: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.100 rillig 7165: </pre>
1.299 rillig 7166: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
7167: package and has no meaning outside it.</p>
1.75 rillig 7168: </div>
1.299 rillig 7169: <div class="sect2">
7170: <div class="titlepage"><div><div><h3 class="title">
7171: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
7172: <p>The automatic copying of config files can be toggled by setting the
7173: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7174: installation.</p>
1.88 wiz 7175: </div>
1.75 rillig 7176: </div>
1.148 asau 7177: <div class="sect1">
1.75 rillig 7178: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7179: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7180: <p>System startup scripts are special files because they must be
7181: installed in a place known by the underlying OS, usually outside the
7182: 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
7183: can be used. However, pkginstall provides a special mechanism to handle
7184: these files.</p>
7185: <p>In order to provide system startup scripts, the package has
7186: to:</p>
7187: <div class="orderedlist"><ol class="orderedlist" type="1">
7188: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7189: the <code class="literal">.sh</code> suffix appended. Considering the
1.338 nia 7190: <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
7191: has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.299 rillig 7192: <li class="listitem">
7193: <p>Tell pkginstall to handle it, appending the name of the script,
7194: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7195: Continuing the previous example:</p>
7196: <pre class="programlisting">
7197: RCD_SCRIPTS+= cupsd
7198: </pre>
7199: </li>
7200: </ol></div>
7201: <p>Once this is done, pkginstall will do the following steps for each
7202: script in an automated fashion:</p>
7203: <div class="orderedlist"><ol class="orderedlist" type="1">
7204: <li class="listitem"><p>Process the file found in the files directory applying all the
7205: substitutions described in the <code class="filename">FILES_SUBST</code>
7206: variable.</p></li>
7207: <li class="listitem"><p>Copy the script from the files directory to the examples
7208: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
7209: that this master file must be explicitly registered in the
7210: <code class="filename">PLIST</code>.</p></li>
7211: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7212: from the examples hierarchy into the system-wide startup scripts
7213: directory.</p></li>
7214: </ol></div>
7215: <div class="sect2">
7216: <div class="titlepage"><div><div><h3 class="title">
7217: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7218: <p>The automatic copying of config files can be toggled by setting the
7219: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7220: installation. Note that the scripts will be always copied inside the
7221: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7222: matter what the value of this variable is.</p>
1.75 rillig 7223: </div>
7224: </div>
1.299 rillig 7225: <div class="sect1">
7226: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7227: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7228: <p>If a package needs to create special users and/or groups during
7229: installation, it can do so by using the pkginstall framework.</p>
7230: <p>Users can be created by adding entries to the
7231: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7232: syntax:</p>
7233: <pre class="programlisting">
7234: user:group
7235: </pre>
7236: <p>Further specification of user details may be done by setting
7237: per-user variables.
7238: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7239: numeric UID for the user.
7240: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7241: user's description or comment.
7242: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7243: user's home directory, and defaults to
7244: <code class="filename">/nonexistent</code> if not specified.
7245: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7246: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7247: not specified.</p>
7248: <p>Similarly, groups can be created by adding entries to the
7249: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7250: <pre class="programlisting">
7251: group
7252: </pre>
7253: <p>The numeric GID of the group may be set by defining
7254: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7255: <p>If a package needs to create the users and groups at an earlier
7256: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7257: <code class="literal">configure</code>,<code class="literal">build</code>, or
7258: <code class="literal">pre-install</code> to indicate the phase before which the
7259: users and groups are created. In this case, the numeric UIDs and GIDs
7260: of the created users and groups are automatically hardcoded into the
7261: final installation scripts.</p>
1.75 rillig 7262: </div>
1.148 asau 7263: <div class="sect1">
1.75 rillig 7264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7265: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7266: <p>Packages that install system shells should register them in the shell
7267: database, <code class="filename">/etc/shells</code>, to make things easier to the
7268: administrator. This must be done from the installation scripts to keep
7269: binary packages working on any system. pkginstall provides an easy way to
7270: accomplish this task.</p>
7271: <p>When a package provides a shell interpreter, it has to set the
7272: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7273: add some hooks to the installation scripts to handle it. Consider the
1.322 leot 7274: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/index.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.299 rillig 7275: <pre class="programlisting">
7276: PKG_SHELL= ${PREFIX}/bin/zsh
7277: </pre>
7278: <div class="sect2">
7279: <div class="titlepage"><div><div><h3 class="title">
7280: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7281: <p>The automatic registration of shell interpreters can be disabled by
7282: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7283: environment variable to <code class="literal">NO</code>.</p>
7284: </div>
1.75 rillig 7285: </div>
1.148 asau 7286: <div class="sect1">
1.75 rillig 7287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7288: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7289: <p>Packages that install X11 fonts should update the database files
7290: that index the fonts within each fonts directory. This can easily be
7291: accomplished within the pkginstall framework.</p>
7292: <p>When a package installs X11 fonts, it must list the directories in
7293: which fonts are installed in the
7294: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7295: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7296: <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
7297: installation scripts to run the appropriate commands to update the fonts
7298: database files within each of those directories. For convenience, if the
7299: directory path is relative, it is taken to be relative to the package's
1.322 leot 7300: installation prefix. Consider the following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/index.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75 rillig 7301: <pre class="programlisting">
1.299 rillig 7302: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75 rillig 7303: </pre>
1.299 rillig 7304: <div class="sect2">
7305: <div class="titlepage"><div><div><h3 class="title">
7306: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7307: <p>The automatic update of fonts databases can be disabled by
7308: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7309: environment variable to <code class="literal">NO</code>.</p>
1.75 rillig 7310: </div>
7311: </div>
7312: </div>
1.148 asau 7313: <div class="chapter">
1.75 rillig 7314: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 7315: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75 rillig 7316: <div class="toc">
7317: <p><b>Table of Contents</b></p>
1.210 leot 7318: <dl class="toc">
1.267 rillig 7319: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75 rillig 7320: <dd><dl>
1.267 rillig 7321: <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>
7322: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7323: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7324: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7325: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7326: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7327: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7328: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7329: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7330: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7331: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7332: </dl></dd>
7333: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7334: <dd><dl>
7335: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7336: <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>
7337: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7338: </dl></dd>
7339: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7340: <dd><dl>
7341: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7342: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7343: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.338 nia 7344: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.267 rillig 7345: </dl></dd>
7346: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7347: <dd><dl>
7348: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7349: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 7350: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.338 nia 7351: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
7352: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
7353: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
7354: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.267 rillig 7355: </dl></dd>
7356: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7357: <dd><dl>
7358: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7359: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 7360: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7361: <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>
7362: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 7363: </dl></dd>
7364: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7365: <dd><dl>
7366: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7367: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7368: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7369: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7370: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 7371: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 7372: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
7373: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 7374: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
7375: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
7376: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
7377: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
7378: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
7379: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
7380: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 7381: emulation</a></span></dt>
1.318 nia 7382: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
7383: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.75 rillig 7384: </dl></dd>
1.267 rillig 7385: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7386: </dl>
7387: </div>
1.148 asau 7388: <div class="sect1">
1.75 rillig 7389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 7390: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78 rillig 7391: <p>One appealing feature of pkgsrc is that it runs on many
1.218 rillig 7392: different platforms. As a result, it is important to ensure,
7393: where possible, that packages in pkgsrc are portable. This
7394: chapter mentions some particular details you should pay
7395: attention to while working on pkgsrc.</p>
1.148 asau 7396: <div class="sect2">
1.78 rillig 7397: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7398: <a name="pulling-vars-from-etc-mk.conf"></a>21.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93 rillig 7399: </h3></div></div></div>
1.78 rillig 7400: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7401: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7402: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7403: want to use those variables in the preprocessor directives of
1.322 leot 7404: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87 wiz 7405: <code class="literal">.for</code>), you need to include the file
7406: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7407: loads the user preferences.</p>
1.78 rillig 7408: <p>But note that some variables may not be completely defined
1.219 rillig 7409: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7410: included, as they may contain references to variables that are
7411: not yet defined. In shell commands (the lines in
7412: <code class="filename">Makefile</code> that are indented with a tab) this
7413: is no problem, since variables are only expanded when they are
7414: used. But in the preprocessor directives mentioned above and in
7415: dependency lines (of the form <code class="literal">target:
7416: dependencies</code>) the variables are expanded at load
7417: time.</p>
1.148 asau 7418: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7419: <h3 class="title">Note</h3>
1.218 rillig 7420: <p>To check whether a variable can be used at load time,
7421: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78 rillig 7422: </div>
7423: </div>
1.148 asau 7424: <div class="sect2">
1.78 rillig 7425: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7426: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88 wiz 7427: <p>Occasionally, packages require interaction from the user,
7428: and this can be in a number of ways:</p>
1.148 asau 7429: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7430: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7431: interaction such as entering username/password or accepting a
7432: license on a web page.</p></li>
1.128 wiz 7433: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7434: passwords.</p></li>
1.128 wiz 7435: <li class="listitem"><p>help to configure the package before it is built</p></li>
7436: <li class="listitem"><p>help during the build process</p></li>
7437: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7438: </ul></div>
1.218 rillig 7439: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7440: variable to define which stages need interaction. This should be
7441: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7442: <pre class="programlisting">
1.100 rillig 7443: INTERACTIVE_STAGE= configure install
1.222 sevan 7444: </pre>
1.88 wiz 7445: <p>The user can then decide to skip this package by setting the
1.218 rillig 7446: <code class="varname">BATCH</code> variable. Packages that require interaction
7447: are also excluded from bulk builds.</p>
1.75 rillig 7448: </div>
1.148 asau 7449: <div class="sect2">
1.75 rillig 7450: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7451: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222 sevan 7452: <p>Authors of software can choose the licence under which software
7453: can be copied. The Free Software Foundation has declared some
7454: licenses "Free", and the Open Source Initiative has a definition of
7455: "Open Source".</p>
7456: <p>By default, pkgsrc allows packages with Free or Open Source
7457: licenses to be built. To allow packages with other licenses to be
7458: built as well, the pkgsrc user needs to add these licenses to the
7459: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7460: that this variable only affects which packages may be
7461: <span class="emphasis"><em>built</em></span>, while the license terms often also
7462: restrict the actual use of the package and its redistribution.</p>
1.98 wiz 7463: <p>One might want to only install packages with a BSD license,
1.218 rillig 7464: or the GPL, and not the other. The free licenses are added to the
1.222 sevan 7465: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.121 jnemeth 7466: user can override the default by setting the
7467: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222 sevan 7468: of "+=". The licenses accepted by default are defined in the
7469: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7470: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78 rillig 7471: <p>The license tag mechanism is intended to address
1.87 wiz 7472: copyright-related issues surrounding building, installing and
7473: using a package, and not to address redistribution issues (see
7474: <code class="varname">RESTRICTED</code> and
1.222 sevan 7475: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121 jnemeth 7476: Packages with redistribution restrictions should set these
7477: tags.</p>
1.98 wiz 7478: <p>Denoting that a package may be copied according to a
7479: particular license is done by placing the license in
1.87 wiz 7480: <code class="filename">pkgsrc/licenses</code> and setting the
7481: <code class="varname">LICENSE</code> variable to a string identifying the
1.322 leot 7482: license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/index.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87 wiz 7483: <pre class="programlisting">
1.100 rillig 7484: LICENSE= xv-license
1.222 sevan 7485: </pre>
1.87 wiz 7486: <p>When trying to build, the user will get a notice that the
1.98 wiz 7487: package is covered by a license which has not been placed in the
7488: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7489: <pre class="programlisting">
1.100 rillig 7490: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7491: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7492: ===> To view the license, enter "/usr/bin/make show-license".
7493: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7494: ===> ACCEPTABLE_LICENSES+=xv-license
7495: *** Error code 1
1.222 sevan 7496: </pre>
1.110 hubertf 7497: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7498: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7499: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7500: convey to pkgsrc that it should not in the future fail because of
7501: that license:</p>
1.78 rillig 7502: <pre class="programlisting">
1.100 rillig 7503: ACCEPTABLE_LICENSES+=xv-license
1.222 sevan 7504: </pre>
7505: <p>The use of <code class="varname">LICENSE=shareware</code>,
7506: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7507: is deprecated because it does not crisply refer to a particular
7508: license text. Another problem with such usage is that it does not
7509: enable a user to tell pkgsrc to proceed for a single package
7510: without also telling pkgsrc to proceed for all packages with that
7511: tag.</p>
7512: <div class="sect3">
7513: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7514: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154 rodent 7515: <p>When adding a package with a new license, the following steps
7516: are required:</p>
7517: <div class="orderedlist"><ol class="orderedlist" type="1">
7518: <li class="listitem">
1.284 rillig 7519: <p>Check whether the license qualifies as Free or Open Source by
7520: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7521: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222 sevan 7522: Open Source Initiative</a>. If this is the case, the filename in
7523: <code class="filename">pkgsrc/licenses/</code> does not need the
7524: <code class="filename">-license</code> suffix, and the license name should be
7525: added to:</p>
1.154 rodent 7526: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7527: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7528: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7529: <li class="listitem"><p>default_acceptable_licenses in
7530: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154 rodent 7531: </ul></div>
7532: </li>
1.284 rillig 7533: <li class="listitem"><p>The license text should be added to
7534: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7535: licenses can be seen in this directory.</p></li>
1.154 rodent 7536: </ol></div>
1.222 sevan 7537: </div>
7538: <div class="sect3">
7539: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7540: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98 wiz 7541: <p>When the license changes (in a way other than formatting),
1.222 sevan 7542: make sure that the new license has a different name (e.g.,
1.98 wiz 7543: append the version number if it exists, or the date). Just
7544: because a user told pkgsrc to build programs under a previous
7545: version of a license does not mean that pkgsrc should build
1.99 rillig 7546: programs under the new licenses. The higher-level point is that
1.98 wiz 7547: pkgsrc does not evaluate licenses for reasonableness; the only
7548: test is a mechanistic test of whether a particular text has been
1.222 sevan 7549: approved by either of two bodies (FSF or OSI).</p>
7550: </div>
1.75 rillig 7551: </div>
1.148 asau 7552: <div class="sect2">
1.75 rillig 7553: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7554: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75 rillig 7555: <p>Some licenses restrict how software may be re-distributed.
1.222 sevan 7556: By declaring the restrictions, package tools can
1.98 wiz 7557: automatically refrain from e.g. placing binary packages on FTP
7558: sites.</p>
1.222 sevan 7559: <p>There are four possible restrictions, which are
1.98 wiz 7560: the cross product of sources (distfiles) and binaries not being
7561: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7562: language in any license, and because non-Free licenses tend to be
7563: different from each other, pkgsrc adopts a definition of FTP and
1.222 sevan 7564: CD-ROM.
7565:
7566: "FTP" means making the source or binary file available over the
7567: Internet at no charge.
7568:
7569: "CD-ROM" means making the source or binary available on some kind of
7570: media, together with other source and binary packages, which is sold
7571: for a distribution charge.
1.98 wiz 7572: </p>
7573: <p>In order to encode these restrictions, the package system
1.87 wiz 7574: defines five make variables that can be set to note these
7575: restrictions:</p>
1.148 asau 7576: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7577: <li class="listitem">
1.75 rillig 7578: <p><code class="varname">RESTRICTED</code></p>
7579: <p>This variable should be set whenever a restriction
1.87 wiz 7580: exists (regardless of its kind). Set this variable to a
1.98 wiz 7581: string containing the reason for the restriction. It should
7582: be understood that those wanting to understand the restriction
7583: will have to read the license, and perhaps seek advice of
7584: counsel.</p>
1.75 rillig 7585: </li>
1.128 wiz 7586: <li class="listitem">
1.75 rillig 7587: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7588: <p>Binaries may not be placed on CD-ROM containing other
7589: binary packages, for which a distribution charge may be made.
7590: In this case, set this variable to
7591: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7592: </li>
1.128 wiz 7593: <li class="listitem">
1.75 rillig 7594: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7595: <p>Binaries may not made available on the Internet without
7596: charge. In this case, set this variable to
7597: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7598: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7599: </li>
1.128 wiz 7600: <li class="listitem">
1.75 rillig 7601: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7602: <p>Distfiles may not be placed on CD-ROM, together with
7603: other distfiles, for which a fee may be charged. In this
7604: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7605: </p>
1.75 rillig 7606: </li>
1.128 wiz 7607: <li class="listitem">
1.75 rillig 7608: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7609: <p>Distfiles may not made available via FTP at no charge.
7610: In this case, set this variable to
7611: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7612: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7613: </li>
7614: </ul></div>
1.222 sevan 7615: <p>Please note that packages will be removed from pkgsrc when the
7616: distfiles are not distributable and cannot be obtained for a period
7617: of one full quarter branch. Packages with manual/interactive fetch
7618: must have a maintainer and it is his/her responsibility to ensure
7619: this.</p>
1.75 rillig 7620: </div>
1.148 asau 7621: <div class="sect2">
1.75 rillig 7622: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7623: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290 gutterid 7624: <p>Your package may depend on some other package being present,
7625: and there are various ways of expressing this dependency.
7626: pkgsrc supports the <code class="varname">DEPENDS</code>,
7627: <code class="varname">BUILD_DEPENDS</code>,
7628: <code class="varname">TOOL_DEPENDS</code>, and
7629: <code class="varname">TEST_DEPENDS</code> definitions, the
1.88 wiz 7630: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7631: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7632: to handle dependencies, and which uses the variables named above.
1.299 rillig 7633: See <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a> for more information.</p>
1.290 gutterid 7634: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7635: definition registers that pre-requisite in the binary package so it
7636: will be pulled in when the binary package is later installed, whilst
7637: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7638: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7639: dependency that is only needed for building or testing the resulting
1.299 rillig 7640: package. See also <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> for more information.</p>
1.75 rillig 7641: <p>This means that if you only need a package present whilst
1.290 gutterid 7642: you are building or testing, it should be noted as a
7643: <code class="varname">TOOL_DEPENDS</code>,
7644: <code class="varname">BUILD_DEPENDS</code>, or
7645: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.269 leot 7646: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7647: packages, i.e. packages for the architecture where the package
7648: is built;
7649: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290 gutterid 7650: packages, i.e., packages for the architecture for which the package
1.269 leot 7651: is built.</p>
1.290 gutterid 7652: <p>The format for a <code class="varname">DEPENDS</code>,
7653: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7654: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75 rillig 7655: <pre class="programlisting">
1.100 rillig 7656: <pre-req-package-name>:../../<category>/<pre-req-package>
1.222 sevan 7657: </pre>
1.128 wiz 7658: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7659: may include any of the wildcard version numbers recognized by
1.322 leot 7660: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128 wiz 7661: <div class="orderedlist"><ol class="orderedlist" type="1">
7662: <li class="listitem">
1.75 rillig 7663: <p>If your package needs another package's binaries or
1.160 wiz 7664: libraries to build and run, and if that package has a
1.87 wiz 7665: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7666: <pre class="programlisting">
1.100 rillig 7667: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7668: </pre>
1.75 rillig 7669: </li>
1.128 wiz 7670: <li class="listitem">
1.160 wiz 7671: <p>If your package needs another package's binaries or
7672: libraries only for building, and if that package has a
7673: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7674: <pre class="programlisting">
7675: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7676: </pre>
1.160 wiz 7677: <p>but set
7678: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7679: to make it a build dependency only. This case is rather
7680: rare.</p>
7681: </li>
7682: <li class="listitem">
1.132 spz 7683: <p>If your package needs binaries from another package to build,
1.269 leot 7684: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75 rillig 7685: <pre class="programlisting">
1.269 leot 7686: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222 sevan 7687: </pre>
1.75 rillig 7688: </li>
1.269 leot 7689: <li class="listitem"><p>If your package needs static libraries to link against, header
7690: files to include, etc. from another package to build,
7691: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132 spz 7692: <li class="listitem"><p>If your package needs a library with which to link and
7693: there is no <code class="filename">buildlink3.mk</code> file
7694: available, create one. Using
7695: <code class="varname">DEPENDS</code> won't be sufficient because the
7696: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7697: <li class="listitem">
1.132 spz 7698: <p>If your package needs some executable to be able to run
7699: correctly and if there's no
7700: <code class="filename">buildlink3.mk</code> file, this is specified
7701: using the <code class="varname">DEPENDS</code> variable. The
1.322 leot 7702: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/index.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.242 wiz 7703: be able to execute the latex binary from the tex-latex-bin package
1.132 spz 7704: when it runs, and that is specified:</p>
1.75 rillig 7705: <pre class="programlisting">
1.242 wiz 7706: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222 sevan 7707: </pre>
1.132 spz 7708: </li>
1.290 gutterid 7709: <li class="listitem"><p>If your package includes a test suite that has extra
7710: dependencies only required for this purpose (frequently this
7711: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7712: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132 spz 7713: <li class="listitem">
7714: <p>You can use wildcards in package dependencies. Note that
7715: such wildcard dependencies are retained when creating binary
7716: packages. The dependency is checked when installing the binary
7717: package and any package which matches the pattern will be
7718: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7719: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7720: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7721: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7722: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7723: <p>Wildcards can also be used to specify that a package
1.87 wiz 7724: will only build against a certain minimum version of a
7725: pre-requisite:</p>
1.75 rillig 7726: <pre class="programlisting">
1.132 spz 7727: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.222 sevan 7728: </pre>
1.132 spz 7729: <p>This means that the package will build using version 6.0
7730: of ImageMagick or newer. Such a dependency may be warranted
7731: if, for example, the command line options of an executable
7732: have changed.</p>
7733: <p>If you need to depend on minimum versions of libraries,
1.298 wiz 7734: set
7735: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7736: to the appropriate pattern before including its
7737: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7738: <pre class="programlisting">
7739: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7740: .include "../../graphics/jpeg/buildlink3.mk"
7741: </pre>
1.75 rillig 7742: <p>For security fixes, please update the package
1.267 rillig 7743: vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, “Handling packages with security problems”</a> for more
1.87 wiz 7744: information.</p>
1.75 rillig 7745: </li>
7746: </ol></div>
7747: <p>If your package needs files from another package to build,
1.87 wiz 7748: add the relevant distribution files to
7749: <code class="varname">DISTFILES</code>, so they will be extracted
1.322 leot 7750: automatically. See the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/index.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87 wiz 7751: (It relies on the jpeg sources being present in source form
7752: during the build.)</p>
1.75 rillig 7753: </div>
1.148 asau 7754: <div class="sect2">
1.75 rillig 7755: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7756: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.341 gutterid 7757: <p>Your package may conflict with other packages users might
7758: already have installed on their system, e.g., if your package
1.88 wiz 7759: installs the same set of files as another package in the pkgsrc
1.342 wiz 7760: tree.</p>
1.322 leot 7761: <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>
7762: and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/index.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.255 leot 7763: install the same shared library, thus you set in
7764: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7765: <pre class="programlisting">
7766: CONFLICTS= Xaw-Xpm-[0-9]*
7767: </pre>
7768: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7769: <pre class="programlisting">
7770: CONFLICTS= libXaw3d-[0-9]*
7771: </pre>
1.322 leot 7772: <p><a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255 leot 7773: that conflict with existing packages and abort. However, in many
7774: situations this is too late in the process. Binary package managers
7775: will not know about the conflict until they attempt to install the
7776: package after already downloading it and all its dependencies.
7777: Users may also waste time building a package and its dependencies
7778: only to find out at the end that it conflicts with another package
7779: they have installed.</p>
7780: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7781: should be added in all cases where it is known that packages conflict
7782: with each other. These <code class="varname">CONFLICTS</code> entries are
1.322 leot 7783: exported in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255 leot 7784: managers to inform users that packages cannot be installed onto
7785: the target system.</p>
1.75 rillig 7786: </div>
1.148 asau 7787: <div class="sect2">
1.75 rillig 7788: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7789: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7790: <p>There are several reasons why a package might be
1.88 wiz 7791: instructed to not build under certain circumstances. If the
1.87 wiz 7792: package builds and runs on most platforms, the exceptions
1.193 dholland 7793: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7794: the package builds and runs on a small handful of platforms,
7795: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7796: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7797: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7798: (OS-version-platform) that can use glob-style
7799: wildcards.</p>
7800: <p>If a package is not appropriate for some platforms (as
1.225 maya 7801: opposed to merely broken), a different set of variables should be
1.193 dholland 7802: used as this affects failure reporting and statistics.
7803: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7804: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 dholland 7805: the package is appropriate for only a small handful of platforms
7806: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7807: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7808: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7809: (OS-version-platform) that can use glob-style
7810: wildcards.</p>
1.88 wiz 7811: <p>Some packages are tightly bound to a specific version of an
1.322 leot 7812: operating system, e.g. LKMs or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/index.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
1.88 wiz 7813: backwards compatible with other versions of the OS, and should be
7814: uploaded to a version specific directory on the FTP server. Mark
7815: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7816: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7817: the package system internals, but may be used in the
7818: future.</p>
1.75 rillig 7819: <p>If the package should be skipped (for example, because it
1.87 wiz 7820: provides functionality already provided by the system), set
1.88 wiz 7821: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7822: the package should fail because some preconditions are not met,
7823: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7824: message.</p>
1.75 rillig 7825: </div>
1.148 asau 7826: <div class="sect2">
1.75 rillig 7827: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7828: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7829: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7830: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7831: be set in the package Makefile. This will be carried into any
7832: binary package that is made from this pkgsrc entry. A
1.128 wiz 7833: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.322 leot 7834: not be deleted using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128 wiz 7835: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7836: </div>
1.148 asau 7837: <div class="sect2">
1.75 rillig 7838: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7839: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7840: <p>When a vulnerability is found, this should be noted in
1.320 wiz 7841: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>.
7842: Entries in that file consist of three parts:</p>
7843: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7844: <li class="listitem"><p>package version pattern</p></li>
7845: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
7846: <li class="listitem"><p>URL providing additional information about the issue</p></li>
7847: </ul></div>
7848: <p>For the package version pattern please always use `<' to
7849: mark an upper bound (not `<='!). This will avoid possible
7850: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
7851: related to security fixes. Lower bounds can be added too, using
7852: '>' or '>='. For example,
1.321 wiz 7853: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.320 wiz 7854: versions 1.0 (included) to 1.2 (excluded) of
7855: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
7856: issue.</p>
7857: <p>Entries should always be added at the bottom of the file.</p>
7858: <p>When fixing packages, please modify the upper bound of the
7859: corresponding entry. To continue the previous example, if a fix
7860: was backported to version 1.1nb2, change the previous pattern to
1.321 wiz 7861: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.320 wiz 7862: <p>To locally test a package version pattern against a
7863: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
7864: pmatch</strong></span> command.</p>
7865: <p>The URL should be as permanent as possible and provide as
7866: much information about the issue as possible. CVE entries are
7867: preferred.</p>
7868: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.138 wiz 7869: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7870: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7871: <code class="varname">PKGREVISION</code> should be increased (this is of
7872: course not necessary if the problem is fixed by using a newer
7873: release of the software), and the pattern in the
7874: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7875: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7876: branch, be sure to submit a pullup request!</p>
1.75 rillig 7877: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7878: semi-automatically by a weekly cron job.</p>
1.320 wiz 7879: <p>In case a security issue is disputed, please contact
7880: pkgsrc-security@NetBSD.org.</p>
1.75 rillig 7881: </div>
1.148 asau 7882: <div class="sect2">
1.75 rillig 7883: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7884: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75 rillig 7885: <p>When making fixes to an existing package it can be useful
1.87 wiz 7886: to change the version number in <code class="varname">PKGNAME</code>. To
7887: avoid conflicting with future versions by the original author, a
1.128 wiz 7888: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.87 wiz 7889: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7890: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7891: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7892: <pre class="programlisting">
1.100 rillig 7893: DISTNAME= foo-17.42
7894: PKGREVISION= 9
1.222 sevan 7895: </pre>
1.75 rillig 7896: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7897: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7898: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7899: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7900: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7901: <p>When a new release of the package is released, the
1.87 wiz 7902: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7903: minor release of the above package, things should be like:</p>
1.75 rillig 7904: <pre class="programlisting">
1.100 rillig 7905: DISTNAME= foo-17.43
1.222 sevan 7906: </pre>
1.87 wiz 7907: <p><code class="varname">PKGREVISION</code> should be incremented for any
7908: non-trivial change in the resulting binary package. Without a
7909: <code class="varname">PKGREVISION</code> bump, someone with the previous
7910: version installed has no way of knowing that their package is out
7911: of date. Thus, changes without increasing
7912: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7913: trivial that no reasonable person would want to upgrade", and this
7914: is the rough test for when increasing
7915: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7916: changes that do not merit increasing
7917: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 7918: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7919: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284 rillig 7920: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7921: comments in Makefile.</p></li>
7922: <li class="listitem"><p>Changing build variables if the resulting binary
7923: package is the same.</p></li>
7924: <li class="listitem"><p>Changing
7925: <code class="filename">DESCR</code>.</p></li>
7926: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7927: default options don't change.</p></li>
1.100 rillig 7928: </ul></div>
1.87 wiz 7929: <p>Examples of changes that do merit an increase to
7930: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 7931: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7932: <li class="listitem"><p>Security fixes</p></li>
7933: <li class="listitem"><p>Changes or additions to a patch
7934: file</p></li>
7935: <li class="listitem"><p>Changes to the
7936: <code class="filename">PLIST</code></p></li>
7937: <li class="listitem"><p>A dependency is changed or
7938: renamed.</p></li>
1.100 rillig 7939: </ul></div>
1.78 rillig 7940: <p>PKGREVISION must also be incremented when dependencies have ABI
7941: changes.</p>
1.75 rillig 7942: </div>
1.148 asau 7943: <div class="sect2">
1.79 rillig 7944: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7945: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.295 rillig 7946: <p>When you want to replace the same text in multiple files, or
7947: multiple times in the same file, it is cumbersome to maintain a patch
7948: file for this. This is where the SUBST framework steps in. It provides an
7949: easy-to-use interface for replacing text in files. It just needs the
7950: following information:</p>
7951: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7952: <li class="listitem"><p>In which phase of the package build cycle should the
7953: replacement happen?</p></li>
7954: <li class="listitem"><p>In which files should the replacement
1.287 rillig 7955: happen?</p></li>
1.295 rillig 7956: <li class="listitem"><p>Which text should be replaced with
7957: what?</p></li>
1.287 rillig 7958: </ul></div>
7959: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295 rillig 7960: variables. A minimal example is:</p>
7961: <pre class="programlisting">
7962: SUBST_CLASSES+= paths
7963: SUBST_STAGE.paths= pre-configure
7964: SUBST_FILES.paths= src/*.c
7965: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
7966: </pre>
7967: <p>Translated into English, it means: In the pre-configure stage (that
7968: is, after applying the patches from the patches/ directory and before
7969: running the configure script and the portability check), replace the text
7970: <code class="literal">/usr/local</code> with the content of the variable
7971: <code class="varname">PREFIX</code>.</p>
7972: <p>Each SUBST block starts by appending an identifier to
7973: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
7974: identifier can be chosen freely by the package. If there should ever be
7975: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
7976: early, so don't worry about name collisions.</p>
7977: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
7978: SUBST block are parameterized using this identifier. In the remainder of
7979: this section, these parameterized variables are written as
7980: <code class="varname">SUBST_STAGE.*</code>.</p>
7981: <pre class="programlisting">
7982: SUBST_CLASSES+= paths
7983: SUBST_STAGE.paths= pre-configure
7984: SUBST_MESSAGE.paths= Fixing absolute paths.
7985: SUBST_FILES.paths= src/*.c
7986: SUBST_FILES.paths+= scripts/*.sh
7987: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
7988: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
7989: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
7990: </pre>
7991: <p>To get a complete picture about the SUBST substitutions, run
7992: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
7993: expected, run pkglint on the package, which detects several typical
7994: mistakes surrounding the SUBST blocks. For any questions that might
7995: remain after this, have a look at
7996: <code class="filename">mk/subst.mk</code>.</p>
7997: <div class="sect3">
7998: <div class="titlepage"><div><div><h4 class="title">
7999: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
8000: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
8001: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
8002: <code class="literal">pre-configure</code> is used most often, by far. The most
8003: popular stages are, in chronological order:</p>
8004: <div class="variablelist"><dl class="variablelist">
8005: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
8006: <dd>
8007: <p>The substitutions are applied immediately after the
8008: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
8009: package will leave no traces of the original files.</p>
8010: <p>When the substitution applies to files for which there is also a
8011: patch in the <code class="filename">patches/</code> directory, this means that the
8012: patches will be computed based on the result of the substitution. When
8013: these patches are sent to the upstream maintainer later, to be fixed in
8014: the upstream package, these patches may no longer match what the upstream
8015: author is used to. Because of this, <code class="literal">pre-configure</code> is
8016: often a better choice.</p>
8017: </dd>
8018: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
8019: <dd>
8020: <p>The substitutions are applied after the patches from the
8021: <code class="filename">patches/</code> directory. This makes it possible to run
8022: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.322 leot 8023: can be edited using the tools pkgvi and mkpatches from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package.</p>
1.295 rillig 8024: <p>When updating the patches, it is helpful to explicitly separate the
8025: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
8026: configure</strong></span>, and to only edit the patches between these commands.
8027: Otherwise the substitutions from the SUBST block will end up in the patch
8028: file. When this happens in really obvious ways, pkglint will complain
8029: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
8030: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
8031: can only detect these really obvious
8032: cases.</p>
8033: </dd>
8034: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
8035: <dd><p>This stage should only be used if the package defines a
8036: <code class="literal">pre-configure</code> action itself, and the substitution must
8037: happen after that. Typical examples are packages that use the
8038: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
8039: script from
8040: <code class="filename">configure.ac</code>.</p></dd>
8041: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
8042: <dd><p>This stage is used to fix up any mistakes by the
8043: configure stage.</p></dd>
8044: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
8045: <dd><p>This stage should only be used for substitutions that are
8046: clearly related to building the package, not for fixing the
8047: configuration. Substitutions for pathnames (such as replacing
8048: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
8049: user names (such as replacing <code class="literal">@MY_USER@</code> with the
8050: actual username) belong in pre-configure or post-configure
8051: instead.</p></dd>
8052: <dt><span class="term"><code class="literal">post-build</code></span></dt>
8053: <dd>
8054: <p>Just as with pre-build, this stage should only be used
8055: for substitutions that are clearly related to building the package, not
8056: for fixing the configuration. Substitutions for pathnames (such as
8057: replacing <code class="filename">/usr/local</code> with
8058: <code class="literal">${PREFIX}</code>) or user names (such as replacing
8059: <code class="literal">@MY_USER@</code> with the actual username) belong in
8060: pre-configure or post-configure instead.</p>
8061: <p>A typical use is to update pkg-config files to include the rpath
8062: compiler options.</p>
8063: </dd>
8064: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8065: <dd><p>In general, the install phase should be as simple as
8066: possible. As with the pre-build and post-build stages, it should not be
8067: used to fix pathnames or user names, these belong in pre-configure
8068: instead. There are only few legitimate use cases for applying
8069: substitutions in this stage.</p></dd>
8070: </dl></div>
8071: </div>
8072: <div class="sect3">
8073: <div class="titlepage"><div><div><h4 class="title">
1.296 rillig 8074: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295 rillig 8075: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8076: filename patterns. These patterns are relative to
8077: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8078: A typical example is:</p>
8079: <pre class="programlisting">
8080: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8081: </pre>
8082: <p>The above patterns, especially the last, are quite broad. The SUBST
8083: implementation checks that each filename pattern that is mentioned here
8084: has an effect. For example, if none of the
8085: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8086: and substituted, that filename pattern is redundant and should be left
1.296 rillig 8087: out. By default, the SUBST framework will complain with an error message.
8088: If the text to be substituted occurs in some of the files from a single
8089: pattern, but not in all of them, that is totally ok, and the SUBST
1.295 rillig 8090: framework will only print an INFO message for those files.</p>
8091: <p>If there is a good reason for having redundant filename patterns,
1.296 rillig 8092: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295 rillig 8093: <p>Another popular way of choosing the files for the substitutions is
8094: via a shell command, like this:</p>
8095: <pre class="programlisting">
1.296 rillig 8096: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.295 rillig 8097: SUBST_FILES.path= ${C_FILES_CMD:sh}
8098: </pre>
8099: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8100: freely chosen and independent of the SUBST framework.</p>
8101: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8102: lists each file individually. Thereby chances are higher that there are
8103: filename patterns in which no substitution happens. Since the SUBST
8104: framework cannot know whether the filename patterns in
8105: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8106: Makefile (where any redundant filename pattern would be suspicious) or
8107: been generated by a shell command (in which redundant filename patterns
8108: are more likely and to be expected), it will complain about these
8109: redundant filename patterns. Therefore, SUBST blocks that use a shell
8110: command to generate the list of filename patterns often need to set
8111: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8112: </div>
8113: <div class="sect3">
8114: <div class="titlepage"><div><div><h4 class="title">
8115: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8116: <p>In most cases, the substitutions are given using one or more
1.322 leot 8117: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.295 rillig 8118: <pre class="programlisting">
8119: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8120: </pre>
8121: <p>Each of the sed commands needs to be preceded by the
8122: <code class="literal">-e</code> option and should be specified on a line of its
8123: own, to avoid hiding short sed commands at the end of a line.</p>
8124: <p>Since the sed commands often contain shell metacharacters as the
8125: separator (the <code class="literal">|</code> in the above example), it is common
8126: to enclose them in single quotes.</p>
8127: <p>A common substitution is to replace placeholders of the form
8128: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8129: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8130: <pre class="programlisting">
8131: SUBST_VARS.path= PREFIX
8132: </pre>
8133: <p>This type of substitutions is typically done by the GNU configure
1.296 rillig 8134: scripts during the do-configure stage, but in some cases these need to be
8135: overridden. The same pattern is also used when a package defines patches
8136: that replace previously hard-coded paths like
8137: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8138: placeholder first, which then gets substituted by the actual
8139: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8140: cases, it works equally well to just use the SUBST framework to directly
8141: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8142: thereby omitting the intermediate patch file.</p>
1.295 rillig 8143: <p>If the above is not flexible enough, it is possible to not use sed
8144: at all for the substitution but to specify an entirely different command,
8145: like this:</p>
1.87 wiz 8146: <pre class="programlisting">
1.295 rillig 8147: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8148: </pre>
8149: <p>This is used for the few remaining packages in which the
8150: distributed files use Windows-style line endings that need to be
8151: converted to UNIX-style line endings.</p>
8152: </div>
8153: <div class="sect3">
8154: <div class="titlepage"><div><div><h4 class="title">
8155: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8156: <p>When a SUBST block is applied during a package build, a message is
8157: logged. The default message is fine for most purposes but can be
8158: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8159: message.</p>
8160: </div>
1.79 rillig 8161: </div>
1.75 rillig 8162: </div>
1.148 asau 8163: <div class="sect1">
1.75 rillig 8164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8165: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 8166: <div class="sect2">
1.75 rillig 8167: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8168: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75 rillig 8169: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8170: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8171: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8172: with the name of each file to download as an argument, expecting
8173: it to output the URL of the directory from which to download
1.322 leot 8174: it. <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/index.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87 wiz 8175: example of this usage.</p>
1.75 rillig 8176: <p>If the download can't be automated, because the user must
1.87 wiz 8177: submit personal information to apply for a password, or must pay
8178: for the source, or whatever, you can set
8179: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8180: displayed to the user before aborting the build. Example:</p>
8181: <pre class="programlisting">
1.100 rillig 8182: FETCH_MESSAGE= "Please download the files"
8183: FETCH_MESSAGE+= " "${DISTFILES:Q}
8184: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222 sevan 8185: </pre>
1.75 rillig 8186: </div>
1.148 asau 8187: <div class="sect2">
1.75 rillig 8188: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8189: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75 rillig 8190: <p>Sometimes authors of a software package make some
1.87 wiz 8191: modifications after the software was released, and they put up a
8192: new distfile without changing the package's version number. If a
8193: package is already in pkgsrc at that time, the checksum will
8194: no longer match. The contents of the new distfile should be
8195: compared against the old one before changing anything, to make
8196: sure the distfile was really updated on purpose, and that
8197: no trojan horse or so crept in.
1.97 rillig 8198: Please mention that the distfiles were compared and what was found
1.159 rodent 8199: in your commit message.</p>
1.220 wiz 8200: <p>Then, the correct way to work around this is to set
8201: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8202: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8203: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8204: a variable prefix). All <code class="varname">DISTFILES</code> and
1.93 rillig 8205: <code class="varname">PATCHFILES</code> for this package will be put in that
1.267 rillig 8206: subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="21.1.10. How to handle incrementing versions when fixing an existing package">Section 21.1.10, “How to handle incrementing versions when fixing an existing package”</a> for more details.) In case this
1.87 wiz 8207: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220 wiz 8208: including the <code class="filename">nbX</code> suffix) or a date stamp can
8209: be appended, like
8210: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284 rillig 8211: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8212: name does not contain a version and the distfile is apt to change. In
8213: cases where the likelihood of this is very small,
8214: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8215: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8216: distfile name changes, even if a package is being moved or
8217: renamed.</p>
1.159 rodent 8218: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8219: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8220: path in the filenames.
1.159 rodent 8221: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8222: Furthermore, a mail to the package's authors seems appropriate
8223: telling them that changing distfiles after releases without
8224: changing the file names is not good practice.</p>
1.75 rillig 8225: </div>
1.199 tnn 8226: <div class="sect2">
8227: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8228: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284 rillig 8229: <p>Helper methods exist for packages hosted on github.com which
8230: will often have distfile names that clash with other packages, for
8231: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8232: from below:</p>
1.199 tnn 8233: <div class="sect3">
8234: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8235: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284 rillig 8236: <p>If your distfile URL looks similar to
1.303 bacon 8237: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284 rillig 8238: then you are packaging a tagged release.</p>
1.199 tnn 8239: <pre class="programlisting">
1.303 bacon 8240: DISTNAME= example-1.0
1.200 tnn 8241: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8242: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8243: GITHUB_TAG= v${PKGVERSION_NOREV}
1.199 tnn 8244: EXTRACT_SUFX= .zip
8245: </pre>
1.345 gutterid 8246: <p>Here, DISTNAME combined with use of GITHUB_TAG leads the
8247: file fetching infrastructure to save the resulting file locally as
8248: <code class="literal">example-1.0.zip</code>.</p>
1.199 tnn 8249: </div>
8250: <div class="sect3">
8251: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8252: <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>
8253: <p>If your distfile looks similar to
8254: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8255: release, then set the package version to 0.0.0.N, where N is the number
8256: of commits to the repository, and set GITHUB_TAG to the commit hash.
8257: This will (almost) ensure that the first tagged release will have a
8258: version greater than this one so that package upgrades will function
8259: properly.</p>
8260: <pre class="programlisting">
8261: DISTNAME= example-0.0.0.347
8262: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8263: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8264: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8265: </pre>
8266: </div>
8267: <div class="sect3">
8268: <div class="titlepage"><div><div><h4 class="title">
8269: <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>
8270: <p>If your distfile looks similar to
8271: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8272: then include the last release version and the commit count since that
8273: release in the package version and set GITHUB_TAG to the commit hash.
8274: The latest release and commit count are shown in the output of
8275: "git describe --tags":
8276: </p>
8277: <pre class="screen">
8278: # git clone https://github.com/username/example
8279: # cd example
8280: # git describe --tags
8281: 1.2.3-5-g988881a
8282: </pre>
1.199 tnn 8283: <pre class="programlisting">
1.303 bacon 8284: DISTNAME= example-1.2.3.5
8285: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8286: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8287: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222 sevan 8288: </pre>
1.199 tnn 8289: </div>
8290: <div class="sect3">
8291: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8292: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284 rillig 8293: <p>If your distfile URL looks similar to
1.303 bacon 8294: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284 rillig 8295: then you are packaging a release.</p>
1.199 tnn 8296: <pre class="programlisting">
8297: DISTNAME= offensive-1.6
1.200 tnn 8298: PKGNAME= ${DISTNAME:S/offensive/proper/}
8299: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8300: GITHUB_PROJECT= example
1.200 tnn 8301: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8302: EXTRACT_SUFX= .zip
1.222 sevan 8303: </pre>
1.199 tnn 8304: </div>
8305: </div>
1.75 rillig 8306: </div>
1.148 asau 8307: <div class="sect1">
1.75 rillig 8308: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8309: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 8310: <div class="sect2">
1.75 rillig 8311: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8312: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8313: <p>pkgsrc supports many different machines, with different
1.87 wiz 8314: object formats like a.out and ELF, and varying abilities to do
8315: shared library and dynamic loading at all. To accompany this,
8316: varying commands and options have to be passed to the
8317: compiler, linker, etc. to get the Right Thing, which can be
8318: pretty annoying especially if you don't have all the machines
8319: at your hand to test things. The
1.322 leot 8320: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/index.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128 wiz 8321: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8322: both static and dynamic libraries from a set of source files,
8323: thus being platform-independent.</p>
8324: <p>Here's how to use libtool in a package in seven simple
8325: steps:</p>
1.128 wiz 8326: <div class="orderedlist"><ol class="orderedlist" type="1">
8327: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8328: Makefile.</p></li>
1.128 wiz 8329: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8330: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8331: add it to the definition of <code class="varname">CC</code>, if only
8332: libraries are being built in a given Makefile. This one command
8333: will build both PIC and non-PIC library objects, so you need not
8334: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8335: <li class="listitem">
1.75 rillig 8336: <p>For the linking of the library, remove any
1.128 wiz 8337: <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
8338: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8339: <pre class="programlisting">
1.100 rillig 8340: ${LIBTOOL} --mode=link \
8341: ${CC} -o ${.TARGET:.a=.la} \
8342: ${OBJS:.o=.lo} \
8343: -rpath ${PREFIX}/lib \
8344: -version-info major:minor
1.222 sevan 8345: </pre>
1.75 rillig 8346: <p>Note that the library is changed to have a
1.87 wiz 8347: <code class="filename">.la</code> extension, and the objects are
8348: changed to have a <code class="filename">.lo</code>
8349: extension. Change <code class="varname">OBJS</code> as
8350: necessary. This automatically creates all of the
8351: <code class="filename">.a</code>,
8352: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8353: necessary) in the build directory. Be sure to include
1.128 wiz 8354: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8355: minor are zero, as libtool will otherwise strip off the
8356: shared library version.</p>
1.75 rillig 8357: <p>From the libtool manual:</p>
8358: <pre class="programlisting">
1.100 rillig 8359: So, libtool library versions are described by three integers:
1.69 rillig 8360:
1.100 rillig 8361: CURRENT
8362: The most recent interface number that this library implements.
1.69 rillig 8363:
1.100 rillig 8364: REVISION
8365: The implementation number of the CURRENT interface.
1.69 rillig 8366:
1.100 rillig 8367: AGE
8368: The difference between the newest and oldest interfaces that
8369: this library implements. In other words, the library implements
8370: all the interface numbers in the range from number `CURRENT -
8371: AGE' to `CURRENT'.
1.1 grant 8372:
1.100 rillig 8373: If two libraries have identical CURRENT and AGE numbers, then the
8374: dynamic linker chooses the library with the greater REVISION number.
1.222 sevan 8375: </pre>
1.128 wiz 8376: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8377: different results for a.out and ELF (excluding symlinks)
8378: in only one case. An ELF library of the form
1.128 wiz 8379: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87 wiz 8380: will have a symlink of
1.128 wiz 8381: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87 wiz 8382: on an a.out platform. This is handled
8383: automatically.</p>
1.128 wiz 8384: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8385: directory of the library being built.</p>
1.76 rillig 8386: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8387: <code class="filename">.la</code> file, the other files will be
8388: added automatically.</p>
1.75 rillig 8389: </li>
1.128 wiz 8390: <li class="listitem">
1.76 rillig 8391: <p>When linking shared object (<code class="filename">.so</code>)
1.322 leot 8392: files, i.e. files that are loaded via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128 wiz 8393: shared libraries, use <span class="quote">“<span class="quote">-module
8394: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8395: tacked on.</p>
1.76 rillig 8396: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8397: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8398: </li>
1.128 wiz 8399: <li class="listitem">
1.75 rillig 8400: <p>When linking programs that depend on these libraries
1.87 wiz 8401: <span class="emphasis"><em>before</em></span> they are installed, preface
1.322 leot 8402: the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ld.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 8403: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8404: libraries (static or shared), but please be aware that
8405: libtool will not allow you to specify a relative path in
1.128 wiz 8406: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8407: expects you to change that argument to be the
8408: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8409: <pre class="programlisting">
1.100 rillig 8410: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222 sevan 8411: </pre>
1.75 rillig 8412: <p>should be changed to:</p>
8413: <pre class="programlisting">
1.100 rillig 8414: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222 sevan 8415: </pre>
1.75 rillig 8416: <p>and it will do the right thing with the libraries.</p>
8417: </li>
1.128 wiz 8418: <li class="listitem">
1.322 leot 8419: <p>When installing libraries, preface the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8420: or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cp.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 8421: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8422: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8423: <pre class="programlisting">
1.126 jakllsch 8424: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222 sevan 8425: </pre>
1.76 rillig 8426: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8427: shared library, any needed symlinks, and run
1.322 leot 8428: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75 rillig 8429: </li>
1.128 wiz 8430: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8431: the <code class="filename">.la</code>
8432: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8433: </ol></div>
8434: </div>
1.148 asau 8435: <div class="sect2">
1.75 rillig 8436: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8437: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8438: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8439: package Makefile. This will override the package's own libtool
8440: in most cases. For older libtool using packages, libtool is
8441: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8442: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8443: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8444: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8445: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8446: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8447: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8448: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8449: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8450: libraries built and installed, then use
8451: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8452: <p>If your package makes use of the platform-independent library
1.87 wiz 8453: for loading dynamic shared objects, that comes with libtool
8454: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8455: <p>Some packages use libtool incorrectly so that the package
8456: may not work or build in some circumstances. Some of the more
8457: common errors are:</p>
1.148 asau 8458: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8459: <li class="listitem">
1.75 rillig 8460: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8461: executable or library. This in itself isn't a problem if one of two things
8462: has been done:</p>
1.128 wiz 8463: <div class="orderedlist"><ol class="orderedlist" type="1">
8464: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8465: <code class="filename">libfoo.la</code>, not
8466: <code class="filename">foo.la</code></p></li>
1.128 wiz 8467: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8468: </ol></div>
8469: </li>
1.128 wiz 8470: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8471: The function lt_dlinit() should be called and the macro
8472: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8473: executables.</p></li>
1.75 rillig 8474: </ul></div>
8475: </div>
1.148 asau 8476: <div class="sect2">
1.75 rillig 8477: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8478: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8479: <p>If a package needs GNU autoconf or automake to be executed
1.338 nia 8480: to regenerate the
8481: <code class="filename">configure</code>
8482: script and <code class="filename">Makefile.in</code> makefile
8483: templates from <code class="filename">configure.ac</code> and
8484: <code class="filename">Makefile.am</code>,
8485: then they should be executed in a pre-configure target:</p>
1.75 rillig 8486: <pre class="programlisting">
1.338 nia 8487: USE_TOOLS+= autoconf automake autoreconf
8488: GNU_CONFIGURE= yes
1.100 rillig 8489: ...
1.1 grant 8490:
1.100 rillig 8491: pre-configure:
1.338 nia 8492: set -e; cd ${WRKSRC} && autoreconf -fi
1.100 rillig 8493: ...
1.222 sevan 8494: </pre>
1.338 nia 8495: <p>Packages which use GNU Automake will sometimes
8496: require GNU Make (<code class="literal">gmake</code> in
8497: <code class="varname">USE_TOOLS</code>),
8498: but not always. Note that autoreconf
8499: only needs to be executed if <code class="filename">configure.ac</code>
8500: or Makefiles are modified, or <code class="filename">configure</code>
8501: is not present.</p>
1.75 rillig 8502: <p>There are times when the configure process makes
1.87 wiz 8503: additional changes to the generated files, which then causes
8504: the build process to try to re-execute the automake sequence.
8505: This is prevented by touching various files in the configure
8506: stage. If this causes problems with your package you can set
8507: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8508: Makefile.</p>
1.75 rillig 8509: </div>
1.338 nia 8510: <div class="sect2">
8511: <div class="titlepage"><div><div><h3 class="title">
8512: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
8513: <p>Packages using Meson to configure need to include:
8514:
8515: </p>
8516: <pre class="programlisting">
8517: .include "../../devel/meson/build.mk"
8518: </pre>
8519: <p>In nearly all cases (any program with dependencies),
8520: pkg-config needs to be added to
8521: <code class="varname">USE_TOOLS</code>. If the package installs
8522: translation files for non-English languages, also
8523: add msgfmt and xgettext:
8524:
8525: </p>
8526: <pre class="programlisting">
8527: USE_TOOLS+= pkg-config msgfmt xgettext
8528: </pre>
8529: <p>If any options need to be passed to Meson, use
8530: <code class="varname">MESON_ARGS</code> instead of
8531: <code class="varname">CONFIGURE_ARGS</code>:
8532:
8533: </p>
8534: <pre class="programlisting">
8535: MESON_ARGS+= -Dx11=false
8536: </pre>
8537: </div>
1.75 rillig 8538: </div>
1.148 asau 8539: <div class="sect1">
1.75 rillig 8540: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8541: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148 asau 8542: <div class="sect2">
1.87 wiz 8543: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8544: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.338 nia 8545: <p>Compilers for the C and C++ languages comes with
1.87 wiz 8546: the NetBSD base system. By default, pkgsrc assumes that a package
8547: is written in C and will hide all other compilers (via the wrapper
1.299 rillig 8548: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8549: <p>To declare which language's compiler a package needs, set
8550: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.327 wiz 8551: currently are:
8552: </p>
8553: <pre class="programlisting">
8554: c99, c++, c++03, gnu++03, c++0x, gnu++0x, c++11, gnu++11,
8555: c++14, gnu++14, c++17, gnu++17, c++20, gnu++20, fortran,
8556: fortran77, java, objc, obj-c++, and ada.
8557: </pre>
8558: <p>
8559: (and any combination). The default is
1.128 wiz 8560: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8561: written in C++, usually need a C compiler for the configure
8562: phase.</p>
1.338 nia 8563: <p>To express a general requirement on a specific C or C++
8564: version, normally only <code class="varname">GCC_REQD</code> needs to be set.
8565: For example, GCC 7 includes support for C++17, so if the package uses
8566: C++17 it should specify:
8567:
8568: </p>
8569: <pre class="programlisting">
8570: GCC_REQD+= 7
8571: </pre>
8572: <p>Language variants like <code class="literal">c++11</code> for
8573: <code class="varname">USE_LANGUAGES</code> should only be specified
8574: if the package does not explicitly set <code class="literal">-std=...</code>
8575: when compiling (i.e. the package assumes the compiler defaults to
8576: C++11 or some other standard). This is usually a bug in the
8577: upstream build system.</p>
8578: <p>GCC version 5 includes support for C++14, while GCC 4.7 includes
8579: more-or-less complete support for C++11. For more information, consult
8580: <a class="ulink" href="https://gcc.gnu.org/projects/cxx-status.html" target="_top">GCC's own documentation on programming language support.</a></p>
1.87 wiz 8581: </div>
1.148 asau 8582: <div class="sect2">
1.87 wiz 8583: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8584: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87 wiz 8585: <p>If a program is written in Java, use the Java framework in
8586: pkgsrc. The package must include
8587: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8588: provides the following variables:</p>
1.148 asau 8589: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8590: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8591: dependency on the JDK is added. If
1.128 wiz 8592: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8593: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8594: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8595: JDK.</p></li>
1.128 wiz 8596: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8597: a package needs a Java2 implementation. The supported values
1.128 wiz 8598: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8599: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8600: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8601: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8602: above. This variable is not set by default.</p></li>
1.130 wiz 8603: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8604: automatically set to the runtime location of the used Java
8605: implementation dependency. It may be used to set
8606: <code class="varname">JAVA_HOME</code> to a good value if the program
8607: needs this variable to be defined.
8608: </p></li>
1.87 wiz 8609: </ul></div>
8610: </div>
1.148 asau 8611: <div class="sect2">
1.87 wiz 8612: <div class="titlepage"><div><div><h3 class="title">
1.320 wiz 8613: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
8614: <p>If a program is written in Go and has any dependencies on
8615: other Go modules, have the package include
8616: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8617: <div class="orderedlist"><ol class="orderedlist" type="1">
8618: <li class="listitem"><p>Generate a list of those dependencies with
8619: <span class="command"><strong>make clean && make patch && make show-go-modules >
8620: go-modules.mk</strong></span>.</p></li>
1.338 nia 8621: <li class="listitem"><p>Prepend
8622: <code class="literal">.include "go-modules.mk"</code> to any other
8623: <code class="literal">.include</code>s.</p></li>
8624: <li class="listitem"><p>Incorporate these modules in
8625: <code class="filename">distinfo</code> with <span class="command"><strong>make
8626: makesum</strong></span>.</p></li>
8627: </ol></div>
8628: </div>
8629: <div class="sect2">
8630: <div class="titlepage"><div><div><h3 class="title">
8631: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
8632: <p>If a program is written in Rust and uses Cargo to build,
8633: have the package include
8634: <code class="filename">../../lang/rust/cargo.mk</code>.</p>
8635: <div class="orderedlist"><ol class="orderedlist" type="1">
8636: <li class="listitem"><p>Generate a list of those dependencies with
8637: <span class="command"><strong>make CARGO_ARGS="build --release" build &&
8638: make print-cargo-depends > cargo-depends.mk</strong></span>.</p></li>
8639: <li class="listitem"><p>Prepend
8640: <code class="literal">.include "cargo-depends.mk"</code> to any other
8641: <code class="literal">.include</code>s.</p></li>
1.320 wiz 8642: <li class="listitem"><p>Incorporate these modules in
8643: <code class="filename">distinfo</code> with <span class="command"><strong>make
8644: makesum</strong></span>.</p></li>
8645: </ol></div>
8646: </div>
8647: <div class="sect2">
8648: <div class="titlepage"><div><div><h3 class="title">
1.338 nia 8649: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.318 nia 8650: <p>If your package contains interpreted Perl scripts, add
1.128 wiz 8651: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8652: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8653: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8654: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8655: that you want adjusted. Every occurrence of
8656: <code class="filename">*/bin/perl</code> in a she-bang line will be
1.325 gutterid 8657: replaced with the full path to the Perl executable.</p>
8658: <p>If a particular version of Perl is needed, set the
1.87 wiz 8659: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8660: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.318 nia 8661: <p>See <a class="xref" href="#perl-modules" title="21.6.6. Packages installing Perl modules">Section 21.6.6, “Packages installing Perl modules”</a> for information
1.325 gutterid 8662: about handling Perl modules.</p>
8663: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
8664: for the language now known as Raku.</p>
1.87 wiz 8665: </div>
1.148 asau 8666: <div class="sect2">
1.87 wiz 8667: <div class="titlepage"><div><div><h3 class="title">
1.338 nia 8668: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.147 wiz 8669: <p><code class="varname">REPLACE_SH</code>,
8670: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8671: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.340 gutterid 8672: she-bangs in files. Please use the appropriate one, preferring
8673: <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.183 wiz 8674: Each should contain a list of scripts, relative to
8675: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8676: occurrence of the matching shell in a she-bang line will be
8677: replaced with the full path to the shell executable.
1.147 wiz 8678: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8679: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8680: </div>
1.148 asau 8681: <div class="sect2">
1.147 wiz 8682: <div class="titlepage"><div><div><h3 class="title">
1.338 nia 8683: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.325 gutterid 8684: <p>There are further similar REPLACE variables available, e.g.,
8685: <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
8686: and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.326 gutterid 8687: noted above, have their actions defined centrally in
1.325 gutterid 8688: <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.326 gutterid 8689: languages define the actions of these variables within their own
8690: dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
8691: actioned in <code class="filename">lang/php/phpversion.mk</code>, and
8692: <code class="varname">REPLACE_PYTHON</code> is actioned in
1.325 gutterid 8693: <code class="filename">lang/python/application.mk</code>. For other languages,
8694: consult the mk files found within their specific directories (the
1.331 gutterid 8695: naming convention varies), or check the list found in
8696: <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.325 gutterid 8697: <p>Currently, special handling for other languages varies
1.87 wiz 8698: in pkgsrc. If a compiler package provides a
8699: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8700: just add a (build) dependency on the appropriate compiler
8701: package.</p>
8702: </div>
8703: </div>
1.148 asau 8704: <div class="sect1">
1.87 wiz 8705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8706: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8707: <p>The most common failures when building a package are that
8708: some platforms do not provide certain header files, functions or
8709: libraries, or they provide the functions in a library that the
8710: original package author didn't know. To work around this, you
8711: can rewrite the source code in most cases so that it does not
8712: use the missing functions or provides a replacement function.</p>
1.148 asau 8713: <div class="sect2">
1.77 rillig 8714: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8715: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8716: <p>If a package already comes with a GNU configure script, the
8717: preferred way to fix the build failure is to change the
8718: configure script, not the code. In the other cases, you can
8719: utilize the C preprocessor, which defines certain macros
8720: depending on the operating system and hardware architecture it
8721: compiles for. These macros can be queried using for example
8722: <code class="varname">#if defined(__i386)</code>. Almost every operating
8723: system, hardware architecture and compiler has its own macro.
8724: For example, if the macros <code class="varname">__GNUC__</code>,
8725: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8726: are all defined, you know that you are using NetBSD on an i386
8727: compatible CPU, and your compiler is GCC.</p>
8728: <p>The list of the following macros for hardware and
8729: operating system depends on the compiler that is used. For
8730: example, if you want to conditionally compile code on Solaris,
8731: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8732: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8733: <div class="sect3">
1.75 rillig 8734: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8735: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.338 nia 8736: <p>To distinguish between specific NetBSD versions,
8737: you should use the following code.</p>
8738: <pre class="programlisting">
8739: #ifdef __NetBSD__
8740: #include <sys/param.h>
8741: #if __NetBSD_Prereq__(9,99,17)
8742: /* use a newer feature */
8743: #else
8744: /* older code */
8745: #endif
8746: #endif
8747:
8748: #ifndef _WIN32
8749: /* Unix-like specific code */
8750: #endif
8751: </pre>
1.75 rillig 8752: <p>To distinguish between 4.4 BSD-derived systems and the
8753: rest of the world, you should use the following code.</p>
8754: <pre class="programlisting">
1.100 rillig 8755: #include <sys/param.h>
8756: #if (defined(BSD) && BSD >= 199306)
8757: /* BSD-specific code goes here */
8758: #else
8759: /* non-BSD-specific code goes here */
8760: #endif
1.75 rillig 8761: </pre>
1.338 nia 8762: <p>You can also test for the following macros:</p>
1.75 rillig 8763: <pre class="programlisting">
1.151 obache 8764: Cygwin __CYGWIN__
8765: DragonFly __DragonFly__
1.100 rillig 8766: FreeBSD __FreeBSD__
1.151 obache 8767: Haiku __HAIKU__
1.100 rillig 8768: Interix __INTERIX
8769: IRIX __sgi (TODO: get a definite source for this)
1.338 nia 8770: Linux __linux
1.193 dholland 8771: Mac OS X __APPLE__
1.151 obache 8772: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8773: Minix3 __minix
1.100 rillig 8774: NetBSD __NetBSD__
8775: OpenBSD __OpenBSD__
8776: Solaris sun, __sun
1.75 rillig 8777: </pre>
8778: </div>
1.148 asau 8779: <div class="sect3">
1.75 rillig 8780: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8781: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75 rillig 8782: <pre class="programlisting">
1.100 rillig 8783: i386 i386, __i386, __i386__
1.338 nia 8784: x86-64 __amd64__, __x86_64__
8785: ARM __arm__
1.100 rillig 8786: MIPS __mips
8787: SPARC sparc, __sparc
1.338 nia 8788: PowerPC __powerpc
1.75 rillig 8789: </pre>
8790: </div>
1.148 asau 8791: <div class="sect3">
1.75 rillig 8792: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8793: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75 rillig 8794: <pre class="programlisting">
1.100 rillig 8795: GCC __GNUC__ (major version), __GNUC_MINOR__
8796: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8797: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8798: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8799: </pre>
8800: </div>
8801: </div>
1.148 asau 8802: <div class="sect2">
1.78 rillig 8803: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8804: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8805: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8806: combinations of compiler version and architecture and almost
8807: always relation to optimisation being enabled. Common symptoms
8808: are gcc internal errors or never finishing compiling a
1.78 rillig 8809: file.</p>
8810: <p>Typically, a workaround involves testing the
8811: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8812: optimisation for that combination of file,
1.198 tnn 8813: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8814: <p>This used to be a big problem in the past, but is rarely
8815: needed now as compiler technology has matured. If you still need
8816: to add a compiler specific workaround, please do so in the file
8817: <code class="filename">hacks.mk</code> and describe the symptom and
8818: compiler version as detailed as possible.</p>
1.78 rillig 8819: </div>
1.148 asau 8820: <div class="sect2">
1.78 rillig 8821: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 8822: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8823: <p>Compilation sometimes fails with an error message like this:</p>
8824: <pre class="programlisting">
8825: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8826: fatal error: pango/pango.h: No such file or directory
8827: </pre>
8828: <p>The proper way to fix this problem depends on the type of the
8829: header, which is described in the following sections.</p>
8830: <div class="sect3">
8831: <div class="titlepage"><div><div><h4 class="title">
8832: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8833: <p>If the header name looks like it comes from a different package,
8834: that other package should be included via the buildlink3
8835: framework.</p>
8836: <p>First, look whether the header is somewhere in the buildlink3
8837: directory below <code class="varname">WRKDIR</code>. In the above case of
8838: the missing Pango header:</p>
8839: <pre class="programlisting">
8840: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8841: </pre>
8842: <p>In the case of Pango, the output is:</p>
8843: <pre class="programlisting">
8844: work/.buildlink/include/pango-1.0/pango/pango.h
8845: </pre>
8846: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8847: in the <code class="filename">.buildlink</code> directory, it would have been
8848: found automatically. There is an extra <code class="filename">pango-1.0</code>
8849: path component though, which means that the compiler command line must
8850: contain an option of the form
8851: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8852: most cases this option is generated by the configure script, which can be examined using:</p>
8853: <pre class="programlisting">
8854: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8855: -I/usr/pkg/include/pango-1.0
8856: -I/usr/pkg/include/pango-1.0
8857: -I/usr/pkg/include/pango-1.0
8858: -I/usr/pkg/include/pango-1.0
8859: -I/usr/pkg/include/pango-1.0
8860: </pre>
8861: <p>This looks good. These options are transformed by the buildlink
8862: wrapper to refer to the correct path inside
8863: <code class="filename">work/.buildlink</code>.</p>
8864: <p>Since the compilation fails though, examine the compiler command
8865: lines in <code class="filename">work/.work.log</code> to see whether the
8866: <code class="literal">-I</code> option is included in the particular command
8867: line.</p>
8868: <p>To further analyze the situation, run <span class="command"><strong>bmake
8869: build-env</strong></span>, which sets up an interactive, realistic environment
8870: including all the pkgsrc wrapper commands and environment variables. From
8871: there, try to compile some simple example programs that use the
8872: header.</p>
8873: </div>
8874: <div class="sect3">
8875: <div class="titlepage"><div><div><h4 class="title">
8876: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8877: <p>If the name of the header seems to come from the package itself,
8878: and if the build is run with parallel jobs, the package may have some
8879: undeclared dependencies between the <code class="filename">.c</code> and the
8880: <code class="filename">.h</code> files, and a C file is compiled before its
8881: required header is generated.</p>
8882: <p>To see whether the build runs with parallel jobs, run
8883: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8884: like this:</p>
8885: <pre class="programlisting">
8886: usr MAKE_JOBS= 7
8887: pkg MAKE_JOBS_SAFE # undefined
8888: def _MAKE_JOBS_N= 7
8889: </pre>
8890: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8891: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8892: package could have disabled parallel builds by setting
8893: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8894: in this case it hasn't.</p>
8895: <p>To see whether the build failure is caused by parallel builds,
8896: first save the exact error message and a bit of context, maybe you need
8897: it later for reporting a bug. Next, run:</p>
8898: <pre class="programlisting">
8899: MAKE_JOBS_SAFE=no bmake clean build
8900: </pre>
8901: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8902: report</a> against the pkgsrc package, including the exact error
8903: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8904: </div>
1.288 rillig 8905: <div class="sect3">
8906: <div class="titlepage"><div><div><h4 class="title">
8907: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
8908: <p>Pkgsrc does not work reliably if any of
8909: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
8910: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
8911: bootstrap program prevents installing pkgsrc in symlink-based
8912: directories. Existing pkgsrc installations are not checked for symlinks
8913: though.</p>
8914: <p>The "No such file or directory" error messages are a typical
8915: symptom of symlinks, and it's quite difficult to find out that this is
8916: the actual cause.</p>
8917: </div>
8918: <div class="sect3">
8919: <div class="titlepage"><div><div><h4 class="title">
8920: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
8921: <p>When building a hierarchy of packages, it may happen that one
8922: package is built and then pkgsrc is updated. This situation can provoke
8923: various hard to diagnose build errors. To clean up the situation:</p>
8924: <pre class="programlisting">
1.338 nia 8925: <code class="prompt">$</code> (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.288 rillig 8926: </pre>
1.338 nia 8927: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
8928: prevent running this command in the wrong directory.)</p>
1.288 rillig 8929: <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
8930: that directory as well.</p>
8931: </div>
8932: <div class="sect3">
8933: <div class="titlepage"><div><div><h4 class="title">
8934: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
8935: <p>On platforms other than BSD, third-party packages are installed in
8936: <code class="filename">/usr/include</code>, together with the base system. This
8937: means that pkgsrc cannot distinguish between headers provided by the base
8938: system (which it needs) and headers from third-party packages (which are
8939: often included in pkgsrc as well). This can lead to subtle version
8940: mismatches.</p>
8941: <p>In pkgsrc installations that have been active for several years, it
8942: may happen that some files are manually deleted. To exclude this unlikely
8943: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
8944: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
8945: check/fix dependencies.</p>
8946: <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>
8947: for contact information. Be prepared to describe what you have tried so
8948: far and what any error messages were.</p>
8949: </div>
1.287 rillig 8950: </div>
8951: <div class="sect2">
8952: <div class="titlepage"><div><div><h3 class="title">
8953: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.128 wiz 8954: </h3></div></div></div>
1.92 rillig 8955: <p>This error message often means that a package did not
1.78 rillig 8956: link to a shared library it needs. The following functions are
8957: known to cause this error message over and over.</p>
8958: <div class="informaltable">
1.216 tnn 8959: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78 rillig 8960: <colgroup>
8961: <col>
8962: <col>
8963: <col>
8964: </colgroup>
8965: <thead><tr>
8966: <th>Function</th>
8967: <th>Library</th>
8968: <th>Affected platforms</th>
8969: </tr></thead>
8970: <tbody>
8971: <tr>
8972: <td>accept, bind, connect</td>
8973: <td>-lsocket</td>
8974: <td>Solaris</td>
8975: </tr>
8976: <tr>
8977: <td>crypt</td>
8978: <td>-lcrypt</td>
8979: <td>DragonFly, NetBSD</td>
8980: </tr>
8981: <tr>
8982: <td>dlopen, dlsym</td>
8983: <td>-ldl</td>
8984: <td>Linux</td>
8985: </tr>
8986: <tr>
8987: <td>gethost*</td>
8988: <td>-lnsl</td>
8989: <td>Solaris</td>
8990: </tr>
8991: <tr>
8992: <td>inet_aton</td>
8993: <td>-lresolv</td>
8994: <td>Solaris</td>
8995: </tr>
8996: <tr>
8997: <td>nanosleep, sem_*, timer_*</td>
8998: <td>-lrt</td>
8999: <td>Solaris</td>
9000: </tr>
9001: <tr>
9002: <td>openpty</td>
9003: <td>-lutil</td>
9004: <td>Linux</td>
9005: </tr>
9006: </tbody>
9007: </table>
9008: </div>
1.338 nia 9009: <p>To fix these linker errors, it is often sufficient to add
1.87 wiz 9010: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
9011: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.338 nia 9012: <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.87 wiz 9013: bmake</strong></span>.</p>
1.148 asau 9014: <div class="sect3">
1.92 rillig 9015: <div class="titlepage"><div><div><h4 class="title">
1.338 nia 9016: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.92 rillig 9017: <p>When you are using the SunPro compiler, there is another
9018: possibility. That compiler cannot handle the following code:</p>
9019: <pre class="programlisting">
1.100 rillig 9020: extern int extern_func(int);
1.93 rillig 9021:
1.100 rillig 9022: static inline int
9023: inline_func(int x)
9024: {
1.92 rillig 9025: return extern_func(x);
1.100 rillig 9026: }
1.93 rillig 9027:
1.100 rillig 9028: int main(void)
9029: {
1.92 rillig 9030: return 0;
1.100 rillig 9031: }
1.92 rillig 9032: </pre>
9033: <p>It generates the code for <code class="function">inline_func</code> even if
9034: that function is never used. This code then refers to
9035: <code class="function">extern_func</code>, which can usually not be resolved. To
9036: solve this problem you can try to tell the package to disable inlining
9037: of functions.</p>
9038: </div>
1.343 gutterid 9039: <div class="sect3">
9040: <div class="titlepage"><div><div><h4 class="title">
9041: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
9042: <p>When building for older machine architectures (e.g., i386, PowerPC),
9043: builds may fail because the package expects modern 64-bit atomic functions
9044: which the underlying hardware either doesn't support, or will only support
9045: with specific compiler flags. This is generally handled via inclusion of
9046: mk/atomic64.mk.</p>
9047: </div>
1.87 wiz 9048: </div>
1.148 asau 9049: <div class="sect2">
1.87 wiz 9050: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 9051: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87 wiz 9052: <p>Sometimes packages fail to build because the compiler runs
9053: into an operating system specific soft limit. With the
9054: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.338 nia 9055: to unlimit the resources. The allowed values are any combination of
9056: <span class="quote">“<span class="quote">cputime</span>”</span>,
9057: <span class="quote">“<span class="quote">datasize</span>”</span>,
9058: <span class="quote">“<span class="quote">memorysize</span>”</span>,
9059: <span class="quote">“<span class="quote">stacksize</span>”</span> and
9060: <span class="quote">“<span class="quote">virtualsize</span>”</span>.
1.87 wiz 9061: Setting this variable is similar to running the shell builtin
1.110 hubertf 9062: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 9063: segment size or maximum stack size of a process, respectively, to
9064: their hard limits.</p>
1.78 rillig 9065: </div>
1.75 rillig 9066: </div>
1.148 asau 9067: <div class="sect1">
1.75 rillig 9068: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9069: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 9070: <div class="sect2">
1.75 rillig 9071: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9072: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 9073: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 9074: with some operating systems cannot create more than one
9075: directory at a time. As such, you should call
9076: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
9077: <pre class="programlisting">
1.100 rillig 9078: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
9079: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222 sevan 9080: </pre>
1.338 nia 9081: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
9082: directly, you can also append <span class="quote">“<span class="quote"><code class="literal">dir1
9083: dir2</code></span>”</span> to the <code class="varname">INSTALLATION_DIRS</code>
9084: variable, which will automatically do the right thing.</p>
1.75 rillig 9085: </div>
1.148 asau 9086: <div class="sect2">
1.75 rillig 9087: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9088: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 9089: <p>In general, documentation should be installed into
1.87 wiz 9090: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.338 nia 9091: <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.87 wiz 9092: includes the version number of the package).</p>
1.84 wiz 9093: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 9094: directory where HTML documentation is installed with the
1.338 nia 9095: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag is
9096: needed because otherwise the documentation ends up in
9097: <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
9098: pkgsrc, the HTML documentation should go into the package-specific
9099: directory, just like any other documentation.</p>
1.87 wiz 9100: <p>An exception to the above is that library API documentation
1.322 leot 9101: generated with the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/index.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87 wiz 9102: browsers (devhelp) should be left at their default location, which
9103: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
9104: documentation can be recognized from files ending in
9105: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
9106: (It is also acceptable to install such files in
9107: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
9108: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
9109: <code class="filename">.devhelp*</code> file must be directly in that
9110: directory then, no additional subdirectory level is allowed in
9111: this case. This is usually achieved by using
1.128 wiz 9112: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 9113: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
9114: though.)</p>
1.75 rillig 9115: </div>
1.148 asau 9116: <div class="sect2">
1.75 rillig 9117: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9118: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 9119: <p>Certain packages, most of them in the games category, install
1.87 wiz 9120: a score file that allows all users on the system to record their
9121: highscores. In order for this to work, the binaries need to be
9122: installed setgid and the score files owned by the appropriate
1.142 wiz 9123: group and/or owner (traditionally the "games" user/group). Set
9124: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 9125: following variables, documented in more detail in
9126: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 9127: behaviour: <code class="varname">GAMEDATAMODE</code>,
9128: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210 leot 9129: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
9130: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
9131: <code class="varname">GAMEDATA_PERMS</code> and
9132: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
9133: <p>An example that illustrates some of the variables described above is
9134: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
9135: used to properly set directory permissions of the directory where the
9136: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
9137: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
9138: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
9139: binary:</p>
9140: <pre class="programlisting">
1.223 rillig 9141: USE_GAMESGROUP= yes
1.210 leot 9142:
1.223 rillig 9143: BUILD_DEFS+= VARBASE
1.210 leot 9144:
1.223 rillig 9145: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
9146: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
9147: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222 sevan 9148: </pre>
1.210 leot 9149: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
9150: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
9151: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
9152: needed to be accessed by setgid games and
9153: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114 jmcneill 9154: <p>A package should therefore never hard code file ownership or
1.210 leot 9155: access permissions but rely on <code class="varname">*_PERMS</code> as described above
9156: or alternatively on <code class="varname">INSTALL_GAME</code>,
9157: <code class="varname">INSTALL_GAME_DATA</code> and
9158: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75 rillig 9159: </div>
1.148 asau 9160: <div class="sect2">
1.75 rillig 9161: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9162: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 9163: <p><code class="varname">DESTDIR</code> support means that a package
9164: installs into a staging directory, not the final location of the
9165: files. Then a binary package is created which can be used for
9166: installation as usual. There are two ways: Either the package must
1.128 wiz 9167: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9168: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 9169: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9170: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224 leot 9171: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
9172: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145 wiz 9173: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9174: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 9175: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9176: the inclusion.</p></li>
1.128 wiz 9177: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 9178: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 9179: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 9180: automatically. Many manual rules and pre/post-install often are
9181: incorrect; fix them.</p></li>
1.128 wiz 9182: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 9183: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 9184: <li class="listitem"><p>In general, packages should support
1.103 wiz 9185: <code class="varname">UNPRIVILEGED</code> to be able to use
9186: DESTDIR.</p></li>
9187: </ul></div>
9188: </div>
1.148 asau 9189: <div class="sect2">
1.103 wiz 9190: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9191: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 9192: <p>Your package may also contain scripts with hardcoded paths to
1.318 nia 9193: other interpreters besides (or as well as) Perl. To correct the
1.87 wiz 9194: full pathname to the script interpreter, you need to set the
9195: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 9196: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 9197: <pre class="programlisting">
1.100 rillig 9198: REPLACE_INTERPRETER+= tcl
9199: REPLACE.tcl.old= .*/bin/tclsh
9200: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9201: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9202: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222 sevan 9203: </pre>
1.75 rillig 9204: </div>
1.148 asau 9205: <div class="sect2">
1.75 rillig 9206: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9207: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.75 rillig 9208: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 9209: the Makefile fragment
9210: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 9211: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 9212: configuration for such modules as well as various hooks to tune
9213: this configuration. See comments in this file for
9214: details.</p>
1.75 rillig 9215: <p>Perl5 modules will install into different places depending
1.87 wiz 9216: on the version of perl used during the build process. To
9217: address this, pkgsrc will append lines to the
9218: <code class="filename">PLIST</code> corresponding to the files listed in
9219: the installed <code class="filename">.packlist</code> file generated by
9220: most perl5 modules. This is invoked by defining
9221: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 9222: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9223: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9224: e.g.:</p>
1.75 rillig 9225: <pre class="programlisting">
1.153 wiz 9226: PERL5_PACKLIST= auto/Pg/.packlist
1.222 sevan 9227: </pre>
1.153 wiz 9228: <p>The perl5 config variables
9229: <code class="varname">installarchlib</code>,
9230: <code class="varname">installscript</code>,
9231: <code class="varname">installvendorbin</code>,
9232: <code class="varname">installvendorscript</code>,
9233: <code class="varname">installvendorarch</code>,
9234: <code class="varname">installvendorlib</code>,
9235: <code class="varname">installvendorman1dir</code>, and
9236: <code class="varname">installvendorman3dir</code> represent those
9237: locations in which components of perl5 modules may be installed,
9238: provided as variable with uppercase and prefixed with
9239: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9240: and may be used by perl5 packages that don't have a packlist.
9241: These variables are also substituted for in the
9242: <code class="filename">PLIST</code> as uppercase prefixed with
9243: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 9244: </div>
1.148 asau 9245: <div class="sect2">
1.75 rillig 9246: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9247: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 9248: <p>Some packages install info files or use the
1.128 wiz 9249: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 9250: commands. <code class="varname">INFO_FILES</code> should be defined in
9251: the package Makefile so that <code class="filename">INSTALL</code> and
9252: <code class="filename">DEINSTALL</code> scripts will be generated to
9253: handle registration of the info files in the Info directory
1.128 wiz 9254: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 9255: files registration is either provided by the system, or by a
9256: special purpose package automatically added as dependency if
9257: needed.</p>
1.75 rillig 9258: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 9259: <code class="filename">${PREFIX}</code> where info files are primarily
9260: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 9261: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 9262: <p>The info files for the package should be listed in the
1.87 wiz 9263: package <code class="filename">PLIST</code>; however any split info files
9264: need not be listed.</p>
1.128 wiz 9265: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9266: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 9267: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 9268: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 9269: should be noted with the <code class="varname">TEXINFO_REQD</code>
9270: variable in the package <code class="filename">Makefile</code>. By
9271: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 9272: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 9273: does not match the required minimum, a build dependency on the
1.322 leot 9274: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/index.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87 wiz 9275: be added automatically.</p>
1.75 rillig 9276: <p>The build and installation process of the software provided
1.87 wiz 9277: by the package should not use the
1.110 hubertf 9278: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 9279: info files is the task of the package
9280: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 9281: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 9282: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 9283: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9284: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 9285: in <code class="varname">PATH</code>.</p>
1.110 hubertf 9286: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 9287: no effect except the logging of a message. The script overriding
1.110 hubertf 9288: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 9289: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 9290: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 9291: </div>
1.148 asau 9292: <div class="sect2">
1.75 rillig 9293: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9294: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 9295: <p>All packages that install manual pages should install them
1.87 wiz 9296: into the same directory, so that there is one common place to look
9297: for them. In pkgsrc, this place is
9298: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9299: should be used in packages. The default for
9300: <code class="varname">PKGMANDIR</code> is
1.128 wiz 9301: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9302: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 9303: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9304: <h3 class="title">Note</h3>
1.87 wiz 9305: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9306: is far from complete.</p>
1.75 rillig 9307: </div>
1.81 rillig 9308: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 9309: <code class="filename">man/</code> as the top level directory for the man
9310: page file entries, and the pkgsrc framework will convert as
9311: needed. In all other places, the correct
9312: <code class="varname">PKGMANDIR</code> must be used.</p>
9313: <p>Packages that are
9314: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 9315: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 9316: <code class="filename">./configure</code>
9317: --mandir switch to set where the man pages should be installed.
9318: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9319: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9320: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9321: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 9322: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 9323: Or if the <code class="filename">./configure</code> script uses
9324: a non-standard use of --mandir, you can set
9325: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299 rillig 9326: <p>See <a class="xref" href="#manpage-compression" title="19.5. Man page compression">Section 19.5, “Man page compression”</a> for
1.87 wiz 9327: information on installation of compressed manual pages.</p>
1.75 rillig 9328: </div>
1.148 asau 9329: <div class="sect2">
1.75 rillig 9330: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9331: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9332: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9333: the fonts database in the directory where they get installed at
9334: installation and deinstallation time. This can be automatically
9335: done by using the pkginstall framework.</p>
1.75 rillig 9336: <p>You can list the directories where fonts are installed in the
1.87 wiz 9337: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9338: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 9339: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.87 wiz 9340: Also make sure that the database file
9341: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9342: <p>Note that you should not create new directories for fonts;
1.87 wiz 9343: instead use the standard ones to avoid that the user needs to
9344: manually configure his X server to find them.</p>
1.75 rillig 9345: </div>
1.148 asau 9346: <div class="sect2">
1.75 rillig 9347: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9348: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9349: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9350: registered in system-wide catalogs (like DTDs, sub-catalogs,
9351: etc.), you need to take some extra steps:</p>
1.128 wiz 9352: <div class="orderedlist"><ol class="orderedlist" type="1">
9353: <li class="listitem"><p>Include
1.87 wiz 9354: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9355: your <code class="filename">Makefile</code>, which takes care of
9356: registering those files in system-wide catalogs at
9357: installation and deinstallation time.</p></li>
1.128 wiz 9358: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9359: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9360: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9361: any XML catalogs installed by the package.</p></li>
1.128 wiz 9362: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9363: to be added to the SGML catalog. These come in groups of
9364: three strings; see xmlcatmgr(1) for more information
9365: (specifically, arguments recognized by the 'add' action).
9366: Note that you will normally not use this variable.</p></li>
1.128 wiz 9367: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9368: to be added to the XML catalog. These come in groups of three
9369: strings; see xmlcatmgr(1) for more information (specifically,
9370: arguments recognized by the 'add' action). Note that you will
9371: normally not use this variable.</p></li>
1.75 rillig 9372: </ol></div>
9373: </div>
1.148 asau 9374: <div class="sect2">
1.75 rillig 9375: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9376: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9377: <p>If a package provides extensions to the MIME database by
1.87 wiz 9378: installing <code class="filename">.xml</code> files inside
9379: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9380: need to take some extra steps to ensure that the database is kept
9381: consistent with respect to these new files:</p>
1.128 wiz 9382: <div class="orderedlist"><ol class="orderedlist" type="1">
9383: <li class="listitem"><p>Include
1.87 wiz 9384: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9385: (avoid using the <code class="filename">buildlink3.mk</code> file from
9386: this same directory, which is reserved for inclusion from
9387: other <code class="filename">buildlink3.mk</code> files). It takes
9388: care of rebuilding the MIME database at installation and
9389: deinstallation time, and disallows any access to it directly
9390: from the package.</p></li>
1.128 wiz 9391: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9392: <code class="filename">share/mime</code> directory,
9393: <span class="emphasis"><em>except</em></span> for files saved under
9394: <code class="filename">share/mime/packages</code>. The former are
9395: handled automatically by
9396: the update-mime-database program, but the latter are
9397: package-dependent and must be removed by the package that
9398: installed them in the first place.</p></li>
1.128 wiz 9399: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9400: from the PLIST. They will be handled by the shared-mime-info
9401: package.</p></li>
1.75 rillig 9402: </ol></div>
9403: </div>
1.148 asau 9404: <div class="sect2">
1.75 rillig 9405: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9406: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.93 rillig 9407: <p>If a package uses intltool during its build, add
9408: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9409: which forces it to use the intltool package provided by pkgsrc,
9410: instead of the one bundled with the distribution file.</p>
1.75 rillig 9411: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9412: latest available version; this way, the package benefits of any
9413: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9414: </div>
1.148 asau 9415: <div class="sect2">
1.75 rillig 9416: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9417: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9418: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9419: the startup directory by default, but you can enable it, by adding
9420: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9421: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9422: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9423: it will automatically remove the scripts when the package is
9424: deinstalled.</p>
1.75 rillig 9425: </div>
1.148 asau 9426: <div class="sect2">
1.75 rillig 9427: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9428: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9429: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9430: the <code class="filename">ls-R</code> database of the tree needs to be
9431: updated.</p>
1.148 asau 9432: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9433: <h3 class="title">Note</h3>
1.125 wiz 9434: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9435: packages should install files
1.125 wiz 9436: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9437: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9438: </div>
1.128 wiz 9439: <div class="orderedlist"><ol class="orderedlist" type="1">
9440: <li class="listitem"><p>Include
1.125 wiz 9441: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9442: takes care of rebuilding the <code class="filename">ls-R</code>
9443: database at installation and deinstallation time.</p></li>
1.128 wiz 9444: <li class="listitem">
1.75 rillig 9445: <p>If your package installs files into a texmf
1.87 wiz 9446: tree other than the one
1.125 wiz 9447: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9448: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9449: trees that need database update.</p>
1.75 rillig 9450: <p>If your package also installs font map files that need
1.110 hubertf 9451: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9452: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9453: set <code class="varname">TEX_MAP_FILES</code> and/or
9454: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9455: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9456: be run automatically at installation/deinstallation to
9457: enable/disable font map files for TeX output
9458: drivers.</p>
1.75 rillig 9459: </li>
1.128 wiz 9460: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9461: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9462: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9463: </ol></div>
9464: </div>
1.148 asau 9465: <div class="sect2">
1.85 jmmv 9466: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9467: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.87 wiz 9468: emulation</h3></div></div></div>
9469: <p>There are some packages that provide libraries and
9470: executables for running binaries from a one operating system
9471: on a different one (if the latter supports it). One example
9472: is running Linux binaries on NetBSD.</p>
1.322 leot 9473: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/index.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87 wiz 9474: helps in extracting and packaging Linux rpm packages.</p>
9475: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9476: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9477: if all libraries for each installed executable can be found by
9478: the dynamic linker. Since the standard dynamic linker is run,
9479: this fails for emulation packages, because the libraries used
9480: by the emulation are not in the standard directories.</p>
9481: </div>
1.299 rillig 9482: <div class="sect2">
9483: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9484: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.299 rillig 9485: <p>If a package installs images under the
9486: <code class="filename">share/icons/hicolor</code> and/or updates the
9487: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9488: database, you need to take some extra steps to make sure that the
9489: shared theme directory is handled appropriately and that the cache
9490: database is rebuilt:</p>
9491: <div class="orderedlist"><ol class="orderedlist" type="1">
9492: <li class="listitem"><p>Include
9493: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9494: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9495: entry that refers to the theme cache.</p></li>
9496: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9497: directories from the <code class="filename">share/icons/hicolor</code>
9498: hierarchy because they will be handled automatically.</p></li>
9499: </ol></div>
9500: <p>The best way to verify that the PLIST is correct with
9501: respect to the last two points is to regenerate it using
9502: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9503: </div>
9504: <div class="sect2">
9505: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9506: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.299 rillig 9507: <p>If a package installs <code class="filename">.desktop</code> files
9508: under <code class="filename">share/applications</code> and these include
9509: MIME information (MimeType key), you need to take extra steps to
9510: ensure that they are registered into the MIME database:</p>
9511: <div class="orderedlist"><ol class="orderedlist" type="1">
9512: <li class="listitem"><p>Include
9513: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9514: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9515: <code class="filename">share/applications/mimeinfo.cache</code> file.
9516: It will be handled automatically.</p></li>
9517: </ol></div>
9518: <p>The best way to verify that the PLIST is correct with
9519: respect to the last point is to regenerate it using <span class="command"><strong>make
9520: print-PLIST</strong></span>.</p>
9521: </div>
9522: </div>
9523: <div class="sect1">
9524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9525: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9526: <p>In some cases one does not have the time to solve a problem
9527: immediately. In this case, one can plainly mark a package as broken. For
9528: this, one just sets the variable <code class="varname">BROKEN</code> to the
9529: reason why the package is broken (similar to the
9530: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9531: the package will immediately be shown this message, and the build
9532: will not be even tried.</p>
9533: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9534: intervals.</p>
9535: </div>
9536: </div>
9537: <div class="chapter">
9538: <div class="titlepage"><div><div><h2 class="title">
9539: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9540: <div class="toc">
9541: <p><b>Table of Contents</b></p>
9542: <dl class="toc">
9543: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9544: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9545: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9546: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9547: </dl>
9548: </div>
9549: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9550: site</a>:</p>
9551: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9552: environment, an intuitive and attractive desktop for users, and the
9553: GNOME development platform, an extensive framework for building
9554: applications that integrate into the rest of the desktop.</p></blockquote></div>
9555: <p>pkgsrc provides a seamless way to automatically build and install
9556: a complete GNOME environment <span class="emphasis"><em>under many different
9557: platforms</em></span>. We can say with confidence that pkgsrc is one of
9558: the most advanced build and packaging systems for GNOME due to its
9559: included technologies buildlink3, the wrappers and tools framework and
9560: automatic configuration file management. Lots of efforts are put into
9561: achieving a completely clean deinstallation of installed software
9562: components.</p>
9563: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9564: the above also means that great efforts are put into making GNOME work
1.316 cirnatda 9565: under this operating system.</p>
1.299 rillig 9566: <p>This chapter is aimed at pkgsrc developers and other people
9567: interested in helping our GNOME porting and packaging efforts. It
9568: provides instructions on how to manage the existing packages and some
9569: important information regarding their internals.</p>
9570: <div class="sect1">
9571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9572: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9573: <p>pkgsrc includes three GNOME-related meta packages:</p>
9574: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 9575: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/index.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.299 rillig 9576: the core GNOME desktop environment. It only includes the necessary
9577: bits to get it to boot correctly, although it may lack important
9578: functionality for daily operation. The idea behind this package is
9579: to let end users build their own configurations on top of this one,
9580: first installing this meta package to achieve a functional setup and
9581: then adding individual applications.</p></li>
1.322 leot 9582: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.299 rillig 9583: complete installation of the GNOME platform and desktop as defined
9584: by the GNOME project; this is based on the components distributed in
9585: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9586: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9587: official FTP server. Developer-only tools found in those
9588: directories are not installed unless required by some other
9589: component to work properly. Similarly, packages from the bindings
9590: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9591: in unless required as a dependency for an end-user component. This
1.322 leot 9592: 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>
9593: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.299 rillig 9594: Installs all the tools required to build a GNOME component when
9595: fetched from the CVS repository. These are required to let the
9596: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9597: </ul></div>
9598: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9599: sorted in a way that eases updates: a package may depend on other
9600: packages listed before it but not on any listed after it. It is very
9601: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9602: change it to alphabetical sorting!</em></span></p>
9603: </div>
9604: <div class="sect1">
9605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9606: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9607: <p>Almost all GNOME applications are written in C and use a common
9608: set of tools as their build system. Things get different with the new
9609: bindings to other languages (such as Python), but the following will
9610: give you a general idea on the minimum required tools:</p>
9611: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9612: <li class="listitem">
9613: <p>Almost all GNOME applications use the GNU Autotools as their
9614: build system. As a general rule you will need to tell this to your
9615: package:</p>
9616: <pre class="programlisting">
1.338 nia 9617: GNU_CONFIGURE= yes
9618: USE_LIBTOOL= yes
9619: USE_TOOLS+= gmake
1.299 rillig 9620: </pre>
9621: </li>
9622: <li class="listitem">
9623: <p>If the package uses pkg-config to detect dependencies, add this
9624: tool to the list of required utilities:</p>
9625: <pre class="programlisting">
1.338 nia 9626: USE_TOOLS+= pkg-config
1.299 rillig 9627: </pre>
1.322 leot 9628: <p>Also use <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/index.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.299 rillig 9629: the end of the build process to ensure that you did not miss to
9630: specify any dependency in your package and that the version
9631: requirements are all correct.</p>
9632: </li>
9633: <li class="listitem"><p>If the package uses intltool, be sure to add
9634: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9635: to handle dependencies and to force the package to use the latest
9636: available version.</p></li>
9637: <li class="listitem">
9638: <p>If the package uses gtk-doc (a documentation generation
9639: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9640: tool is rather big and the distfile should come with pregenerated
9641: documentation anyway; if it does not, it is a bug that you ought to
9642: report. For such packages you should disable gtk-doc (unless it is
9643: the default):</p>
9644: <pre class="programlisting">
1.338 nia 9645: CONFIGURE_ARGS+= --disable-gtk-doc
1.299 rillig 9646: </pre>
9647: <p>The default location of installed HTML files
9648: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9649: and should not be changed unless the package insists on installing
9650: them somewhere else. Otherwise programs as
9651: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9652: do that with an entry similar to:</p>
9653: <pre class="programlisting">
1.338 nia 9654: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.299 rillig 9655: </pre>
9656: </li>
9657: </ul></div>
9658: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9659: files under the installation prefix to maintain databases. In this
9660: context, shared means that those exact same directories and files are
9661: used among several different packages, leading to conflicts in the
9662: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9663: handle the most common cases, so you have to forget about using
9664: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9665: omitting shared files from them. If you find yourself doing those,
9666: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9667: <p>The following table lists the common situations that result in
9668: using shared directories or files. For each of them, the appropriate
9669: solution is given. After applying the solution be sure to
9670: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9671: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9672: <div class="table">
9673: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9674: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9675: <colgroup>
9676: <col>
9677: <col>
9678: </colgroup>
9679: <thead><tr>
9680: <th>If the package...</th>
9681: <th>Then...</th>
9682: </tr></thead>
9683: <tbody>
9684: <tr>
9685: <td>Installs icons under the
9686: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9687: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.318 nia 9688: <td>See <a class="xref" href="#hicolor-theme" title="21.6.16. Packages installing hicolor icons">Section 21.6.16, “Packages installing hicolor icons”</a>.</td>
1.299 rillig 9689: </tr>
9690: <tr>
9691: <td>Installs files under
9692: <code class="filename">share/mime/packages</code>.</td>
1.318 nia 9693: <td>See <a class="xref" href="#mime-database" title="21.6.11. Packages installing extensions to the MIME database">Section 21.6.11, “Packages installing extensions to the MIME database”</a>.</td>
1.299 rillig 9694: </tr>
9695: <tr>
9696: <td>Installs <code class="filename">.desktop</code> files under
9697: <code class="filename">share/applications</code> and these include MIME
9698: information.</td>
1.318 nia 9699: <td>See <a class="xref" href="#desktop-files" title="21.6.17. Packages installing desktop files">Section 21.6.17, “Packages installing desktop files”</a>.</td>
1.299 rillig 9700: </tr>
9701: </tbody>
9702: </table></div>
1.75 rillig 9703: </div>
1.299 rillig 9704: <br class="table-break">
1.75 rillig 9705: </div>
1.148 asau 9706: <div class="sect1">
1.87 wiz 9707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 9708: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9709: <p>When seeing GNOME as a whole, there are two kinds of
9710: updates:</p>
9711: <div class="variablelist"><dl class="variablelist">
9712: <dt><span class="term">Major update</span></dt>
9713: <dd>
9714: <p>Given that there is still a very long way for GNOME 3 (if it
9715: ever appears), we consider a major update one that goes from a
9716: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9717: where <code class="literal">Y</code> is even and greater than
9718: <code class="literal">X</code>. These are hard to achieve because they
9719: introduce lots of changes in the components' code and almost all
9720: GNOME distfiles are updated to newer versions. Some of them can
9721: even break API and ABI compatibility with the previous major
9722: version series. As a result, the update needs to be done all at
9723: once to minimize breakage.</p>
9724: <p>A major update typically consists of around 80 package
9725: updates and the addition of some new ones.</p>
9726: </dd>
9727: <dt><span class="term">Minor update</span></dt>
9728: <dd>
9729: <p>We consider a minor update one that goes from a
9730: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9731: one where <code class="literal">Y</code> is greater than
9732: <code class="literal">X</code>. These are easy to achieve because they do
9733: not update all GNOME components, can be done in an incremental way
9734: and do not break API nor ABI compatibility.</p>
9735: <p>A minor update typically consists of around 50 package
9736: updates, although the numbers here may vary a lot.</p>
9737: </dd>
9738: </dl></div>
9739: <p>In order to update the GNOME components in pkgsrc to a new stable
9740: release (either major or minor), the following steps should be
9741: followed:</p>
9742: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128 wiz 9743: <li class="listitem">
1.299 rillig 9744: <p>Get a list of all the tarballs that form the new release by
9745: using the following commands. These will leave the full list of the
9746: components' distfiles into the <code class="filename">list.txt</code>
9747: file:</p>
9748: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9749: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9750: awk '{ print $9 }' >list.txt</code></strong>
9751: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9752: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9753: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.75 rillig 9754: </li>
1.299 rillig 9755: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9756: bump their version to the release you are updating them to. The
9757: three meta packages should be always consistent with versioning.
9758: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9759: in them.</p></li>
1.128 wiz 9760: <li class="listitem">
1.299 rillig 9761: <p>For each meta package, update all its
9762: <code class="varname">DEPENDS</code> lines to match the latest versions as
9763: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9764: newer version (even if found in the FTP) because the meta packages
9765: are supposed to list the exact versions that form a specific GNOME
9766: release. Exceptions are permitted here if a newer version solves a
9767: serious issue in the overall desktop experience; these typically
9768: come in the form of a revision bump in pkgsrc, not in newer versions
9769: from the developers.</p>
9770: <p>Packages not listed in the <code class="filename">list.txt</code> file
9771: should be updated to the latest version available (if found in
9772: pkgsrc). This is the case, for example, of the dependencies on the
1.322 leot 9773: GNU Autotools in the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.75 rillig 9774: </li>
1.128 wiz 9775: <li class="listitem">
1.299 rillig 9776: <p>Generate a patch from the modified meta packages and extract the
9777: list of "new" lines. This will provide you an outline on what
9778: packages need to be updated in pkgsrc and in what order:</p>
9779: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
1.75 rillig 9780: </li>
1.299 rillig 9781: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9782: installed packages and start over from scratch at this point.</p></li>
9783: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9784: of <code class="filename">todo.txt</code> and update the packages listed in
9785: it in order. For major desktop updates none of these should be
9786: committed until the entire set is completed because there are chances
9787: of breaking not-yet-updated packages.</p></li>
9788: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9789: the tree one by one with appropriate log messages. At the end,
9790: commit the three meta package updates and all the corresponding
9791: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9792: <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>
9793: </ol></div>
9794: </div>
9795: <div class="sect1">
9796: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9797: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9798: <p>GNOME is a very big component in pkgsrc which approaches 100
9799: packages. Please, it is very important that you always, always,
9800: <span class="strong"><strong>always</strong></span> feed back any portability
9801: 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
9802: their attention on portability issues and to ensure that future versions
9803: can be built out-of-the box on NetBSD. The less custom patches in
9804: pkgsrc, the easier further updates are. Those developers in charge of
9805: issuing major GNOME updates will be grateful if you do that.</p>
1.315 cirnatda 9806: <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
9807: GitLab</a>. Not all components use these to track bugs, but most
1.299 rillig 9808: of them do. Do not be short on your reports: always provide detailed
9809: explanations of the current failure, how it can be improved to achieve
1.315 cirnatda 9810: maximum portability and, if at all possible, provide a patch against the
9811: main Git branch. The more verbose you are, the higher chances of your
9812: patch being accepted.</p>
1.299 rillig 9813: <p>Also, please avoid using preprocessor magic to fix portability
9814: issues. While the FreeBSD GNOME people are doing a great job in porting
9815: GNOME to their operating system, the official GNOME sources are now
9816: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9817: and similar macros. This hurts portability. Please see our patching
9818: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9819: details.</p>
9820: </div>
1.75 rillig 9821: </div>
1.148 asau 9822: <div class="chapter">
1.75 rillig 9823: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9824: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75 rillig 9825: <div class="toc">
9826: <p><b>Table of Contents</b></p>
1.210 leot 9827: <dl class="toc">
1.267 rillig 9828: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9829: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9830: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9831: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9832: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9833: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9834: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9835: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9836: </dl>
9837: </div>
1.148 asau 9838: <div class="sect1">
1.75 rillig 9839: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9840: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9841: <p>Our policy is that we accept binaries only from pkgsrc
9842: developers to guarantee that the packages don't contain any
9843: trojan horses etc. This is not to annoy anyone but rather to
9844: protect our users! You're still free to put up your home-made
9845: binary packages and tell the world where to get them. NetBSD
9846: developers doing bulk builds and wanting to upload them please
1.267 rillig 9847: see <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.174 asau 9848: builds)</i></a>.</p>
1.75 rillig 9849: </div>
1.148 asau 9850: <div class="sect1">
1.75 rillig 9851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9852: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.333 nia 9853: <p>Firstly, you can import new packages into
9854: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
9855: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
9856: for details.</p>
9857: <p>Next, check that your package is complete, compiles and
1.299 rillig 9858: runs well; see <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> and the rest of this
1.333 nia 9859: 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>
9860: tool and fix any errors that appear.</p>
9861: <p>Finally, send a report to the pkgsrc bug tracking system,
1.322 leot 9862: either with the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87 wiz 9863: that, go to the web page
1.289 leot 9864: <a class="ulink" href="https://www.NetBSD.org/support/send-pr.html" target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
1.124 snj 9865: which contains some instructions and a link to a form where you
9866: can submit packages. The
1.322 leot 9867: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/index.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.124 snj 9868: also available as a substitute for either of the above two tools.
9869: </p>
1.87 wiz 9870: <p>In the form of the problem report, the category should be
1.128 wiz 9871: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9872: and version number, and the description field should contain a
9873: short description of your package (contents of the COMMENT
1.333 nia 9874: variable or DESCR file are OK).</p>
1.75 rillig 9875: </div>
1.148 asau 9876: <div class="sect1">
1.75 rillig 9877: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9878: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9879: <p>Please note all package additions, updates, moves, and
1.93 rillig 9880: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9881: important to keep this file up to date and conforming to the
9882: existing format, because it will be used by scripts to
1.289 leot 9883: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9884: sites. Additionally, check the
1.76 rillig 9885: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9886: for the package you updated or removed, in case it was mentioned
9887: there.</p>
9888: <p>When the <code class="varname">PKGREVISION</code> of a package is
9889: bumped, the change should appear in
1.93 rillig 9890: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9891: related or otherwise relevant. Mass bumps that result from a
9892: dependency being updated should not be mentioned. In all other
9893: cases it's the developer's decision.</p>
9894: <p>There is a make target that helps in creating proper
1.110 hubertf 9895: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9896: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9897: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9898: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9899: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9900: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9901: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9902: For new packages, or package moves or removals, set the
9903: <code class="varname">CTYPE</code> variable on the command line to "Added",
9904: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9905: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9906: not the same as your NetBSD login name. The target also automatically
9907: removes possibly existing entries for the package in the
9908: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9909: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9910: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9911: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9912: makes the cvs commands use the main repository.
9913: </p>
1.75 rillig 9914: </div>
1.148 asau 9915: <div class="sect1">
1.75 rillig 9916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9917: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243 wiz 9918: <p>For several years, there have been mirrors of pkgsrc in
9919: fossil, git, and hg. Standard practise when using these tools is to
9920: make the first line of a commit message function as a summary that
9921: can be read without the rest, such as is commonly done with "git log
9922: --oneline". For this reason, we have the following guidelines for
9923: pkgsrc commit messages:</p>
9924: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9925: <li class="listitem"><p>Start the commit message with a line that explains the
1.244 wiz 9926: big picture in 65 characters or less. When a commit is for one
1.243 wiz 9927: package, include the name of the package. For updates, include the
9928: version to which it is updated.</p></li>
9929: <li class="listitem"><p>Leave the next line empty.</p></li>
9930: <li class="listitem"><p>Then come the details for the commit (changes in that
9931: package, reason for a change) and any relevant PRs. Wrap this
9932: section.</p></li>
9933: </ul></div>
9934: <p>Here is an example:
9935: </p>
9936: <pre class="programlisting">
9937: libxslt: update to 1.0.30
9938:
9939: Changes since 1.0.29:
9940: ...
9941: </pre>
9942: <p>
9943: </p>
9944: <p>Here is another example:
9945: </p>
9946: <pre class="programlisting">
9947: mk/bsd.pkg.mk: enable SSP by default on NetBSD
9948:
9949: (rationale)
9950: </pre>
9951: <p>
9952: </p>
9953: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
9954: allowed on the pkgsrc repository to change commit messages.</p>
9955: </div>
9956: <div class="sect1">
9957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9958: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9959: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9960: access to the pkgsrc repository.</p>
9961: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9962: Start by adding the directory and then files in the directory. Don't
9963: forget to add the new package to the category's
9964: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9965: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9966: <pre class="programlisting">
9967: <code class="prompt">$</code> cd .../pkgsrc/category
9968: <code class="prompt">$</code> cvs add pkgname
9969: <code class="prompt">$</code> cd pkgname
9970: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9971: <code class="prompt">$</code> cvs add patches/p*
9972: <code class="prompt">$</code> cvs status | less
1.141 wiz 9973: <code class="prompt">$</code> cvs commit
1.140 wiz 9974: <code class="prompt">$</code> cd ..
9975: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9976: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 9977: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 9978: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 9979: </pre>
1.87 wiz 9980: <p>The commit message of the initial import should include part of the
1.76 rillig 9981: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9982: what the package is/does.</p>
1.140 wiz 9983: <p>Also mention the new package in
9984: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9985: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9986: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9987: </div>
1.148 asau 9988: <div class="sect1">
1.75 rillig 9989: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9990: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9991: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9992: changes between old and new versions into the commit log when updating
1.87 wiz 9993: a package. There are various reasons for this:</p>
1.148 asau 9994: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9995: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9996: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9997: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9998: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9999: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 10000: repository is very useful for people who read the pkgsrc-changes mailing
10001: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 10002: the package.</p></li>
1.75 rillig 10003: </ul></div>
1.87 wiz 10004: <p>Please also recognize that, just because a new version of a package
1.75 rillig 10005: has been released, it should not automatically be upgraded in the CVS
10006: repository. We prefer to be conservative in the packages that are
10007: included in pkgsrc - development or beta packages are not really the
10008: best thing for most places in which pkgsrc is used. Please use your
10009: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 10010: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 10011: </div>
1.148 asau 10012: <div class="sect1">
1.75 rillig 10013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10014: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122 reed 10015: <p>Renaming packages is not recommended.</p>
1.290 gutterid 10016: <p>When renaming packages, be sure to fix any references to the old name
1.122 reed 10017: in other Makefiles, options, buildlink files, etc.</p>
1.282 leot 10018: <p>
1.290 gutterid 10019: Also, when renaming a package, please add
1.282 leot 10020: the package name and version pattern(s) of the previous package
10021: to <code class="varname">SUPERSEDES</code>.
1.122 reed 10022: This may be repeated for multiple renames.
10023: The new package would be an exact replacement.
1.282 leot 10024: Example:
1.122 reed 10025: </p>
1.282 leot 10026: <pre class="programlisting">
10027: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
10028: SUPERSEDES+= optcomp-[0-9]*
10029: </pre>
1.128 wiz 10030: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 10031: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
10032: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
10033: not be an exact replacement but is a suggestion for the replaced
10034: functionality.</p>
10035: </div>
1.148 asau 10036: <div class="sect1">
1.122 reed 10037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 10038: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122 reed 10039: <p>It is preferred that packages are not renamed or moved, but if needed
10040: please follow these steps.
10041: </p>
1.128 wiz 10042: <div class="orderedlist"><ol class="orderedlist" type="1">
10043: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
10044: <li class="listitem">
1.75 rillig 10045: <p>Remove all CVS dirs.</p>
1.87 wiz 10046: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 10047: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87 wiz 10048: <p>and use that for further work.</p>
1.75 rillig 10049: </li>
1.128 wiz 10050: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
10051: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
10052: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
10053: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 10054: <code class="varname">PREV_PKGPATH</code> to the previous category/package
10055: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
10056: for doing an update using pkgsrc building; for example, it can
1.322 leot 10057: search the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122 reed 10058: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
10059: new <code class="varname">PKGPATH</code> for that moved package. Note that
10060: it may have multiple matches, so the tool should also check on the
10061: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
10062: probably has no value unless <code class="varname">SUPERSEDES</code> is not
10063: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 10064: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 10065: place.</p></li>
1.128 wiz 10066: <li class="listitem">
1.75 rillig 10067: <p>Check if any package depends on it:
10068: </p>
10069: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
10070: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
10071: </li>
1.128 wiz 10072: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
10073: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
10074: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
10075: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
10076: <li class="listitem">
1.75 rillig 10077: <p>Commit the changed and removed files:</p>
10078: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87 wiz 10079: <p>(and any packages from step 5, of course).</p>
1.75 rillig 10080: </li>
10081: </ol></div>
10082: </div>
10083: </div>
1.148 asau 10084: <div class="chapter">
1.75 rillig 10085: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 10086: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 10087: <p>This section contains the answers to questions that may
10088: arise when you are writing a package. If you don't find your
10089: question answered here, first have a look in the other chapters,
10090: and if you still don't have the answer, ask on the
10091: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 10092: <div class="qandaset">
1.289 leot 10093: <a name="devfaq.qandaset"></a><dl>
1.267 rillig 10094: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 10095: MAKEFLAGS, .MAKEFLAGS and
10096: MAKE_FLAGS?</a>
10097: </dt>
1.267 rillig 10098: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 10099: MAKE, GMAKE and
10100: MAKE_PROGRAM?</a>
10101: </dt>
1.267 rillig 10102: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 10103: CC, PKG_CC and
10104: PKGSRC_COMPILER?</a>
10105: </dt>
1.338 nia 10106: <dt>24.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 10107: VARNAME=BUILDLINK_PREFIX.foo
10108: say it's empty?</a>
10109: </dt>
1.338 nia 10110: <dt>24.5. <a href="#devfaq.master_sites">What does
1.78 rillig 10111: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
10112: don't understand the := inside
10113: it.</a>
10114: </dt>
1.338 nia 10115: <dt>24.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 10116: developers?</a>
10117: </dt>
1.338 nia 10118: <dt>24.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 10119: documentation?</a>
10120: </dt>
1.338 nia 10121: <dt>24.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.289 leot 10122: What shall I do?</a>
1.92 rillig 10123: </dt>
1.75 rillig 10124: </dl>
1.148 asau 10125: <table border="0" style="width: 100%;">
10126: <colgroup>
1.75 rillig 10127: <col align="left" width="1%">
1.128 wiz 10128: <col>
1.148 asau 10129: </colgroup>
1.75 rillig 10130: <tbody>
1.148 asau 10131: <tr class="question">
1.75 rillig 10132: <td align="left" valign="top">
1.289 leot 10133: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75 rillig 10134: </td>
10135: <td align="left" valign="top"><p>What is the difference between
10136: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10137: <code class="varname">MAKE_FLAGS</code>?</p></td>
10138: </tr>
10139: <tr class="answer">
1.91 rillig 10140: <td align="left" valign="top"></td>
1.338 nia 10141: <td align="left" valign="top">
10142: <p><code class="varname">MAKEFLAGS</code> are the flags passed
10143: to the pkgsrc-internal invocations of <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.</p>
10144: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
10145: passed to the <code class="varname">MAKE_PROGRAM</code> when building the
10146: package.</p>
10147: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
10148: <span class="command"><strong>bmake</strong></span> and should not be used by
10149: packages.</p>
10150: </td>
1.75 rillig 10151: </tr>
1.148 asau 10152: <tr class="question">
1.75 rillig 10153: <td align="left" valign="top">
1.289 leot 10154: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75 rillig 10155: </td>
10156: <td align="left" valign="top"><p>What is the difference between
10157: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10158: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10159: </tr>
10160: <tr class="answer">
1.91 rillig 10161: <td align="left" valign="top"></td>
1.338 nia 10162: <td align="left" valign="top">
10163: <p><code class="varname">MAKE</code> is the path to the
1.322 leot 10164: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.338 nia 10165: infrastructure.</p>
10166: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
10167: need to say <code class="varname">USE_TOOLS+=gmake</code> to use
10168: that.</p>
10169: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
10170: program that is used for building the package.</p>
10171: </td>
1.75 rillig 10172: </tr>
1.148 asau 10173: <tr class="question">
1.75 rillig 10174: <td align="left" valign="top">
1.289 leot 10175: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75 rillig 10176: </td>
10177: <td align="left" valign="top"><p>What is the difference between
10178: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10179: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10180: </tr>
10181: <tr class="answer">
1.91 rillig 10182: <td align="left" valign="top"></td>
1.75 rillig 10183: <td align="left" valign="top">
1.338 nia 10184: <p><code class="varname">CC</code> is the path to the real C
10185: compiler, which can be configured by the pkgsrc user.</p>
10186: <p><code class="varname">PKG_CC</code> is the path to the compiler
10187: wrapper.</p>
10188: <p><code class="varname">PKGSRC_COMPILER</code> is
10189: <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
10190: compiler that should be used. See
10191: <code class="filename">mk/compiler.mk</code> for more information about
10192: the latter variable.</p>
1.75 rillig 10193: </td>
10194: </tr>
1.148 asau 10195: <tr class="question">
1.75 rillig 10196: <td align="left" valign="top">
1.338 nia 10197: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.4.</b></p>
1.75 rillig 10198: </td>
1.110 hubertf 10199: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 10200: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10201: say it's empty?</p></td>
10202: </tr>
10203: <tr class="answer">
1.91 rillig 10204: <td align="left" valign="top"></td>
1.75 rillig 10205: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 10206: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10207: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 10208: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 10209: command.</p></td>
10210: </tr>
1.148 asau 10211: <tr class="question">
1.78 rillig 10212: <td align="left" valign="top">
1.338 nia 10213: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.5.</b></p>
1.78 rillig 10214: </td>
10215: <td align="left" valign="top"><p>What does
1.220 wiz 10216: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10217: don't understand the <code class="code">:=</code> inside
1.78 rillig 10218: it.</p></td>
10219: </tr>
10220: <tr class="answer">
1.91 rillig 10221: <td align="left" valign="top"></td>
1.338 nia 10222: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
10223: assignment operator, even though it may look like one.
1.78 rillig 10224: Instead, it is a degenerate form of
1.220 wiz 10225: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.322 leot 10226: which is documented in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220 wiz 10227: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78 rillig 10228: case of <code class="varname">MASTER_SITE_*</code>,
10229: <em class="replaceable"><code>old_string</code></em> is the empty string and
10230: <em class="replaceable"><code>new_string</code></em> is
1.220 wiz 10231: <code class="code">package/</code>. That's where the
10232: <code class="code">:</code> and the <code class="code">=</code> fall
1.78 rillig 10233: together.</p></td>
10234: </tr>
1.148 asau 10235: <tr class="question">
1.78 rillig 10236: <td align="left" valign="top">
1.338 nia 10237: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.6.</b></p>
1.78 rillig 10238: </td>
10239: <td align="left" valign="top"><p>Which mailing lists are there for package
10240: developers?</p></td>
10241: </tr>
10242: <tr class="answer">
1.91 rillig 10243: <td align="left" valign="top"></td>
1.148 asau 10244: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289 leot 10245: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78 rillig 10246: <dd><p>This is a list for technical discussions related
10247: to pkgsrc development, e.g. soliciting feedback for changes to
10248: pkgsrc infrastructure, proposed new features, questions related
10249: to porting pkgsrc to a new platform, advice for maintaining a
10250: package, patches that affect many packages, help requests moved
10251: from pkgsrc-users when an infrastructure bug is found,
10252: etc.</p></dd>
1.289 leot 10253: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78 rillig 10254: <dd><p>All bug reports in category "pkg" sent with
1.322 leot 10255: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78 rillig 10256: directly; use one of the other mailing
10257: lists.</p></dd>
10258: </dl></div></td>
10259: </tr>
1.148 asau 10260: <tr class="question">
1.80 rillig 10261: <td align="left" valign="top">
1.338 nia 10262: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.7.</b></p>
1.80 rillig 10263: </td>
10264: <td align="left" valign="top"><p>Where is the pkgsrc
10265: documentation?</p></td>
10266: </tr>
10267: <tr class="answer">
1.91 rillig 10268: <td align="left" valign="top"></td>
1.80 rillig 10269: <td align="left" valign="top">
10270: <p>There are many places where you can find
10271: documentation about pkgsrc:</p>
1.148 asau 10272: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10273: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 10274: of chapters that explain large parts of pkgsrc, but some
10275: chapters tend to be outdated. Which ones they are is hard to
10276: say.</p></li>
1.289 leot 10277: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>), you can find discussions
1.80 rillig 10278: about certain features, announcements of new parts of the pkgsrc
10279: infrastructure and sometimes even announcements that a certain
10280: feature has been marked as obsolete. The benefit here is that
10281: each message has a date appended to it.</p></li>
1.128 wiz 10282: <li class="listitem"><p>Many of the files in the
1.80 rillig 10283: <code class="filename">mk/</code> directory start with a comment that
10284: describes the purpose of the file and how it can be used by the
1.92 rillig 10285: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 10286: documentation is to run <span class="command"><strong>bmake
1.92 rillig 10287: help</strong></span>.</p></li>
1.128 wiz 10288: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 10289: information, but they tend to be highly abbreviated, especially
10290: for actions that occur often. Some contain a detailed
10291: description of what has changed, but they are geared towards the
10292: other pkgsrc developers, not towards an average pkgsrc user.
10293: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10294: don't know what has been before, these messages may not be worth
10295: too much to you.</p></li>
1.128 wiz 10296: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10297: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 10298: mind of the developer who wrote the code. To get this
1.110 hubertf 10299: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 10300: to see who has written it and ask on the
10301: <code class="literal">tech-pkg</code> mailing list, so that others can
10302: find your questions later (see above). To be sure that the
10303: developer in charge reads the mail, you may CC him or
10304: her.</p></li>
10305: </ul></div>
1.299 rillig 10306: </td>
10307: </tr>
10308: <tr class="question">
10309: <td align="left" valign="top">
1.338 nia 10310: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.8.</b></p>
1.299 rillig 10311: </td>
1.338 nia 10312: <td align="left" valign="top"><p>I have a little time to kill.
1.299 rillig 10313: What shall I do?</p></td>
10314: </tr>
10315: <tr class="answer">
10316: <td align="left" valign="top"></td>
10317: <td align="left" valign="top">
10318: <p>This is not really an FAQ yet, but here's the answer
10319: anyway.</p>
1.148 asau 10320: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 10321: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.322 leot 10322: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.299 rillig 10323: will tell you about newer versions of installed packages that are
10324: available, but not yet updated in pkgsrc.</p></li>
10325: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10326: — it contains a list of suggested new packages and a list of
10327: cleanups and enhancements for pkgsrc that would be nice to
10328: have.</p></li>
10329: <li class="listitem"><p>Review packages for which review was requested on
10330: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10331: mailing list.</p></li>
1.85 jmmv 10332: </ul></div>
1.299 rillig 10333: </td>
1.85 jmmv 10334: </tr>
10335: </tbody>
1.299 rillig 10336: </table>
1.85 jmmv 10337: </div>
10338: </div>
1.75 rillig 10339: </div>
1.148 asau 10340: <div class="part">
1.75 rillig 10341: <div class="titlepage"><div><div><h1 class="title">
10342: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10343: <div class="partintro">
1.75 rillig 10344: <div></div>
10345: <p>This part of the guide deals with everything
10346: from the infrastructure that is behind the interfaces described
10347: in the developer's guide. A casual package maintainer should not
10348: need anything from this part.</p>
10349: <div class="toc">
10350: <p><b>Table of Contents</b></p>
1.210 leot 10351: <dl class="toc">
1.299 rillig 10352: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10353: <dd><dl>
1.299 rillig 10354: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10355: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10356: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.75 rillig 10357: <dd><dl>
1.299 rillig 10358: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10359: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.75 rillig 10360: </dl></dd>
1.299 rillig 10361: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10362: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10363: <dd><dl>
1.299 rillig 10364: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10365: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81 rillig 10366: </dl></dd>
1.299 rillig 10367: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10368: <dd><dl>
1.299 rillig 10369: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10370: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10371: </dl></dd>
10372: </dl></dd>
1.299 rillig 10373: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 10374: <dd><dl>
1.299 rillig 10375: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10376: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10377: <dd><dl>
1.299 rillig 10378: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10379: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10380: </dl></dd>
10381: </dl></dd>
1.299 rillig 10382: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10383: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75 rillig 10384: </dl>
10385: </div>
10386: </div>
1.148 asau 10387: <div class="chapter">
1.75 rillig 10388: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10389: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10390: <div class="toc">
10391: <p><b>Table of Contents</b></p>
1.210 leot 10392: <dl class="toc">
1.299 rillig 10393: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10394: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10395: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81 rillig 10396: <dd><dl>
1.299 rillig 10397: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10398: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81 rillig 10399: </dl></dd>
1.299 rillig 10400: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10401: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10402: <dd><dl>
1.299 rillig 10403: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10404: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 10405: </dl></dd>
1.299 rillig 10406: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10407: <dd><dl>
1.299 rillig 10408: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10409: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10410: </dl></dd>
10411: </dl>
10412: </div>
10413: <p>The pkgsrc infrastructure consists of many small Makefile
10414: fragments. Each such fragment needs a properly specified
10415: interface. This chapter explains how such an interface looks
10416: like.</p>
1.148 asau 10417: <div class="sect1">
1.75 rillig 10418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10419: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10420: <p>Whenever a variable is defined in the pkgsrc
10421: infrastructure, the location and the way of definition provide
10422: much information about the intended use of that variable.
10423: Additionally, more documentation may be found in a header
10424: comment or in this pkgsrc guide.</p>
10425: <p>A special file is
10426: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10427: variables that are intended to be user-defined. They are either
10428: defined using the <code class="literal">?=</code> operator or they are
10429: left undefined because defining them to anything would
1.128 wiz 10430: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10431: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10432: file.</p>
10433: <p>Outside this file, the following conventions apply:
10434: Variables that are defined using the <code class="literal">?=</code>
10435: operator may be overridden by a package.</p>
10436: <p>Variables that are defined using the <code class="literal">=</code>
10437: operator may be used read-only at run-time.</p>
10438: <p>Variables whose name starts with an underscore must not be
10439: accessed outside the pkgsrc infrastructure at all. They may
10440: change without further notice.</p>
1.148 asau 10441: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10442: <h3 class="title">Note</h3>
10443: <p>These conventions are currently not applied
10444: consistently to the complete pkgsrc
10445: infrastructure.</p>
10446: </div>
10447: </div>
1.148 asau 10448: <div class="sect1">
1.81 rillig 10449: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10450: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10451: <p>All variables that contain lists of things should default
10452: to being empty. Two examples that do not follow this rule are
10453: <code class="varname">USE_LANGUAGES</code> and
10454: <code class="varname">DISTFILES</code>. These variables cannot simply be
10455: modified using the <code class="literal">+=</code> operator in package
10456: <code class="filename">Makefile</code>s (or other files included by
10457: them), since there is no guarantee whether the variable is
10458: already set or not, and what its value is. In the case of
1.128 wiz 10459: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10460: the default value and just define it as in the following
10461: example.</p>
10462: <pre class="programlisting">
1.100 rillig 10463: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10464: </pre>
10465: <p>Because of the selection of this default value, the same
10466: value appears in many package Makefiles. Similarly for
10467: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10468: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10469: doesn't stand out. Nevertheless it is mentioned in many
10470: files.</p>
10471: </div>
1.148 asau 10472: <div class="sect1">
1.81 rillig 10473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10474: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.148 asau 10475: <div class="sect2">
1.75 rillig 10476: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10477: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.75 rillig 10478: <p>Variable evaluation takes place either at load time or at
10479: runtime, depending on the context in which they occur. The
10480: contexts where variables are evaluated at load time are:</p>
1.148 asau 10481: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10482: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10483: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10484: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10485: <code class="literal">.for</code>,</p></li>
1.128 wiz 10486: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10487: </ul></div>
10488: <p>A special exception are references to the iteration
10489: variables of <code class="literal">.for</code> loops, which are expanded
10490: inline, no matter in which context they appear.</p>
10491: <p>As the values of variables may change during load time,
10492: care must be taken not to evaluate them by accident. Typical
10493: examples for variables that should not be evaluated at load time
10494: are <code class="varname">DEPENDS</code> and
10495: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10496: clear, here is an example:</p>
10497: <pre class="programlisting">
1.100 rillig 10498: CONFIGURE_ARGS= # none
10499: CFLAGS= -O
10500: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10501:
1.100 rillig 10502: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10503:
1.100 rillig 10504: CFLAGS+= -Wall
1.222 sevan 10505: </pre>
1.75 rillig 10506: <p>This code shows how the use of the <code class="literal">:=</code>
10507: operator can quickly lead to unexpected results. The first
10508: paragraph is fairly common code. The second paragraph evaluates
10509: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10510: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10511: <code class="literal">-Wall</code> is appended to the
10512: <code class="varname">CFLAGS</code>, but this addition will not appear in
10513: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10514: paragraphs from above typically occur in completely unrelated
10515: files.</p>
10516: </div>
1.148 asau 10517: <div class="sect2">
1.75 rillig 10518: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10519: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.75 rillig 10520: <p>After all the files have been loaded, the values of the
10521: variables cannot be changed anymore. Variables that are used in
10522: the shell commands are expanded at this point.</p>
10523: </div>
10524: </div>
1.148 asau 10525: <div class="sect1">
1.75 rillig 10526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10527: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10528: <p>There are many ways in which the definition and use of a
1.218 rillig 10529: variable can be restricted in order to detect bugs and violations
10530: of the (mostly unwritten) policies. A package can be checked with
10531: <code class="literal">pkglint -Wall</code> to see whether it meets these
10532: rules.</p>
1.78 rillig 10533: </div>
1.148 asau 10534: <div class="sect1">
1.78 rillig 10535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10536: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10537: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10538: of the following classes. Cases where a file falls into more
10539: than one class should be avoided as it often leads to subtle
10540: bugs.</p>
1.148 asau 10541: <div class="sect2">
1.75 rillig 10542: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10543: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10544: <p>In a traditional imperative programming language some of
1.76 rillig 10545: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10546: procedures. They take some input parameters and—after
10547: inclusion—provide a result in output parameters. Since all
1.76 rillig 10548: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10549: care must be taken not to use parameter names that have already
10550: another meaning. For example, <code class="varname">PKGNAME</code> is a
10551: bad choice for a parameter name.</p>
10552: <p>Procedures are completely evaluated at preprocessing time.
10553: That is, when calling a procedure all input parameters must be
10554: completely resolvable. For example,
10555: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10556: parameter since it is very likely that further text will be
10557: added after calling the procedure, which would effectively apply
10558: the procedure to only a part of the variable. Also, references
1.218 rillig 10559: to other variables will be modified after calling the
1.75 rillig 10560: procedure.</p>
10561: <p>A procedure can declare its output parameters either as
10562: suitable for use in preprocessing directives or as only
10563: available at runtime. The latter alternative is for variables
10564: that contain references to other runtime variables.</p>
10565: <p>Procedures shall be written such that it is possible to
10566: call the procedure more than once. That is, the file must not
10567: contain multiple-inclusion guards.</p>
10568: <p>Examples for procedures are
1.76 rillig 10569: <code class="filename">mk/bsd.options.mk</code> and
10570: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10571: that the parameters are evaluated at load time, they should be
10572: assigned using the <code class="literal">:=</code> operator, which should
10573: be used only for this purpose.</p>
10574: </div>
1.148 asau 10575: <div class="sect2">
1.75 rillig 10576: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10577: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10578: <p>Action files take some input parameters and may define
10579: runtime variables. They shall not define loadtime variables.
10580: There are action files that are included implicitly by the
10581: pkgsrc infrastructure, while other must be included
10582: explicitly.</p>
10583: <p>An example for action files is
1.76 rillig 10584: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10585: </div>
10586: </div>
1.148 asau 10587: <div class="sect1">
1.81 rillig 10588: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10589: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10590: <p>Package <code class="filename">Makefile</code>s usually consist of
10591: a set of variable definitions, and include the file
10592: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10593: Before that, they may also include various other
10594: <code class="filename">*.mk</code> files if they need to query the
10595: availability of certain features like the type of compiler or
10596: the X11 implementation. Due to the heavy use of preprocessor
10597: directives like <code class="literal">.if</code> and
10598: <code class="literal">.for</code>, the order in which the files are loaded
10599: matters.</p>
10600: <p>This section describes at which point the various files
10601: are loaded and gives reasons for that order.</p>
1.148 asau 10602: <div class="sect2">
1.81 rillig 10603: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10604: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10605: </h3></div></div></div>
10606: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10607: is to define some essential variables like
10608: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10609: <code class="varname">MACHINE_ARCH</code>.</p>
10610: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10611: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104 rillig 10612: After that, those variables
1.81 rillig 10613: that have not been overridden by the user are loaded from
10614: <code class="filename">mk/defaults/mk.conf</code>.</p>
10615: <p>After the user settings, the system settings and platform
10616: settings are loaded, which may override the user
10617: settings.</p>
10618: <p>Then, the tool definitions are loaded. The tool wrappers
10619: are not yet in effect. This only happens when building a
10620: package, so the proper variables must be used instead of the
10621: direct tool names.</p>
10622: <p>As the last steps, some essential variables from the
10623: wrapper and the package system flavor are loaded, as well as the
10624: variables that have been cached in earlier phases of a package
10625: build.</p>
10626: </div>
1.148 asau 10627: <div class="sect2">
1.81 rillig 10628: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10629: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10630: </h3></div></div></div>
1.81 rillig 10631: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10632: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10633: loaded, which fill default values for those variables that have
1.93 rillig 10634: not been defined by the package. These variables may later
1.81 rillig 10635: be used even in unrelated files.</p>
10636: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10637: provides the target <code class="literal">error-check</code> that is added
10638: as a special dependency to all other targets that use
10639: <code class="varname">DELAYED_ERROR_MSG</code> or
10640: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10641: <p>Then, the package-specific hacks from
10642: <code class="filename">hacks.mk</code> are included.</p>
10643: <p>Then, various other files follow. Most of them don't have
10644: any dependencies on what they need to have included before or
10645: after them, though some do.</p>
10646: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10647: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10648: restricts the use of these variables to all the files that have
10649: been included before. Appearances in later files will be
10650: silently ignored.</p>
10651: <p>Then, the files for the main targets are included, in the
10652: order of later execution, though the actual order should not
10653: matter.</p>
10654: <p>At last, some more files are included that don't set any
10655: interesting variables but rather just define make targets to be
10656: executed.</p>
10657: </div>
10658: </div>
1.75 rillig 10659: </div>
1.148 asau 10660: <div class="chapter">
1.75 rillig 10661: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10662: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.75 rillig 10663: <div class="toc">
10664: <p><b>Table of Contents</b></p>
1.210 leot 10665: <dl class="toc">
1.299 rillig 10666: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10667: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10668: <dd><dl>
1.299 rillig 10669: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10670: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10671: </dl></dd>
10672: </dl>
10673: </div>
10674: <p>The pkgsrc infrastructure consists of a large codebase,
10675: and there are many corners where every little bit of a file is
10676: well thought out, making pkgsrc likely to fail as soon as
10677: anything is changed near those parts. To prevent most changes
10678: from breaking anything, a suite of regression tests should go
10679: along with every important part of the pkgsrc infrastructure.
10680: This chapter describes how regression tests work in pkgsrc and
10681: how you can add new tests.</p>
1.148 asau 10682: <div class="sect1">
1.75 rillig 10683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10684: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.322 leot 10685: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/index.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110 hubertf 10686: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10687: can simply run that command, which will run all tests in the
1.283 rillig 10688: <code class="filename">regress/</code> directory.</p>
1.75 rillig 10689: </div>
1.148 asau 10690: <div class="sect1">
1.75 rillig 10691: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10692: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.283 rillig 10693: <p>Every directory in the <code class="filename">regress/</code>
10694: directory that contains a file called <code class="filename">spec</code>
1.75 rillig 10695: is considered a regression test. This file is a shell program
1.110 hubertf 10696: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10697: The following functions can be overridden to suit your
10698: needs.</p>
1.148 asau 10699: <div class="sect2">
1.75 rillig 10700: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10701: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.218 rillig 10702: <p>These functions do not take any parameters. Although they
10703: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.289 leot 10704: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218 rillig 10705: question</a> for details.</p>
1.148 asau 10706: <div class="variablelist"><dl class="variablelist">
1.218 rillig 10707: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75 rillig 10708: <dd><p>This function prepares the environment for the
10709: test. By default it does nothing.</p></dd>
1.218 rillig 10710: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10711: <dd>
10712: <p>This function runs the actual test. By default,
1.75 rillig 10713: it calls <code class="varname">TEST_MAKE</code> with the arguments
10714: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10715: error messages into the file
1.218 rillig 10716: <code class="varname">TEST_OUTFILE</code>.</p>
10717: <p>When defining this function, make sure that all output that
10718: needs to be checked is written to the correct output file.
10719: Example:</p>
10720: <pre class="programlisting">
10721: do_test() {
1.223 rillig 10722: echo "Example output"
1.218 rillig 10723: } 1>$TEST_OUTFILE 2>&1
10724: </pre>
10725: </dd>
10726: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10727: <dd>
10728: <p>This function is run after the test and is
1.75 rillig 10729: typically used to compare the actual output from the one that is
10730: expected. It can make use of the various helper functions from
1.218 rillig 10731: the next section. Example:</p>
10732: <pre class="programlisting">
10733: check_result() {
1.223 rillig 10734: exit_status 0
10735: output_require "Example"
10736: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10737: output_prohibit "no such file or directory"
1.283 rillig 10738: regress_fail "expected $expected but got $actual for input $input"
1.218 rillig 10739: }
10740: </pre>
10741: </dd>
10742: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75 rillig 10743: <dd><p>This function cleans everything up after the
10744: test has been run. By default it does nothing.</p></dd>
10745: </dl></div>
10746: </div>
1.148 asau 10747: <div class="sect2">
1.75 rillig 10748: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10749: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.148 asau 10750: <div class="variablelist"><dl class="variablelist">
1.283 rillig 10751: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10752: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218 rillig 10753: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75 rillig 10754: <dd><p>This function compares the exitcode of the
1.218 rillig 10755: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75 rillig 10756: If they differ, the test will fail.</p></dd>
1.218 rillig 10757: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10758: <dd>
10759: <p>This function checks for each of its parameters
10760: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75 rillig 10761: extended regular expression. If it does not, the test will
1.218 rillig 10762: fail. Example:</p>
10763: <pre class="programlisting">
1.219 rillig 10764: output_require "looks fine"
10765: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218 rillig 10766: </pre>
10767: </dd>
1.292 leot 10768: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75 rillig 10769: <dd><p>This function checks for each of its parameters
1.110 hubertf 10770: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10771: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10772: If any of the regular expressions matches, the test will
10773: fail.</p></dd>
10774: </dl></div>
10775: </div>
10776: </div>
10777: </div>
1.148 asau 10778: <div class="chapter">
1.75 rillig 10779: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10780: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10781: <div class="toc">
10782: <p><b>Table of Contents</b></p>
1.299 rillig 10783: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.75 rillig 10784: </div>
10785: <p>The pkgsrc system has already been ported to many
10786: operating systems, hardware architectures and compilers. This
10787: chapter explains the necessary steps to make pkgsrc even more
10788: portable.</p>
1.148 asau 10789: <div class="sect1">
1.75 rillig 10790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10791: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10792: <p>To port pkgsrc to a new operating system (called
10793: <code class="literal">MyOS</code> in this example), you need to touch the
10794: following files:</p>
1.148 asau 10795: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10796: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75 rillig 10797: <dd><p>This file contains some basic definitions, for
10798: example the name of the C
10799: compiler.</p></dd>
1.76 rillig 10800: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10801: <dd><p>Insert code that defines the variables
10802: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.327 wiz 10803: <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.75 rillig 10804: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10805: <code class="varname">APPEND_ELF</code>, and the other variables that
10806: appear in this file.</p></dd>
1.93 rillig 10807: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10808: <dd><p>This file contains the platform-specific
10809: definitions that are used by pkgsrc. Start by copying one of the
10810: other files and edit it to your
10811: needs.</p></dd>
1.93 rillig 10812: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10813: <dd><p>This file defines the paths to all the tools
10814: that are needed by one or the other package in pkgsrc, as well
10815: as by pkgsrc itself. Find out where these tools are on your
10816: platform and add them.</p></dd>
10817: </dl></div>
10818: <p>Now, you should be able to build some basic packages, like
1.322 leot 10819: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/index.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/index.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75 rillig 10820: </div>
10821: </div>
10822: </div>
1.148 asau 10823: <div class="appendix">
10824: <div class="titlepage"><div><div><h1 class="title">
10825: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10826: <div class="toc">
10827: <p><b>Table of Contents</b></p>
1.210 leot 10828: <dl class="toc">
1.75 rillig 10829: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10830: <dd><dl>
10831: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10832: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10833: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287 rillig 10834: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 10835: </dl></dd>
10836: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10837: </dl>
10838: </div>
10839: <p>We checked to find a piece of software that wasn't in the packages
10840: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10841: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10842: present in the tree is beyond us, but it's useful for the purposes of
10843: this exercise.</p>
1.148 asau 10844: <div class="sect1">
1.75 rillig 10845: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10846: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10847: <div class="sect2">
1.75 rillig 10848: <div class="titlepage"><div><div><h3 class="title">
10849: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10850: <pre class="programlisting">
1.100 rillig 10851: # $NetBSD$
10852: #
1.1 grant 10853:
1.100 rillig 10854: DISTNAME= bison-1.25
10855: CATEGORIES= devel
1.286 rillig 10856: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 grant 10857:
1.136 dholland 10858: MAINTAINER= pkgsrc-users@NetBSD.org
1.289 leot 10859: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.100 rillig 10860: COMMENT= GNU yacc clone
1.1 grant 10861:
1.100 rillig 10862: GNU_CONFIGURE= yes
1.152 wiz 10863: INFO_FILES= yes
1.1 grant 10864:
1.100 rillig 10865: .include "../../mk/bsd.pkg.mk"
1.1 grant 10866: </pre>
1.75 rillig 10867: </div>
1.148 asau 10868: <div class="sect2">
1.75 rillig 10869: <div class="titlepage"><div><div><h3 class="title">
10870: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10871: <pre class="programlisting">
1.100 rillig 10872: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.322 leot 10873: improvements. Why you would want this when Berkeley <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100 rillig 10874: of the NetBSD source tree is beyond me.
1.1 grant 10875: </pre>
1.75 rillig 10876: </div>
1.148 asau 10877: <div class="sect2">
1.75 rillig 10878: <div class="titlepage"><div><div><h3 class="title">
10879: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10880: <pre class="programlisting">
1.100 rillig 10881: @comment $NetBSD$
10882: bin/bison
10883: man/man1/bison.1.gz
10884: share/bison.simple
10885: share/bison.hairy
1.1 grant 10886: </pre>
1.75 rillig 10887: </div>
1.148 asau 10888: <div class="sect2">
1.75 rillig 10889: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 10890: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75 rillig 10891: <p>The NetBSD package system comes with
1.322 leot 10892: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75 rillig 10893: which helps to check the contents of these
10894: files. After installation it is quite easy to use, just change to the
1.286 rillig 10895: directory of the package you wish to examine and run
1.110 hubertf 10896: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10897: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286 rillig 10898: ERROR: Makefile: Each package must define its LICENSE.
10899: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10900: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10901: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10902: 1 error, 2 warnings and 1 note found.
10903: (Run "pkglint -e" to show explanations.)
10904: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287 rillig 10905: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75 rillig 10906: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285 rillig 10907: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75 rillig 10908: -Wall</strong></span> for a very thorough check.</p>
10909: </div>
10910: </div>
1.148 asau 10911: <div class="sect1">
1.75 rillig 10912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10913: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10914: <p>Create the directory where the package lives,
10915: plus any auxiliary directories:</p>
10916: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10917: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10918: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10919: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10920: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299 rillig 10921: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 12. Package components - files, directories and contents">Chapter 12, <i>Package components - files, directories and contents</i></a>)
1.75 rillig 10922: then continue with fetching the distfile:</p>
10923: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10924: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10925: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10926: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10927: ftp: Error retrieving file: 500 Internal error
10928:
10929: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10930: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10931: ftp: Error retrieving file: 500 Internal error
10932:
10933: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10934: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10935: Successfully retrieved file.</pre>
10936: <p>Generate the checksum of the distfile into
1.76 rillig 10937: <code class="filename">distinfo</code>:</p>
1.88 wiz 10938: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10939: <p>Now compile:</p>
10940: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10941: >> Checksum OK for bison-1.25.tar.gz.
10942: ===> Extracting for bison-1.25
10943: ===> Patching for bison-1.25
10944: ===> Ignoring empty patch directory
10945: ===> Configuring for bison-1.25
10946: creating cache ./config.cache
10947: checking for gcc... cc
10948: checking whether we are using GNU C... yes
10949: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10950: checking how to run the C preprocessor... cc -E
10951: checking for minix/config.h... no
10952: checking for POSIXized ISC... no
10953: checking whether cross-compiling... no
10954: checking for ANSI C header files... yes
10955: checking for string.h... yes
10956: checking for stdlib.h... yes
10957: checking for memory.h... yes
10958: checking for working const... yes
10959: checking for working alloca.h... no
10960: checking for alloca... yes
10961: checking for strerror... yes
10962: updating cache ./config.cache
10963: creating ./config.status
10964: creating Makefile
10965: ===> Building for bison-1.25
10966: 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
10967: 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
10968: 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
10969: 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
10970: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 10971: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\" -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -g ./files.c
1.1 grant 10972: 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
10973: 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
10974: 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
10975: 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
10976: 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
10977: 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
10978: 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
10979: 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
10980: 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
10981: 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
10982: 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
10983: 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
10984: 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
10985: 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
10986: 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
10987: 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
10988: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10989: rm -f bison.s1
1.75 rillig 10990: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10991: <p>Everything seems OK, so install the files:</p>
10992: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10993: >> Checksum OK for bison-1.25.tar.gz.
10994: ===> Installing for bison-1.25
10995: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10996: rm -f /usr/pkg/bin/bison
10997: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10998: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10999: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
11000: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
11001: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
11002: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
11003: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 11004: ===> Registering installation for bison-1.25</pre>
11005: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 11006: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 11007: binary package, do this now:</p>
11008: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 11009: >> Checksum OK for bison-1.25.tar.gz.
11010: ===> Building package for bison-1.25
11011: Creating package bison-1.25.tgz
11012: Registering depends:.
1.75 rillig 11013: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
11014: <p>Now that you don't need the source and object files
11015: any more, clean up:</p>
11016: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
11017: ===> Cleaning for bison-1.25</pre>
11018: </div>
11019: </div>
1.148 asau 11020: <div class="appendix">
11021: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 11022: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.75 rillig 11023: <div class="toc">
11024: <p><b>Table of Contents</b></p>
1.210 leot 11025: <dl class="toc">
1.322 leot 11026: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
11027: <dd><dl>
11028: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
11029: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
11030: </dl></dd>
11031: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
11032: <dd><dl>
11033: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
11034: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
11035: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
11036: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
11037: </dl></dd>
11038: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
11039: <dd><dl>
11040: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
11041: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
11042: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
11043: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
11044: </dl></dd>
1.75 rillig 11045: </dl>
11046: </div>
1.322 leot 11047: <p>
11048: A number of mechanisms are available in pkgsrc to improve the security of the
11049: resulting system. This page describes the mechanisms, and gives hints
11050: about detecting and fixing problems.
11051: </p>
11052: <p>
11053: Mechanisms can be enabled individually in
11054: <code class="filename">mk.conf</code>, and are
11055: individually described below.
11056: </p>
11057: <p>
11058: Typically, a feature will cause some programs to fail to build or work
11059: when first enabled. This can be due to latent problems in the
11060: program, and can be due to other reasons. After enough testing to
11061: have confidence that user problems will be quite rare, individual
11062: mechanisms will be enabled by default.
11063: </p>
11064: <p>
11065: For each mechanism, see the Caveats section below for an explanation
11066: of what might go wrong at compile time and at run time, and how to
11067: notice and address these problems.
11068: </p>
1.148 asau 11069: <div class="sect1">
1.75 rillig 11070: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11071: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
11072: <div class="sect2">
11073: <div class="titlepage"><div><div><h3 class="title">
11074: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
11075: <div class="sect3">
11076: <div class="titlepage"><div><div><h4 class="title">
11077: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
11078: <p>
11079: This allows substitute wrappers to be used for some commonly used
11080: library functions that do not have built-in bounds checking - but
11081: could in some cases.
11082: </p>
11083: <p>
11084: Two mitigation levels are available:
11085: </p>
11086: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11087: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
11088: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
11089: </ul></div>
11090: <p>
11091: "strong" has been enabled by default since pkgsrc-2017Q3.
11092: </p>
11093: </div>
11094: <div class="sect3">
11095: <div class="titlepage"><div><div><h4 class="title">
11096: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
11097: <p>
11098: This enables a stack-smashing protection mitigation. It is done by adding a
11099: guard variable to functions with vulnerable objects. The guards are initialized
11100: when a function is entered and then checked when the function exits. The guard
11101: check will fail and the program forcibly exited if the variable was modified in
11102: the meantime. This can happen in case of buffer overflows or memory corruption,
11103: and therefore exposing these bugs.
11104: </p>
11105: <p>
11106: Different mitigation levels are available:
11107: </p>
11108: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11109: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
11110: by the compiler;</p></li>
11111: <li class="listitem"><p>"all", which will protect every function;</p></li>
11112: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
11113: two settings above.</p></li>
11114: </ul></div>
11115: <p>
11116: This mitigation is supported by both GCC and clang. It may be supported in
11117: additional compilers, possibly under a different name. It is particularly useful
11118: for unsafe programming languages, such as C/C++.
11119: </p>
11120: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11121: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
11122: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
11123: </ul></div>
11124: <p>More details can be found here:</p>
11125: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11126: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
11127: </p></li></ul></div>
11128: </div>
11129: <div class="sect3">
11130: <div class="titlepage"><div><div><h4 class="title">
11131: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
11132: <p>
11133: This requests the creation of PIE (Position Independent Executables) for all
11134: executables. The PIE mechanism is normally used for shared libraries, so that
11135: they can be loaded at differing addresses at runtime. PIE itself does not have
11136: useful security properties; however, it is necessary to fully leverage some,
11137: such as ASLR. Some operating systems support Address Space Layout Randomization
11138: (ASLR), which causes different addresses to be used each time a program is run.
11139: This makes it more difficult for an attacker to guess addresses and thus makes
11140: exploits harder to construct. With PIE, ASLR can really be applied to the entire
11141: program, instead of the stack and heap only.
11142: </p>
11143: <p>
11144: PIE executables will only be built for toolchains that are known to support PIE.
11145: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
11146: </p>
11147: <p>
11148: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
11149: </p>
1.75 rillig 11150: </div>
1.325 gutterid 11151: <div class="sect3">
11152: <div class="titlepage"><div><div><h4 class="title">
1.334 nia 11153: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.322 leot 11154: <p>
11155: This also makes the exploitation of some security vulnerabilities more
11156: difficult in some cases.
11157: </p>
11158: <p>Two different mitigation levels are available:</p>
11159: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11160: <li class="listitem"><p>
1.334 nia 11161: partial (the default): the ELF sections are reordered so that internal data sections
1.322 leot 11162: precede the program's own data sections, and non-PLT GOT is read-only;
11163: </p></li>
11164: <li class="listitem"><p>
11165: full: in addition to partial RELRO, every relocation is performed immediately
1.333 nia 11166: when starting the program, allowing the entire GOT to be read-only. This
11167: can greatly slow down startup of large programs.
1.322 leot 11168: </p></li>
11169: </ul></div>
11170: <p>
11171: This is currently supported by GCC. Many software distributions now enable this
1.335 nia 11172: feature by default, at the "partial" level.
1.322 leot 11173: </p>
11174: <p>
11175: More details can be found here:
11176: </p>
11177: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11178: <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>
11179: </p></li></ul></div>
1.75 rillig 11180: </div>
1.334 nia 11181: </div>
11182: <div class="sect2">
11183: <div class="titlepage"><div><div><h3 class="title">
11184: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
11185: <div class="sect3">
11186: <div class="titlepage"><div><div><h4 class="title">
11187: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
11188: <p>
11189: With this option, pkgsrc will try to build packages reproducibly. This allows
11190: packages built from the same tree and with the same options, to produce
11191: identical results bit by bit. This option should be combined with ASLR and
11192: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
11193: attackers attempting to exploit security vulnerabilities.
11194: </p>
11195: <p>
11196: More details can be found here:
11197: </p>
11198: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11199: <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>
11200: </p></li></ul></div>
11201: <p>
11202: More work likely needs to be done before pkgsrc is fully reproducible.
11203: </p>
11204: </div>
1.322 leot 11205: <div class="sect3">
11206: <div class="titlepage"><div><div><h4 class="title">
1.334 nia 11207: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.322 leot 11208: <p>
11209: This uses <code class="literal">-fstack-check</code> with GCC for
11210: another stack protection mitigation.
11211: </p>
11212: <p>
11213: It asks the compiler to generate code verifying that it does not corrupt the
11214: stack. According to GCC's manual page, this is really only useful for
11215: multi-threaded programs.
11216: </p>
1.76 rillig 11217: </div>
11218: </div>
11219: </div>
1.148 asau 11220: <div class="sect1">
1.76 rillig 11221: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11222: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
11223: <div class="sect2">
11224: <div class="titlepage"><div><div><h3 class="title">
11225: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
11226: <div class="sect3">
11227: <div class="titlepage"><div><div><h4 class="title">
11228: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
11229: <p>
11230: A number of packages may fail to build with this option enabled. The
11231: failures are often related to the absence of the <code class="literal">-fPIC</code>
11232: compilation flag when building libraries or executables (or ideally
11233: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
11234: <code class="varname">CFLAGS</code> already, but requires the package to
11235: actually support it.
11236: </p>
11237: <div class="sect4">
11238: <div class="titlepage"><div><div><h5 class="title">
11239: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
11240: <p>
11241: These instructions are meant as a reference only; they likely need to be adapted
11242: for many packages individually.
11243: </p>
11244: <p>
11245: For packages using <code class="filename">Makefiles</code>:
11246: </p>
11247: <pre class="programlisting">
11248: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
11249: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
11250: </pre>
11251: <p>
11252: For packages using <code class="filename">Imakefiles</code>:
11253: </p>
11254: <pre class="programlisting">
11255: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
11256: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
11257: </pre>
11258: </div>
11259: </div>
11260: <div class="sect3">
11261: <div class="titlepage"><div><div><h4 class="title">
11262: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
11263: <p>
11264: Some programs may fail to run, or crash at random times once built as PIE. Two
11265: scenarios are essentially possible. This is nearly always due to a bug in
11266: the program being exposed due to ASLR.
11267: </p>
11268: </div>
11269: <div class="sect3">
11270: <div class="titlepage"><div><div><h4 class="title">
11271: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
11272: <p>
11273: Ideally, packages should be fixed for compatibility with MKPIE.
11274: However, in some cases this is very difficult, due to complex build systems,
11275: packages using non-standard toolchains, or programming languages with odd
11276: bootstrapping mechanisms.
11277: </p>
11278: <p>
11279: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
11280: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
11281: <code class="filename">bsd.prefs.mk</code> is included.
11282: </p>
11283: </div>
11284: </div>
11285: <div class="sect2">
11286: <div class="titlepage"><div><div><h3 class="title">
11287: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
11288: <div class="sect3">
11289: <div class="titlepage"><div><div><h4 class="title">
11290: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
11291: <p>
11292: This feature makes use of pre-processing directives to look for hardened,
11293: alternative implementations of essential library calls. Some programs may fail
11294: to build as a result; this usually happens for those trying too hard to be
11295: portable, or otherwise abusing definitions in the standard library.
11296: </p>
11297: </div>
11298: <div class="sect3">
11299: <div class="titlepage"><div><div><h4 class="title">
11300: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
11301: <p>
11302: This feature may cause some programs to crash, usually indicating an
11303: actual bug in the program. The fix will typically involve patching the
11304: original program's source code.
11305: </p>
11306: </div>
11307: <div class="sect3">
11308: <div class="titlepage"><div><div><h4 class="title">
11309: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
11310: <p>
11311: At least in the case of GCC, FORTIFY will only be applied if optimization is
11312: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
11313: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
11314: optimization level. This cannot easily be applied globally, as some packages
11315: may require specific optimization levels.
11316: </p>
11317: </div>
11318: <div class="sect3">
11319: <div class="titlepage"><div><div><h4 class="title">
11320: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
11321: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11322: <h3 class="title">Note</h3>
11323: <p>FORTIFY should not be disabled to work around runtime crashes in
11324: the program! This is a very bad idea and will expose you to security
11325: vulnerabilities.
11326: </p>
11327: </div>
11328: <p>
11329: To disable FORTIFY on a per-package basis, set the following
11330: in the package's <code class="filename">Makefile</code>
11331: before <code class="filename">bsd.prefs.mk</code> is included:
11332: </p>
11333: <pre class="programlisting">
11334: FORTIFY_SUPPORTED= no
11335: </pre>
11336: </div>
11337: </div>
11338: <div class="sect2">
11339: <div class="titlepage"><div><div><h3 class="title">
11340: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
11341: <div class="sect3">
11342: <div class="titlepage"><div><div><h4 class="title">
11343: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
11344: <p>
11345: For better protection, full RELRO requires every symbol to be resolved when the
11346: program starts, rather than simply when required at run-time. This will have
11347: more impact on programs using a lot of symbols, or linked to libraries exposing
11348: a lot of symbols. Therefore, daemons or programs otherwise running in
11349: background are affected only when started. Programs loading plug-ins at
11350: run-time are affected when loading the plug-ins.
11351: </p>
11352: <p>
11353: The impact is not expected to be noticeable on modern hardware, except in some
11354: cases for big programs.
11355: </p>
11356: </div>
11357: <div class="sect3">
11358: <div class="titlepage"><div><div><h4 class="title">
11359: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
11360: <p>
11361: Some programs handle plug-ins and dependencies in a way that conflicts with
11362: RELRO: for instance, with an initialization routine listing any other plug-in
11363: required. With full RELRO, the missing symbols are resolved before the
11364: initialization routine can run, and the dynamic loader will not be able to find
11365: them directly and abort as a result. Unfortunately, this is how Xorg loads its
11366: drivers. Partial RELRO can be applied instead in this case.
11367: </p>
11368: </div>
11369: <div class="sect3">
11370: <div class="titlepage"><div><div><h4 class="title">
11371: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
11372: <p>
11373: To disable RELRO on a per-package basis, set the following
11374: in the package's <code class="filename">Makefile</code>
11375: before <code class="filename">bsd.prefs.mk</code> is included:
11376: </p>
11377: <pre class="programlisting">
11378: RELRO_SUPPORTED= no
11379: </pre>
1.324 nia 11380: <p>
11381: It is also possible to at most enable partial RELRO, by
11382: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
11383: </p>
1.322 leot 11384: </div>
11385: </div>
11386: <div class="sect2">
11387: <div class="titlepage"><div><div><h3 class="title">
11388: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
11389: <div class="sect3">
11390: <div class="titlepage"><div><div><h4 class="title">
11391: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
11392: <p>
11393: The stack-smashing protection provided by this option does not work for some
11394: programs. The most common situation in which this happens is when the program
11395: allocates variables on the stack, with the size determined at run-time.
11396: </p>
11397: </div>
11398: <div class="sect3">
11399: <div class="titlepage"><div><div><h4 class="title">
11400: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
11401: <p>
11402: Again, this feature may cause some programs to crash via a
11403: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
11404: </p>
11405: <p>
11406: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
11407: messages are sent and - by default -
11408: appended to <code class="filename">/var/log/messages</code>, e.g.:
11409: </p>
11410: <pre class="programlisting">
11411: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
11412: </pre>
11413: <p>
11414: (where <code class="literal">hostname</code> is the hostname(1) and
11415: <code class="literal">program</code> is the basename(1) of the program crashed).
11416: </p>
11417: <p>
11418: Patching the original program is then required.
11419: </p>
11420: <p>
11421: Rebuilding the package via:
11422: </p>
11423: <pre class="programlisting">
11424: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
11425: </pre>
11426: <p>
11427: and inspecting the backtrace of the coredump via the debugger
11428: should point out the problematic call by inspecting the frame
11429: calling the _chk() (SSP) function.
11430: </p>
11431: </div>
11432: <div class="sect3">
11433: <div class="titlepage"><div><div><h4 class="title">
11434: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
11435: <p>
11436: The compiler emits extra code when using this feature: a check for buffer
11437: overflows is performed when entering and exiting functions, requiring an extra
11438: variable on the stack. The level of protection can otherwise be adjusted to
11439: affect only those functions considered more sensitive by the compiler (with
11440: -fstack-protector instead of -fstack-protector-all).
11441: </p>
11442: <p>
11443: The impact is not expected to be noticeable on modern hardware. However,
11444: programs with a hard requirement to run at the fastest possible speed should
11445: avoid using this feature, or using libraries built with this feature.
11446: </p>
11447: </div>
11448: <div class="sect3">
11449: <div class="titlepage"><div><div><h4 class="title">
11450: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
11451: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11452: <h3 class="title">Note</h3>
11453: <p>SSP should not be disabled to work around runtime crashes in
11454: the program! This is a very bad idea and will expose you to security
11455: vulnerabilities.</p>
11456: </div>
11457: <p>
11458: To disable SSP on a per-package basis, set the following
11459: in the package's <code class="filename">Makefile</code>
11460: before <code class="filename">bsd.prefs.mk</code> is included:
11461: </p>
11462: <pre class="programlisting">
11463: SSP_SUPPORTED= no
11464: </pre>
11465: </div>
11466: </div>
11467: </div>
11468: <div class="sect1">
11469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11470: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
11471: <p>
11472: The illusion of security is worse than having no security at all. This section
11473: lists a number of ways to ensure the security features requested are actually
11474: effective.
11475: </p>
11476: <p>
11477: These instructions were obtained and tested on a system derived from NetBSD 7
11478: (amd64). YMMV.
11479: </p>
11480: <div class="sect2">
11481: <div class="titlepage"><div><div><h3 class="title">
11482: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
11483: <p>
11484: The ELF executable type in use changes for binaries built as PIE; without:
11485: </p>
11486: <pre class="programlisting">
11487: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
11488: /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
11489: </pre>
11490: <p>as opposed to the following binary, built as PIE:</p>
11491: <pre class="programlisting">
11492: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
11493: /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
11494: </pre>
11495: <p>
11496: The latter result is then what is expected.
11497: </p>
11498: </div>
11499: <div class="sect2">
11500: <div class="titlepage"><div><div><h3 class="title">
11501: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
11502: <p>
11503: The following command should list a section called RELRO:
11504: </p>
11505: <pre class="programlisting">
11506: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
11507:
11508: /path/to/bin/ary: file format elf64-x86-64
11509:
11510: Program Header:
11511: [...]
11512: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
11513: </pre>
11514: <p>
11515: This check is now performed automatically if
11516: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
11517: </p>
11518: </div>
11519: <div class="sect2">
11520: <div class="titlepage"><div><div><h3 class="title">
11521: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
11522: <p>
11523: The dynamic loader will apply RELRO immediately when detecting the presence of
11524: the <code class="varname">BIND_NOW</code> flag:
11525: </p>
11526: <pre class="programlisting">
11527: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
11528:
11529: /path/to/bin/ary: file format elf64-x86-64
11530:
11531: Dynamic Section:
11532: [...]
11533: BIND_NOW 0x0000000000000000
11534: </pre>
11535: <p>
11536: This has to be combined with partial RELRO (see above) to be fully efficient.
11537: </p>
11538: <p>
11539: This check is now performed automatically (where supported) if
11540: <code class="varname">PKG_DEVELOPER</code> is set.
11541: </p>
11542: </div>
11543: <div class="sect2">
11544: <div class="titlepage"><div><div><h3 class="title">
11545: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.323 nia 11546: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11547: <h3 class="title">Note</h3>
11548: <p>
11549: Checking for SSP using this method only works where the operating system
11550: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
11551: on recent NetBSD/FreeBSD/Linux versions.
11552: </p>
11553: </div>
1.322 leot 11554: <p>
11555: Building objects, binaries and libraries with SSP will affect the presence of
11556: additional symbols in the resulting file:
11557: </p>
11558: <pre class="programlisting">
11559: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
11560: [...]
11561: U __stack_chk_fail
11562: 0000000000600ea0 B __stack_chk_guard
11563: </pre>
11564: <p>
11565: This is an indicator that the program was indeed built with support for SSP.
11566: </p>
11567: <p>
11568: This check is now performed automatically (where supported) if
11569: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
11570: </p>
11571: </div>
11572: </div>
11573: </div>
11574: <div class="appendix">
11575: <div class="titlepage"><div><div><h1 class="title">
11576: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
11577: <div class="toc">
11578: <p><b>Table of Contents</b></p>
11579: <dl class="toc">
11580: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
11581: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
11582: </dl>
11583: </div>
11584: <div class="sect1">
11585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11586: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
11587: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11588: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11589: => figlet221.tar.gz doesn't seem to exist on this system.
11590: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11591: => [172219 bytes]
11592: Connected to ftp.plig.net.
11593: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11594: 331 Guest login ok, send your complete e-mail address as password.
11595: 230-You are user #5 of 500 simultaneous users allowed.
11596: 230-
11597: 230- ___ _ _ _
11598: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11599: 230- | _| _| . |_| . | | | . |_| . | _| . |
11600: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11601: 230- |_| |_| |___| |___|
11602: 230-
11603: 230-** Welcome to ftp.plig.org **
11604: 230-
11605: 230-Please note that all transfers from this FTP site are logged. If you
11606: 230-do not like this, please disconnect now.
11607: 230-
11608: 230-This archive is available via
11609: 230-
11610: 230-HTTP: http://ftp.plig.org/
11611: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11612: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11613: 230-
11614: 230-Please email comments, bug reports and requests for packages to be
11615: 230-mirrored to ftp-admin@plig.org.
11616: 230-
11617: 230-
11618: 230 Logged in anonymously.
11619: Remote system type is UNIX.
11620: Using binary mode to transfer files.
11621: 200 Type okay.
11622: 250 "/pub" is new cwd.
11623: 250-"/pub/figlet" is new cwd.
11624: 250-
11625: 250-Welcome to the figlet archive at ftp.figlet.org
11626: 250-
11627: 250- ftp://ftp.figlet.org/pub/figlet/
11628: 250-
11629: 250-The official FIGlet web page is:
11630: 250- http://www.figlet.org/
11631: 250-
11632: 250-If you have questions, please mailto:info@figlet.org. If you want to
11633: 250-contribute a font or something else, you can email us.
11634: 250
11635: 250 "/pub/figlet/program" is new cwd.
11636: 250 "/pub/figlet/program/unix" is new cwd.
11637: local: figlet221.tar.gz remote: figlet221.tar.gz
11638: 502 Unimplemented command.
11639: 227 Entering Passive Mode (195,40,6,41,246,104)
11640: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11641: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11642: 226 Transfer completed.
11643: 172219 bytes received in 00:02 (75.99 KB/s)
11644: 221 Goodbye.
11645: => Checksum OK for figlet221.tar.gz.
11646: ===> Extracting for figlet-2.2.1nb2
11647: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11648: ===> Patching for figlet-2.2.1nb2
11649: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11650: ===> Overriding tools for figlet-2.2.1nb2
11651: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11652: ===> Configuring for figlet-2.2.1nb2
11653: ===> Building for figlet-2.2.1nb2
11654: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11655: chmod a+x figlet
11656: gcc -O2 -o chkfont chkfont.c
11657: => Unwrapping files-to-be-installed.
11658: <code class="prompt">#</code>
11659: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11660: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11661: ===> Installing for figlet-2.2.1nb2
11662: install -d -o root -g wheel -m 755 /usr/pkg/bin
11663: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11664: mkdir -p /usr/pkg/share/figlet
11665: cp figlet /usr/pkg/bin
11666: cp chkfont /usr/pkg/bin
11667: chmod 555 figlist showfigfonts
11668: cp figlist /usr/pkg/bin
11669: cp showfigfonts /usr/pkg/bin
11670: cp fonts/*.flf /usr/pkg/share/figlet
11671: cp fonts/*.flc /usr/pkg/share/figlet
11672: cp figlet.6 /usr/pkg/man/man6
11673: ===> Registering installation for figlet-2.2.1nb2
11674: <code class="prompt">#</code></pre>
11675: </div>
11676: <div class="sect1">
11677: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11678: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
11679: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11680: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11681: ===> Packaging figlet-2.2.1nb2
11682: ===> Building binary package for figlet-2.2.1nb2
11683: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11684: Using SrcDir value of /usr/pkg
11685: Registering depends:.
11686: <code class="prompt">#</code></pre>
11687: </div>
11688: </div>
11689: <div class="appendix">
11690: <div class="titlepage"><div><div><h1 class="title">
11691: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
11692: <div class="toc">
11693: <p><b>Table of Contents</b></p>
11694: <dl class="toc">
11695: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11696: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11697: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11698: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11699: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
11700: <code class="filename">stable</code>,
11701: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11702: source packages</a></span></dt>
11703: </dl>
11704: </div>
11705: <p>As in other big projects, the directory layout of pkgsrc
11706: is quite complex for newbies. This chapter explains where you
11707: find things on the FTP server. The base directory on
11708: <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>.
11709: On other servers it may be different, but inside this directory,
11710: everything should look the same, no matter on which server you
11711: are. This directory contains some subdirectories, which are
11712: explained below.</p>
11713: <div class="sect1">
11714: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11715: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
11716: <p>The directory <code class="filename">distfiles</code> contains lots
11717: of archive files from all pkgsrc packages, which are mirrored
11718: here. The subdirectories are called after their package names
11719: and are used when the distributed files have names that don't
11720: explicitly contain a version number or are otherwise too generic
11721: (for example <code class="filename">release.tar.gz</code>).</p>
11722: </div>
11723: <div class="sect1">
11724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11725: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
11726: <p>This directory contains things that individual pkgsrc
11727: developers find worth publishing.</p>
11728: </div>
11729: <div class="sect1">
11730: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11731: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
11732: <p>This directory contains binary packages for the various
11733: platforms that are supported by pkgsrc.
11734: 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>
11735: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11736: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
11737: operating system for which the packages have been built. The
11738: name is taken from the output of the <span class="command"><strong>uname</strong></span>
11739: command, so it may differ from the one you are used to
11740: hear.</p></li>
11741: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
11742: architecture of the platform for which the packages have been
11743: built. It also includes the <code class="varname">ABI</code> (Application
11744: Binary Interface) for platforms that have several of
11745: them.</p></li>
11746: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
11747: the operating system. For version numbers that change often (for
11748: example NetBSD-current), the often-changing part should be
11749: replaced with an <code class="literal">x</code>, for example
11750: <code class="literal">4.99.x</code>.</p></li>
11751: <li class="listitem"><p><code class="varname">TAG</code> is either
11752: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11753: for a stable branch, or <code class="literal">head</code> for packages
11754: built from the HEAD branch. The latter should only be used when
11755: the packages are updated on a regular basis. Otherwise the date
11756: from checking out pkgsrc should be appended, for example
11757: <code class="literal">head_20071015</code>.</p></li>
11758: </ul></div>
11759: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11760: can quickly click through the directories on the
11761: server and find the best binary packages for their machines. Since they
11762: usually know the operating system and the hardware architecture, OPSYS
11763: and ARCH are placed first. After these choices, they can select the
11764: best combination of OSVERSION and TAG together, since it is usually the
11765: case that packages stay compatible between different version of the
11766: operating system.</p>
11767: <p>In each of these directories, there is a
11768: whole binary packages collection for a specific platform. It has a directory called
11769: <code class="filename">All</code> which contains all binary packages.
11770: Besides that, there are various category directories that
11771: contain symbolic links to the real binary packages.</p>
11772: </div>
11773: <div class="sect1">
11774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11775: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 11776: <p>Here are the reports from bulk builds, for those who want
11777: to fix packages that didn't build on some of the platforms. The
1.322 leot 11778: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="D.3. packages: Binary packages">Section D.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.108 rillig 11779: </div>
1.148 asau 11780: <div class="sect1">
1.108 rillig 11781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11782: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.261 leot 11783: <code class="filename">stable</code>,
1.126 jakllsch 11784: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11785: source packages</h2></div></div></div>
1.128 wiz 11786: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 11787: that is the files that define how to create binary packages from
11788: source archives.</p>
1.262 leot 11789: <p>Each of the <code class="filename">current</code>,
11790: <code class="filename">stable</code> and
11791: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11792: directories share the same structure. They each contain a
11793: <code class="filename">pkgsrc</code> directory and
11794: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76 rillig 11795: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11796: snapshot of the CVS repository, which is updated regularly. The
1.262 leot 11797: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11798: as the directory, ready to be downloaded as a whole.</p>
11799: <p>The <code class="filename">current</code> directory contains files
11800: related to the HEAD branch of the CVS repository.
11801: In this directory there is an additional file called
11802: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11803: all pkgsrc <code class="filename">README</code>s with information about
11804: categories and packages.
11805: </p>
11806: <p>The <code class="filename">stable</code> directory is a symlink to
11807: the latest
11808: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11809: </p>
11810: <p>The
11811: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11812: directories contain files related to the
11813: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11814: stable branch of the CVS repository. In these directories there is
11815: an additional file called
11816: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.{bz,gz,xz}</code>,
1.76 rillig 11817: which contains the state of pkgsrc when it was branched.</p>
11818: </div>
1.75 rillig 11819: </div>
1.148 asau 11820: <div class="appendix">
11821: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 11822: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.267 rillig 11823: <p>
11824: The following list contains all help topics that are available
11825: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11826: </p>
1.269 leot 11827: <table border="0" summary="Simple list" class="simplelist">
11828: <tr>
11829: <td>#!</td>
11830: <td>-lintl</td>
11831: </tr>
11832: <tr>
1.320 wiz 11833: <td>32bit</td>
1.269 leot 11834: <td>64bit</td>
1.320 wiz 11835: </tr>
11836: <tr>
1.269 leot 11837: <td>ABI</td>
1.320 wiz 11838: <td>ACCEPTABLE_LICENSES</td>
1.269 leot 11839: </tr>
11840: <tr>
11841: <td>ACROREAD_FONTPATH</td>
1.320 wiz 11842: <td>ADDITIONAL</td>
1.269 leot 11843: </tr>
11844: <tr>
11845: <td>AFAIK</td>
1.320 wiz 11846: <td>AIX</td>
1.269 leot 11847: </tr>
11848: <tr>
11849: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.320 wiz 11850: <td>ALL_ENV</td>
1.269 leot 11851: </tr>
11852: <tr>
1.348 wiz 11853: <td>ALSA_PC</td>
1.315 cirnatda 11854: <td>ALTERNATIVES_SRC</td>
1.348 wiz 11855: </tr>
11856: <tr>
1.343 gutterid 11857: <td>AMANDA_TMP</td>
1.348 wiz 11858: <td>AMANDA_USER</td>
1.342 wiz 11859: </tr>
11860: <tr>
1.343 gutterid 11861: <td>AMANDA_VAR</td>
1.348 wiz 11862: <td>APACHE_GROUP</td>
1.338 nia 11863: </tr>
11864: <tr>
1.343 gutterid 11865: <td>APACHE_MODULE_NAME</td>
1.348 wiz 11866: <td>APACHE_MODULE_SRC</td>
1.332 rillig 11867: </tr>
11868: <tr>
1.343 gutterid 11869: <td>APACHE_MODULE_SRCDIR</td>
1.348 wiz 11870: <td>APACHE_PKG_PREFIX</td>
1.329 leot 11871: </tr>
11872: <tr>
1.343 gutterid 11873: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.348 wiz 11874: <td>APACHE_SUEXEC_DOCROOT</td>
1.327 wiz 11875: </tr>
11876: <tr>
1.343 gutterid 11877: <td>APACHE_USER</td>
1.348 wiz 11878: <td>APPEND_ABI</td>
1.311 leot 11879: </tr>
11880: <tr>
1.343 gutterid 11881: <td>APPEND_ELF</td>
1.348 wiz 11882: <td>ARLA_CACHE</td>
1.292 leot 11883: </tr>
11884: <tr>
1.343 gutterid 11885: <td>AUDIT_PACKAGES_FLAGS</td>
1.348 wiz 11886: <td>AUTOCONF_REQD</td>
1.274 rillig 11887: </tr>
11888: <tr>
1.343 gutterid 11889: <td>AUTOMAKE_OVERRIDE</td>
1.348 wiz 11890: <td>AUTOMAKE_REQD</td>
1.269 leot 11891: </tr>
11892: <tr>
1.343 gutterid 11893: <td>AUTO_MKDIRS</td>
1.348 wiz 11894: <td>BDB185_DEFAULT</td>
1.269 leot 11895: </tr>
11896: <tr>
1.343 gutterid 11897: <td>BDBBASE</td>
1.348 wiz 11898: <td>BDB_ACCEPTED</td>
1.269 leot 11899: </tr>
11900: <tr>
1.343 gutterid 11901: <td>BDB_DEFAULT</td>
1.348 wiz 11902: <td>BDB_LIBS</td>
1.269 leot 11903: </tr>
11904: <tr>
1.343 gutterid 11905: <td>BDB_TYPE</td>
1.348 wiz 11906: <td>BINCIMAP_GROUP</td>
1.269 leot 11907: </tr>
11908: <tr>
1.343 gutterid 11909: <td>BINCIMAP_USER</td>
1.348 wiz 11910: <td>BIND_DIR</td>
1.269 leot 11911: </tr>
11912: <tr>
1.343 gutterid 11913: <td>BIND_GROUP</td>
1.348 wiz 11914: <td>BIND_USER</td>
1.269 leot 11915: </tr>
11916: <tr>
1.343 gutterid 11917: <td>BINOWN</td>
1.348 wiz 11918: <td>BINPKG_SITES</td>
1.269 leot 11919: </tr>
11920: <tr>
1.343 gutterid 11921: <td>BIN_INSTALL_FLAGS</td>
1.348 wiz 11922: <td>BISON_PKGDATADIR</td>
1.269 leot 11923: </tr>
11924: <tr>
1.343 gutterid 11925: <td>BLAS</td>
1.348 wiz 11926: <td>BLAS_ACCEPTED</td>
1.269 leot 11927: </tr>
11928: <tr>
1.343 gutterid 11929: <td>BLAS_C_INTERFACE</td>
1.348 wiz 11930: <td>BLAS_INCLUDES</td>
1.269 leot 11931: </tr>
11932: <tr>
1.343 gutterid 11933: <td>BLAS_INDEX64</td>
1.348 wiz 11934: <td>BLAS_LIBS</td>
1.312 gdt 11935: </tr>
11936: <tr>
1.344 gutterid 11937: <td>BLAS_PC</td>
1.348 wiz 11938: <td>BLAS_TYPE</td>
1.344 gutterid 11939: </tr>
11940: <tr>
11941: <td>BOOTSTRAP_DEPENDS</td>
1.348 wiz 11942: <td>BROKEN</td>
1.269 leot 11943: </tr>
11944: <tr>
1.344 gutterid 11945: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.348 wiz 11946: <td>BROKEN_ON_PLATFORM</td>
1.269 leot 11947: </tr>
11948: <tr>
1.344 gutterid 11949: <td>BSDSRCDIR</td>
1.348 wiz 11950: <td>BSDXSRCDIR</td>
1.303 bacon 11951: </tr>
11952: <tr>
1.344 gutterid 11953: <td>BSD_MAKE_ENV</td>
1.348 wiz 11954: <td>BUILDLINK_AUTO_DIRS</td>
1.320 wiz 11955: </tr>
11956: <tr>
1.344 gutterid 11957: <td>BUILDLINK_AUTO_VARS</td>
1.348 wiz 11958: <td>BUILDLINK_CFLAGS</td>
1.269 leot 11959: </tr>
11960: <tr>
1.344 gutterid 11961: <td>BUILDLINK_CONTENTS_FILTER</td>
1.348 wiz 11962: <td>BUILDLINK_CPPFLAGS</td>
1.292 leot 11963: </tr>
11964: <tr>
1.348 wiz 11965: <td>BUILDLINK_DEPMETHOD</td>
1.344 gutterid 11966: <td>BUILDLINK_FILES</td>
1.269 leot 11967: </tr>
11968: <tr>
1.331 gutterid 11969: <td>BUILDLINK_FILES_CMD</td>
1.344 gutterid 11970: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.320 wiz 11971: </tr>
11972: <tr>
1.331 gutterid 11973: <td>BUILDLINK_LDFLAGS</td>
1.344 gutterid 11974: <td>BUILDLINK_LIBS</td>
1.269 leot 11975: </tr>
11976: <tr>
1.331 gutterid 11977: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.344 gutterid 11978: <td>BUILDLINK_PKGNAME</td>
1.269 leot 11979: </tr>
11980: <tr>
1.331 gutterid 11981: <td>BUILDLINK_PREFIX</td>
1.344 gutterid 11982: <td>BUILDLINK_RPATHDIRS</td>
1.269 leot 11983: </tr>
11984: <tr>
1.331 gutterid 11985: <td>BUILDLINK_TREE</td>
1.344 gutterid 11986: <td>BUILD_DEFS</td>
1.269 leot 11987: </tr>
11988: <tr>
1.331 gutterid 11989: <td>BUILD_DEFS_EFFECTS</td>
1.344 gutterid 11990: <td>BUILD_DEPENDS</td>
1.269 leot 11991: </tr>
11992: <tr>
1.331 gutterid 11993: <td>BUILD_DIRS</td>
1.344 gutterid 11994: <td>BUILD_ENV_SHELL</td>
1.269 leot 11995: </tr>
11996: <tr>
1.331 gutterid 11997: <td>BUILD_MAKE_CMD</td>
1.344 gutterid 11998: <td>BUILD_MAKE_FLAGS</td>
1.269 leot 11999: </tr>
12000: <tr>
1.331 gutterid 12001: <td>BUILD_TARGET</td>
1.344 gutterid 12002: <td>BUILTIN_FIND_FILES</td>
1.269 leot 12003: </tr>
12004: <tr>
1.331 gutterid 12005: <td>BUILTIN_FIND_FILES_VAR</td>
1.344 gutterid 12006: <td>BUILTIN_FIND_GREP</td>
1.269 leot 12007: </tr>
12008: <tr>
1.331 gutterid 12009: <td>BUILTIN_FIND_HEADERS</td>
1.344 gutterid 12010: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.269 leot 12011: </tr>
12012: <tr>
1.331 gutterid 12013: <td>BUILTIN_FIND_PKGCONFIG</td>
1.344 gutterid 12014: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.269 leot 12015: </tr>
12016: <tr>
1.331 gutterid 12017: <td>BUILTIN_PKG</td>
1.344 gutterid 12018: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.309 gutterid 12019: </tr>
12020: <tr>
1.331 gutterid 12021: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.344 gutterid 12022: <td>BUILTIN_VERSION_SCRIPT</td>
1.269 leot 12023: </tr>
12024: <tr>
1.331 gutterid 12025: <td>BUILTIN_X11_TYPE</td>
1.344 gutterid 12026: <td>BUILTIN_X11_VERSION</td>
1.269 leot 12027: </tr>
12028: <tr>
1.331 gutterid 12029: <td>CACTI_GROUP</td>
1.344 gutterid 12030: <td>CACTI_USER</td>
1.269 leot 12031: </tr>
12032: <tr>
1.331 gutterid 12033: <td>CANNA_GROUP</td>
1.344 gutterid 12034: <td>CANNA_USER</td>
1.269 leot 12035: </tr>
12036: <tr>
1.331 gutterid 12037: <td>CAT</td>
1.344 gutterid 12038: <td>CBLAS_LIBS</td>
1.269 leot 12039: </tr>
12040: <tr>
1.344 gutterid 12041: <td>CBLAS_PC</td>
1.331 gutterid 12042: <td>CCACHE_BASE</td>
1.269 leot 12043: </tr>
12044: <tr>
1.303 bacon 12045: <td>CCACHE_DIR</td>
1.331 gutterid 12046: <td>CCACHE_LOGFILE</td>
1.269 leot 12047: </tr>
12048: <tr>
1.303 bacon 12049: <td>CC_VERSION</td>
1.331 gutterid 12050: <td>CC_VERSION_STRING</td>
1.269 leot 12051: </tr>
12052: <tr>
1.303 bacon 12053: <td>CDRECORD_CONF</td>
1.331 gutterid 12054: <td>CDROM_PKG_URL_DIR</td>
1.269 leot 12055: </tr>
12056: <tr>
1.303 bacon 12057: <td>CDROM_PKG_URL_HOST</td>
1.341 gutterid 12058: <td>CHANGES</td>
1.338 nia 12059: </tr>
12060: <tr>
1.348 wiz 12061: <td>CHECKOUT_DATE</td>
1.341 gutterid 12062: <td>CHECK_COMPILER</td>
1.348 wiz 12063: </tr>
12064: <tr>
1.343 gutterid 12065: <td>CHECK_FAKEHOME</td>
1.348 wiz 12066: <td>CHECK_FILES</td>
1.342 wiz 12067: </tr>
12068: <tr>
1.343 gutterid 12069: <td>CHECK_FILES_SKIP</td>
1.348 wiz 12070: <td>CHECK_FILES_STRICT</td>
1.332 rillig 12071: </tr>
12072: <tr>
1.343 gutterid 12073: <td>CHECK_HEADERS</td>
1.348 wiz 12074: <td>CHECK_HEADERS_SKIP</td>
1.329 leot 12075: </tr>
12076: <tr>
1.343 gutterid 12077: <td>CHECK_INTERPRETER</td>
1.348 wiz 12078: <td>CHECK_INTERPRETER_SKIP</td>
1.327 wiz 12079: </tr>
12080: <tr>
1.343 gutterid 12081: <td>CHECK_PERMS</td>
1.348 wiz 12082: <td>CHECK_PERMS_AUTOFIX</td>
1.320 wiz 12083: </tr>
12084: <tr>
1.343 gutterid 12085: <td>CHECK_PERMS_SKIP</td>
1.348 wiz 12086: <td>CHECK_PIE</td>
1.311 leot 12087: </tr>
12088: <tr>
1.343 gutterid 12089: <td>CHECK_PIE_SKIP</td>
1.348 wiz 12090: <td>CHECK_PIE_SUPPORTED</td>
1.292 leot 12091: </tr>
12092: <tr>
1.343 gutterid 12093: <td>CHECK_PORTABILITY</td>
1.348 wiz 12094: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.274 rillig 12095: </tr>
12096: <tr>
1.343 gutterid 12097: <td>CHECK_PORTABILITY_SKIP</td>
1.348 wiz 12098: <td>CHECK_RELRO</td>
1.331 gutterid 12099: </tr>
12100: <tr>
1.343 gutterid 12101: <td>CHECK_RELRO_SKIP</td>
1.348 wiz 12102: <td>CHECK_RELRO_SUPPORTED</td>
1.269 leot 12103: </tr>
12104: <tr>
1.343 gutterid 12105: <td>CHECK_SHLIBS</td>
1.348 wiz 12106: <td>CHECK_SHLIBS_SKIP</td>
1.269 leot 12107: </tr>
12108: <tr>
1.343 gutterid 12109: <td>CHECK_SHLIBS_SUPPORTED</td>
1.348 wiz 12110: <td>CHECK_SHLIBS_TOXIC</td>
1.269 leot 12111: </tr>
12112: <tr>
1.343 gutterid 12113: <td>CHECK_SSP</td>
1.348 wiz 12114: <td>CHECK_SSP_SKIP</td>
1.269 leot 12115: </tr>
12116: <tr>
1.343 gutterid 12117: <td>CHECK_SSP_SUPPORTED</td>
1.348 wiz 12118: <td>CHECK_STRIPPED</td>
1.269 leot 12119: </tr>
12120: <tr>
1.343 gutterid 12121: <td>CHECK_STRIPPED_SKIP</td>
1.348 wiz 12122: <td>CHECK_WRKREF</td>
1.269 leot 12123: </tr>
12124: <tr>
1.343 gutterid 12125: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.348 wiz 12126: <td>CHECK_WRKREF_SKIP</td>
1.269 leot 12127: </tr>
12128: <tr>
1.343 gutterid 12129: <td>CLAMAV_DBDIR</td>
1.348 wiz 12130: <td>CLAMAV_GROUP</td>
1.269 leot 12131: </tr>
12132: <tr>
1.343 gutterid 12133: <td>CLAMAV_USER</td>
1.348 wiz 12134: <td>CLANGBASE</td>
1.269 leot 12135: </tr>
12136: <tr>
1.343 gutterid 12137: <td>CLEANDEPENDS</td>
1.348 wiz 12138: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.269 leot 12139: </tr>
12140: <tr>
1.343 gutterid 12141: <td>CMAKE_INSTALL_NAME_DIR</td>
1.348 wiz 12142: <td>CMAKE_INSTALL_PREFIX</td>
1.269 leot 12143: </tr>
12144: <tr>
1.343 gutterid 12145: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.348 wiz 12146: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.269 leot 12147: </tr>
12148: <tr>
1.343 gutterid 12149: <td>CMAKE_PREFIX_PATH</td>
1.348 wiz 12150: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
12151: </tr>
12152: <tr>
12153: <td>COMMON_LISP_DOCFILES</td>
12154: <td>COMMON_LISP_EXAMPLES</td>
1.269 leot 12155: </tr>
12156: <tr>
1.348 wiz 12157: <td>COMMON_LISP_EXTRAFILES</td>
12158: <td>COMMON_LISP_PACKAGES</td>
12159: </tr>
12160: <tr>
12161: <td>COMMON_LISP_SYSTEM</td>
1.305 bacon 12162: <td>COMPILER_RPATH_FLAG</td>
1.269 leot 12163: </tr>
12164: <tr>
1.341 gutterid 12165: <td>COMPILER_USE_SYMLINKS</td>
1.305 bacon 12166: <td>CONFIGURE_ARGS</td>
1.269 leot 12167: </tr>
12168: <tr>
1.341 gutterid 12169: <td>CONFIGURE_DIRS</td>
1.305 bacon 12170: <td>CONFIGURE_ENV</td>
1.269 leot 12171: </tr>
12172: <tr>
1.341 gutterid 12173: <td>CONFIGURE_ENV_SHELL</td>
1.305 bacon 12174: <td>CONFIGURE_HAS_INFODIR</td>
1.269 leot 12175: </tr>
12176: <tr>
1.341 gutterid 12177: <td>CONFIGURE_HAS_MANDIR</td>
1.305 bacon 12178: <td>CONFIGURE_SCRIPT</td>
1.269 leot 12179: </tr>
12180: <tr>
1.341 gutterid 12181: <td>CONFIG_SHELL</td>
1.305 bacon 12182: <td>CONFIG_SHELL_FLAGS</td>
1.269 leot 12183: </tr>
12184: <tr>
1.341 gutterid 12185: <td>CONF_FILES</td>
1.305 bacon 12186: <td>CONF_FILES_MODE</td>
1.269 leot 12187: </tr>
12188: <tr>
1.341 gutterid 12189: <td>CONF_FILES_PERMS</td>
1.305 bacon 12190: <td>CONSERVER_DEFAULTHOST</td>
1.269 leot 12191: </tr>
12192: <tr>
1.341 gutterid 12193: <td>CONSERVER_DEFAULTPORT</td>
1.305 bacon 12194: <td>CP</td>
1.269 leot 12195: </tr>
12196: <tr>
1.347 gutterid 12197: <td>CPE</td>
12198: <td>CPE_EDITION</td>
12199: </tr>
12200: <tr>
12201: <td>CPE_LANG</td>
12202: <td>CPE_OTHER</td>
12203: </tr>
12204: <tr>
12205: <td>CPE_PART</td>
12206: <td>CPE_PRODUCT</td>
12207: </tr>
12208: <tr>
12209: <td>CPE_SW_EDITION</td>
12210: <td>CPE_TARGET_HW</td>
12211: </tr>
12212: <tr>
12213: <td>CPE_TARGET_SW</td>
12214: <td>CPE_UPDATE</td>
12215: </tr>
12216: <tr>
12217: <td>CPE_URI</td>
12218: <td>CPE_VENDOR</td>
12219: </tr>
12220: <tr>
12221: <td>CPE_VERSION</td>
1.341 gutterid 12222: <td>CPP</td>
1.269 leot 12223: </tr>
12224: <tr>
1.347 gutterid 12225: <td>CPP_PRECOMP_FLAGS</td>
1.341 gutterid 12226: <td>CREATE_WRKDIR_SYMLINK</td>
1.269 leot 12227: </tr>
12228: <tr>
1.347 gutterid 12229: <td>CROSSBASE</td>
1.341 gutterid 12230: <td>CTFCONVERT</td>
1.269 leot 12231: </tr>
12232: <tr>
1.347 gutterid 12233: <td>CTF_FILES_SKIP</td>
1.341 gutterid 12234: <td>CTF_SUPPORTED</td>
1.269 leot 12235: </tr>
12236: <tr>
1.347 gutterid 12237: <td>CTYPE</td>
1.341 gutterid 12238: <td>CUPS_GROUP</td>
1.269 leot 12239: </tr>
12240: <tr>
1.347 gutterid 12241: <td>CUPS_SYSTEM_GROUPS</td>
1.341 gutterid 12242: <td>CUPS_USER</td>
1.292 leot 12243: </tr>
12244: <tr>
1.347 gutterid 12245: <td>CURSES_DEFAULT</td>
1.341 gutterid 12246: <td>CURSES_TYPE</td>
1.342 wiz 12247: </tr>
12248: <tr>
1.348 wiz 12249: <td>CVS_EXTRACTDIR</td>
12250: <td>CVS_MODULE</td>
12251: </tr>
12252: <tr>
12253: <td>CVS_PROJECT</td>
12254: <td>CVS_REPOSITORIES</td>
12255: </tr>
12256: <tr>
12257: <td>CVS_ROOT</td>
12258: <td>CVS_ROOT_GNU</td>
12259: </tr>
12260: <tr>
12261: <td>CVS_ROOT_NONGNU</td>
12262: <td>CVS_ROOT_SOURCEFORGE</td>
12263: </tr>
12264: <tr>
12265: <td>CVS_TAG</td>
1.347 gutterid 12266: <td>CXX</td>
1.348 wiz 12267: </tr>
12268: <tr>
1.342 wiz 12269: <td>CYRUS_GROUP</td>
1.348 wiz 12270: <td>CYRUS_IDLE</td>
1.332 rillig 12271: </tr>
12272: <tr>
1.342 wiz 12273: <td>CYRUS_USER</td>
1.348 wiz 12274: <td>DAEMONTOOLS_GROUP</td>
1.329 leot 12275: </tr>
12276: <tr>
1.342 wiz 12277: <td>DAEMONTOOLS_LOG_USER</td>
1.348 wiz 12278: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.327 wiz 12279: </tr>
12280: <tr>
1.342 wiz 12281: <td>DARWIN_REQUIRES_FILTER</td>
1.348 wiz 12282: <td>DBUS_GROUP</td>
1.320 wiz 12283: </tr>
12284: <tr>
1.342 wiz 12285: <td>DBUS_USER</td>
1.348 wiz 12286: <td>DEFANG_GROUP</td>
1.311 leot 12287: </tr>
12288: <tr>
1.342 wiz 12289: <td>DEFANG_USER</td>
1.348 wiz 12290: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.269 leot 12291: </tr>
12292: <tr>
1.342 wiz 12293: <td>DEFAULT_DISTFILES</td>
1.348 wiz 12294: <td>DEFAULT_IRC_SERVER</td>
1.269 leot 12295: </tr>
12296: <tr>
1.342 wiz 12297: <td>DEFAULT_SERIAL_DEVICE</td>
1.348 wiz 12298: <td>DEF_UMASK</td>
1.269 leot 12299: </tr>
12300: <tr>
1.342 wiz 12301: <td>DEINSTALLDEPENDS</td>
1.348 wiz 12302: <td>DEINSTALL_SRC</td>
1.309 gutterid 12303: </tr>
12304: <tr>
1.342 wiz 12305: <td>DEINSTALL_TEMPLATES</td>
1.348 wiz 12306: <td>DELAYED_ERROR_MSG</td>
1.269 leot 12307: </tr>
12308: <tr>
1.342 wiz 12309: <td>DELAYED_WARNING_MSG</td>
1.348 wiz 12310: <td>DEPENDS</td>
1.269 leot 12311: </tr>
12312: <tr>
1.342 wiz 12313: <td>DEPENDS_TARGET</td>
1.348 wiz 12314: <td>DEPENDS_TYPE</td>
1.269 leot 12315: </tr>
12316: <tr>
1.342 wiz 12317: <td>DESTDIR</td>
1.348 wiz 12318: <td>DESTDIR_VARNAME</td>
1.269 leot 12319: </tr>
12320: <tr>
1.342 wiz 12321: <td>DIALER_GROUP</td>
1.348 wiz 12322: <td>DIGEST_REQD</td>
1.269 leot 12323: </tr>
12324: <tr>
1.342 wiz 12325: <td>DISTDIR</td>
1.348 wiz 12326: <td>DISTFILES</td>
1.269 leot 12327: </tr>
12328: <tr>
1.342 wiz 12329: <td>DISTINFO_FILE</td>
1.348 wiz 12330: <td>DISTNAME</td>
1.269 leot 12331: </tr>
12332: <tr>
1.342 wiz 12333: <td>DIST_PATH</td>
1.348 wiz 12334: <td>DIST_SUBDIR</td>
1.269 leot 12335: </tr>
12336: <tr>
1.342 wiz 12337: <td>DJBDNS_AXFR_USER</td>
1.348 wiz 12338: <td>DJBDNS_CACHE_USER</td>
1.269 leot 12339: </tr>
12340: <tr>
1.342 wiz 12341: <td>DJBDNS_DJBDNS_GROUP</td>
1.348 wiz 12342: <td>DJBDNS_LOG_USER</td>
1.269 leot 12343: </tr>
12344: <tr>
1.342 wiz 12345: <td>DJBDNS_RBL_USER</td>
1.348 wiz 12346: <td>DJBDNS_TINY_USER</td>
1.269 leot 12347: </tr>
12348: <tr>
1.342 wiz 12349: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.348 wiz 12350: <td>DL_AUTO_VARS</td>
1.269 leot 12351: </tr>
12352: <tr>
1.342 wiz 12353: <td>DL_CFLAGS</td>
1.348 wiz 12354: <td>DL_LDFLAGS</td>
1.269 leot 12355: </tr>
12356: <tr>
1.342 wiz 12357: <td>DL_LIBS</td>
1.348 wiz 12358: <td>DNS</td>
1.269 leot 12359: </tr>
12360: <tr>
1.342 wiz 12361: <td>DOCOWN</td>
1.348 wiz 12362: <td>DOWNLOADED_DISTFILE</td>
1.269 leot 12363: </tr>
12364: <tr>
1.342 wiz 12365: <td>DQCACHE_GROUP</td>
1.348 wiz 12366: <td>DQCACHE_USER</td>
1.269 leot 12367: </tr>
12368: <tr>
1.342 wiz 12369: <td>DT_LAYOUT</td>
1.348 wiz 12370: <td>DYNAMIC_SITES_CMD</td>
1.333 nia 12371: </tr>
12372: <tr>
1.342 wiz 12373: <td>DYNAMIC_SITES_SCRIPT</td>
1.348 wiz 12374: <td>ECHO</td>
1.269 leot 12375: </tr>
12376: <tr>
1.342 wiz 12377: <td>ECHO_N</td>
1.348 wiz 12378: <td>ELK_GUI</td>
1.269 leot 12379: </tr>
12380: <tr>
1.342 wiz 12381: <td>EMACS_TYPE</td>
1.348 wiz 12382: <td>EMULDIR</td>
1.269 leot 12383: </tr>
12384: <tr>
1.342 wiz 12385: <td>EMULSUBDIR</td>
1.348 wiz 12386: <td>EMULSUBDIRSLASH</td>
1.269 leot 12387: </tr>
12388: <tr>
1.342 wiz 12389: <td>EMUL_ARCH</td>
1.348 wiz 12390: <td>EMUL_DISTRO</td>
1.269 leot 12391: </tr>
12392: <tr>
1.342 wiz 12393: <td>EMUL_EXEC_FMT</td>
1.348 wiz 12394: <td>EMUL_IS_NATIVE</td>
1.269 leot 12395: </tr>
12396: <tr>
1.342 wiz 12397: <td>EMUL_MODULES</td>
1.348 wiz 12398: <td>EMUL_OPSYS</td>
1.269 leot 12399: </tr>
12400: <tr>
1.342 wiz 12401: <td>EMUL_PKG_FMT</td>
1.348 wiz 12402: <td>EMUL_PLATFORM</td>
1.269 leot 12403: </tr>
12404: <tr>
1.342 wiz 12405: <td>EMUL_PLATFORMS</td>
1.348 wiz 12406: <td>EMUL_PREFER</td>
1.269 leot 12407: </tr>
12408: <tr>
1.342 wiz 12409: <td>EMUL_REQD</td>
1.348 wiz 12410: <td>EMUL_TYPE</td>
1.269 leot 12411: </tr>
12412: <tr>
1.342 wiz 12413: <td>ERROR_MSG</td>
1.348 wiz 12414: <td>EXIM_GROUP</td>
1.269 leot 12415: </tr>
12416: <tr>
1.342 wiz 12417: <td>EXIM_USER</td>
1.348 wiz 12418: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.269 leot 12419: </tr>
12420: <tr>
1.342 wiz 12421: <td>EXTRACTOR</td>
1.348 wiz 12422: <td>EXTRACT_CMD</td>
1.269 leot 12423: </tr>
12424: <tr>
1.342 wiz 12425: <td>EXTRACT_CMD_DEFAULT</td>
1.348 wiz 12426: <td>EXTRACT_DIR</td>
1.338 nia 12427: </tr>
12428: <tr>
1.342 wiz 12429: <td>EXTRACT_ELEMENTS</td>
1.348 wiz 12430: <td>EXTRACT_ENV</td>
1.269 leot 12431: </tr>
12432: <tr>
1.342 wiz 12433: <td>EXTRACT_ONLY</td>
1.348 wiz 12434: <td>EXTRACT_OPTS</td>
1.269 leot 12435: </tr>
12436: <tr>
1.342 wiz 12437: <td>EXTRACT_SUFX</td>
1.348 wiz 12438: <td>EXTRACT_USING</td>
1.269 leot 12439: </tr>
12440: <tr>
1.342 wiz 12441: <td>FAIL</td>
1.348 wiz 12442: <td>FAILOVER_FETCH</td>
1.269 leot 12443: </tr>
12444: <tr>
1.342 wiz 12445: <td>FAIL_MSG</td>
1.348 wiz 12446: <td>FAKE_NCURSES</td>
1.269 leot 12447: </tr>
12448: <tr>
1.342 wiz 12449: <td>FAM</td>
1.348 wiz 12450: <td>FAM_ACCEPTED</td>
1.269 leot 12451: </tr>
12452: <tr>
1.342 wiz 12453: <td>FAM_DEFAULT</td>
1.348 wiz 12454: <td>FAM_SERVER</td>
1.269 leot 12455: </tr>
12456: <tr>
1.342 wiz 12457: <td>FCPATH</td>
1.348 wiz 12458: <td>FEATURE_CPPFLAGS</td>
1.269 leot 12459: </tr>
12460: <tr>
1.342 wiz 12461: <td>FEATURE_LDFLAGS</td>
1.348 wiz 12462: <td>FEATURE_LIBS</td>
1.269 leot 12463: </tr>
12464: <tr>
1.342 wiz 12465: <td>FETCH_AFTER_ARGS</td>
1.348 wiz 12466: <td>FETCH_BEFORE_ARGS</td>
1.292 leot 12467: </tr>
12468: <tr>
1.342 wiz 12469: <td>FETCH_CMD</td>
1.348 wiz 12470: <td>FETCH_OUTPUT_ARGS</td>
1.269 leot 12471: </tr>
12472: <tr>
1.342 wiz 12473: <td>FETCH_PROXY</td>
1.348 wiz 12474: <td>FETCH_RESUME_ARGS</td>
1.269 leot 12475: </tr>
12476: <tr>
1.342 wiz 12477: <td>FETCH_TIMEOUT</td>
1.348 wiz 12478: <td>FETCH_USE_IPV4_ONLY</td>
1.269 leot 12479: </tr>
12480: <tr>
1.342 wiz 12481: <td>FETCH_USING</td>
1.348 wiz 12482: <td>FILES_SUBST</td>
1.269 leot 12483: </tr>
12484: <tr>
1.342 wiz 12485: <td>FILES_SUBST_SED</td>
1.348 wiz 12486: <td>FIX_SYSTEM_HEADERS</td>
1.274 rillig 12487: </tr>
12488: <tr>
1.348 wiz 12489: <td>FONTDIR</td>
1.341 gutterid 12490: <td>FONTS_DIRS</td>
1.292 leot 12491: </tr>
12492: <tr>
1.347 gutterid 12493: <td>FONTS_VERBOSE</td>
1.341 gutterid 12494: <td>FOO_HACKS_MK</td>
1.269 leot 12495: </tr>
12496: <tr>
1.348 wiz 12497: <td>FOSSIL_EXTRACTDIR</td>
12498: <td>FOSSIL_REPO</td>
12499: </tr>
12500: <tr>
12501: <td>FOSSIL_REPOSITORIES</td>
12502: <td>FOSSIL_VERSION</td>
12503: </tr>
12504: <tr>
1.347 gutterid 12505: <td>FOX_USE_XUNICODE</td>
1.341 gutterid 12506: <td>FREEWNN_GROUP</td>
1.269 leot 12507: </tr>
12508: <tr>
1.347 gutterid 12509: <td>FREEWNN_USER</td>
1.341 gutterid 12510: <td>FTP_PKG_URL_DIR</td>
1.269 leot 12511: </tr>
12512: <tr>
1.347 gutterid 12513: <td>FTP_PKG_URL_HOST</td>
1.341 gutterid 12514: <td>GAMEDATAMODE</td>
1.269 leot 12515: </tr>
12516: <tr>
1.347 gutterid 12517: <td>GAMEDATA_PERMS</td>
1.341 gutterid 12518: <td>GAMEDIRMODE</td>
1.269 leot 12519: </tr>
12520: <tr>
1.347 gutterid 12521: <td>GAMEDIR_PERMS</td>
1.341 gutterid 12522: <td>GAMEGRP</td>
1.269 leot 12523: </tr>
12524: <tr>
1.347 gutterid 12525: <td>GAMEMODE</td>
1.341 gutterid 12526: <td>GAMEOWN</td>
1.269 leot 12527: </tr>
12528: <tr>
1.347 gutterid 12529: <td>GAMES_GROUP</td>
1.341 gutterid 12530: <td>GAMES_USER</td>
1.269 leot 12531: </tr>
12532: <tr>
1.347 gutterid 12533: <td>GCC</td>
1.341 gutterid 12534: <td>GCCBASE</td>
1.269 leot 12535: </tr>
12536: <tr>
1.347 gutterid 12537: <td>GCC_REQD</td>
1.341 gutterid 12538: <td>GCC_VERSION_SUFFIX</td>
1.269 leot 12539: </tr>
12540: <tr>
1.347 gutterid 12541: <td>GEM_BUILD</td>
1.341 gutterid 12542: <td>GEM_CLEANBUILD</td>
1.269 leot 12543: </tr>
12544: <tr>
1.347 gutterid 12545: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.341 gutterid 12546: <td>GEM_DOCDIR</td>
1.292 leot 12547: </tr>
12548: <tr>
1.347 gutterid 12549: <td>GEM_EXTSDIR</td>
1.341 gutterid 12550: <td>GEM_HOME</td>
1.269 leot 12551: </tr>
12552: <tr>
1.347 gutterid 12553: <td>GEM_KEEPBUILD</td>
1.341 gutterid 12554: <td>GEM_LIBDIR</td>
1.269 leot 12555: </tr>
12556: <tr>
1.347 gutterid 12557: <td>GEM_NAME</td>
1.341 gutterid 12558: <td>GEM_PATH</td>
1.269 leot 12559: </tr>
12560: <tr>
1.347 gutterid 12561: <td>GEM_PLUGINSDIR</td>
1.341 gutterid 12562: <td>GEM_SPECFILE</td>
1.269 leot 12563: </tr>
12564: <tr>
1.347 gutterid 12565: <td>GENERATE_PLIST</td>
1.341 gutterid 12566: <td>GHC</td>
1.292 leot 12567: </tr>
12568: <tr>
1.347 gutterid 12569: <td>GHOSTSCRIPT_REQD</td>
1.341 gutterid 12570: <td>GITHUB_PROJECT</td>
1.311 leot 12571: </tr>
12572: <tr>
1.347 gutterid 12573: <td>GITHUB_RELEASE</td>
1.341 gutterid 12574: <td>GITHUB_SUBMODULES</td>
1.269 leot 12575: </tr>
12576: <tr>
1.347 gutterid 12577: <td>GITHUB_TAG</td>
1.341 gutterid 12578: <td>GITHUB_TYPE</td>
1.338 nia 12579: </tr>
12580: <tr>
1.347 gutterid 12581: <td>GITLAB_PROJECT</td>
1.341 gutterid 12582: <td>GITLAB_RELEASE</td>
1.338 nia 12583: </tr>
12584: <tr>
1.347 gutterid 12585: <td>GITLAB_SUBMODULES</td>
1.341 gutterid 12586: <td>GITLAB_TAG</td>
1.338 nia 12587: </tr>
12588: <tr>
1.347 gutterid 12589: <td>GITLAB_TYPE</td>
1.348 wiz 12590: <td>GIT_BRANCH</td>
12591: </tr>
12592: <tr>
12593: <td>GIT_ENV</td>
12594: <td>GIT_EXTRACTDIR</td>
12595: </tr>
12596: <tr>
12597: <td>GIT_REPO</td>
12598: <td>GIT_REPOSITORIES</td>
12599: </tr>
12600: <tr>
12601: <td>GIT_REVISION</td>
12602: <td>GIT_TAG</td>
1.342 wiz 12603: </tr>
12604: <tr>
1.348 wiz 12605: <td>GNU</td>
1.347 gutterid 12606: <td>GNU_CONFIGURE</td>
1.269 leot 12607: </tr>
12608: <tr>
1.348 wiz 12609: <td>GNU_CONFIGURE_INFODIR</td>
1.347 gutterid 12610: <td>GNU_CONFIGURE_MANDIR</td>
1.269 leot 12611: </tr>
12612: <tr>
1.348 wiz 12613: <td>GNU_CONFIGURE_QUIET</td>
1.347 gutterid 12614: <td>GNU_CONFIGURE_STRICT</td>
1.269 leot 12615: </tr>
12616: <tr>
1.348 wiz 12617: <td>GODEP_REDIRECTS</td>
1.347 gutterid 12618: <td>GO_BUILD_PATTERN</td>
1.276 leot 12619: </tr>
12620: <tr>
1.348 wiz 12621: <td>GO_DEPS</td>
1.347 gutterid 12622: <td>GO_DIST_BASE</td>
1.269 leot 12623: </tr>
12624: <tr>
1.348 wiz 12625: <td>GO_EXTRA_MOD_DIRS</td>
1.347 gutterid 12626: <td>GO_MODULE_FILES</td>
1.269 leot 12627: </tr>
12628: <tr>
1.348 wiz 12629: <td>GO_SRCPATH</td>
1.347 gutterid 12630: <td>GROUP_SPECIFIC_PKGS</td>
1.269 leot 12631: </tr>
12632: <tr>
1.348 wiz 12633: <td>GRUB_NETWORK_CARDS</td>
1.347 gutterid 12634: <td>GRUB_PRESET_COMMAND</td>
1.311 leot 12635: </tr>
12636: <tr>
1.348 wiz 12637: <td>GRUB_SCAN_ARGS</td>
1.347 gutterid 12638: <td>GZIP</td>
1.348 wiz 12639: </tr>
12640: <tr>
12641: <td>HASKELL_COMPILER</td>
12642: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.332 rillig 12643: </tr>
12644: <tr>
1.347 gutterid 12645: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.337 gutterid 12646: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.341 gutterid 12647: </tr>
12648: <tr>
1.347 gutterid 12649: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.341 gutterid 12650: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.335 nia 12651: </tr>
12652: <tr>
1.347 gutterid 12653: <td>HASKELL_PKG_NAME</td>
1.344 gutterid 12654: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
12655: </tr>
12656: <tr>
1.347 gutterid 12657: <td>HAS_CONFIGURE</td>
1.341 gutterid 12658: <td>HEADER_TEMPLATES</td>
1.329 leot 12659: </tr>
12660: <tr>
1.348 wiz 12661: <td>HG_REPO</td>
12662: <td>HG_REPOSITORIES</td>
12663: </tr>
12664: <tr>
12665: <td>HG_TAG</td>
1.347 gutterid 12666: <td>HOMEPAGE</td>
1.348 wiz 12667: </tr>
12668: <tr>
1.343 gutterid 12669: <td>HOST_PKGTOOLS_ARGS</td>
1.348 wiz 12670: <td>HOST_SPECIFIC_PKGS</td>
1.342 wiz 12671: </tr>
12672: <tr>
1.343 gutterid 12673: <td>HOWL_GROUP</td>
1.348 wiz 12674: <td>HOWL_USER</td>
1.338 nia 12675: </tr>
12676: <tr>
1.343 gutterid 12677: <td>ICCBASE</td>
1.348 wiz 12678: <td>ICECAST_CHROOTDIR</td>
1.269 leot 12679: </tr>
12680: <tr>
1.343 gutterid 12681: <td>ICON_THEMES</td>
1.348 wiz 12682: <td>IDOBASE</td>
1.305 bacon 12683: </tr>
12684: <tr>
1.343 gutterid 12685: <td>IGNORE_CCACHE</td>
1.348 wiz 12686: <td>IGNORE_INFO_DIRS</td>
1.269 leot 12687: </tr>
12688: <tr>
1.343 gutterid 12689: <td>IGNORE_INTERACTIVE_FETCH</td>
1.348 wiz 12690: <td>IMAKE</td>
1.269 leot 12691: </tr>
12692: <tr>
1.343 gutterid 12693: <td>IMAKEOPTS</td>
1.348 wiz 12694: <td>IMAKE_MAKE</td>
1.269 leot 12695: </tr>
12696: <tr>
1.343 gutterid 12697: <td>IMAKE_MANINSTALL</td>
1.348 wiz 12698: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.269 leot 12699: </tr>
12700: <tr>
1.343 gutterid 12701: <td>IMDICTDIR</td>
1.348 wiz 12702: <td>INCOMPAT_CURSES</td>
1.269 leot 12703: </tr>
12704: <tr>
1.343 gutterid 12705: <td>INFO_DIR</td>
1.348 wiz 12706: <td>INFO_FILES</td>
1.269 leot 12707: </tr>
12708: <tr>
1.343 gutterid 12709: <td>INFO_FILES_VERBOSE</td>
1.348 wiz 12710: <td>INFO_MSG</td>
1.269 leot 12711: </tr>
12712: <tr>
1.343 gutterid 12713: <td>INIT_SYSTEM</td>
1.348 wiz 12714: <td>INN_DATA_DIR</td>
1.269 leot 12715: </tr>
12716: <tr>
1.343 gutterid 12717: <td>INN_GROUP</td>
1.348 wiz 12718: <td>INN_USER</td>
1.269 leot 12719: </tr>
12720: <tr>
1.343 gutterid 12721: <td>INSTALLATION_DIRS</td>
1.348 wiz 12722: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.287 rillig 12723: </tr>
12724: <tr>
1.343 gutterid 12725: <td>INSTALL_ENV</td>
1.348 wiz 12726: <td>INSTALL_SH_OVERRIDE</td>
1.269 leot 12727: </tr>
12728: <tr>
1.343 gutterid 12729: <td>INSTALL_SRC</td>
1.348 wiz 12730: <td>INSTALL_TEMPLATES</td>
1.269 leot 12731: </tr>
12732: <tr>
1.343 gutterid 12733: <td>INSTALL_UNSTRIPPED</td>
1.348 wiz 12734: <td>IRCD_HYBRID_IRC_GROUP</td>
1.269 leot 12735: </tr>
12736: <tr>
1.343 gutterid 12737: <td>IRCD_HYBRID_IRC_USER</td>
1.348 wiz 12738: <td>IRCD_HYBRID_MAXCONN</td>
1.269 leot 12739: </tr>
12740: <tr>
1.343 gutterid 12741: <td>IRCD_HYBRID_NICLEN</td>
1.348 wiz 12742: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.269 leot 12743: </tr>
12744: <tr>
1.343 gutterid 12745: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.348 wiz 12746: <td>IRCD_HYBRID_TOPICLEN</td>
1.269 leot 12747: </tr>
12748: <tr>
1.343 gutterid 12749: <td>IRIX</td>
1.348 wiz 12750: <td>IRRD_USE_PGP</td>
1.269 leot 12751: </tr>
12752: <tr>
1.343 gutterid 12753: <td>JABBERD_GROUP</td>
1.348 wiz 12754: <td>JABBERD_LOGDIR</td>
1.269 leot 12755: </tr>
12756: <tr>
1.343 gutterid 12757: <td>JABBERD_PIDDIR</td>
1.348 wiz 12758: <td>JABBERD_SPOOLDIR</td>
1.347 gutterid 12759: </tr>
12760: <tr>
12761: <td>JABBERD_USER</td>
1.348 wiz 12762: <td>JAVA_APP_PATH</td>
1.269 leot 12763: </tr>
12764: <tr>
1.348 wiz 12765: <td>JAVA_APP_TARGETS</td>
1.344 gutterid 12766: <td>JAVA_BINPREFIX</td>
1.348 wiz 12767: </tr>
12768: <tr>
1.347 gutterid 12769: <td>JAVA_CLASSPATH</td>
1.348 wiz 12770: <td>JAVA_HOME</td>
1.292 leot 12771: </tr>
12772: <tr>
1.347 gutterid 12773: <td>JAVA_LD_LIBRARY_PATH</td>
1.348 wiz 12774: <td>JAVA_NAME</td>
1.342 wiz 12775: </tr>
12776: <tr>
1.347 gutterid 12777: <td>JAVA_UNLIMIT</td>
1.348 wiz 12778: <td>JAVA_WRAPPERS</td>
1.311 leot 12779: </tr>
12780: <tr>
1.347 gutterid 12781: <td>JPEG_ACCEPTED</td>
1.348 wiz 12782: <td>JPEG_DEFAULT</td>
1.269 leot 12783: </tr>
12784: <tr>
1.347 gutterid 12785: <td>KERBEROS</td>
1.348 wiz 12786: <td>KERMIT_SUID_UUCP</td>
1.332 rillig 12787: </tr>
12788: <tr>
1.347 gutterid 12789: <td>KJS_USE_PCRE</td>
1.348 wiz 12790: <td>KNEWS_DOMAIN_FILE</td>
1.332 rillig 12791: </tr>
12792: <tr>
1.347 gutterid 12793: <td>KNEWS_DOMAIN_NAME</td>
1.348 wiz 12794: <td>KRB5_ACCEPTED</td>
1.269 leot 12795: </tr>
12796: <tr>
1.347 gutterid 12797: <td>KRB5_DEFAULT</td>
1.348 wiz 12798: <td>LANGUAGES</td>
1.269 leot 12799: </tr>
12800: <tr>
1.347 gutterid 12801: <td>LAPACKE_LIBS</td>
1.348 wiz 12802: <td>LAPACKE_PC</td>
1.269 leot 12803: </tr>
12804: <tr>
1.347 gutterid 12805: <td>LAPACK_LIBS</td>
1.348 wiz 12806: <td>LAPACK_PC</td>
1.269 leot 12807: </tr>
12808: <tr>
1.347 gutterid 12809: <td>LATEX2HTML_ICONPATH</td>
1.348 wiz 12810: <td>LDCONFIG_ADD_CMD</td>
1.292 leot 12811: </tr>
12812: <tr>
1.347 gutterid 12813: <td>LDCONFIG_REMOVE_CMD</td>
1.348 wiz 12814: <td>LDD</td>
1.271 brook 12815: </tr>
12816: <tr>
1.347 gutterid 12817: <td>LEAFNODE_DATA_DIR</td>
1.348 wiz 12818: <td>LEAFNODE_GROUP</td>
1.269 leot 12819: </tr>
12820: <tr>
1.347 gutterid 12821: <td>LEAFNODE_USER</td>
1.348 wiz 12822: <td>LIBDVDCSS_HOMEPAGE</td>
1.269 leot 12823: </tr>
12824: <tr>
1.347 gutterid 12825: <td>LIBDVDCSS_MASTER_SITES</td>
1.348 wiz 12826: <td>LIBRSVG_TYPE</td>
1.269 leot 12827: </tr>
12828: <tr>
1.347 gutterid 12829: <td>LIBTOOL</td>
1.348 wiz 12830: <td>LIBTOOLIZE_PLIST</td>
1.269 leot 12831: </tr>
12832: <tr>
1.347 gutterid 12833: <td>LIBTOOL_M4_OVERRIDE</td>
1.348 wiz 12834: <td>LIBUSB_TYPE</td>
1.320 wiz 12835: </tr>
12836: <tr>
1.347 gutterid 12837: <td>LICENSE</td>
1.348 wiz 12838: <td>LINKER_RPATH_FLAG</td>
1.270 leot 12839: </tr>
12840: <tr>
1.347 gutterid 12841: <td>LINK_RPATH_FLAG</td>
1.348 wiz 12842: <td>LINUX_BASE_NODEPS</td>
12843: </tr>
12844: <tr>
12845: <td>LINUX_BASE_PREFERRED</td>
12846: <td>LINUX_BASE_REQUIRED</td>
1.269 leot 12847: </tr>
12848: <tr>
1.335 nia 12849: <td>LINUX_LOCALES</td>
1.347 gutterid 12850: <td>LOCALBASE</td>
1.338 nia 12851: </tr>
12852: <tr>
12853: <td>LOCALBASE_LOCKTYPE</td>
1.347 gutterid 12854: <td>LOCALPATCHES</td>
1.269 leot 12855: </tr>
12856: <tr>
1.338 nia 12857: <td>LOVE_DATA</td>
1.347 gutterid 12858: <td>LOVE_GAME</td>
1.329 leot 12859: </tr>
12860: <tr>
1.338 nia 12861: <td>LOVE_VERSION</td>
1.347 gutterid 12862: <td>LP32PLATFORMS</td>
1.269 leot 12863: </tr>
12864: <tr>
1.338 nia 12865: <td>LP64PLATFORMS</td>
1.347 gutterid 12866: <td>LUA_BUSTED_ARGS</td>
1.269 leot 12867: </tr>
12868: <tr>
1.338 nia 12869: <td>LUA_CDIR</td>
1.347 gutterid 12870: <td>LUA_COMPILER</td>
1.269 leot 12871: </tr>
12872: <tr>
1.338 nia 12873: <td>LUA_DOCDIR</td>
1.347 gutterid 12874: <td>LUA_EXAMPLESDIR</td>
1.336 nia 12875: </tr>
12876: <tr>
1.338 nia 12877: <td>LUA_INCDIR</td>
1.347 gutterid 12878: <td>LUA_INTERPRETER</td>
1.333 nia 12879: </tr>
12880: <tr>
1.338 nia 12881: <td>LUA_LDIR</td>
1.347 gutterid 12882: <td>LUA_LINKER_MAGIC</td>
1.333 nia 12883: </tr>
12884: <tr>
1.338 nia 12885: <td>LUA_PKGPREFIX</td>
1.347 gutterid 12886: <td>LUA_SELF_CONFLICT</td>
1.333 nia 12887: </tr>
12888: <tr>
1.338 nia 12889: <td>LUA_USE_BUSTED</td>
1.347 gutterid 12890: <td>LUA_VERSIONS_ACCEPTED</td>
1.333 nia 12891: </tr>
12892: <tr>
1.338 nia 12893: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.347 gutterid 12894: <td>LUA_VERSION_DEFAULT</td>
1.333 nia 12895: </tr>
12896: <tr>
1.338 nia 12897: <td>LUA_VERSION_REQD</td>
1.347 gutterid 12898: <td>Lua</td>
1.333 nia 12899: </tr>
12900: <tr>
1.338 nia 12901: <td>MACHINE_PLATFORM</td>
1.347 gutterid 12902: <td>MAILAGENT_DOMAIN</td>
1.333 nia 12903: </tr>
12904: <tr>
1.338 nia 12905: <td>MAILAGENT_EMAIL</td>
1.347 gutterid 12906: <td>MAILAGENT_FQDN</td>
1.269 leot 12907: </tr>
12908: <tr>
1.338 nia 12909: <td>MAILAGENT_ORGANIZATION</td>
1.347 gutterid 12910: <td>MAJORDOMO_HOMEDIR</td>
1.320 wiz 12911: </tr>
12912: <tr>
1.348 wiz 12913: <td>MAJOR_OS_VERSION</td>
1.340 gutterid 12914: <td>MAKEINFO_ARGS</td>
1.348 wiz 12915: </tr>
12916: <tr>
1.347 gutterid 12917: <td>MAKE_DIRS</td>
1.348 wiz 12918: <td>MAKE_DIRS_PERMS</td>
1.342 wiz 12919: </tr>
12920: <tr>
1.347 gutterid 12921: <td>MAKE_ENV</td>
1.348 wiz 12922: <td>MAKE_FILE</td>
1.269 leot 12923: </tr>
12924: <tr>
1.347 gutterid 12925: <td>MAKE_FLAGS</td>
1.348 wiz 12926: <td>MAKE_JOBS</td>
1.327 wiz 12927: </tr>
12928: <tr>
1.347 gutterid 12929: <td>MAKE_JOBS_SAFE</td>
1.348 wiz 12930: <td>MAKE_PROGRAM</td>
1.269 leot 12931: </tr>
12932: <tr>
1.347 gutterid 12933: <td>MANCOMPRESSED_IF_MANZ</td>
1.348 wiz 12934: <td>MANINSTALL</td>
1.269 leot 12935: </tr>
12936: <tr>
1.347 gutterid 12937: <td>MANZ</td>
1.348 wiz 12938: <td>MASTER_SITES</td>
1.269 leot 12939: </tr>
12940: <tr>
1.347 gutterid 12941: <td>MASTER_SITE_BACKUP</td>
1.348 wiz 12942: <td>MASTER_SITE_LOCAL</td>
1.303 bacon 12943: </tr>
12944: <tr>
1.347 gutterid 12945: <td>MASTER_SITE_MOZILLA</td>
1.348 wiz 12946: <td>MASTER_SITE_OVERRIDE</td>
1.269 leot 12947: </tr>
12948: <tr>
1.347 gutterid 12949: <td>MASTER_SITE_PERL_CPAN</td>
1.348 wiz 12950: <td>MASTER_SORT</td>
1.269 leot 12951: </tr>
12952: <tr>
1.347 gutterid 12953: <td>MASTER_SORT_RANDOM</td>
1.348 wiz 12954: <td>MASTER_SORT_REGEX</td>
1.269 leot 12955: </tr>
12956: <tr>
1.347 gutterid 12957: <td>MECAB_CHARSET</td>
1.348 wiz 12958: <td>MEDIATOMB_GROUP</td>
1.269 leot 12959: </tr>
12960: <tr>
1.347 gutterid 12961: <td>MEDIATOMB_USER</td>
1.348 wiz 12962: <td>MIPSPROBASE</td>
1.269 leot 12963: </tr>
12964: <tr>
1.347 gutterid 12965: <td>MIREDO_GROUP</td>
1.348 wiz 12966: <td>MIREDO_USER</td>
1.269 leot 12967: </tr>
12968: <tr>
1.347 gutterid 12969: <td>MISSING_FEATURES</td>
1.348 wiz 12970: <td>MKDIR</td>
1.269 leot 12971: </tr>
12972: <tr>
1.347 gutterid 12973: <td>MKPIE_SUPPORTED</td>
1.348 wiz 12974: <td>MLDONKEY_GROUP</td>
1.269 leot 12975: </tr>
12976: <tr>
1.347 gutterid 12977: <td>MLDONKEY_HOME</td>
1.348 wiz 12978: <td>MLDONKEY_USER</td>
1.269 leot 12979: </tr>
12980: <tr>
1.347 gutterid 12981: <td>MONOTONE_GROUP</td>
1.348 wiz 12982: <td>MONOTONE_USER</td>
1.269 leot 12983: </tr>
12984: <tr>
1.347 gutterid 12985: <td>MOTIFBASE</td>
1.348 wiz 12986: <td>MOTIF_TYPE</td>
1.322 leot 12987: </tr>
12988: <tr>
1.347 gutterid 12989: <td>MOTIF_TYPE_DEFAULT</td>
1.348 wiz 12990: <td>MPI_TYPE</td>
1.269 leot 12991: </tr>
12992: <tr>
1.347 gutterid 12993: <td>MSGFMT_STRIP_MSGCTXT</td>
1.348 wiz 12994: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.269 leot 12995: </tr>
12996: <tr>
1.347 gutterid 12997: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.348 wiz 12998: <td>MUST</td>
1.269 leot 12999: </tr>
13000: <tr>
1.336 nia 13001: <td>MV</td>
1.347 gutterid 13002: <td>MYSQL_CHARSET</td>
1.338 nia 13003: </tr>
13004: <tr>
13005: <td>MYSQL_DATADIR</td>
1.347 gutterid 13006: <td>MYSQL_EXTRA_CHARSET</td>
1.329 leot 13007: </tr>
13008: <tr>
1.338 nia 13009: <td>MYSQL_GROUP</td>
1.347 gutterid 13010: <td>MYSQL_USER</td>
1.269 leot 13011: </tr>
13012: <tr>
1.338 nia 13013: <td>MYSQL_VERSION</td>
1.347 gutterid 13014: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.320 wiz 13015: </tr>
13016: <tr>
1.338 nia 13017: <td>MYSQL_VERSIONS_ALL</td>
1.347 gutterid 13018: <td>MYSQL_VERSION_DEFAULT</td>
1.269 leot 13019: </tr>
13020: <tr>
1.338 nia 13021: <td>NAGIOSCMD_GROUP</td>
1.347 gutterid 13022: <td>NAGIOSDIR</td>
1.269 leot 13023: </tr>
13024: <tr>
1.338 nia 13025: <td>NAGIOS_GROUP</td>
1.347 gutterid 13026: <td>NAGIOS_USER</td>
1.269 leot 13027: </tr>
13028: <tr>
1.338 nia 13029: <td>NATIVE_APPEND_ABI</td>
1.347 gutterid 13030: <td>NATIVE_APPEND_ELF</td>
1.309 gutterid 13031: </tr>
13032: <tr>
1.338 nia 13033: <td>NATIVE_EXEC_FMT</td>
1.347 gutterid 13034: <td>NATIVE_MACHINE_PLATFORM</td>
1.269 leot 13035: </tr>
13036: <tr>
1.338 nia 13037: <td>NATIVE_OBJECT_FMT</td>
1.347 gutterid 13038: <td>NBPAX_PROGRAM_PREFIX</td>
1.269 leot 13039: </tr>
13040: <tr>
1.338 nia 13041: <td>NETBSD_LOGIN_NAME</td>
1.347 gutterid 13042: <td>NMH_EDITOR</td>
1.269 leot 13043: </tr>
13044: <tr>
1.338 nia 13045: <td>NMH_MTA</td>
1.347 gutterid 13046: <td>NMH_PAGER</td>
1.269 leot 13047: </tr>
13048: <tr>
1.338 nia 13049: <td>NODE_VERSIONS_ACCEPTED</td>
1.347 gutterid 13050: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.269 leot 13051: </tr>
13052: <tr>
1.338 nia 13053: <td>NODE_VERSION_DEFAULT</td>
1.347 gutterid 13054: <td>NODE_VERSION_REQD</td>
1.269 leot 13055: </tr>
13056: <tr>
1.338 nia 13057: <td>NOLOGIN</td>
1.347 gutterid 13058: <td>NOTE</td>
1.344 gutterid 13059: </tr>
13060: <tr>
13061: <td>NOT_FOR_PLATFORM</td>
1.347 gutterid 13062: <td>NOT_PAX_ASLR_SAFE</td>
1.333 nia 13063: </tr>
13064: <tr>
1.344 gutterid 13065: <td>NOT_PAX_MPROTECT_SAFE</td>
1.347 gutterid 13066: <td>NO_BUILD</td>
1.333 nia 13067: </tr>
13068: <tr>
1.344 gutterid 13069: <td>NO_CHECKSUM</td>
1.347 gutterid 13070: <td>NO_CONFIGURE</td>
1.293 rillig 13071: </tr>
13072: <tr>
1.344 gutterid 13073: <td>NO_SKIP</td>
1.347 gutterid 13074: <td>NS_PREFERRED</td>
1.269 leot 13075: </tr>
13076: <tr>
1.344 gutterid 13077: <td>NULLMAILER_GROUP</td>
1.347 gutterid 13078: <td>NULLMAILER_USER</td>
1.269 leot 13079: </tr>
13080: <tr>
1.344 gutterid 13081: <td>OASIS</td>
1.347 gutterid 13082: <td>OASIS_BUILD_ARGS</td>
1.269 leot 13083: </tr>
13084: <tr>
1.344 gutterid 13085: <td>OBJHOSTNAME</td>
1.347 gutterid 13086: <td>OBJMACHINE</td>
1.269 leot 13087: </tr>
13088: <tr>
1.344 gutterid 13089: <td>OCAML_FINDLIB_DIRS</td>
1.347 gutterid 13090: <td>OCAML_FINDLIB_REGISTER</td>
1.269 leot 13091: </tr>
13092: <tr>
1.344 gutterid 13093: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.347 gutterid 13094: <td>OCAML_SITELIBDIR</td>
1.269 leot 13095: </tr>
13096: <tr>
1.344 gutterid 13097: <td>OCAML_TOPKG_DOCDIR</td>
1.347 gutterid 13098: <td>OCAML_USE_DUNE</td>
1.269 leot 13099: </tr>
13100: <tr>
1.344 gutterid 13101: <td>OCAML_USE_FINDLIB</td>
1.347 gutterid 13102: <td>OCAML_USE_OASIS</td>
1.269 leot 13103: </tr>
13104: <tr>
1.344 gutterid 13105: <td>OCAML_USE_OASIS_DYNRUN</td>
1.347 gutterid 13106: <td>OCAML_USE_OPAM</td>
1.269 leot 13107: </tr>
13108: <tr>
1.344 gutterid 13109: <td>OCAML_USE_TOPKG</td>
1.347 gutterid 13110: <td>OMF</td>
1.269 leot 13111: </tr>
13112: <tr>
1.344 gutterid 13113: <td>ONLY_FOR_COMPILER</td>
1.347 gutterid 13114: <td>ONLY_FOR_PLATFORM</td>
1.269 leot 13115: </tr>
13116: <tr>
1.344 gutterid 13117: <td>OPENSSH_CHROOT</td>
1.347 gutterid 13118: <td>OPENSSH_GROUP</td>
1.269 leot 13119: </tr>
13120: <tr>
1.344 gutterid 13121: <td>OPENSSH_USER</td>
1.347 gutterid 13122: <td>OPSYS</td>
1.269 leot 13123: </tr>
13124: <tr>
1.344 gutterid 13125: <td>OPSYS_EMULDIR</td>
1.347 gutterid 13126: <td>OPSYS_VERSION</td>
1.269 leot 13127: </tr>
13128: <tr>
1.344 gutterid 13129: <td>OS</td>
1.347 gutterid 13130: <td>OSS_TYPE</td>
1.269 leot 13131: </tr>
13132: <tr>
1.344 gutterid 13133: <td>OSX</td>
1.347 gutterid 13134: <td>OSX_TOLERATE_SDK_SKEW</td>
1.269 leot 13135: </tr>
13136: <tr>
1.348 wiz 13137: <td>OS_HAVE_ALSA</td>
13138: <td>OS_HAVE_RCD</td>
13139: </tr>
13140: <tr>
1.344 gutterid 13141: <td>OS_VARIANT</td>
1.347 gutterid 13142: <td>OS_VERSION</td>
1.269 leot 13143: </tr>
13144: <tr>
1.344 gutterid 13145: <td>OTF_FONTS_DIR</td>
1.347 gutterid 13146: <td>OVERRIDE_DIRDEPTH</td>
1.338 nia 13147: </tr>
13148: <tr>
1.344 gutterid 13149: <td>OVERRIDE_GEMSPEC</td>
1.347 gutterid 13150: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.327 wiz 13151: </tr>
13152: <tr>
1.348 wiz 13153: <td>OVERRIDE_ROCKSPEC</td>
1.344 gutterid 13154: <td>OWN_DIRS</td>
1.348 wiz 13155: </tr>
13156: <tr>
1.347 gutterid 13157: <td>OWN_DIRS_PERMS</td>
1.348 wiz 13158: <td>P4GROUP</td>
1.329 leot 13159: </tr>
13160: <tr>
1.347 gutterid 13161: <td>P4PORT</td>
1.348 wiz 13162: <td>P4ROOT</td>
1.342 wiz 13163: </tr>
13164: <tr>
1.347 gutterid 13165: <td>P4USER</td>
1.348 wiz 13166: <td>PACKAGES</td>
1.320 wiz 13167: </tr>
13168: <tr>
1.347 gutterid 13169: <td>PALMOS_DEFAULT_SDK</td>
1.348 wiz 13170: <td>PAMBASE</td>
1.269 leot 13171: </tr>
13172: <tr>
1.347 gutterid 13173: <td>PAM_DEFAULT</td>
1.348 wiz 13174: <td>PAPERSIZE</td>
1.269 leot 13175: </tr>
13176: <tr>
1.347 gutterid 13177: <td>PASSIVE_FETCH</td>
1.348 wiz 13178: <td>PATCHDIR</td>
1.269 leot 13179: </tr>
13180: <tr>
1.347 gutterid 13181: <td>PATCHFILES</td>
1.348 wiz 13182: <td>PATCH_ARGS</td>
1.269 leot 13183: </tr>
13184: <tr>
1.347 gutterid 13185: <td>PATCH_DEBUG</td>
1.348 wiz 13186: <td>PATCH_DIST_ARGS</td>
1.269 leot 13187: </tr>
13188: <tr>
1.347 gutterid 13189: <td>PATCH_DIST_CAT</td>
1.348 wiz 13190: <td>PATCH_DIST_STRIP</td>
1.269 leot 13191: </tr>
13192: <tr>
1.347 gutterid 13193: <td>PATCH_FUZZ_FACTOR</td>
1.348 wiz 13194: <td>PATCH_STRIP</td>
1.324 nia 13195: </tr>
13196: <tr>
1.347 gutterid 13197: <td>PATH</td>
1.348 wiz 13198: <td>PCCBASE</td>
1.269 leot 13199: </tr>
13200: <tr>
1.348 wiz 13201: <td>PEAR</td>
13202: <td>PEAR_CHANNEL</td>
13203: </tr>
13204: <tr>
13205: <td>PEAR_CHANNEL_ALIAS</td>
13206: <td>PEAR_CHANNEL_VERSION</td>
1.269 leot 13207: </tr>
13208: <tr>
1.348 wiz 13209: <td>PEAR_CMD</td>
1.344 gutterid 13210: <td>PEAR_LIB</td>
1.342 wiz 13211: </tr>
13212: <tr>
1.348 wiz 13213: <td>PEAR_PACKAGE_XML</td>
1.344 gutterid 13214: <td>PERL5</td>
1.269 leot 13215: </tr>
13216: <tr>
1.348 wiz 13217: <td>PERL5_CONFIGURE</td>
1.344 gutterid 13218: <td>PERL5_CONFIGURE_DIRS</td>
1.332 rillig 13219: </tr>
13220: <tr>
1.348 wiz 13221: <td>PERL5_LDFLAGS</td>
1.344 gutterid 13222: <td>PERL5_LICENSE</td>
1.320 wiz 13223: </tr>
13224: <tr>
1.348 wiz 13225: <td>PERL5_MODULE_TYPE</td>
1.344 gutterid 13226: <td>PERL5_PACKLIST</td>
1.292 leot 13227: </tr>
13228: <tr>
1.348 wiz 13229: <td>PERL5_PACKLIST_DIR</td>
1.344 gutterid 13230: <td>PERL5_PERLBASE</td>
1.274 rillig 13231: </tr>
13232: <tr>
1.348 wiz 13233: <td>PERL5_SITEBASE</td>
1.344 gutterid 13234: <td>PERL5_USE_PACKLIST</td>
1.274 rillig 13235: </tr>
13236: <tr>
1.348 wiz 13237: <td>PERL5_VENDORBASE</td>
1.344 gutterid 13238: <td>PFCTL</td>
1.269 leot 13239: </tr>
13240: <tr>
1.348 wiz 13241: <td>PFVAR_H</td>
1.344 gutterid 13242: <td>PF_VERSION</td>
1.269 leot 13243: </tr>
13244: <tr>
1.348 wiz 13245: <td>PGGROUP</td>
1.344 gutterid 13246: <td>PGHOME</td>
1.269 leot 13247: </tr>
13248: <tr>
1.348 wiz 13249: <td>PGPKGSRCDIR</td>
1.344 gutterid 13250: <td>PGSQL_TYPE</td>
1.269 leot 13251: </tr>
13252: <tr>
1.348 wiz 13253: <td>PGSQL_VERSION</td>
1.344 gutterid 13254: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.269 leot 13255: </tr>
13256: <tr>
1.348 wiz 13257: <td>PGSQL_VERSION_DEFAULT</td>
1.344 gutterid 13258: <td>PGUSER</td>
1.269 leot 13259: </tr>
13260: <tr>
1.348 wiz 13261: <td>PG_LIB_EXT</td>
1.344 gutterid 13262: <td>PHP</td>
1.269 leot 13263: </tr>
13264: <tr>
1.348 wiz 13265: <td>PHPCOMMON_MK</td>
1.344 gutterid 13266: <td>PHPPKGSRCDIR</td>
1.269 leot 13267: </tr>
13268: <tr>
1.348 wiz 13269: <td>PHP_BASE_VERS</td>
1.344 gutterid 13270: <td>PHP_CHECK_INSTALLED</td>
1.269 leot 13271: </tr>
13272: <tr>
1.348 wiz 13273: <td>PHP_EXTENSION_DIR</td>
1.344 gutterid 13274: <td>PHP_INITIAL_TEENY</td>
1.269 leot 13275: </tr>
13276: <tr>
1.348 wiz 13277: <td>PHP_PKG_PREFIX</td>
1.344 gutterid 13278: <td>PHP_VERSION</td>
1.269 leot 13279: </tr>
13280: <tr>
1.348 wiz 13281: <td>PHP_VERSIONS_ACCEPTED</td>
1.344 gutterid 13282: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.269 leot 13283: </tr>
13284: <tr>
1.348 wiz 13285: <td>PHP_VERSION_DEFAULT</td>
1.344 gutterid 13286: <td>PHP_VERSION_REQD</td>
1.269 leot 13287: </tr>
13288: <tr>
1.348 wiz 13289: <td>PILRC_USE_GTK</td>
1.344 gutterid 13290: <td>PKGCONFIG_BASE</td>
1.269 leot 13291: </tr>
13292: <tr>
1.348 wiz 13293: <td>PKGCONFIG_FILE</td>
1.344 gutterid 13294: <td>PKGCONFIG_OVERRIDE</td>
1.269 leot 13295: </tr>
13296: <tr>
1.348 wiz 13297: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.344 gutterid 13298: <td>PKGDIR</td>
1.269 leot 13299: </tr>
13300: <tr>
1.348 wiz 13301: <td>PKGGNUDIR</td>
1.344 gutterid 13302: <td>PKGINFODIR</td>
1.269 leot 13303: </tr>
13304: <tr>
1.348 wiz 13305: <td>PKGLOCALEDIR</td>
1.344 gutterid 13306: <td>PKGMANDIR</td>
1.269 leot 13307: </tr>
13308: <tr>
1.348 wiz 13309: <td>PKGNAME</td>
1.344 gutterid 13310: <td>PKGNAME_REQD</td>
1.269 leot 13311: </tr>
13312: <tr>
1.348 wiz 13313: <td>PKGPATH</td>
1.344 gutterid 13314: <td>PKGREVISION</td>
1.269 leot 13315: </tr>
13316: <tr>
1.348 wiz 13317: <td>PKGSRC_BLAS_TYPES</td>
1.344 gutterid 13318: <td>PKGSRC_CHANGES</td>
1.269 leot 13319: </tr>
13320: <tr>
1.348 wiz 13321: <td>PKGSRC_COMPILER</td>
1.344 gutterid 13322: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.269 leot 13323: </tr>
13324: <tr>
1.348 wiz 13325: <td>PKGSRC_LOCKTYPE</td>
1.344 gutterid 13326: <td>PKGSRC_MAKE_ENV</td>
1.269 leot 13327: </tr>
13328: <tr>
1.348 wiz 13329: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.344 gutterid 13330: <td>PKGSRC_MKPIE</td>
1.269 leot 13331: </tr>
13332: <tr>
1.348 wiz 13333: <td>PKGSRC_MKREPRO</td>
1.344 gutterid 13334: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.292 leot 13335: </tr>
13336: <tr>
1.348 wiz 13337: <td>PKGSRC_RUN_TEST</td>
1.344 gutterid 13338: <td>PKGSRC_SETENV</td>
1.269 leot 13339: </tr>
13340: <tr>
1.348 wiz 13341: <td>PKGSRC_SLEEPSECS</td>
1.344 gutterid 13342: <td>PKGSRC_TODO</td>
1.274 rillig 13343: </tr>
13344: <tr>
1.348 wiz 13345: <td>PKGSRC_USE_CTF</td>
1.344 gutterid 13346: <td>PKGSRC_USE_FORTIFY</td>
1.269 leot 13347: </tr>
13348: <tr>
1.348 wiz 13349: <td>PKGSRC_USE_MKTOOLS</td>
1.344 gutterid 13350: <td>PKGSRC_USE_RELRO</td>
1.269 leot 13351: </tr>
13352: <tr>
1.348 wiz 13353: <td>PKGSRC_USE_SSP</td>
1.344 gutterid 13354: <td>PKGSRC_USE_STACK_CHECK</td>
1.269 leot 13355: </tr>
13356: <tr>
1.348 wiz 13357: <td>PKGTASKS_DATAFILE</td>
1.344 gutterid 13358: <td>PKGTOOLS_ARGS</td>
1.269 leot 13359: </tr>
13360: <tr>
1.348 wiz 13361: <td>PKGTOOLS_ENV</td>
1.344 gutterid 13362: <td>PKG_ALTERNATIVES</td>
1.269 leot 13363: </tr>
13364: <tr>
1.348 wiz 13365: <td>PKG_APACHE</td>
1.344 gutterid 13366: <td>PKG_APACHE_ACCEPTED</td>
1.269 leot 13367: </tr>
13368: <tr>
1.348 wiz 13369: <td>PKG_APACHE_DEFAULT</td>
1.344 gutterid 13370: <td>PKG_BEST_EXISTS</td>
1.269 leot 13371: </tr>
13372: <tr>
1.348 wiz 13373: <td>PKG_BUILD_OPTIONS</td>
1.344 gutterid 13374: <td>PKG_COMPRESSION</td>
1.269 leot 13375: </tr>
13376: <tr>
1.348 wiz 13377: <td>PKG_CONFIG</td>
1.344 gutterid 13378: <td>PKG_CONFIG_PERMS</td>
1.269 leot 13379: </tr>
13380: <tr>
1.348 wiz 13381: <td>PKG_CREATE_USERGROUP</td>
1.344 gutterid 13382: <td>PKG_DB_TMPDIR</td>
1.269 leot 13383: </tr>
13384: <tr>
1.348 wiz 13385: <td>PKG_DEBUG_LEVEL</td>
1.344 gutterid 13386: <td>PKG_DEFAULT_OPTIONS</td>
1.269 leot 13387: </tr>
13388: <tr>
1.348 wiz 13389: <td>PKG_DESTDIR_SUPPORT</td>
1.344 gutterid 13390: <td>PKG_DEVELOPER</td>
1.269 leot 13391: </tr>
13392: <tr>
1.348 wiz 13393: <td>PKG_DISABLED_OPTIONS</td>
1.344 gutterid 13394: <td>PKG_FATAL_ERRORS</td>
1.348 wiz 13395: </tr>
13396: <tr>
1.347 gutterid 13397: <td>PKG_FC</td>
1.348 wiz 13398: <td>PKG_FILELIST_CMD</td>
1.269 leot 13399: </tr>
13400: <tr>
1.347 gutterid 13401: <td>PKG_GECOS</td>
1.348 wiz 13402: <td>PKG_GID</td>
1.269 leot 13403: </tr>
13404: <tr>
1.347 gutterid 13405: <td>PKG_GROUPS</td>
1.348 wiz 13406: <td>PKG_GROUPS_VARS</td>
1.269 leot 13407: </tr>
13408: <tr>
1.347 gutterid 13409: <td>PKG_HOME</td>
1.348 wiz 13410: <td>PKG_INIT_SCRIPTS</td>
1.269 leot 13411: </tr>
13412: <tr>
1.347 gutterid 13413: <td>PKG_JAVA_HOME</td>
1.348 wiz 13414: <td>PKG_JVM</td>
1.269 leot 13415: </tr>
13416: <tr>
1.347 gutterid 13417: <td>PKG_JVMS_ACCEPTED</td>
1.348 wiz 13418: <td>PKG_JVM_DEFAULT</td>
1.269 leot 13419: </tr>
13420: <tr>
1.347 gutterid 13421: <td>PKG_LEGACY_OPTIONS</td>
1.348 wiz 13422: <td>PKG_LIBTOOL</td>
1.269 leot 13423: </tr>
13424: <tr>
1.347 gutterid 13425: <td>PKG_MKSYMLINKS</td>
1.348 wiz 13426: <td>PKG_OPTIONS</td>
1.269 leot 13427: </tr>
13428: <tr>
1.347 gutterid 13429: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.348 wiz 13430: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.269 leot 13431: </tr>
13432: <tr>
1.347 gutterid 13433: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.348 wiz 13434: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.341 gutterid 13435: </tr>
13436: <tr>
1.347 gutterid 13437: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.348 wiz 13438: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.269 leot 13439: </tr>
13440: <tr>
1.347 gutterid 13441: <td>PKG_OPTIONS_VAR</td>
1.348 wiz 13442: <td>PKG_PHP</td>
1.269 leot 13443: </tr>
13444: <tr>
1.347 gutterid 13445: <td>PKG_PHP_MAJOR_VERS</td>
1.348 wiz 13446: <td>PKG_PHP_VERSION</td>
1.269 leot 13447: </tr>
13448: <tr>
1.347 gutterid 13449: <td>PKG_RCD_SCRIPTS</td>
1.348 wiz 13450: <td>PKG_REFCOUNT_DBDIR</td>
1.269 leot 13451: </tr>
13452: <tr>
1.347 gutterid 13453: <td>PKG_REGISTER_SHELLS</td>
1.348 wiz 13454: <td>PKG_RESUME_TRANSFERS</td>
1.269 leot 13455: </tr>
13456: <tr>
1.347 gutterid 13457: <td>PKG_SHELL</td>
1.348 wiz 13458: <td>PKG_SUGGESTED_OPTIONS</td>
1.269 leot 13459: </tr>
13460: <tr>
1.347 gutterid 13461: <td>PKG_SUPPORTED_OPTIONS</td>
1.348 wiz 13462: <td>PKG_SYSCONFBASE</td>
1.269 leot 13463: </tr>
13464: <tr>
1.347 gutterid 13465: <td>PKG_SYSCONFBASEDIR</td>
1.348 wiz 13466: <td>PKG_SYSCONFDIR</td>
1.269 leot 13467: </tr>
13468: <tr>
1.347 gutterid 13469: <td>PKG_SYSCONFDIR_PERMS</td>
1.348 wiz 13470: <td>PKG_SYSCONFSUBDIR</td>
1.269 leot 13471: </tr>
13472: <tr>
1.347 gutterid 13473: <td>PKG_SYSCONFVAR</td>
1.348 wiz 13474: <td>PKG_TOOLS_BIN</td>
1.269 leot 13475: </tr>
13476: <tr>
1.347 gutterid 13477: <td>PKG_UID</td>
1.348 wiz 13478: <td>PKG_UPDATE_FONTS_DB</td>
1.269 leot 13479: </tr>
13480: <tr>
1.347 gutterid 13481: <td>PKG_USERS</td>
1.348 wiz 13482: <td>PKG_USERS_VARS</td>
1.269 leot 13483: </tr>
13484: <tr>
1.347 gutterid 13485: <td>PKG_VERBOSE</td>
1.348 wiz 13486: <td>PLEASE</td>
1.269 leot 13487: </tr>
13488: <tr>
1.347 gutterid 13489: <td>PLIST</td>
1.348 wiz 13490: <td>PLIST_AWK</td>
1.269 leot 13491: </tr>
13492: <tr>
1.347 gutterid 13493: <td>PLIST_AWK_ENV</td>
1.348 wiz 13494: <td>PLIST_SRC</td>
1.269 leot 13495: </tr>
13496: <tr>
1.347 gutterid 13497: <td>PLIST_SUBST</td>
1.348 wiz 13498: <td>PLIST_TYPE</td>
1.269 leot 13499: </tr>
13500: <tr>
1.347 gutterid 13501: <td>PLIST_VARS</td>
1.348 wiz 13502: <td>POPTOP_USE_MPPE</td>
1.269 leot 13503: </tr>
13504: <tr>
1.347 gutterid 13505: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.348 wiz 13506: <td>POST_FETCH_HOOK</td>
1.269 leot 13507: </tr>
13508: <tr>
1.347 gutterid 13509: <td>PREFER</td>
1.348 wiz 13510: <td>PREFER_NATIVE</td>
1.269 leot 13511: </tr>
13512: <tr>
1.347 gutterid 13513: <td>PREFER_NATIVE_PTHREADS</td>
1.348 wiz 13514: <td>PREFER_PKGSRC</td>
1.269 leot 13515: </tr>
13516: <tr>
1.347 gutterid 13517: <td>PREFIX</td>
1.348 wiz 13518: <td>PREPEND_PATH</td>
1.269 leot 13519: </tr>
13520: <tr>
1.347 gutterid 13521: <td>PRE_ROOT_CMD</td>
1.348 wiz 13522: <td>PRIVILEGED_STAGES</td>
1.269 leot 13523: </tr>
13524: <tr>
1.347 gutterid 13525: <td>PS</td>
1.348 wiz 13526: <td>PTHREAD_AUTO_VARS</td>
1.269 leot 13527: </tr>
13528: <tr>
1.347 gutterid 13529: <td>PTHREAD_CFLAGS</td>
1.348 wiz 13530: <td>PTHREAD_LDFLAGS</td>
1.269 leot 13531: </tr>
13532: <tr>
1.347 gutterid 13533: <td>PTHREAD_LIBS</td>
1.348 wiz 13534: <td>PTHREAD_OPTS</td>
1.269 leot 13535: </tr>
13536: <tr>
1.347 gutterid 13537: <td>PTHREAD_TYPE</td>
1.348 wiz 13538: <td>PVM_SSH</td>
1.269 leot 13539: </tr>
13540: <tr>
1.347 gutterid 13541: <td>PYPKGPREFIX</td>
1.348 wiz 13542: <td>PYTHON_FOR_BUILD_ONLY</td>
1.269 leot 13543: </tr>
13544: <tr>
1.347 gutterid 13545: <td>PYTHON_SELF_CONFLICT</td>
1.348 wiz 13546: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.269 leot 13547: </tr>
13548: <tr>
1.347 gutterid 13549: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.348 wiz 13550: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.269 leot 13551: </tr>
13552: <tr>
1.347 gutterid 13553: <td>PYTHON_VERSION_DEFAULT</td>
1.348 wiz 13554: <td>PYTHON_VERSION_REQD</td>
1.269 leot 13555: </tr>
13556: <tr>
1.347 gutterid 13557: <td>PYVERSSUFFIX</td>
1.348 wiz 13558: <td>QMAILDIR</td>
1.269 leot 13559: </tr>
13560: <tr>
1.347 gutterid 13561: <td>QMAIL_ALIAS_USER</td>
1.348 wiz 13562: <td>QMAIL_DAEMON_USER</td>
1.269 leot 13563: </tr>
13564: <tr>
1.347 gutterid 13565: <td>QMAIL_LOG_USER</td>
1.348 wiz 13566: <td>QMAIL_NOFILES_GROUP</td>
1.269 leot 13567: </tr>
13568: <tr>
1.347 gutterid 13569: <td>QMAIL_PASSWD_USER</td>
1.348 wiz 13570: <td>QMAIL_QMAIL_GROUP</td>
1.269 leot 13571: </tr>
13572: <tr>
1.347 gutterid 13573: <td>QMAIL_QUEUE_DIR</td>
1.348 wiz 13574: <td>QMAIL_QUEUE_EXTRA</td>
1.269 leot 13575: </tr>
13576: <tr>
1.347 gutterid 13577: <td>QMAIL_QUEUE_USER</td>
1.348 wiz 13578: <td>QMAIL_REMOTE_USER</td>
1.269 leot 13579: </tr>
13580: <tr>
1.347 gutterid 13581: <td>QMAIL_ROOT_USER</td>
1.348 wiz 13582: <td>QMAIL_SEND_USER</td>
1.269 leot 13583: </tr>
13584: <tr>
1.347 gutterid 13585: <td>QORE_LATEST_MODULE_API</td>
1.348 wiz 13586: <td>QORE_MODULE_API</td>
1.269 leot 13587: </tr>
13588: <tr>
1.347 gutterid 13589: <td>QORE_MODULE_DIR</td>
1.348 wiz 13590: <td>QORE_USER_MODULE_DIR</td>
1.269 leot 13591: </tr>
13592: <tr>
1.347 gutterid 13593: <td>QORE_VERSION</td>
1.348 wiz 13594: <td>QPOPPER_FAC</td>
1.269 leot 13595: </tr>
13596: <tr>
1.347 gutterid 13597: <td>QPOPPER_SPOOL_DIR</td>
1.348 wiz 13598: <td>QPOPPER_USER</td>
1.269 leot 13599: </tr>
13600: <tr>
1.347 gutterid 13601: <td>RAKE_NAME</td>
1.348 wiz 13602: <td>RASMOL_DEPTH</td>
13603: </tr>
13604: <tr>
13605: <td>RCD_DIR</td>
13606: <td>RCD_ORDER</td>
1.333 nia 13607: </tr>
13608: <tr>
1.347 gutterid 13609: <td>RCD_SCRIPTS</td>
1.348 wiz 13610: <td>RCD_SCRIPTS_DIR</td>
1.333 nia 13611: </tr>
13612: <tr>
1.347 gutterid 13613: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.348 wiz 13614: <td>RCD_SCRIPTS_MODE</td>
1.342 wiz 13615: </tr>
13616: <tr>
1.347 gutterid 13617: <td>RCD_SCRIPTS_SHELL</td>
1.348 wiz 13618: <td>RCD_SCRIPT_SRC</td>
1.269 leot 13619: </tr>
13620: <tr>
1.348 wiz 13621: <td>RCD_SUBR</td>
1.347 gutterid 13622: <td>RDOC</td>
1.329 leot 13623: </tr>
13624: <tr>
1.344 gutterid 13625: <td>READLINE_DEFAULT</td>
1.347 gutterid 13626: <td>READLINE_TYPE</td>
1.320 wiz 13627: </tr>
13628: <tr>
1.344 gutterid 13629: <td>REAL_ROOT_GROUP</td>
1.347 gutterid 13630: <td>REAL_ROOT_USER</td>
1.338 nia 13631: </tr>
13632: <tr>
1.344 gutterid 13633: <td>RECURSIVE_MAKE</td>
1.347 gutterid 13634: <td>RELAY_CTRL_DIR</td>
1.292 leot 13635: </tr>
13636: <tr>
1.344 gutterid 13637: <td>RELRO_SUPPORTED</td>
1.347 gutterid 13638: <td>REPLACE_AWK</td>
1.329 leot 13639: </tr>
13640: <tr>
1.344 gutterid 13641: <td>REPLACE_BASH</td>
1.347 gutterid 13642: <td>REPLACE_CSH</td>
1.327 wiz 13643: </tr>
13644: <tr>
1.344 gutterid 13645: <td>REPLACE_KSH</td>
1.347 gutterid 13646: <td>REPLACE_LUA</td>
1.269 leot 13647: </tr>
13648: <tr>
1.344 gutterid 13649: <td>REPLACE_NODEJS</td>
1.347 gutterid 13650: <td>REPLACE_OCTAVE</td>
1.320 wiz 13651: </tr>
13652: <tr>
1.344 gutterid 13653: <td>REPLACE_PERL</td>
1.347 gutterid 13654: <td>REPLACE_PERL6</td>
1.311 leot 13655: </tr>
13656: <tr>
1.344 gutterid 13657: <td>REPLACE_PHP</td>
1.347 gutterid 13658: <td>REPLACE_PYTHON</td>
1.269 leot 13659: </tr>
13660: <tr>
1.344 gutterid 13661: <td>REPLACE_QORE</td>
1.347 gutterid 13662: <td>REPLACE_R</td>
1.333 nia 13663: </tr>
13664: <tr>
1.344 gutterid 13665: <td>REPLACE_RUBY</td>
1.347 gutterid 13666: <td>REPLACE_RUBY_DIRS</td>
1.269 leot 13667: </tr>
13668: <tr>
1.344 gutterid 13669: <td>REPLACE_RUBY_PAT</td>
1.347 gutterid 13670: <td>REPLACE_SH</td>
1.331 gutterid 13671: </tr>
13672: <tr>
1.344 gutterid 13673: <td>REPLACE_TEXLUA</td>
1.347 gutterid 13674: <td>REPLACE_WISH</td>
1.269 leot 13675: </tr>
13676: <tr>
1.344 gutterid 13677: <td>REQD_DIRS</td>
1.347 gutterid 13678: <td>REQD_DIRS_PERMS</td>
1.333 nia 13679: </tr>
13680: <tr>
1.344 gutterid 13681: <td>REQD_FILES</td>
1.347 gutterid 13682: <td>REQD_FILES_MODE</td>
1.269 leot 13683: </tr>
13684: <tr>
1.344 gutterid 13685: <td>REQD_FILES_PERMS</td>
1.347 gutterid 13686: <td>RESOLV_AUTO_VARS</td>
1.269 leot 13687: </tr>
13688: <tr>
1.344 gutterid 13689: <td>RESOLV_LDFLAGS</td>
1.347 gutterid 13690: <td>RESOLV_LIBS</td>
1.269 leot 13691: </tr>
13692: <tr>
1.344 gutterid 13693: <td>RM</td>
1.348 wiz 13694: <td>ROCKSPEC_NAME</td>
13695: </tr>
13696: <tr>
13697: <td>ROCKSPEC_SPECFILE</td>
1.347 gutterid 13698: <td>ROOT_CMD</td>
1.269 leot 13699: </tr>
13700: <tr>
1.344 gutterid 13701: <td>ROOT_GROUP</td>
1.347 gutterid 13702: <td>ROOT_USER</td>
1.269 leot 13703: </tr>
13704: <tr>
1.344 gutterid 13705: <td>RPCGEN</td>
1.347 gutterid 13706: <td>RPM</td>
1.320 wiz 13707: </tr>
13708: <tr>
1.344 gutterid 13709: <td>RPM2PKG_PLIST</td>
1.347 gutterid 13710: <td>RPM2PKG_PREFIX</td>
1.332 rillig 13711: </tr>
13712: <tr>
1.344 gutterid 13713: <td>RPM2PKG_STAGE</td>
1.347 gutterid 13714: <td>RPM2PKG_STRIP</td>
1.329 leot 13715: </tr>
13716: <tr>
1.344 gutterid 13717: <td>RPM2PKG_SUBPREFIX</td>
1.347 gutterid 13718: <td>RPMFILES</td>
1.327 wiz 13719: </tr>
13720: <tr>
1.344 gutterid 13721: <td>RPMIGNOREPATH</td>
1.347 gutterid 13722: <td>RPM_DB_PREFIX</td>
1.269 leot 13723: </tr>
13724: <tr>
1.344 gutterid 13725: <td>RSSH_CVS_PATH</td>
1.347 gutterid 13726: <td>RSSH_RDIST_PATH</td>
1.311 leot 13727: </tr>
13728: <tr>
1.344 gutterid 13729: <td>RSSH_RSYNC_PATH</td>
1.347 gutterid 13730: <td>RSSH_SCP_PATH</td>
1.269 leot 13731: </tr>
13732: <tr>
1.344 gutterid 13733: <td>RSSH_SFTP_SERVER_PATH</td>
1.347 gutterid 13734: <td>RUBY</td>
1.269 leot 13735: </tr>
13736: <tr>
1.344 gutterid 13737: <td>RUBYGEM</td>
1.347 gutterid 13738: <td>RUBYGEM_MANPAGES</td>
1.269 leot 13739: </tr>
13740: <tr>
1.341 gutterid 13741: <td>RUBYGEM_NAME</td>
1.347 gutterid 13742: <td>RUBYGEM_OPTIONS</td>
1.346 jnemeth 13743: </tr>
13744: <tr>
13745: <td>RUBYGEM_USE_MANPAGES</td>
1.347 gutterid 13746: <td>RUBYGEM_VERBOSE</td>
1.269 leot 13747: </tr>
13748: <tr>
1.344 gutterid 13749: <td>RUBY_ABI_VERSION</td>
1.347 gutterid 13750: <td>RUBY_ARCH</td>
1.269 leot 13751: </tr>
13752: <tr>
1.344 gutterid 13753: <td>RUBY_ARCHINC</td>
1.347 gutterid 13754: <td>RUBY_ARCHLIB</td>
1.269 leot 13755: </tr>
13756: <tr>
1.344 gutterid 13757: <td>RUBY_BASE</td>
1.347 gutterid 13758: <td>RUBY_BASERIDIR</td>
1.269 leot 13759: </tr>
13760: <tr>
1.344 gutterid 13761: <td>RUBY_BUILD_DOCUMENT</td>
1.347 gutterid 13762: <td>RUBY_DLEXT</td>
1.269 leot 13763: </tr>
13764: <tr>
1.344 gutterid 13765: <td>RUBY_DOC</td>
1.347 gutterid 13766: <td>RUBY_DYNAMIC_DIRS</td>
1.269 leot 13767: </tr>
13768: <tr>
1.344 gutterid 13769: <td>RUBY_EG</td>
1.347 gutterid 13770: <td>RUBY_ENCODING_ARG</td>
1.269 leot 13771: </tr>
13772: <tr>
1.344 gutterid 13773: <td>RUBY_EXTCONF</td>
1.347 gutterid 13774: <td>RUBY_EXTCONF_CHECK</td>
1.269 leot 13775: </tr>
13776: <tr>
1.344 gutterid 13777: <td>RUBY_EXTCONF_DEBUG</td>
1.347 gutterid 13778: <td>RUBY_EXTCONF_MAKEFILE</td>
1.269 leot 13779: </tr>
13780: <tr>
1.344 gutterid 13781: <td>RUBY_GEM_ARCH</td>
1.347 gutterid 13782: <td>RUBY_GEM_BASE</td>
1.269 leot 13783: </tr>
13784: <tr>
1.344 gutterid 13785: <td>RUBY_INC</td>
1.347 gutterid 13786: <td>RUBY_LIB</td>
1.269 leot 13787: </tr>
13788: <tr>
1.344 gutterid 13789: <td>RUBY_LIB_BASE</td>
1.347 gutterid 13790: <td>RUBY_NAME</td>
1.269 leot 13791: </tr>
13792: <tr>
1.344 gutterid 13793: <td>RUBY_NOVERSION</td>
1.347 gutterid 13794: <td>RUBY_PKGPREFIX</td>
1.338 nia 13795: </tr>
13796: <tr>
1.344 gutterid 13797: <td>RUBY_RAILS</td>
1.347 gutterid 13798: <td>RUBY_RAILS52_VERSION</td>
1.269 leot 13799: </tr>
13800: <tr>
1.344 gutterid 13801: <td>RUBY_RAILS60_VERSION</td>
1.347 gutterid 13802: <td>RUBY_RAILS61_VERSION</td>
1.269 leot 13803: </tr>
13804: <tr>
1.344 gutterid 13805: <td>RUBY_RAILS70_VERSION</td>
1.347 gutterid 13806: <td>RUBY_RAILS_ACCEPTED</td>
1.269 leot 13807: </tr>
13808: <tr>
1.344 gutterid 13809: <td>RUBY_RAILS_DEFAULT</td>
1.347 gutterid 13810: <td>RUBY_RAILS_REQD</td>
1.269 leot 13811: </tr>
13812: <tr>
1.344 gutterid 13813: <td>RUBY_RAILS_STRICT_DEP</td>
1.347 gutterid 13814: <td>RUBY_RIDIR</td>
1.269 leot 13815: </tr>
13816: <tr>
1.344 gutterid 13817: <td>RUBY_SETUP</td>
1.347 gutterid 13818: <td>RUBY_SHLIB</td>
1.269 leot 13819: </tr>
13820: <tr>
1.344 gutterid 13821: <td>RUBY_SHLIBALIAS</td>
1.347 gutterid 13822: <td>RUBY_SHLIBVER</td>
1.269 leot 13823: </tr>
13824: <tr>
1.344 gutterid 13825: <td>RUBY_SIMPLE_INSTALL</td>
1.347 gutterid 13826: <td>RUBY_SITEARCHLIB</td>
1.269 leot 13827: </tr>
13828: <tr>
1.344 gutterid 13829: <td>RUBY_SITELIB</td>
1.347 gutterid 13830: <td>RUBY_SITELIB_BASE</td>
1.312 gdt 13831: </tr>
13832: <tr>
1.344 gutterid 13833: <td>RUBY_SITERIDIR</td>
1.347 gutterid 13834: <td>RUBY_SLEXT</td>
1.289 leot 13835: </tr>
13836: <tr>
1.344 gutterid 13837: <td>RUBY_SRCDIR</td>
1.347 gutterid 13838: <td>RUBY_STATICLIB</td>
1.269 leot 13839: </tr>
13840: <tr>
1.344 gutterid 13841: <td>RUBY_SUFFIX</td>
1.347 gutterid 13842: <td>RUBY_SYSRIDIR</td>
1.269 leot 13843: </tr>
13844: <tr>
1.344 gutterid 13845: <td>RUBY_USE_PTHREAD</td>
1.347 gutterid 13846: <td>RUBY_VENDORARCHLIB</td>
1.269 leot 13847: </tr>
13848: <tr>
1.344 gutterid 13849: <td>RUBY_VENDORLIB</td>
1.347 gutterid 13850: <td>RUBY_VENDORLIB_BASE</td>
1.269 leot 13851: </tr>
13852: <tr>
1.344 gutterid 13853: <td>RUBY_VER</td>
1.347 gutterid 13854: <td>RUBY_VERSION</td>
1.269 leot 13855: </tr>
13856: <tr>
1.344 gutterid 13857: <td>RUBY_VERSIONS_ACCEPTED</td>
1.347 gutterid 13858: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.269 leot 13859: </tr>
13860: <tr>
1.344 gutterid 13861: <td>RUBY_VERSION_DEFAULT</td>
1.347 gutterid 13862: <td>RUBY_VERSION_REQD</td>
1.269 leot 13863: </tr>
13864: <tr>
1.344 gutterid 13865: <td>RUBY_VER_DIR</td>
1.347 gutterid 13866: <td>RUN</td>
1.269 leot 13867: </tr>
13868: <tr>
1.344 gutterid 13869: <td>RUN_LDCONFIG</td>
1.347 gutterid 13870: <td>RUST_TYPE</td>
1.269 leot 13871: </tr>
13872: <tr>
1.344 gutterid 13873: <td>SCO</td>
1.347 gutterid 13874: <td>SCREWS_GROUP</td>
1.269 leot 13875: </tr>
13876: <tr>
1.344 gutterid 13877: <td>SCREWS_USER</td>
1.347 gutterid 13878: <td>SCRIPTS_ENV</td>
1.269 leot 13879: </tr>
13880: <tr>
1.344 gutterid 13881: <td>SCROLLKEEPER_DATADIR</td>
1.347 gutterid 13882: <td>SCROLLKEEPER_REBUILDDB</td>
1.269 leot 13883: </tr>
13884: <tr>
1.344 gutterid 13885: <td>SCROLLKEEPER_UPDATEDB</td>
1.347 gutterid 13886: <td>SDIST_PAWD</td>
1.269 leot 13887: </tr>
13888: <tr>
1.344 gutterid 13889: <td>SDL12_TYPE</td>
1.347 gutterid 13890: <td>SERIAL_DEVICES</td>
1.269 leot 13891: </tr>
13892: <tr>
1.344 gutterid 13893: <td>SETGIDGAME</td>
1.347 gutterid 13894: <td>SETGID_GAMES_PERMS</td>
1.269 leot 13895: </tr>
13896: <tr>
1.344 gutterid 13897: <td>SETUID_ROOT_PERMS</td>
1.347 gutterid 13898: <td>SH</td>
1.336 nia 13899: </tr>
13900: <tr>
1.344 gutterid 13901: <td>SHLIB</td>
1.348 wiz 13902: <td>SHORTNAME</td>
13903: </tr>
13904: <tr>
1.347 gutterid 13905: <td>SIGN_PACKAGES</td>
1.348 wiz 13906: <td>SILC_CLIENT_WITH_PERL</td>
1.269 leot 13907: </tr>
13908: <tr>
1.347 gutterid 13909: <td>SITE_SPECIFIC_PKGS</td>
1.348 wiz 13910: <td>SKIP_DEPENDS</td>
1.342 wiz 13911: </tr>
13912: <tr>
1.347 gutterid 13913: <td>SMF_INSTANCES</td>
1.348 wiz 13914: <td>SMF_MANIFEST</td>
1.269 leot 13915: </tr>
13916: <tr>
1.347 gutterid 13917: <td>SMF_METHODS</td>
1.348 wiz 13918: <td>SMF_METHOD_SHELL</td>
1.269 leot 13919: </tr>
13920: <tr>
1.347 gutterid 13921: <td>SMF_METHOD_SRC</td>
1.348 wiz 13922: <td>SMF_NAME</td>
1.292 leot 13923: </tr>
13924: <tr>
1.347 gutterid 13925: <td>SMF_PREFIX</td>
1.348 wiz 13926: <td>SMF_SRCDIR</td>
1.269 leot 13927: </tr>
13928: <tr>
1.347 gutterid 13929: <td>SNIPROXY_GROUP</td>
1.348 wiz 13930: <td>SNIPROXY_USER</td>
1.332 rillig 13931: </tr>
13932: <tr>
1.347 gutterid 13933: <td>SOURCE_BUFFSIZE</td>
1.348 wiz 13934: <td>SPECIAL_PERMS</td>
1.269 leot 13935: </tr>
13936: <tr>
1.347 gutterid 13937: <td>SPECIFIC_PKGS</td>
1.348 wiz 13938: <td>SSH_SUID</td>
1.274 rillig 13939: </tr>
13940: <tr>
1.347 gutterid 13941: <td>SSP_SUPPORTED</td>
1.348 wiz 13942: <td>SSYNC_PAWD</td>
1.269 leot 13943: </tr>
13944: <tr>
1.347 gutterid 13945: <td>STEP_MSG</td>
1.348 wiz 13946: <td>STRIP</td>
1.269 leot 13947: </tr>
13948: <tr>
1.347 gutterid 13949: <td>STRIP_DBG</td>
1.348 wiz 13950: <td>STRIP_DEBUG</td>
1.269 leot 13951: </tr>
13952: <tr>
1.347 gutterid 13953: <td>STRIP_DEBUG_SUPPORTED</td>
1.348 wiz 13954: <td>STRIP_FILES_SKIP</td>
1.269 leot 13955: </tr>
13956: <tr>
1.347 gutterid 13957: <td>SU</td>
1.348 wiz 13958: <td>SUBDIR</td>
1.269 leot 13959: </tr>
13960: <tr>
1.347 gutterid 13961: <td>SUBST</td>
1.348 wiz 13962: <td>SUBST_CLASSES</td>
1.269 leot 13963: </tr>
13964: <tr>
1.347 gutterid 13965: <td>SUBST_FILES</td>
1.348 wiz 13966: <td>SUBST_FILTER_CMD</td>
1.269 leot 13967: </tr>
13968: <tr>
1.347 gutterid 13969: <td>SUBST_MESSAGE</td>
1.348 wiz 13970: <td>SUBST_NOOP_OK</td>
1.269 leot 13971: </tr>
13972: <tr>
1.347 gutterid 13973: <td>SUBST_SED</td>
1.348 wiz 13974: <td>SUBST_SHOW_DIFF</td>
1.269 leot 13975: </tr>
13976: <tr>
1.347 gutterid 13977: <td>SUBST_SKIP_TEXT_CHECK</td>
1.348 wiz 13978: <td>SUBST_STAGE</td>
1.269 leot 13979: </tr>
13980: <tr>
1.347 gutterid 13981: <td>SUBST_VARS</td>
1.348 wiz 13982: <td>SUNWSPROBASE</td>
1.269 leot 13983: </tr>
13984: <tr>
1.347 gutterid 13985: <td>SUSE_PREFER</td>
1.348 wiz 13986: <td>SU_CMD</td>
13987: </tr>
13988: <tr>
13989: <td>SVN_EXTRACTDIR</td>
13990: <td>SVN_REPO</td>
13991: </tr>
13992: <tr>
13993: <td>SVN_REPOSITORIES</td>
13994: <td>SVN_REVISION</td>
1.289 leot 13995: </tr>
13996: <tr>
1.347 gutterid 13997: <td>SYSCONFBASE</td>
1.348 wiz 13998: <td>TARGET_ARCH</td>
1.269 leot 13999: </tr>
14000: <tr>
1.347 gutterid 14001: <td>TBL</td>
1.348 wiz 14002: <td>TERMCAP_TYPE</td>
1.342 wiz 14003: </tr>
14004: <tr>
1.347 gutterid 14005: <td>TERMINFO_DEFAULT</td>
1.348 wiz 14006: <td>TERMINFO_TYPE</td>
1.269 leot 14007: </tr>
14008: <tr>
1.347 gutterid 14009: <td>TEST</td>
1.348 wiz 14010: <td>TEST_DEPENDS</td>
1.332 rillig 14011: </tr>
14012: <tr>
1.347 gutterid 14013: <td>TEST_DIRS</td>
1.348 wiz 14014: <td>TEST_ENV</td>
1.327 wiz 14015: </tr>
14016: <tr>
1.347 gutterid 14017: <td>TEST_ENV_SHELL</td>
1.348 wiz 14018: <td>TEST_MAKE_CMD</td>
1.332 rillig 14019: </tr>
14020: <tr>
1.347 gutterid 14021: <td>TEST_MAKE_FLAGS</td>
1.348 wiz 14022: <td>TEST_TARGET</td>
1.320 wiz 14023: </tr>
14024: <tr>
1.347 gutterid 14025: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.348 wiz 14026: <td>TEXLIVE_REV</td>
1.303 bacon 14027: </tr>
14028: <tr>
1.347 gutterid 14029: <td>TEXLIVE_UNVERSIONED</td>
1.348 wiz 14030: <td>TEXMFSITE</td>
1.274 rillig 14031: </tr>
14032: <tr>
1.347 gutterid 14033: <td>TEX_FORMATS</td>
1.348 wiz 14034: <td>TEX_HYPHEN_DAT</td>
1.269 leot 14035: </tr>
14036: <tr>
1.347 gutterid 14037: <td>TEX_HYPHEN_DEF</td>
1.348 wiz 14038: <td>TEX_TEXMF_DIRS</td>
1.269 leot 14039: </tr>
14040: <tr>
1.347 gutterid 14041: <td>THTTPD_LOG_FACILITY</td>
1.348 wiz 14042: <td>TINYDYN_USER</td>
1.269 leot 14043: </tr>
14044: <tr>
1.347 gutterid 14045: <td>TLSWRAPPER_CHROOT</td>
1.348 wiz 14046: <td>TO</td>
1.269 leot 14047: </tr>
14048: <tr>
1.347 gutterid 14049: <td>TOOLS_ALIASES</td>
1.348 wiz 14050: <td>TOOLS_ALWAYS_WRAP</td>
1.269 leot 14051: </tr>
14052: <tr>
1.347 gutterid 14053: <td>TOOLS_ARGS</td>
1.348 wiz 14054: <td>TOOLS_BROKEN</td>
1.269 leot 14055: </tr>
14056: <tr>
1.347 gutterid 14057: <td>TOOLS_CMD</td>
1.348 wiz 14058: <td>TOOLS_CMDLINE_SED</td>
1.269 leot 14059: </tr>
14060: <tr>
1.347 gutterid 14061: <td>TOOLS_CREATE</td>
1.348 wiz 14062: <td>TOOLS_CROSS_DESTDIR</td>
1.269 leot 14063: </tr>
14064: <tr>
1.347 gutterid 14065: <td>TOOLS_DIR</td>
1.348 wiz 14066: <td>TOOLS_FAIL</td>
1.269 leot 14067: </tr>
14068: <tr>
1.347 gutterid 14069: <td>TOOLS_GNU_MISSING</td>
1.348 wiz 14070: <td>TOOLS_LDCONFIG</td>
1.269 leot 14071: </tr>
14072: <tr>
1.347 gutterid 14073: <td>TOOLS_NOOP</td>
1.348 wiz 14074: <td>TOOLS_PATH</td>
1.269 leot 14075: </tr>
14076: <tr>
1.347 gutterid 14077: <td>TOOLS_SCRIPT</td>
1.348 wiz 14078: <td>TOOLS_USE_CROSS_COMPILE</td>
1.269 leot 14079: </tr>
14080: <tr>
1.347 gutterid 14081: <td>TOOL_DEPENDS</td>
1.348 wiz 14082: <td>TTF_FONTDIR</td>
1.269 leot 14083: </tr>
14084: <tr>
1.344 gutterid 14085: <td>TTF_FONTS_DIR</td>
1.347 gutterid 14086: <td>TYPE</td>
1.269 leot 14087: </tr>
14088: <tr>
1.344 gutterid 14089: <td>UAC_REQD_EXECS</td>
1.347 gutterid 14090: <td>UCSPI_SSL_GROUP</td>
1.338 nia 14091: </tr>
14092: <tr>
1.344 gutterid 14093: <td>UCSPI_SSL_USER</td>
1.347 gutterid 14094: <td>UNLIMIT_RESOURCES</td>
1.269 leot 14095: </tr>
14096: <tr>
1.344 gutterid 14097: <td>UNPRIVILEGED</td>
1.347 gutterid 14098: <td>UNPRIVILEGED_GROUP</td>
1.329 leot 14099: </tr>
14100: <tr>
1.344 gutterid 14101: <td>UNPRIVILEGED_GROUPS</td>
1.347 gutterid 14102: <td>UNPRIVILEGED_USER</td>
1.327 wiz 14103: </tr>
14104: <tr>
1.344 gutterid 14105: <td>UNWRAP_FILES</td>
1.347 gutterid 14106: <td>UNWRAP_PATTERNS</td>
1.269 leot 14107: </tr>
14108: <tr>
1.344 gutterid 14109: <td>UPDATE_GEMSPEC</td>
1.347 gutterid 14110: <td>UPDATE_TARGET</td>
1.269 leot 14111: </tr>
14112: <tr>
1.344 gutterid 14113: <td>URI</td>
1.347 gutterid 14114: <td>USERGROUP_PHASE</td>
1.269 leot 14115: </tr>
14116: <tr>
1.344 gutterid 14117: <td>USERPPP_GROUP</td>
1.347 gutterid 14118: <td>USER_SPECIFIC_PKGS</td>
1.269 leot 14119: </tr>
14120: <tr>
1.344 gutterid 14121: <td>USE_ABI_DEPENDS</td>
1.347 gutterid 14122: <td>USE_APR</td>
1.269 leot 14123: </tr>
14124: <tr>
1.344 gutterid 14125: <td>USE_BSD_MAKEFILE</td>
1.347 gutterid 14126: <td>USE_BUILTIN</td>
1.269 leot 14127: </tr>
14128: <tr>
1.344 gutterid 14129: <td>USE_CROSS_COMPILE</td>
1.347 gutterid 14130: <td>USE_CURSES</td>
1.269 leot 14131: </tr>
14132: <tr>
1.344 gutterid 14133: <td>USE_CWRAPPERS</td>
1.347 gutterid 14134: <td>USE_DB185</td>
1.269 leot 14135: </tr>
14136: <tr>
1.344 gutterid 14137: <td>USE_FEATURES</td>
1.347 gutterid 14138: <td>USE_GAMESGROUP</td>
1.269 leot 14139: </tr>
14140: <tr>
1.344 gutterid 14141: <td>USE_GCC_RUNTIME</td>
1.347 gutterid 14142: <td>USE_IMAKE</td>
1.320 wiz 14143: </tr>
14144: <tr>
1.344 gutterid 14145: <td>USE_JAVA</td>
1.347 gutterid 14146: <td>USE_JAVA2</td>
1.269 leot 14147: </tr>
14148: <tr>
1.344 gutterid 14149: <td>USE_LANGUAGES</td>
1.347 gutterid 14150: <td>USE_LIBTOOL</td>
1.269 leot 14151: </tr>
14152: <tr>
1.344 gutterid 14153: <td>USE_NATIVE_GCC</td>
1.347 gutterid 14154: <td>USE_NETBSD_REPO</td>
1.269 leot 14155: </tr>
14156: <tr>
1.344 gutterid 14157: <td>USE_PKGSRC_GCC</td>
1.347 gutterid 14158: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.269 leot 14159: </tr>
14160: <tr>
1.344 gutterid 14161: <td>USE_PKGTASKS</td>
1.347 gutterid 14162: <td>USE_PKG_ADMIN_DIGEST</td>
1.269 leot 14163: </tr>
14164: <tr>
1.344 gutterid 14165: <td>USE_RUBY_EXTCONF</td>
1.347 gutterid 14166: <td>USE_RUBY_INSTALL</td>
1.269 leot 14167: </tr>
14168: <tr>
1.344 gutterid 14169: <td>USE_RUBY_SETUP</td>
1.347 gutterid 14170: <td>USE_RUBY_SETUP_PKG</td>
1.269 leot 14171: </tr>
14172: <tr>
1.344 gutterid 14173: <td>USE_TOOLS</td>
1.347 gutterid 14174: <td>UUCP_GROUP</td>
1.269 leot 14175: </tr>
14176: <tr>
1.344 gutterid 14177: <td>UUCP_USER</td>
1.347 gutterid 14178: <td>VARBASE</td>
1.269 leot 14179: </tr>
14180: <tr>
1.344 gutterid 14181: <td>VARNAME</td>
1.347 gutterid 14182: <td>VIM_EXTRA_OPTS</td>
1.269 leot 14183: </tr>
14184: <tr>
1.344 gutterid 14185: <td>WARNING_MSG</td>
1.347 gutterid 14186: <td>WCALC_CGIDIR</td>
1.269 leot 14187: </tr>
14188: <tr>
1.344 gutterid 14189: <td>WCALC_CGIPATH</td>
1.347 gutterid 14190: <td>WCALC_HTMLDIR</td>
1.269 leot 14191: </tr>
14192: <tr>
1.344 gutterid 14193: <td>WCALC_HTMLPATH</td>
1.347 gutterid 14194: <td>WDM_MANAGERS</td>
1.269 leot 14195: </tr>
14196: <tr>
1.344 gutterid 14197: <td>WRAPPER_CC</td>
1.347 gutterid 14198: <td>WRAPPER_REORDER_CMDS</td>
1.269 leot 14199: </tr>
14200: <tr>
1.344 gutterid 14201: <td>WRKDIR</td>
1.347 gutterid 14202: <td>WRKDIR_BASENAME</td>
1.269 leot 14203: </tr>
14204: <tr>
1.344 gutterid 14205: <td>WRKDIR_LOCKTYPE</td>
1.347 gutterid 14206: <td>WRKLOG</td>
1.269 leot 14207: </tr>
14208: <tr>
1.344 gutterid 14209: <td>WRKOBJDIR</td>
1.347 gutterid 14210: <td>WRKSRC</td>
1.269 leot 14211: </tr>
14212: <tr>
1.344 gutterid 14213: <td>X10_PORT</td>
1.347 gutterid 14214: <td>X11</td>
1.269 leot 14215: </tr>
14216: <tr>
1.344 gutterid 14217: <td>X11BASE</td>
1.347 gutterid 14218: <td>X11_PKGSRCDIR</td>
1.269 leot 14219: </tr>
14220: <tr>
1.344 gutterid 14221: <td>X11_TYPE</td>
1.347 gutterid 14222: <td>X509_CERTIFICATE</td>
1.303 bacon 14223: </tr>
14224: <tr>
1.344 gutterid 14225: <td>X509_KEY</td>
1.347 gutterid 14226: <td>XAW_TYPE</td>
1.269 leot 14227: </tr>
14228: <tr>
1.344 gutterid 14229: <td>XLOCK_DEFAULT_MODE</td>
1.347 gutterid 14230: <td>XMKMF</td>
1.269 leot 14231: </tr>
14232: <tr>
1.344 gutterid 14233: <td>XMKMF_FLAGS</td>
1.347 gutterid 14234: <td>XXX</td>
1.269 leot 14235: </tr>
14236: <tr>
1.348 wiz 14237: <td>XXXX</td>
1.344 gutterid 14238: <td>YES</td>
1.348 wiz 14239: </tr>
14240: <tr>
1.347 gutterid 14241: <td>ZSH_STATIC</td>
1.348 wiz 14242: <td>__stdc__</td>
1.269 leot 14243: </tr>
14244: <tr>
1.347 gutterid 14245: <td>_vargroups</td>
1.348 wiz 14246: <td>accept</td>
1.342 wiz 14247: </tr>
14248: <tr>
1.347 gutterid 14249: <td>acquire-localbase-lock</td>
1.348 wiz 14250: <td>acquire-lock</td>
1.269 leot 14251: </tr>
14252: <tr>
1.347 gutterid 14253: <td>add</td>
1.348 wiz 14254: <td>added</td>
1.274 rillig 14255: </tr>
14256: <tr>
1.347 gutterid 14257: <td>administrator</td>
1.348 wiz 14258: <td>alloca</td>
1.332 rillig 14259: </tr>
14260: <tr>
1.347 gutterid 14261: <td>alternatives</td>
1.348 wiz 14262: <td>aslr</td>
1.269 leot 14263: </tr>
14264: <tr>
1.347 gutterid 14265: <td>asprintf</td>
1.348 wiz 14266: <td>atlas</td>
1.316 cirnatda 14267: </tr>
14268: <tr>
1.347 gutterid 14269: <td>autoconf</td>
1.348 wiz 14270: <td>automake</td>
1.289 leot 14271: </tr>
14272: <tr>
1.347 gutterid 14273: <td>autoreconf</td>
1.348 wiz 14274: <td>awk</td>
1.269 leot 14275: </tr>
14276: <tr>
1.347 gutterid 14277: <td>bash</td>
1.348 wiz 14278: <td>big-endian</td>
1.269 leot 14279: </tr>
14280: <tr>
1.347 gutterid 14281: <td>bin-install</td>
1.348 wiz 14282: <td>bind</td>
1.289 leot 14283: </tr>
14284: <tr>
1.347 gutterid 14285: <td>binpkg-list</td>
1.348 wiz 14286: <td>blas</td>
1.269 leot 14287: </tr>
14288: <tr>
1.347 gutterid 14289: <td>bootstrap-depends</td>
1.348 wiz 14290: <td>broken</td>
1.269 leot 14291: </tr>
14292: <tr>
1.347 gutterid 14293: <td>broken_on_platform</td>
1.348 wiz 14294: <td>bsd</td>
1.269 leot 14295: </tr>
14296: <tr>
1.347 gutterid 14297: <td>bsd.prog.mk</td>
1.348 wiz 14298: <td>build</td>
1.271 brook 14299: </tr>
14300: <tr>
1.347 gutterid 14301: <td>build-env</td>
1.348 wiz 14302: <td>buildlink-directories</td>
1.269 leot 14303: </tr>
14304: <tr>
1.347 gutterid 14305: <td>buildlink-oss-soundcard-h</td>
1.348 wiz 14306: <td>c</td>
1.292 leot 14307: </tr>
14308: <tr>
1.347 gutterid 14309: <td>c++</td>
1.348 wiz 14310: <td>ccache</td>
1.274 rillig 14311: </tr>
14312: <tr>
1.347 gutterid 14313: <td>cce</td>
1.348 wiz 14314: <td>cdefs</td>
1.269 leot 14315: </tr>
14316: <tr>
1.347 gutterid 14317: <td>ceil</td>
1.348 wiz 14318: <td>changes</td>
1.289 leot 14319: </tr>
14320: <tr>
1.347 gutterid 14321: <td>changes-entry</td>
1.348 wiz 14322: <td>changes-entry-noupdate</td>
1.269 leot 14323: </tr>
14324: <tr>
1.347 gutterid 14325: <td>check</td>
1.348 wiz 14326: <td>check-clean</td>
1.269 leot 14327: </tr>
14328: <tr>
1.347 gutterid 14329: <td>check-files</td>
1.348 wiz 14330: <td>check-files-clean</td>
1.269 leot 14331: </tr>
14332: <tr>
1.347 gutterid 14333: <td>check-vulnerable</td>
1.348 wiz 14334: <td>checksum</td>
1.269 leot 14335: </tr>
14336: <tr>
1.347 gutterid 14337: <td>checksum-phase</td>
1.348 wiz 14338: <td>clean</td>
1.289 leot 14339: </tr>
14340: <tr>
1.347 gutterid 14341: <td>clean-depends</td>
1.348 wiz 14342: <td>cleandir</td>
1.269 leot 14343: </tr>
14344: <tr>
1.347 gutterid 14345: <td>commit</td>
1.348 wiz 14346: <td>commit-changes-entry</td>
1.269 leot 14347: </tr>
14348: <tr>
1.347 gutterid 14349: <td>compact</td>
1.348 wiz 14350: <td>compiler</td>
1.269 leot 14351: </tr>
14352: <tr>
1.347 gutterid 14353: <td>conf</td>
1.348 wiz 14354: <td>config.guess</td>
1.269 leot 14355: </tr>
14356: <tr>
1.347 gutterid 14357: <td>config.sub</td>
1.348 wiz 14358: <td>configuration</td>
1.269 leot 14359: </tr>
14360: <tr>
1.347 gutterid 14361: <td>configure</td>
1.348 wiz 14362: <td>configure-env</td>
1.269 leot 14363: </tr>
14364: <tr>
1.347 gutterid 14365: <td>configure-help</td>
1.348 wiz 14366: <td>configure_args</td>
1.269 leot 14367: </tr>
14368: <tr>
1.347 gutterid 14369: <td>connect</td>
1.348 wiz 14370: <td>cos</td>
1.269 leot 14371: </tr>
14372: <tr>
1.347 gutterid 14373: <td>cpe</td>
1.348 wiz 14374: <td>cputime</td>
1.269 leot 14375: </tr>
14376: <tr>
1.344 gutterid 14377: <td>create-usergroup</td>
1.348 wiz 14378: <td>csh</td>
1.269 leot 14379: </tr>
14380: <tr>
1.344 gutterid 14381: <td>ctf</td>
1.348 wiz 14382: <td>cvs</td>
1.269 leot 14383: </tr>
14384: <tr>
1.340 gutterid 14385: <td>debug</td>
1.344 gutterid 14386: <td>declaration</td>
1.338 nia 14387: </tr>
14388: <tr>
1.340 gutterid 14389: <td>declare</td>
1.344 gutterid 14390: <td>defined</td>
1.289 leot 14391: </tr>
14392: <tr>
1.340 gutterid 14393: <td>depend</td>
1.344 gutterid 14394: <td>dependencies</td>
1.329 leot 14395: </tr>
14396: <tr>
1.340 gutterid 14397: <td>depends</td>
1.344 gutterid 14398: <td>depends-checksum</td>
1.320 wiz 14399: </tr>
14400: <tr>
1.340 gutterid 14401: <td>depends-fetch</td>
1.344 gutterid 14402: <td>deps</td>
1.269 leot 14403: </tr>
14404: <tr>
1.340 gutterid 14405: <td>describe</td>
1.344 gutterid 14406: <td>destdir</td>
1.311 leot 14407: </tr>
14408: <tr>
1.340 gutterid 14409: <td>disable</td>
1.344 gutterid 14410: <td>distclean</td>
1.269 leot 14411: </tr>
14412: <tr>
1.340 gutterid 14413: <td>distinfo</td>
1.344 gutterid 14414: <td>dl</td>
1.269 leot 14415: </tr>
14416: <tr>
1.340 gutterid 14417: <td>dlopen</td>
1.344 gutterid 14418: <td>do-buildlink</td>
1.269 leot 14419: </tr>
14420: <tr>
1.340 gutterid 14421: <td>do-clean</td>
1.344 gutterid 14422: <td>do-configure</td>
1.269 leot 14423: </tr>
14424: <tr>
1.340 gutterid 14425: <td>do-configure-post-hook</td>
1.344 gutterid 14426: <td>do-extract</td>
1.269 leot 14427: </tr>
14428: <tr>
1.340 gutterid 14429: <td>do-fetch</td>
1.344 gutterid 14430: <td>do-install</td>
1.277 rillig 14431: </tr>
14432: <tr>
1.340 gutterid 14433: <td>emul</td>
1.344 gutterid 14434: <td>emul-distinfo</td>
1.269 leot 14435: </tr>
14436: <tr>
1.340 gutterid 14437: <td>emul-fetch</td>
1.344 gutterid 14438: <td>emulation</td>
1.332 rillig 14439: </tr>
14440: <tr>
1.340 gutterid 14441: <td>emulator</td>
1.344 gutterid 14442: <td>enable</td>
1.269 leot 14443: </tr>
14444: <tr>
1.336 nia 14445: <td>endian</td>
1.348 wiz 14446: <td>endif</td>
14447: </tr>
14448: <tr>
1.344 gutterid 14449: <td>enomem</td>
1.348 wiz 14450: <td>ensurepip</td>
1.269 leot 14451: </tr>
14452: <tr>
1.344 gutterid 14453: <td>err</td>
1.348 wiz 14454: <td>errx</td>
1.342 wiz 14455: </tr>
14456: <tr>
1.344 gutterid 14457: <td>etc</td>
1.348 wiz 14458: <td>exp</td>
1.329 leot 14459: </tr>
14460: <tr>
1.344 gutterid 14461: <td>extract-rpm</td>
1.348 wiz 14462: <td>fabs</td>
1.269 leot 14463: </tr>
14464: <tr>
1.344 gutterid 14465: <td>feature</td>
1.348 wiz 14466: <td>features</td>
1.320 wiz 14467: </tr>
14468: <tr>
1.344 gutterid 14469: <td>fetch</td>
1.348 wiz 14470: <td>fetch-list</td>
1.311 leot 14471: </tr>
14472: <tr>
1.344 gutterid 14473: <td>follows</td>
1.348 wiz 14474: <td>forbids</td>
1.269 leot 14475: </tr>
14476: <tr>
1.344 gutterid 14477: <td>form</td>
1.348 wiz 14478: <td>format</td>
1.269 leot 14479: </tr>
14480: <tr>
1.344 gutterid 14481: <td>fortify</td>
1.348 wiz 14482: <td>fortify_source</td>
1.289 leot 14483: </tr>
14484: <tr>
1.348 wiz 14485: <td>fossil</td>
1.344 gutterid 14486: <td>friend</td>
1.332 rillig 14487: </tr>
14488: <tr>
1.340 gutterid 14489: <td>fts</td>
1.344 gutterid 14490: <td>fts_close</td>
1.338 nia 14491: </tr>
14492: <tr>
1.340 gutterid 14493: <td>fts_open</td>
1.344 gutterid 14494: <td>fts_read</td>
1.269 leot 14495: </tr>
14496: <tr>
1.340 gutterid 14497: <td>fts_set</td>
1.344 gutterid 14498: <td>gcc</td>
1.269 leot 14499: </tr>
14500: <tr>
1.340 gutterid 14501: <td>gethostbyaddr</td>
1.344 gutterid 14502: <td>gethostbyname</td>
1.269 leot 14503: </tr>
14504: <tr>
1.340 gutterid 14505: <td>gethostbyname2</td>
1.344 gutterid 14506: <td>getopt_long</td>
1.269 leot 14507: </tr>
14508: <tr>
1.340 gutterid 14509: <td>getprogname</td>
1.344 gutterid 14510: <td>getservbyname</td>
1.289 leot 14511: </tr>
14512: <tr>
1.340 gutterid 14513: <td>getservbyport</td>
1.344 gutterid 14514: <td>getservent</td>
1.269 leot 14515: </tr>
14516: <tr>
1.332 rillig 14517: <td>gettext</td>
1.348 wiz 14518: <td>git</td>
14519: </tr>
14520: <tr>
1.344 gutterid 14521: <td>github</td>
1.348 wiz 14522: <td>gitlab</td>
1.289 leot 14523: </tr>
14524: <tr>
1.344 gutterid 14525: <td>glob</td>
1.348 wiz 14526: <td>gnu</td>
1.342 wiz 14527: </tr>
14528: <tr>
1.344 gutterid 14529: <td>gnu_configure_strict</td>
1.348 wiz 14530: <td>go</td>
1.338 nia 14531: </tr>
14532: <tr>
1.344 gutterid 14533: <td>go-deps</td>
1.348 wiz 14534: <td>golang</td>
1.332 rillig 14535: </tr>
14536: <tr>
1.344 gutterid 14537: <td>guess-license</td>
1.348 wiz 14538: <td>hashbang</td>
1.269 leot 14539: </tr>
14540: <tr>
1.344 gutterid 14541: <td>heimdal</td>
1.348 wiz 14542: <td>help</td>
1.274 rillig 14543: </tr>
14544: <tr>
1.348 wiz 14545: <td>hg</td>
1.344 gutterid 14546: <td>imake</td>
1.269 leot 14547: </tr>
14548: <tr>
1.340 gutterid 14549: <td>increment</td>
1.344 gutterid 14550: <td>indirect</td>
1.329 leot 14551: </tr>
14552: <tr>
1.340 gutterid 14553: <td>inet_aton</td>
1.344 gutterid 14554: <td>interp</td>
1.269 leot 14555: </tr>
14556: <tr>
1.340 gutterid 14557: <td>interpreter</td>
1.344 gutterid 14558: <td>intl</td>
1.320 wiz 14559: </tr>
14560: <tr>
1.340 gutterid 14561: <td>ip4</td>
1.344 gutterid 14562: <td>ip6</td>
1.311 leot 14563: </tr>
14564: <tr>
1.340 gutterid 14565: <td>ipv4</td>
1.344 gutterid 14566: <td>ipv6</td>
1.269 leot 14567: </tr>
14568: <tr>
1.340 gutterid 14569: <td>iso</td>
1.344 gutterid 14570: <td>kerberos</td>
1.269 leot 14571: </tr>
14572: <tr>
1.340 gutterid 14573: <td>krb</td>
1.344 gutterid 14574: <td>krb5</td>
1.269 leot 14575: </tr>
14576: <tr>
1.340 gutterid 14577: <td>ksh</td>
1.344 gutterid 14578: <td>lapack</td>
1.269 leot 14579: </tr>
14580: <tr>
1.340 gutterid 14581: <td>latex</td>
1.344 gutterid 14582: <td>libintl_bindtextdomain</td>
1.303 bacon 14583: </tr>
14584: <tr>
1.340 gutterid 14585: <td>libintl_gettext</td>
1.344 gutterid 14586: <td>libintl_textdomain</td>
1.303 bacon 14587: </tr>
14588: <tr>
1.340 gutterid 14589: <td>libnbcompat</td>
1.344 gutterid 14590: <td>libs</td>
1.269 leot 14591: </tr>
14592: <tr>
1.340 gutterid 14593: <td>libtool</td>
1.344 gutterid 14594: <td>licence</td>
1.292 leot 14595: </tr>
14596: <tr>
1.340 gutterid 14597: <td>license</td>
1.344 gutterid 14598: <td>lintl</td>
1.269 leot 14599: </tr>
14600: <tr>
1.340 gutterid 14601: <td>little-endian</td>
1.344 gutterid 14602: <td>lock</td>
1.289 leot 14603: </tr>
14604: <tr>
1.340 gutterid 14605: <td>locking</td>
1.344 gutterid 14606: <td>lua</td>
1.274 rillig 14607: </tr>
14608: <tr>
1.340 gutterid 14609: <td>lvalue</td>
1.344 gutterid 14610: <td>make</td>
1.271 brook 14611: </tr>
14612: <tr>
1.340 gutterid 14613: <td>makesum</td>
1.344 gutterid 14614: <td>memory</td>
1.269 leot 14615: </tr>
14616: <tr>
1.348 wiz 14617: <td>mercurial</td>
1.343 gutterid 14618: <td>meta</td>
1.348 wiz 14619: </tr>
14620: <tr>
1.344 gutterid 14621: <td>meta-package</td>
1.348 wiz 14622: <td>meta_package</td>
1.342 wiz 14623: </tr>
14624: <tr>
1.344 gutterid 14625: <td>mit-krb5</td>
1.348 wiz 14626: <td>mk.conf</td>
1.269 leot 14627: </tr>
14628: <tr>
1.344 gutterid 14629: <td>mkl</td>
1.348 wiz 14630: <td>mount</td>
1.269 leot 14631: </tr>
14632: <tr>
1.344 gutterid 14633: <td>move</td>
1.348 wiz 14634: <td>moved</td>
1.292 leot 14635: </tr>
14636: <tr>
1.344 gutterid 14637: <td>mprotect</td>
1.348 wiz 14638: <td>mremap</td>
1.274 rillig 14639: </tr>
14640: <tr>
1.344 gutterid 14641: <td>nb</td>
1.348 wiz 14642: <td>nbcompat</td>
1.341 gutterid 14643: </tr>
14644: <tr>
1.344 gutterid 14645: <td>netlib</td>
1.348 wiz 14646: <td>node</td>
1.269 leot 14647: </tr>
14648: <tr>
1.344 gutterid 14649: <td>node.js</td>
1.348 wiz 14650: <td>nodejs</td>
1.269 leot 14651: </tr>
14652: <tr>
1.344 gutterid 14653: <td>obstack</td>
1.348 wiz 14654: <td>obstack_ptr_grow</td>
1.333 nia 14655: </tr>
14656: <tr>
1.344 gutterid 14657: <td>occurs</td>
1.348 wiz 14658: <td>only</td>
1.333 nia 14659: </tr>
14660: <tr>
1.344 gutterid 14661: <td>openblas</td>
1.348 wiz 14662: <td>options</td>
1.320 wiz 14663: </tr>
14664: <tr>
1.344 gutterid 14665: <td>options.mk</td>
1.348 wiz 14666: <td>order</td>
1.269 leot 14667: </tr>
14668: <tr>
1.344 gutterid 14669: <td>override</td>
1.348 wiz 14670: <td>override-intltool</td>
1.269 leot 14671: </tr>
14672: <tr>
1.344 gutterid 14673: <td>override-message-intltool</td>
1.348 wiz 14674: <td>package</td>
1.269 leot 14675: </tr>
14676: <tr>
1.344 gutterid 14677: <td>parallel</td>
1.348 wiz 14678: <td>path</td>
1.271 brook 14679: </tr>
14680: <tr>
1.344 gutterid 14681: <td>pax</td>
1.348 wiz 14682: <td>paxctl</td>
1.269 leot 14683: </tr>
14684: <tr>
1.344 gutterid 14685: <td>pbulk-index</td>
1.348 wiz 14686: <td>pc</td>
1.269 leot 14687: </tr>
14688: <tr>
1.344 gutterid 14689: <td>perl</td>
1.348 wiz 14690: <td>perl5</td>
1.269 leot 14691: </tr>
14692: <tr>
1.344 gutterid 14693: <td>perms</td>
1.348 wiz 14694: <td>php</td>
1.269 leot 14695: </tr>
14696: <tr>
1.344 gutterid 14697: <td>pkg-build-options</td>
1.348 wiz 14698: <td>pkg-config</td>
1.269 leot 14699: </tr>
14700: <tr>
1.344 gutterid 14701: <td>pkg_build_options</td>
1.348 wiz 14702: <td>platform</td>
1.269 leot 14703: </tr>
14704: <tr>
1.344 gutterid 14705: <td>plist</td>
1.348 wiz 14706: <td>post-extract</td>
1.269 leot 14707: </tr>
14708: <tr>
1.344 gutterid 14709: <td>post-fetch</td>
1.348 wiz 14710: <td>post-wrapper</td>
1.269 leot 14711: </tr>
14712: <tr>
1.344 gutterid 14713: <td>pre-build-checks-hook</td>
1.348 wiz 14714: <td>pre-configure</td>
1.269 leot 14715: </tr>
14716: <tr>
1.344 gutterid 14717: <td>pre-configure-checks-hook</td>
1.348 wiz 14718: <td>pre-extract</td>
1.269 leot 14719: </tr>
14720: <tr>
1.344 gutterid 14721: <td>pre-fetch</td>
1.348 wiz 14722: <td>print-go-deps</td>
1.269 leot 14723: </tr>
14724: <tr>
1.344 gutterid 14725: <td>print-plist</td>
1.348 wiz 14726: <td>print-summary-data</td>
1.289 leot 14727: </tr>
14728: <tr>
1.344 gutterid 14729: <td>privileged-install-hook</td>
1.348 wiz 14730: <td>pypi</td>
1.269 leot 14731: </tr>
14732: <tr>
1.344 gutterid 14733: <td>python</td>
1.348 wiz 14734: <td>r</td>
1.269 leot 14735: </tr>
14736: <tr>
1.344 gutterid 14737: <td>readme-all</td>
1.348 wiz 14738: <td>recursive</td>
1.269 leot 14739: </tr>
14740: <tr>
1.344 gutterid 14741: <td>recv</td>
1.348 wiz 14742: <td>recvfrom</td>
1.269 leot 14743: </tr>
14744: <tr>
1.344 gutterid 14745: <td>regcomp</td>
1.348 wiz 14746: <td>release-localbase-lock</td>
1.269 leot 14747: </tr>
14748: <tr>
1.344 gutterid 14749: <td>release-lock</td>
1.348 wiz 14750: <td>relro</td>
1.289 leot 14751: </tr>
14752: <tr>
1.344 gutterid 14753: <td>remove</td>
1.348 wiz 14754: <td>removed</td>
1.289 leot 14755: </tr>
14756: <tr>
1.344 gutterid 14757: <td>rename</td>
1.348 wiz 14758: <td>renamed</td>
1.269 leot 14759: </tr>
14760: <tr>
1.344 gutterid 14761: <td>reorder</td>
1.348 wiz 14762: <td>replace</td>
1.341 gutterid 14763: </tr>
14764: <tr>
1.344 gutterid 14765: <td>replace_interpreter</td>
1.348 wiz 14766: <td>reproducible</td>
1.341 gutterid 14767: </tr>
14768: <tr>
1.344 gutterid 14769: <td>resolv</td>
1.348 wiz 14770: <td>root</td>
1.269 leot 14771: </tr>
14772: <tr>
1.344 gutterid 14773: <td>ruby</td>
1.348 wiz 14774: <td>send</td>
1.269 leot 14775: </tr>
14776: <tr>
1.344 gutterid 14777: <td>sendfile</td>
1.348 wiz 14778: <td>sendto</td>
1.269 leot 14779: </tr>
14780: <tr>
1.344 gutterid 14781: <td>setenv</td>
1.348 wiz 14782: <td>setgid</td>
1.289 leot 14783: </tr>
14784: <tr>
1.344 gutterid 14785: <td>setprogname</td>
1.348 wiz 14786: <td>setuid</td>
1.269 leot 14787: </tr>
14788: <tr>
1.344 gutterid 14789: <td>sh</td>
1.348 wiz 14790: <td>shebang</td>
1.269 leot 14791: </tr>
14792: <tr>
1.344 gutterid 14793: <td>show</td>
1.348 wiz 14794: <td>show-all</td>
1.269 leot 14795: </tr>
14796: <tr>
1.344 gutterid 14797: <td>show-build-defs</td>
1.348 wiz 14798: <td>show-depends</td>
1.269 leot 14799: </tr>
14800: <tr>
1.344 gutterid 14801: <td>show-depends-dirs</td>
1.348 wiz 14802: <td>show-depends-pkgpaths</td>
1.296 rillig 14803: </tr>
14804: <tr>
1.344 gutterid 14805: <td>show-depends-recursive</td>
1.348 wiz 14806: <td>show-deps</td>
1.269 leot 14807: </tr>
14808: <tr>
1.344 gutterid 14809: <td>show-distfiles</td>
1.348 wiz 14810: <td>show-downlevel</td>
1.337 gutterid 14811: </tr>
14812: <tr>
1.344 gutterid 14813: <td>show-subdir-var</td>
1.348 wiz 14814: <td>show-tools</td>
1.338 nia 14815: </tr>
14816: <tr>
1.344 gutterid 14817: <td>show-var</td>
1.348 wiz 14818: <td>show-vars</td>
1.269 leot 14819: </tr>
14820: <tr>
1.344 gutterid 14821: <td>snprintf</td>
1.348 wiz 14822: <td>socket</td>
1.269 leot 14823: </tr>
14824: <tr>
1.344 gutterid 14825: <td>ssp</td>
1.348 wiz 14826: <td>st_mode</td>
1.269 leot 14827: </tr>
14828: <tr>
1.344 gutterid 14829: <td>stage-install</td>
1.348 wiz 14830: <td>strcasestr</td>
1.269 leot 14831: </tr>
14832: <tr>
1.344 gutterid 14833: <td>strict</td>
1.348 wiz 14834: <td>strip</td>
1.289 leot 14835: </tr>
14836: <tr>
1.344 gutterid 14837: <td>strndup</td>
1.348 wiz 14838: <td>strnlen</td>
1.269 leot 14839: </tr>
14840: <tr>
1.344 gutterid 14841: <td>strsep</td>
1.348 wiz 14842: <td>subst</td>
1.269 leot 14843: </tr>
14844: <tr>
1.344 gutterid 14845: <td>substitutions</td>
1.348 wiz 14846: <td>subversion</td>
1.277 rillig 14847: </tr>
14848: <tr>
1.341 gutterid 14849: <td>sun</td>
1.344 gutterid 14850: <td>sunpro</td>
1.329 leot 14851: </tr>
14852: <tr>
1.341 gutterid 14853: <td>sunwspro</td>
1.348 wiz 14854: <td>svn</td>
1.327 wiz 14855: </tr>
14856: <tr>
1.348 wiz 14857: <td>symlink</td>
1.343 gutterid 14858: <td>test</td>
1.342 wiz 14859: </tr>
14860: <tr>
1.348 wiz 14861: <td>test-env</td>
1.343 gutterid 14862: <td>tex</td>
1.338 nia 14863: </tr>
14864: <tr>
1.348 wiz 14865: <td>texlive</td>
1.343 gutterid 14866: <td>tmp</td>
1.269 leot 14867: </tr>
14868: <tr>
1.348 wiz 14869: <td>todo</td>
1.343 gutterid 14870: <td>tool</td>
1.269 leot 14871: </tr>
14872: <tr>
1.348 wiz 14873: <td>tools</td>
1.343 gutterid 14874: <td>tools-libtool-m4-override</td>
1.269 leot 14875: </tr>
14876: <tr>
1.348 wiz 14877: <td>transitive</td>
1.343 gutterid 14878: <td>type</td>
1.269 leot 14879: </tr>
14880: <tr>
1.348 wiz 14881: <td>ulimit</td>
1.343 gutterid 14882: <td>undefined</td>
1.269 leot 14883: </tr>
14884: <tr>
1.348 wiz 14885: <td>undo-replace</td>
1.343 gutterid 14886: <td>unlimit</td>
1.269 leot 14887: </tr>
14888: <tr>
1.348 wiz 14889: <td>unprivileged</td>
1.343 gutterid 14890: <td>unprivileged-install-hook</td>
1.269 leot 14891: </tr>
14892: <tr>
1.348 wiz 14893: <td>unstripped</td>
1.343 gutterid 14894: <td>update</td>
1.269 leot 14895: </tr>
14896: <tr>
1.348 wiz 14897: <td>updated</td>
1.343 gutterid 14898: <td>upload</td>
1.269 leot 14899: </tr>
14900: <tr>
1.348 wiz 14901: <td>upload-distfiles</td>
1.343 gutterid 14902: <td>use_tools</td>
1.269 leot 14903: </tr>
14904: <tr>
1.348 wiz 14905: <td>user</td>
1.343 gutterid 14906: <td>utimes</td>
1.269 leot 14907: </tr>
14908: <tr>
1.348 wiz 14909: <td>vasprintf</td>
1.343 gutterid 14910: <td>verbose</td>
1.269 leot 14911: </tr>
14912: <tr>
1.348 wiz 14913: <td>vsnprintf</td>
1.343 gutterid 14914: <td>warn</td>
1.269 leot 14915: </tr>
14916: <tr>
1.348 wiz 14917: <td>warning</td>
1.343 gutterid 14918: <td>warnings</td>
1.269 leot 14919: </tr>
14920: <tr>
1.348 wiz 14921: <td>warnx</td>
1.343 gutterid 14922: <td>wattr_off</td>
1.269 leot 14923: </tr>
14924: <tr>
1.348 wiz 14925: <td>wattr_on</td>
1.343 gutterid 14926: <td>work</td>
1.269 leot 14927: </tr>
14928: <tr>
1.348 wiz 14929: <td>wrapper</td>
1.289 leot 14930: <td>wrkdir</td>
1.269 leot 14931: </tr>
14932: </table>
1.267 rillig 14933: </div>
14934: <div class="appendix">
14935: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 14936: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 14937: <div class="toc">
14938: <p><b>Table of Contents</b></p>
1.210 leot 14939: <dl class="toc">
1.322 leot 14940: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
14941: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75 rillig 14942: </dl>
14943: </div>
1.79 rillig 14944: <p>This section contains information on editing the pkgsrc
14945: guide itself.</p>
1.148 asau 14946: <div class="sect1">
1.75 rillig 14947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 14948: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.79 rillig 14949: <p>The pkgsrc guide's source code is stored in
14950: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
14951: are created from it:</p>
1.148 asau 14952: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 14953: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
14954: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289 leot 14955: <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>
14956: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79 rillig 14957: The PDF version of the pkgsrc guide.</p></li>
1.289 leot 14958: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79 rillig 14959: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 14960: </ul></div>
14961: </div>
1.148 asau 14962: <div class="sect1">
1.75 rillig 14963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 14964: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.79 rillig 14965: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 14966: <div class="procedure"><ol class="procedure" type="1">
1.304 bacon 14967: <li class="step"><p>Make sure you have checked out the htdocs repository
14968: into a sibling directory of your pkgsrc directory. You will need
14969: the ability to commit from both pkgsrc and htdocs.</p></li>
1.148 asau 14970: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 14971: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 14972: documentation) installed. These are automatically installed when
1.322 leot 14973: you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/index.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148 asau 14974: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 14975: right directory. All further steps will take place
14976: here.</p></li>
1.148 asau 14977: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 14978: <code class="filename">files/</code>.</p></li>
1.148 asau 14979: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 14980: guide for valid XML and to build the final output files. If you
14981: get any errors at this stage, you can just edit the files, as
14982: there are only symbolic links in the working directory, pointing
14983: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 14984: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 14985: commit)</strong></span></p></li>
1.148 asau 14986: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 14987: regenerate the output files with the proper RCS
14988: Ids.</p></li>
1.148 asau 14989: <li class="step">
1.110 hubertf 14990: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 14991: commit the files in both <code class="filename">pkgsrc/doc</code> and
14992: <code class="filename">htdocs</code>.</p>
1.148 asau 14993: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 14994: <h3 class="title">Note</h3>
14995: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 14996: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
14997: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 14998: directory.</p>
14999: </div>
15000: </li>
1.79 rillig 15001: </ol></div>
1.75 rillig 15002: </div>
15003: </div>
15004: </div></body>
1.1 grant 15005: </html>
CVSweb <webmaster@jp.NetBSD.org>