Annotation of pkgsrc/doc/pkgsrc.html, revision 1.337
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.328 jnemeth 33: <div><p class="copyright">Copyright © 1994-2022 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.41 2022/01/01 06:45:38 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.106 rillig 242: </dl></dd>
243: </dl></dd>
1.299 rillig 244: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106 rillig 245: <dd><dl>
1.299 rillig 246: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
247: <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>
248: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
249: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 250: </dl></dd>
1.299 rillig 251: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106 rillig 252: <dd><dl>
1.299 rillig 253: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
254: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
255: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
256: </dl></dd>
257: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
258: <dd><dl>
259: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
260: <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 261: <dd><dl>
1.299 rillig 262: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
263: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133 wiz 264: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
265: and
266: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
267: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 268: </dl></dd>
1.299 rillig 269: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
270: <dd><dl>
271: <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>
272: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
273: </dl></dd>
274: </dl></dd>
275: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106 rillig 276: <dd><dl>
1.299 rillig 277: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
278: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
279: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
280: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
281: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
282: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
283: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
284: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
285: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106 rillig 286: </dl></dd>
1.299 rillig 287: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
288: <dd><dl>
289: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
290: <dd><dl>
291: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
292: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106 rillig 293: </dl></dd>
1.299 rillig 294: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106 rillig 295: <dd><dl>
1.299 rillig 296: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
297: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
298: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
299: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
300: </dl></dd>
301: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
302: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
303: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
304: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
305: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
306: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
307: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.267 rillig 308: </dl></dd>
309: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
310: <dd><dl>
311: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
312: <dd><dl>
313: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
314: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
315: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
316: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
317: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
318: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
319: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
320: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
321: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
322: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
323: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
324: </dl></dd>
325: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
326: <dd><dl>
327: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
328: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
329: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
330: </dl></dd>
331: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
332: <dd><dl>
333: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
334: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
336: </dl></dd>
337: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
338: <dd><dl>
339: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
340: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 341: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
342: <dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
343: <dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
344: <dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
1.267 rillig 345: </dl></dd>
346: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
347: <dd><dl>
348: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
349: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 350: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
351: <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>
352: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 353: </dl></dd>
354: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
355: <dd><dl>
356: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
357: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
358: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
359: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
360: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 361: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 362: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
363: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 364: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
365: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
366: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
367: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
368: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
369: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
370: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 371: emulation</a></span></dt>
1.318 nia 372: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
373: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.77 rillig 374: </dl></dd>
1.267 rillig 375: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 376: </dl></dd>
1.299 rillig 377: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
378: <dd><dl>
379: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
380: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
381: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
382: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
383: </dl></dd>
1.267 rillig 384: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 385: <dd><dl>
1.267 rillig 386: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
387: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
388: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
389: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
390: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
391: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
392: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
393: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
394: </dl></dd>
395: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75 rillig 396: </dl></dd>
397: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
398: <dd><dl>
1.299 rillig 399: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 400: <dd><dl>
1.299 rillig 401: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
402: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
403: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81 rillig 404: <dd><dl>
1.299 rillig 405: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
406: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81 rillig 407: </dl></dd>
1.299 rillig 408: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
409: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 410: <dd><dl>
1.299 rillig 411: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
412: <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 413: </dl></dd>
1.299 rillig 414: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 415: <dd><dl>
1.299 rillig 416: <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>
417: <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 418: </dl></dd>
419: </dl></dd>
1.299 rillig 420: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 421: <dd><dl>
1.299 rillig 422: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
423: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 424: <dd><dl>
1.299 rillig 425: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
426: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 427: </dl></dd>
428: </dl></dd>
1.299 rillig 429: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
430: <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 431: </dl></dd>
432: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
433: <dd><dl>
434: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
435: <dd><dl>
436: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
437: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
438: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287 rillig 439: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 440: </dl></dd>
441: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
442: </dl></dd>
1.322 leot 443: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.75 rillig 444: <dd><dl>
1.322 leot 445: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
446: <dd><dl>
447: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
448: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
449: </dl></dd>
450: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
451: <dd><dl>
452: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
453: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
454: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
455: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
456: </dl></dd>
457: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
458: <dd><dl>
459: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
460: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
461: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
462: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
463: </dl></dd>
464: </dl></dd>
465: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
466: <dd><dl>
467: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
468: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.75 rillig 469: </dl></dd>
1.322 leot 470: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.76 rillig 471: <dd><dl>
1.322 leot 472: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
473: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
474: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
475: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
476: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.261 leot 477: <code class="filename">stable</code>,
1.128 wiz 478: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 479: source packages</a></span></dt>
480: </dl></dd>
1.322 leot 481: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
482: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75 rillig 483: <dd><dl>
1.322 leot 484: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
485: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75 rillig 486: </dl></dd>
487: </dl>
488: </div>
1.82 rillig 489: <div class="list-of-tables">
490: <p><b>List of Tables</b></p>
491: <dl>
492: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
493: </dt>
1.299 rillig 494: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 495: </dt>
1.299 rillig 496: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 497: </dt>
1.82 rillig 498: </dl>
499: </div>
1.148 asau 500: <div class="chapter">
501: <div class="titlepage"><div><div><h1 class="title">
502: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 503: <div class="toc">
504: <p><b>Table of Contents</b></p>
1.210 leot 505: <dl class="toc">
1.75 rillig 506: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 507: <dd><dl>
508: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
509: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
510: </dl></dd>
1.75 rillig 511: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
512: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 513: <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 514: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
515: </dl>
516: </div>
1.148 asau 517: <div class="sect1">
1.75 rillig 518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
519: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 520: <p>There is a lot of software freely available for Unix-based
521: systems, which is usually available in form of the source code. Before
522: such software can be used, it needs to be configured to the local
523: system, compiled and installed, and this is exactly what The NetBSD
524: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
525: to handle binary packages, so that not every user has to build the
526: packages for himself, which is a time-costly task.</p>
1.75 rillig 527: <p>pkgsrc currently contains several thousand packages,
528: including:</p>
1.148 asau 529: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 530: <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 531: web server</p></li>
1.322 leot 532: <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 533: web browser</p></li>
1.322 leot 534: <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 535: Desktop Environment</p></li>
1.322 leot 536: <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 537: Desktop Environment</p></li>
538: </ul></div>
1.219 rillig 539: <p>… just to name a few.</p>
1.75 rillig 540: <p>pkgsrc has built-in support for handling varying dependencies,
541: such as pthreads and X11, and extended features such as IPv6 support on
542: a range of platforms.</p>
1.148 asau 543: <div class="sect2">
1.82 rillig 544: <div class="titlepage"><div><div><h3 class="title">
545: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
546: <p>
547: pkgsrc provides the following key features:
548: </p>
1.148 asau 549: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 550: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 551: and installation of binary packages. The source and latest
552: patches are retrieved from a master or mirror download site, checksum
553: verified, then built on your system. Support for binary-only
554: distributions is available for both native platforms and NetBSD
555: emulated platforms.</p></li>
1.128 wiz 556: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 557: including binaries, libraries, man pages and other
558: documentation.</p></li>
1.214 sevan 559: <li class="listitem"><p>Tracking of package dependencies automatically, including when
560: performing updates, to ensure required packages are installed. The
561: configuration files of various packages are handled automatically during
562: updates, so local changes are preserved.</p></li>
1.128 wiz 563: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 564: consists of highly portable code. This allows the greatest speed of
1.132 spz 565: development when porting to a new platform. This portability also
1.82 rillig 566: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
567: platforms</em></span>.</p></li>
1.128 wiz 568: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 569: international encryption requirements and build-time options for a
570: large number of packages are all set in a simple, central
571: configuration file.</p></li>
1.128 wiz 572: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 573: freely available under a BSD license, so you may extend and adapt
574: pkgsrc to your needs. Support for local packages and patches is
575: available right out of the box, so you can configure it specifically
576: for your environment.</p></li>
577: </ul></div>
1.91 rillig 578: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 579: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 580: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 581: — That means, if a package contains bugs, it's better to find
1.91 rillig 582: them and to complain about them rather than to just install the package
583: and hope that it works. There are numerous checks in pkgsrc that try to
1.322 leot 584: 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 585: of shell scripts), and post-installation checks (installed files,
586: references to shared libraries, script interpreters).</p></li>
1.128 wiz 587: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 588: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 589: pkgsrc has been ported to many operating systems. Care is taken that
590: packages behave the same on all platforms.</p></li>
591: </ul></div>
1.82 rillig 592: </div>
1.148 asau 593: <div class="sect2">
1.82 rillig 594: <div class="titlepage"><div><div><h3 class="title">
595: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
596: <p>pkgsrc consists of both a source distribution and a binary
597: distribution for these operating systems. After retrieving the required
598: source or binaries, you can be up and running with pkgsrc in just
599: minutes!</p>
1.75 rillig 600: <p>pkgsrc was derived from FreeBSD's ports system, and
601: initially developed for NetBSD only. Since then, pkgsrc has
602: grown a lot, and now supports the following platforms:</p>
1.82 rillig 603: <div class="table">
604: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216 tnn 605: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 606: <colgroup>
607: <col>
608: <col>
1.202 sevan 609: <col>
1.82 rillig 610: </colgroup>
611: <thead><tr>
612: <th>Platform</th>
613: <th>Date Support Added</th>
1.202 sevan 614: <th>Notes</th>
1.82 rillig 615: </tr></thead>
616: <tbody>
617: <tr>
1.289 leot 618: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 619: <td align="center">Aug 1997</td>
1.202 sevan 620: <td class="auto-generated"> </td>
1.82 rillig 621: </tr>
622: <tr>
1.110 hubertf 623: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 624: <td align="center">Mar 1999</td>
1.264 sevan 625: <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 626: </tr>
627: <tr>
1.289 leot 628: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 629: <td align="center">Jun 1999</td>
1.264 sevan 630: <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 631: </tr>
632: <tr>
633: <td>
1.230 sevan 634: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82 rillig 635: </td>
636: <td align="center">Oct 2001</td>
1.305 bacon 637: <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 638: </tr>
639: <tr>
1.289 leot 640: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 641: <td align="center">Nov 2002</td>
1.264 sevan 642: <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 643: </tr>
644: <tr>
1.289 leot 645: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 646: <td align="center">Nov 2002</td>
1.264 sevan 647: <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 648: </tr>
649: <tr>
1.289 leot 650: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 651: <td align="center">Dec 2002</td>
1.202 sevan 652: <td>
1.264 sevan 653: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
654: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.202 sevan 655: </td>
1.82 rillig 656: </tr>
657: <tr>
658: <td>BSD/OS</td>
659: <td align="center">Dec 2003</td>
1.202 sevan 660: <td class="auto-generated"> </td>
1.82 rillig 661: </tr>
662: <tr>
1.289 leot 663: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 664: <td align="center">Dec 2003</td>
1.264 sevan 665: <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 666: </tr>
667: <tr>
668: <td>
1.289 leot 669: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 670: (Microsoft Windows Services for Unix)
671: </td>
672: <td align="center">Mar 2004</td>
1.264 sevan 673: <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 674: </tr>
675: <tr>
1.289 leot 676: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 677: <td align="center">Oct 2004</td>
1.202 sevan 678: <td class="auto-generated"> </td>
1.82 rillig 679: </tr>
680: <tr>
1.110 hubertf 681: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 682: <td align="center">Nov 2004</td>
1.264 sevan 683: <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 684: </tr>
1.98 wiz 685: <tr>
1.289 leot 686: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 687: <td align="center">Apr 2007</td>
1.264 sevan 688: <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 689: </tr>
1.128 wiz 690: <tr>
1.289 leot 691: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128 wiz 692: <td align="center">Sep 2010</td>
1.264 sevan 693: <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 694: </tr>
1.151 obache 695: <tr>
1.289 leot 696: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 697: <td align="center">Jan 2011</td>
1.202 sevan 698: <td class="auto-generated"> </td>
1.151 obache 699: </tr>
700: <tr>
1.289 leot 701: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151 obache 702: <td align="center">Nov 2011</td>
1.264 sevan 703: <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 704: </tr>
705: <tr>
1.289 leot 706: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151 obache 707: <td align="center">Mar 2013</td>
1.264 sevan 708: <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 709: </tr>
1.166 jnemeth 710: <tr>
1.289 leot 711: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166 jnemeth 712: <td align="center">Jul 2013</td>
1.264 sevan 713: <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 714: </tr>
1.214 sevan 715: <tr>
1.289 leot 716: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214 sevan 717: <td align="center">Jun 2014</td>
1.264 sevan 718: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
1.214 sevan 719: </tr>
1.82 rillig 720: </tbody>
1.91 rillig 721: </table></div>
1.82 rillig 722: </div>
1.91 rillig 723: <br class="table-break">
1.82 rillig 724: </div>
1.75 rillig 725: </div>
1.148 asau 726: <div class="sect1">
1.75 rillig 727: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
728: <a name="overview"></a>1.2. Overview</h2></div></div></div>
729: <p>This document is divided into three parts. The first,
1.110 hubertf 730: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 731: describes how one can use one of the packages in the Package
732: Collection, either by installing a precompiled binary package,
1.93 rillig 733: or by building one's own copy using the NetBSD package system.
1.110 hubertf 734: 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 735: package so it can be easily built by other NetBSD users without
736: knowing about the package's building details. The third part,
1.110 hubertf 737: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 738: is intended for those who want to understand how pkgsrc is
739: implemented.</p>
740: <p>This document is available in various formats:
1.110 hubertf 741: <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 742: </div>
1.148 asau 743: <div class="sect1">
1.75 rillig 744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
745: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 746: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
747: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 748: terminology used within this document.</p>
1.148 asau 749: <div class="variablelist"><dl class="variablelist">
1.75 rillig 750: <dt><span class="term">Package</span></dt>
751: <dd><p>A set of files and building instructions
752: that describe what's necessary
753: to build a certain piece of software using
754: pkgsrc. Packages are traditionally stored under
1.236 wiz 755: <code class="filename">/usr/pkgsrc</code>,
756: but may be stored in any location,
757: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75 rillig 758: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 759: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 760: is part of the NetBSD operating system and can be bootstrapped
761: to run on non-NetBSD operating systems as well. It handles
762: building (compiling), installing, and removing of
763: packages.</p></dd>
1.75 rillig 764: <dt><span class="term">Distfile</span></dt>
765: <dd><p>This term describes the file or files that are
766: provided by the author of the piece of software to
767: distribute his work. All the changes necessary to build on
768: NetBSD are reflected in the corresponding package. Usually
769: the distfile is in the form of a compressed tar-archive,
770: but other types are possible, too. Distfiles are usually
771: stored below
1.76 rillig 772: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 773: <dt><span class="term">Port</span></dt>
774: <dd><p>This is the term used by FreeBSD and OpenBSD people
775: for what we call a package.
1.128 wiz 776: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 777: architecture.</p></dd>
778: <dt><span class="term">Precompiled/binary package</span></dt>
779: <dd>
780: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 781: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 782: file so it can be installed on machines of the same
783: machine architecture without the need to
784: recompile. Packages are usually generated in
1.76 rillig 785: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 786: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 787: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 788: especially in the context of precompiled packages.</p>
789: </dd>
790: <dt><span class="term">Program</span></dt>
1.88 wiz 791: <dd><p>The piece of software to be installed which will be
792: constructed from all the files in the distfile by the
793: actions defined in the corresponding package.</p></dd>
1.75 rillig 794: </dl></div>
1.148 asau 795: <div class="sect2">
1.75 rillig 796: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 797: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 798: <div class="variablelist"><dl class="variablelist">
1.75 rillig 799: <dt><span class="term">pkgsrc users</span></dt>
800: <dd>
801: <p>The
802: pkgsrc users are people who use the packages provided by pkgsrc.
803: Typically they are system administrators. The people using the
1.128 wiz 804: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
805: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 806: <p>There are two kinds of pkgsrc users: Some only want to
807: install pre-built binary packages. Others build the pkgsrc
808: packages from source, either for installing them directly or for
1.110 hubertf 809: 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 810: documentation.</p>
811: </dd>
812: <dt><span class="term">package maintainers</span></dt>
813: <dd><p>A
1.110 hubertf 814: 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 815: <dt><span class="term">infrastructure developers</span></dt>
816: <dd><p>These people are involved in all those files
1.76 rillig 817: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 818: 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 819: too.</p></dd>
820: </dl></div>
821: </div>
822: </div>
1.148 asau 823: <div class="sect1">
1.75 rillig 824: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
825: <a name="typography"></a>1.4. Typography</h2></div></div></div>
826: <p>When giving examples for commands, shell prompts are used to
827: show if the command should/can be issued as root, or if
1.128 wiz 828: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.226 sevan 829: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
830: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
831: bourne shell and derivatives.</p>
1.75 rillig 832: </div>
833: </div>
1.148 asau 834: <div class="part">
1.75 rillig 835: <div class="titlepage"><div><div><h1 class="title">
836: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
837: <div class="toc">
838: <p><b>Table of Contents</b></p>
1.210 leot 839: <dl class="toc">
1.267 rillig 840: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
841: <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 842: <dd><dl>
1.267 rillig 843: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 844: <dd><dl>
1.267 rillig 845: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
846: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 847: </dl></dd>
1.267 rillig 848: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 849: <dd><dl>
1.267 rillig 850: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
851: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 852: </dl></dd>
853: </dl></dd>
1.267 rillig 854: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75 rillig 855: <dd><dl>
1.267 rillig 856: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
857: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 858: </dl></dd>
1.267 rillig 859: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75 rillig 860: <dd><dl>
1.267 rillig 861: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 862: <dd><dl>
1.267 rillig 863: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
864: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317 nia 865: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
866: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
867: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
868: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
869: <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>
870: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75 rillig 871: </dl></dd>
1.267 rillig 872: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75 rillig 873: <dd><dl>
1.267 rillig 874: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
875: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
876: <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 877: </dl></dd>
878: </dl></dd>
1.267 rillig 879: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75 rillig 880: <dd><dl>
1.267 rillig 881: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
882: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
883: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
884: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 885: <dd><dl>
1.267 rillig 886: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
887: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
888: <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 889: </dl></dd>
1.267 rillig 890: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
891: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75 rillig 892: </dl></dd>
1.267 rillig 893: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75 rillig 894: <dd><dl>
1.267 rillig 895: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
896: <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 897: </dl></dd>
1.267 rillig 898: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 899: builds)</a></span></dt>
1.75 rillig 900: <dd><dl>
1.267 rillig 901: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 902: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 903: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
904: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 905: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
906: <dd><dl>
1.294 rillig 907: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
908: <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 909: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
910: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
911: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
912: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
913: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
914: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
915: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
916: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 917: </dl></dd>
918: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
919: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267 rillig 920: </dl></dd>
921: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
922: <dd><dl>
923: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
924: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
925: </dl></dd>
926: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
927: <dd><dl>
928: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
929: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
930: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
931: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
932: <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>
933: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
934: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
935: <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>
936: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
937: <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 938: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 939: <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 940: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267 rillig 941: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
942: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
943: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
944: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
945: <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 946: </dl></dd>
947: </dl>
948: </div>
1.148 asau 949: <div class="chapter">
1.75 rillig 950: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 951: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
952: <p>
953: To get help when using pkgsrc, the definitive source is this
954: document, the pkgsrc guide. If you don't find anything here,
955: there are alternatives:
956: </p>
957: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
958: <li class="listitem">
959: <p>
960: The built-in pkgsrc help, which is available after bootstrapping
961: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
962: help for any topic, such as a variable name like
963: <code class="varname">BUILD_DEFS</code>, a make target like
964: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
965: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322 leot 966: <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 967: </li>
968: <li class="listitem"><p>
1.278 rillig 969: To see the value of a single variable, run <span class="command"><strong>bmake
970: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
971: </p></li>
972: <li class="listitem"><p>
973: To see the values of the most common variables, run
974: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
975: topic. To see the variables for a single topic, run
976: <span class="command"><strong>bmake
977: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
978: <span class="command"><strong>bmake show-all-fetch</strong></span>.
979: </p></li>
980: <li class="listitem"><p>
1.267 rillig 981: The pkgsrc-users mailing list, to which
982: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
983: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
984: questions</a>.</p></li>
985: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
986: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
987: or by using a specialized chat program such as
988: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
989: Pick any user name and join the channel #pkgsrc.</p></li>
990: </ul></div>
991: </div>
992: <div class="chapter">
993: <div class="titlepage"><div><div><h2 class="title">
994: <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 995: <div class="toc">
996: <p><b>Table of Contents</b></p>
1.210 leot 997: <dl class="toc">
1.267 rillig 998: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 999: <dd><dl>
1.267 rillig 1000: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
1001: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 1002: </dl></dd>
1.267 rillig 1003: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 1004: <dd><dl>
1.267 rillig 1005: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
1006: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 1007: </dl></dd>
1008: </dl>
1009: </div>
1.91 rillig 1010: <p>Before you download and extract the files, you need to decide
1011: where you want to extract them. When using pkgsrc as root user, pkgsrc
1012: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
1013: free to install the sources and binary packages wherever you want in
1014: your filesystem, provided that the pathname does not contain white-space
1015: or other characters that are interpreted specially by the shell and some
1016: other programs. A safe bet is to use only letters, digits, underscores
1017: and dashes.</p>
1.148 asau 1018: <div class="sect1">
1.75 rillig 1019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1020: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75 rillig 1021: <p>Before you download any pkgsrc files, you should decide
1022: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1023: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1024: quarterly basis from the current branch and only gets modified
1025: for security updates. The names of the stable branches are built
1026: from the year and the quarter, for example
1.329 leot 1027: <code class="literal">2021Q4</code>.</p>
1.75 rillig 1028: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 1029: want to download pkgsrc. You can get it as a tar file or via CVS.
1030: Both ways are described here.</p>
1.157 asau 1031: <p>Note that tar archive contains CVS working copy.
1032: Thus you can switch to using CVS at any later time.</p>
1.148 asau 1033: <div class="sect2">
1.75 rillig 1034: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1035: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75 rillig 1036: <p>The primary download location for all pkgsrc files is
1.264 sevan 1037: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157 asau 1038: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1039: (it points to the same location).
1040: There are a number of subdirectories for different purposes,
1.322 leot 1041: 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 1042: <p>The tar archive for the current branch is in the directory
1.264 sevan 1043: <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 1044: It is autogenerated weekly.</p>
1.157 asau 1045: <p>To save download time we provide bzip2- and
1046: xz-compressed archives which are published at
1.264 sevan 1047: <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 1048: and
1.264 sevan 1049: <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 1050: respectively.
1051: </p>
1052: <p>You can fetch the same files using FTP.</p>
1.329 leot 1053: <p>The tar file for the stable branch 2021Q4 is in the
1054: 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 1055: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112 weinem 1056: <pre class="screen">
1.329 leot 1057: <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 1058: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 1059: or your web browser.</p>
1.112 weinem 1060: <p>Then, extract it with:</p>
1.188 snj 1061: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 weinem 1062: <p>This will create the directory <code class="filename">pkgsrc/</code>
1063: in <code class="filename">/usr/</code> and all the package source will be
1064: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1065: <p>To download pkgsrc-current, run:</p>
1066: <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 1067: </div>
1.148 asau 1068: <div class="sect2">
1.75 rillig 1069: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1070: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128 wiz 1071: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.329 leot 1072: <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 1073: </pre>
1074: <p>This will create the directory <code class="filename">pkgsrc/</code>
1075: in your <code class="filename">/usr/</code> directory and all the package source
1076: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1077: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 1078: <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 1079: </pre>
1.289 leot 1080: <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 1081: <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 1082: <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 1083: </pre>
1084: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1085: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1086: or better globally in <code class="filename">/etc/profile</code>:</p>
1087: <pre class="programlisting">
1088: # set CVS remote shell command
1089: CVS_RSH=ssh
1090: export CVS_RSH
1091: </pre>
1092: <p>By default, CVS doesn't do things like most people would expect it to do.
1093: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1094: in your home directory and saving the following lines to it.
1095: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1096: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1097: <pre class="programlisting">
1098: # recommended CVS configuration file from the pkgsrc guide
1.268 sevan 1099: cvs -q
1.101 rillig 1100: checkout -P
1.103 wiz 1101: update -dP
1102: diff -upN
1.101 rillig 1103: rdiff -u
1.128 wiz 1104: release -d
1.101 rillig 1105: </pre>
1.75 rillig 1106: </div>
1107: </div>
1.148 asau 1108: <div class="sect1">
1.75 rillig 1109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1110: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75 rillig 1111: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1112: (which also works if you have first installed it via a tar
1113: file). It saves bandwidth and hard disk activity, compared to
1114: downloading the tar file again.</p>
1.148 asau 1115: <div class="sect2">
1.75 rillig 1116: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1117: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148 asau 1118: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1119: <h3 class="title">Warning</h3>
1.77 rillig 1120: <p>When updating from a tar file, you first need to
1121: completely remove the old pkgsrc directory. Otherwise those
1122: files that have been removed from pkgsrc in the mean time will
1123: not be removed on your local disk, resulting in inconsistencies.
1124: When removing the old files, any changes that you have done to
1125: the pkgsrc files will be lost after updating. Therefore updating
1126: via CVS is strongly recommended.</p>
1.75 rillig 1127: </div>
1.82 rillig 1128: <p>Note that by default the distfiles and the binary packages
1129: are saved in the pkgsrc tree, so don't forget to rescue them
1.188 snj 1130: before updating. You can also configure pkgsrc to store distfiles
1131: and packages in directories outside the pkgsrc tree by setting the
1.82 rillig 1132: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267 rillig 1133: 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 1134: <p>To update pkgsrc from a tar file, download the tar file as
1135: explained above. Then, make sure that you have not made any
1136: changes to the files in the pkgsrc directory. Remove the pkgsrc
1137: directory and extract the new tar file. Done.</p>
1138: </div>
1.148 asau 1139: <div class="sect2">
1.75 rillig 1140: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1141: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132 spz 1142: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1143: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1144: </pre>
1145: <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>
1146: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1147: </pre>
1.148 asau 1148: <div class="sect3">
1.75 rillig 1149: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1150: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75 rillig 1151: <p>When updating pkgsrc, the CVS program keeps track of the
1152: branch you selected. But if you, for whatever reason, want to
1153: switch from the stable branch to the current one, you can do it
1.128 wiz 1154: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1155: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1156: back to the stable branch, add the
1.329 leot 1157: <span class="quote">“<span class="quote">-rpkgsrc-2021Q4</span>”</span> option.</p>
1.75 rillig 1158: </div>
1.148 asau 1159: <div class="sect3">
1.75 rillig 1160: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1161: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75 rillig 1162: <p>When you update pkgsrc, the CVS program will only touch
1163: those files that are registered in the CVS repository. That
1164: means that any packages that you created on your own will stay
1165: unmodified. If you change files that are managed by CVS, later
1166: updates will try to merge your changes with those that have been
1167: done by others. See the CVS manual, chapter
1.128 wiz 1168: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1169: </div>
1170: </div>
1171: </div>
1172: </div>
1.148 asau 1173: <div class="chapter">
1.75 rillig 1174: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1175: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75 rillig 1176: <div class="toc">
1177: <p><b>Table of Contents</b></p>
1.210 leot 1178: <dl class="toc">
1.267 rillig 1179: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1180: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 1181: </dl>
1182: </div>
1.148 asau 1183: <div class="sect1">
1.75 rillig 1184: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1185: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1186: <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 1187: </div>
1.148 asau 1188: <div class="sect1">
1.82 rillig 1189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1190: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1191: <p>pkgsrc can be bootstrapped for use in two different modes:
1192: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1193: to privileged one all programs are installed under one particular user
1.149 asau 1194: and cannot utilise privileged operations (packages don't create
1195: special users and all special file permissions like setuid are ignored).
1196: </p>
1.82 rillig 1197: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1198: <pre class="screen">
1.167 asau 1199: <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 1200: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1201: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1202: </pre>
1.149 asau 1203: <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>
1204: <p>By default, in privileged mode pkgsrc uses
1205: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1206: where programs will be installed in,
1.230 sevan 1207: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149 asau 1208: directory where pkgsrc will do its internal bookkeeping,
1209: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1210: where packages install their persistent data.
1211: In unprivileged mode pkgsrc uses
1212: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230 sevan 1213: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149 asau 1214: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1215: </p>
1216: <p>You can change default layout using command-line arguments.
1217: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1218: </p>
1.148 asau 1219: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1220: <h3 class="title">Note</h3>
1.110 hubertf 1221: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1222: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1223: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1224: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1225: </div>
1.149 asau 1226: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1227: <h3 class="title">Note</h3>
1228: <p>It is possible to bootstrap multiple instances of pkgsrc
1229: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1230: corresponding to the installation you're working with to build
1231: and install packages.
1232: </p>
1233: </div>
1.75 rillig 1234: </div>
1235: </div>
1.148 asau 1236: <div class="chapter">
1.75 rillig 1237: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1238: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75 rillig 1239: <div class="toc">
1240: <p><b>Table of Contents</b></p>
1.210 leot 1241: <dl class="toc">
1.267 rillig 1242: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 1243: <dd><dl>
1.267 rillig 1244: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1245: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317 nia 1246: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1247: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1248: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1249: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1250: <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>
1251: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.267 rillig 1252: </dl></dd>
1253: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1254: <dd><dl>
1255: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1256: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1257: <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 1258: </dl></dd>
1259: </dl>
1260: </div>
1261: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1262: is to only install the package tools and to use binary packages
1.128 wiz 1263: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1264: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1265: of pkgsrc, too. Then you are able to build your own packages,
1266: and you can still use binary packages from someone else.</p>
1.148 asau 1267: <div class="sect1">
1.75 rillig 1268: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1269: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.317 nia 1270: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264 sevan 1271: site and mirrors, there are collections of binary packages,
1.109 rillig 1272: ready to be installed. These binary packages have been built using the
1273: default settings for the directories, that is:</p>
1.148 asau 1274: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1275: <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>
1276: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1277: <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 1278: </ul></div>
1279: <p>If you cannot use these directories for whatever reasons (maybe
1280: because you're not root), you cannot use these binary packages, but
1.267 rillig 1281: 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 1282: <div class="sect2">
1.75 rillig 1283: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1284: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1285: <p>To install binary packages, you first need to know from where
1286: to get them. The first place where you should look is on the main
1.317 nia 1287: 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 1288: <p>This directory contains binary packages for multiple
1289: platforms. First, select your operating system. (Ignore the
1290: directories with version numbers attached to it, they just exist for
1291: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1292: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1293: <p>In this directory, you often find a file called
1294: <code class="filename">bootstrap.tar.gz</code> which contains the package
1295: management tools. If the file is missing, it is likely that your
1296: operating system already provides those tools. Download the file and
1297: extract it in the <code class="filename">/</code> directory. It will create
1298: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230 sevan 1299: for managing binary packages and the database of installed packages).</p>
1.75 rillig 1300: </div>
1.148 asau 1301: <div class="sect2">
1.75 rillig 1302: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1303: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1304: <p>In the directory from the last section, there is a
1.196 wiz 1305: subdirectory called <code class="filename">All/</code>, which contains all the
1.109 rillig 1306: binary packages that are available for the platform, excluding those
1.317 nia 1307: that may not be distributed via HTTP or FTP.</p>
1.109 rillig 1308: <p>To install packages directly from an FTP or HTTP server, run
1309: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1310: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1311: <pre class="screen">
1.317 nia 1312: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1313: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284 rillig 1314: <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 1315: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.317 nia 1316: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.109 rillig 1317: </pre>
1318: <p>Instead of URLs, you can also use local paths, for example if
1319: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1320: repository. If you want to install packages from multiple sources,
1321: you can separate them by a semicolon in
1322: <code class="varname">PKG_PATH</code>.</p>
1323: <p>After these preparations, installing a package is very
1324: easy:</p>
1325: <pre class="screen">
1.317 nia 1326: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1327: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1328: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1329: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1330: </pre>
1331: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1332: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1333: <p>Any prerequisite packages needed to run the
1.88 wiz 1334: package in question will be installed, too, assuming they are
1.317 nia 1335: present in the repository.</p>
1.75 rillig 1336: <p>After you've installed packages, be sure to have
1.88 wiz 1337: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1338: <code class="varname">PATH</code> so you can actually start the just
1339: installed program.</p>
1.75 rillig 1340: </div>
1.148 asau 1341: <div class="sect2">
1.75 rillig 1342: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1343: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1344: <p>To update binary packages, it is recommended that you use
1345: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1346: package repository to your locally installed packages and safely
1347: replace any older packages.</p>
1348: <p>Note that pkgsrc is released as quarterly branches.
1349: If you are updating to a newer quarterly branch of pkgsrc, you may
1350: need to adjust the repository in
1351: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1352: </div>
1353: <div class="sect2">
1354: <div class="titlepage"><div><div><h3 class="title">
1355: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.82 rillig 1356: <p>To deinstall a package, it does not matter whether it was
1.317 nia 1357: installed from source code or from a binary package. Neither the
1358: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1359: command need to know.</p>
1360: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.88 wiz 1361: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.317 nia 1362: name can be given with or without version number.</p>
1.82 rillig 1363: </div>
1.148 asau 1364: <div class="sect2">
1.82 rillig 1365: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1366: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1367: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.317 nia 1368: installed packages or binary package files.
1369: As with other management tools, it works with packages installed
1370: from source or binaries.</p>
1.82 rillig 1371: </div>
1.148 asau 1372: <div class="sect2">
1.82 rillig 1373: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1374: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82 rillig 1375: <p>
1.279 leot 1376: The pkgsrc Security Team and Packages Groups maintain a list of
1.317 nia 1377: known vulnerabilities to packages which are (or have been)
1.88 wiz 1378: included in pkgsrc. The list is available from the NetBSD
1.317 nia 1379: 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>.
1380: </p>
1381: <p>
1382: Please note that not every "vulnerability" with a CVE assignment is
1383: exploitable in every configuration.
1384: Some bugs are marked as active simply because an fix was not
1385: marked as such.
1386: Operating system specific hardening and mitigation features may also
1387: reduce the impact of bugs.
1.88 wiz 1388: </p>
1.82 rillig 1389: <p>
1.125 wiz 1390: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1391: this list can be downloaded
1392: automatically, and a security audit of all packages installed on a system
1393: can take place.
1394: </p>
1.82 rillig 1395: <p>
1.125 wiz 1396: There are two components to auditing. The first
1397: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1398: is for downloading
1.88 wiz 1399: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1400: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1401: installed packages are vulnerable. If a package is vulnerable, you
1402: will see output similar to the following:
1403: </p>
1.82 rillig 1404: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289 leot 1405: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1406: <p>
1.125 wiz 1407: You may wish to have the
1.317 nia 1408: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1409: file downloaded daily so that
1410: it remains current. This may be done by adding an appropriate entry
1.322 leot 1411: 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 1412: </p>
1413: <pre class="screen">
1.233 sevan 1414: # Download vulnerabilities file
1.230 sevan 1415: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.233 sevan 1416: # Audit the installed packages and email results to root
1417: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1418: root >/dev/null 2>&1
1.125 wiz 1419: </pre>
1420: <p>
1.230 sevan 1421: will update the vulnerability list every day at 3AM, followed by an audit
1422: at 3:09AM. The result of the audit are then emailed to root.
1.125 wiz 1423:
1.230 sevan 1424: On NetBSD this may be accomplished instead by adding the following
1425: line to <code class="filename">/etc/daily.conf</code>:
1426: </p>
1427: <pre class="screen">
1428: fetch_pkg_vulnerabilities=YES
1429: </pre>
1430: <p>
1431: to fetch the vulnerability list from the daily security script. The system
1432: is set to audit the packages by default but can be set explicitly, if
1.235 yyamano 1433: desired (not required), by adding the following line to
1.230 sevan 1434: <code class="filename">/etc/security.conf</code>:
1.125 wiz 1435: </p>
1436: <pre class="screen">
1.230 sevan 1437: check_pkg_vulnerabilities=YES
1.125 wiz 1438: </pre>
1439: <p>
1.322 leot 1440: 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 1441: </p>
1.82 rillig 1442: </div>
1.148 asau 1443: <div class="sect2">
1.82 rillig 1444: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1445: <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 1446: <p>
1.322 leot 1447: 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 1448: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.317 nia 1449: argument to check if any packages are stale, e.g.
1.88 wiz 1450: </p>
1451: <pre class="screen">
1452: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1453: ...
1.88 wiz 1454: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1455: </pre>
1.82 rillig 1456: </div>
1.148 asau 1457: <div class="sect2">
1.82 rillig 1458: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1459: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.110 hubertf 1460: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1461: administrative functions on the package system.</p>
1.82 rillig 1462: </div>
1.75 rillig 1463: </div>
1.148 asau 1464: <div class="sect1">
1.75 rillig 1465: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1466: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88 wiz 1467: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1468: directory now contains a set of packages, organized into
1469: categories. You can browse the online index of packages, or run
1.110 hubertf 1470: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1471: directory to build local <code class="filename">README.html</code> files for
1.322 leot 1472: 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 1473: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1474: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1475: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1476: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1477: different <code class="varname">LOCALBASE</code> definitions on the same
1478: system (inside a chroot is an exception). </p>
1479: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1480: 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 1481: instructions how to create your own packages.</p>
1.148 asau 1482: <div class="sect2">
1.75 rillig 1483: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1484: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82 rillig 1485: <p>To build packages from source, you need a working C
1.88 wiz 1486: compiler. On NetBSD, you need to install the
1.128 wiz 1487: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1488: sets. If you want to build X11-related packages, the
1.128 wiz 1489: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1490: sets are required, too.</p>
1.75 rillig 1491: </div>
1.148 asau 1492: <div class="sect2">
1.75 rillig 1493: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1494: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75 rillig 1495: <p>The first step for building a package is downloading the
1.88 wiz 1496: distfiles (i.e. the unmodified source). If they have not yet been
1497: downloaded, pkgsrc will fetch them automatically.</p>
1498: <p>If you have all files that you need in the
1499: <code class="filename">distfiles</code> directory,
1500: you don't need to connect. If the distfiles are on CD-ROM, you can
1501: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1502: </p>
1.82 rillig 1503: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1504: <p>
1.110 hubertf 1505: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1506: <p>By default a list of distribution sites will be randomly
1507: intermixed to prevent huge load on servers which holding popular
1508: packages (for example, SourceForge.net mirrors). Thus, every
1509: time when you need to fetch yet another distfile all the mirrors
1510: will be tried in new (random) order. You can turn this feature
1511: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1512: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1513: <p>You can overwrite some of the major distribution sites to
1514: fit to sites that are close to your own. By setting one or two
1515: variables you can modify the order in which the master sites are
1516: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1517: delimited list of domain suffixes.
1518: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1519: contains a whitespace delimited list of regular expressions. It
1520: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1521: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1522: some examples. This may save some of your bandwidth and
1523: time.</p>
1.75 rillig 1524: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1525: if you want to keep the settings, by editing the
1.110 hubertf 1526: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1527: and adding the definitions there.</p>
1.82 rillig 1528: <p>
1.88 wiz 1529: If a package depends on many other packages (such as
1.322 leot 1530: <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 1531: alternate between periods of
1532: downloading source, and compiling. To ensure you have all the source
1533: downloaded initially you can run the command:
1534: </p>
1.82 rillig 1535: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1536: <p>
1.88 wiz 1537: which will output and run a set of shell commands to fetch the
1538: necessary files into the <code class="filename">distfiles</code> directory. You can
1539: also choose to download the files manually.
1540: </p>
1.75 rillig 1541: </div>
1.148 asau 1542: <div class="sect2">
1.75 rillig 1543: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1544: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1545: <p>
1.88 wiz 1546: Once the software has downloaded, any patches will be applied, then it
1547: will be compiled for you. This may take some time depending on your
1548: computer, and how many other packages the software depends on and their
1549: compile time.
1550: </p>
1.148 asau 1551: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1552: <h3 class="title">Note</h3>
1553: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1554: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1555: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1556: </div>
1.87 wiz 1557: <p>For example, type</p>
1.88 wiz 1558: <pre class="screen">
1559: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1560: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1561: </pre>
1.75 rillig 1562: <p>at the shell prompt to build the various components of the
1.88 wiz 1563: package.</p>
1.82 rillig 1564: <p>The next stage is to actually install the newly compiled
1.88 wiz 1565: program onto your system. Do this by entering:
1.82 rillig 1566:
1.88 wiz 1567: </p>
1.82 rillig 1568: <pre class="screen">
1.88 wiz 1569: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1570: </pre>
1.82 rillig 1571: <p>
1572:
1.88 wiz 1573: while you are still in the directory for whatever package you
1574: are installing.</p>
1.82 rillig 1575: <p>Installing the package on your system may require you to
1.88 wiz 1576: be root. However, pkgsrc has a
1577: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1578: to only become root for the actual installation step.</p>
1.82 rillig 1579: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1580: You can now enter:
1.82 rillig 1581:
1.88 wiz 1582: </p>
1.82 rillig 1583: <pre class="screen">
1.88 wiz 1584: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1585: </pre>
1.82 rillig 1586: <p>
1587:
1.88 wiz 1588: to remove the compiled files in the work directory, as you shouldn't need
1589: them any more. If other packages were also added to your system
1590: (dependencies) to allow your program to compile, you can tidy these up
1591: also with the command:</p>
1.82 rillig 1592: <pre class="screen">
1.88 wiz 1593: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1594: </pre>
1.75 rillig 1595: <p>Taking the figlet utility as an example, we can install it on our
1.322 leot 1596: 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 1597: <p>The program is installed under the default root of the
1598: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1599: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1600: variable in your environment, and it will use that value as the
1601: root of your packages tree. So, to use
1602: <code class="filename">/usr/local</code>, set
1603: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1604: Please note that you should use a directory which is dedicated to
1605: packages and not shared with other programs (i.e., do not try and
1606: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1607: to add any of your own files or directories (such as
1608: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1609: <code class="filename">pkgsrc/</code>) below the
1610: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1611: conflicts between programs and other files installed by the
1612: package system and whatever else may have been installed
1613: there.</p>
1.110 hubertf 1614: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1615: alter some configuration options at build time. Have a look at
1616: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1617: of what will be set there by default. Environment variables such
1618: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1619: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1620: set them each time you want to use pkgsrc.</p>
1.128 wiz 1621: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1622: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 1623: or being installed. This may be for debugging purposes, or out of
1624: simple curiosity. A number of utility values have been added to
1625: help with this.</p>
1.128 wiz 1626: <div class="orderedlist"><ol class="orderedlist" type="1">
1627: <li class="listitem">
1.322 leot 1628: <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 1629: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1630: information will be displayed. For example,</p>
1.75 rillig 1631: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1632: <p>will show all the commands that are invoked, up to and
1.128 wiz 1633: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1634: </li>
1.128 wiz 1635: <li class="listitem">
1.322 leot 1636: <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 1637: definition, then the <code class="varname">VARNAME</code> definition
1638: should be used, in conjunction with the show-var
1.322 leot 1639: 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 1640: variable <code class="varname">LOCALBASE</code>:</p>
1641: <pre class="screen">
1642: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 1643: /usr/pkg
1644: <code class="prompt">%</code>
1.88 wiz 1645: </pre>
1.75 rillig 1646: </li>
1647: </ol></div>
1648: <p>If you want to install a binary package that you've either
1.88 wiz 1649: created yourself (see next section), that you put into
1650: pkgsrc/packages manually or that is located on a remote FTP
1651: server, you can use the "bin-install" target. This target will
1.322 leot 1652: 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 1653: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1654: sites searched is kept in the variable
1655: <code class="varname">BINPKG_SITES</code>, which defaults to
1.322 leot 1656: 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 1657: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1658: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1659: details.</p>
1660: <p>A final word of warning: If you set up a system that has a
1661: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1662: set that before any packages are installed, as you cannot use
1663: several directories for the same purpose. Doing so will result in
1664: pkgsrc not being able to properly detect your installed packages,
1665: and fail miserably. Note also that precompiled binary packages are
1666: usually built with the default <code class="varname">LOCALBASE</code> of
1667: <code class="filename">/usr/pkg</code>, and that you should
1668: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1669: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 1670: </div>
1671: </div>
1672: </div>
1.148 asau 1673: <div class="chapter">
1.75 rillig 1674: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1675: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75 rillig 1676: <div class="toc">
1677: <p><b>Table of Contents</b></p>
1.210 leot 1678: <dl class="toc">
1.267 rillig 1679: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1680: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1681: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
1682: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1683: <dd><dl>
1684: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
1685: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1686: <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 1687: </dl></dd>
1.267 rillig 1688: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
1689: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75 rillig 1690: </dl>
1691: </div>
1.104 rillig 1692: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 1693: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1694: that file depends on the installation. On NetBSD, when you use
1.322 leot 1695: <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 1696: <code class="filename">/etc/</code>. In all other cases the default location is
1697: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1698: bootstrap program to install the binary packages.</p>
1699: <p>The format of the configuration file is that of the usual
1700: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1701: is done by setting variables in this file. Note that you can define all
1702: kinds of variables, and no special error checking (for example for
1.223 rillig 1703: spelling mistakes) takes place.</p>
1.148 asau 1704: <div class="sect1">
1.75 rillig 1705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1706: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223 rillig 1707: <p>The following variables apply to all
1.89 rillig 1708: pkgsrc packages. A complete list of the variables that can be
1709: configured by the user is available in
1710: <code class="filename">mk/defaults/mk.conf</code>, together with some
1711: comments that describe each variable's intent.</p>
1.148 asau 1712: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1713: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 1714: packages will be installed. The default is
1.76 rillig 1715: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 1716: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 1717: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1718: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 1719: installed. The default is
1.76 rillig 1720: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 1721: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 1722: X11 is installed on the system. The default is
1.194 bsiegert 1723: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 1724: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 1725: downloaded copies of the original source distributions used
1726: for building pkgsrc packages. The default is
1.76 rillig 1727: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 1728: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 1729: database about installed packages is stored. The default is
1.230 sevan 1730: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128 wiz 1731: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 1732: If set, override the packages'
1733: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 1734: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 1735: Backup location(s) for distribution files and patch files
1736: if not found locally or in
1.76 rillig 1737: <code class="filename">${MASTER_SITES}</code> or
1738: <code class="filename">${PATCH_SITES}</code> respectively.
1.230 sevan 1739: The defaults is
1740: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 1741: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 1742: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1743: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 1744: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1745: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1746: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 1747: List of acceptable licenses. License names are case-sensitive.
1748: Whenever you try to build a package whose license is not in this
1749: list, you will get an error message. If the license condition is
1750: simple enough, the error message will include specific
1751: instructions on how to change this variable.</p></li>
1.75 rillig 1752: </ul></div>
1753: </div>
1.148 asau 1754: <div class="sect1">
1.75 rillig 1755: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1756: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219 rillig 1757: <p>
1.75 rillig 1758: </p>
1.148 asau 1759: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1760: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 1761: directory for the binary packages. The default is
1.76 rillig 1762: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 1763: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 1764: The top level directory where, if defined, the separate
1765: working directories will get created, and symbolically
1.76 rillig 1766: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 1767: This is useful for building packages on several
1.76 rillig 1768: architectures, then <code class="filename">${PKGSRCDIR}</code>
1769: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 1770: is local to every architecture. (It should be noted that
1771: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 1772: — it is an internal definition which refers to the
1.75 rillig 1773: root of the pkgsrc tree. It is possible to have many
1774: pkgsrc tree instances.)</p></li>
1.128 wiz 1775: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 1776: Directory for local patches that aren't part of pkgsrc.
1.299 rillig 1777: 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 1778: information.</p></li>
1.128 wiz 1779: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 1780: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 1781: BSD-style Makefile. If this is not set,
1782: <code class="varname">MAKECONF</code> is set to
1.76 rillig 1783: <code class="filename">/dev/null</code> to avoid picking up
1784: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75 rillig 1785: </ul></div>
1786: </div>
1.148 asau 1787: <div class="sect1">
1.75 rillig 1788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1789: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.312 gdt 1790: <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 1791: By default, binary packages of built packages are
1.263 leot 1792: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256 maya 1793: this variable to "no" prevents this.</p></li></ul></div>
1.217 jnemeth 1794: <p>Packages have to support installation into a
1.103 wiz 1795: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1796: to be built, before the actual filesystem is touched. DESTDIR
1797: support exists in two variations:</p>
1.148 asau 1798: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1799: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 1800: installation and packaging is still run as root.</p></li>
1801: <li class="listitem"><p>Full DESTDIR support can run the complete
1802: build, installation and packaging as normal user. Root
1803: privileges are only needed to add packages.</p></li>
1804: </ul></div>
1.103 wiz 1805: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1806: clean</code></strong> needs to be run as root.</p>
1.118 imil 1807: <p>Considering the <code class="filename">foo/bar</code> package,
1808: DESTDIR full support can be tested using the following commands
1809:
1810: </p>
1811: <pre class="programlisting">
1812: <code class="prompt">$</code> id
1813: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1814: <code class="prompt">$</code> mkdir $HOME/packages
1815: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1816: </pre>
1817: <p>
1818:
1819: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1820: should be needed
1821:
1822: </p>
1823: <pre class="programlisting">
1.174 asau 1824: <code class="prompt">$</code> make stage-install
1.118 imil 1825: </pre>
1826: <p>
1827:
1828: Create a package without root privileges
1829:
1830: </p>
1831: <pre class="programlisting">
1.174 asau 1832: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 1833: </pre>
1834: <p>
1835:
1836: For the following command, you must be able to gain root
1.322 leot 1837: 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 1838:
1839: </p>
1840: <pre class="programlisting">
1.174 asau 1841: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 1842: </pre>
1843: <p>
1844:
1845: Then, as a simple user
1846:
1847: </p>
1848: <pre class="programlisting">
1849: <code class="prompt">$</code> make clean
1850: </pre>
1851: <p>
1852:
1853: </p>
1.103 wiz 1854: </div>
1.148 asau 1855: <div class="sect1">
1.103 wiz 1856: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1857: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 1858: <div class="sect2">
1.78 rillig 1859: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1860: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 1861: <p>By default, pkgsrc will use GCC to build packages. This may be
1862: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 1863: <div class="variablelist"><dl class="variablelist">
1.89 rillig 1864: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1865: <dd>
1866: <p>This is a list of values specifying the chain of
1867: compilers to invoke when building packages. Valid values
1868: are:</p>
1.148 asau 1869: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 1870: <li class="listitem"><p><code class="varname">ccc</code>:
1871: Compaq C Compilers (Tru64)</p></li>
1872: <li class="listitem"><p><code class="varname">ccache</code>:
1873: compiler cache (chainable)</p></li>
1874: <li class="listitem"><p><code class="varname">clang</code>:
1875: Clang C and Objective-C compiler</p></li>
1.128 wiz 1876: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 1877: distributed C/C++ (chainable)</p></li>
1.174 asau 1878: <li class="listitem"><p><code class="varname">f2c</code>:
1879: Fortran 77 to C compiler (chainable)</p></li>
1880: <li class="listitem"><p><code class="varname">icc</code>:
1881: Intel C++ Compiler (Linux)</p></li>
1882: <li class="listitem"><p><code class="varname">ido</code>:
1883: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 1884: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 1885: GNU C/C++ Compiler</p></li>
1.174 asau 1886: <li class="listitem"><p><code class="varname">hp</code>:
1887: HP-UX C/aC++ compilers</p></li>
1.128 wiz 1888: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 1889: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 1890: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 1891: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 1892: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 1893: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 1894: <li class="listitem"><p><code class="varname">xlc</code>:
1.230 sevan 1895: IBM's XL C/C++ compiler suite</p></li>
1.89 rillig 1896: </ul></div>
1897: <p>The default is
1.128 wiz 1898: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 1899: <code class="varname">ccache</code> and/or
1900: <code class="varname">distcc</code> with an appropriate
1901: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 1902: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 1903: variable should always be terminated with a value for
1904: a real compiler. Note that only one real compiler
1.128 wiz 1905: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 1906: is not allowed).</p>
1.89 rillig 1907: </dd>
1908: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1909: <dd><p>This specifies the minimum version of GCC to use
1910: when building packages. If the system GCC doesn't
1911: satisfy this requirement, then pkgsrc will build and
1912: install one of the GCC packages to use instead.</p></dd>
1.266 leot 1913: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225 maya 1914: <dd><p>Specifies which version of python to use when several
1915: options are available.</p></dd>
1916: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291 gutterid 1917: <dd><p>Specifies the Fortran compiler to use.
1918: The default is <code class="varname">gfortran</code>.</p></dd>
1.225 maya 1919: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1920: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1921: <code class="varname">gfortran</code> is used, this option specifies which
1922: version to use.</p></dd>
1.89 rillig 1923: </dl></div>
1924: </div>
1.148 asau 1925: <div class="sect2">
1.89 rillig 1926: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1927: <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 1928: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1929: please make sure to use the <code class="literal">+=</code> operator
1930: instead of the <code class="literal">=</code> operator:</p>
1931: <pre class="programlisting">
1.100 rillig 1932: CFLAGS+= -your -flags
1.78 rillig 1933: </pre>
1934: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 1935: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 1936: need to add their own flags. You may want to take a look
1.322 leot 1937: 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 1938: package if you're interested in optimization specifically
1939: for the current CPU. </p>
1.78 rillig 1940: </div>
1.148 asau 1941: <div class="sect2">
1.88 wiz 1942: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1943: <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 1944: <p>If you want to pass flags to the linker, both in the configure
1945: step and the build step, you can do this in two ways. Either set
1946: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1947: between the two is that <code class="varname">LIBS</code> will be appended to
1948: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1949: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1950: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1951: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1952: <code class="varname">CFLAGS</code>, if you do not wish to override these
1953: settings, use the <code class="literal">+=</code> operator:</p>
1954: <pre class="programlisting">
1.100 rillig 1955: LDFLAGS+= -your -linkerflags
1.88 wiz 1956: </pre>
1957: </div>
1.78 rillig 1958: </div>
1.148 asau 1959: <div class="sect1">
1.78 rillig 1960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1961: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 1962: <p>
1.75 rillig 1963: </p>
1.148 asau 1964: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1965: <li class="listitem">
1.75 rillig 1966: <p><code class="varname">PKG_DEVELOPER</code>:
1967: Run some sanity checks that package developers want:
1968: </p>
1.148 asau 1969: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 1970: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 1971: fuzz</p></li>
1.128 wiz 1972: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 1973: binaries will find their shared libs.</p></li>
1.75 rillig 1974: </ul></div>
1975: <p>
1.87 wiz 1976: </p>
1.75 rillig 1977: </li>
1.128 wiz 1978: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 1979: of debugging output which is displayed whilst making and
1980: installing the package. The default value for this is 0,
1981: which will not display the commands as they are executed
1982: (normal, default, quiet operation); the value 1 will display
1983: all shell commands before their invocation, and the value 2
1984: will display both the shell commands before their invocation,
1.223 rillig 1985: as well as their actual execution progress with <span class="command"><strong>set
1986: -x</strong></span>.</p></li>
1.75 rillig 1987: </ul></div>
1988: <p>
1989: </p>
1990: </div>
1.148 asau 1991: <div class="sect1">
1.75 rillig 1992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1993: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 1994: <p>Some packages have build time options, usually to select
1995: between different dependencies, enable optional support for big
1996: dependencies or enable experimental features.</p>
1.75 rillig 1997: <p>To see which options, if any, a package supports, and which
1.110 hubertf 1998: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 1999: show-options</strong></span>, for example:</p>
1.75 rillig 2000: <pre class="programlisting">
2001: The following options are supported by this package:
2002: ssl Enable SSL support.
2003: Exactly one of the following gecko options is required:
2004: firefox Use firefox as gecko rendering engine.
2005: mozilla Use mozilla as gecko rendering engine.
2006: At most one of the following database options may be selected:
2007: mysql Enable support for MySQL database.
2008: pgsql Enable support for PostgreSQL database.
1.1 grant 2009:
1.75 rillig 2010: These options are enabled by default: firefox
2011: These options are currently enabled: mozilla ssl
1.1 grant 2012: </pre>
1.75 rillig 2013: <p>The following variables can be defined in
1.110 hubertf 2014: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2015: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2016: which can be used to select or disable options for all packages
2017: that support them, and
2018: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2019: which can be used to select or disable options specifically for
2020: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2021: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2022: are disabled. A few examples:</p>
1.75 rillig 2023: <pre class="screen">
1.110 hubertf 2024: <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 2025: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2026: PKG_OPTIONS.kdebase= debug -sasl
2027: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2028: <p>It is important to note that options that were specifically
1.120 snj 2029: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2030: you do not wish to include the option. If you are unsure you can view
2031: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2032: <p>The following settings are consulted in the order given, and
2033: the last setting that selects or disables an option is
2034: used:</p>
1.128 wiz 2035: <div class="orderedlist"><ol class="orderedlist" type="1">
2036: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2037: maintainer</p></li>
1.128 wiz 2038: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2039: variables (see below)</p></li>
1.128 wiz 2040: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2041: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2042: </ol></div>
2043: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2044: selected is used, all others are automatically disabled. If an
2045: option of the group is explicitly disabled, the previously
2046: selected option, if any, is used. It is an error if no option
2047: from a required group of options is selected, and building the
2048: package will fail.</p>
2049: <p>Before the options framework was introduced, build options
2050: were selected by setting a variable (often named
2051: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2052: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2053: transition to the options framework for the user, these legacy
2054: variables are converted to the appropriate options setting
2055: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2056: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2057: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2058: directly. Support for the legacy variables will be removed
2059: eventually.</p>
1.75 rillig 2060: </div>
2061: </div>
1.148 asau 2062: <div class="chapter">
1.75 rillig 2063: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2064: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75 rillig 2065: <div class="toc">
2066: <p><b>Table of Contents</b></p>
1.210 leot 2067: <dl class="toc">
1.267 rillig 2068: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2069: <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 2070: </dl>
2071: </div>
1.148 asau 2072: <div class="sect1">
1.75 rillig 2073: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2074: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2075: <p>Once you have built and installed a package, you can create
2076: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.322 leot 2077: 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 2078: the same package on a group of hosts and wasting CPU time. It also
2079: provides a simple means for others to install your package, should
2080: you distribute it.</p>
2081: <p>To create a binary package, change into the appropriate
1.110 hubertf 2082: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2083: package</strong></span>:</p>
2084: <pre class="screen">
1.223 rillig 2085: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2086: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2087: </pre>
1.87 wiz 2088: <p>This will build and install your package (if not already done),
2089: and then build a binary package from what was installed. You can
1.110 hubertf 2090: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2091: it. Binary packages are created by default in
2092: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.322 leot 2093: gzipped tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a
2094: 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 2095: <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 2096: such a binary package.</p>
1.75 rillig 2097: </div>
1.148 asau 2098: <div class="sect1">
1.75 rillig 2099: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2100: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.299 rillig 2101: <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 2102: </div>
2103: </div>
1.148 asau 2104: <div class="chapter">
1.106 rillig 2105: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2106: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 2107: builds)</h2></div></div></div>
2108: <div class="toc">
2109: <p><b>Table of Contents</b></p>
1.210 leot 2110: <dl class="toc">
1.267 rillig 2111: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 2112: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 2113: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2114: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 2115: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2116: <dd><dl>
1.294 rillig 2117: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2118: <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 2119: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
2120: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
2121: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
2122: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
2123: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
2124: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
2125: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
2126: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 2127: </dl></dd>
2128: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2129: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2130: </dl>
2131: </div>
1.290 gutterid 2132: <p>For a number of reasons, you may want to build binary packages
2133: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180 wiz 2134: For instance, when you have multiple machines that should run the same software,
2135: it is wasted time if they all build their packages themselves from source.
2136: Or you may want to build a list of packages you want and check them before
1.290 gutterid 2137: deploying onto production systems.
1.180 wiz 2138: There is a way of getting a set of binary packages:
1.290 gutterid 2139: the bulk build system, or pbulk ("p" stands for "parallel").
1.223 rillig 2140: This chapter describes how to set it up.</p>
1.148 asau 2141: <div class="sect1">
1.106 rillig 2142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2143: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180 wiz 2144: <p>First of all, you have to decide whether you build all packages
2145: or a limited set of them. Full bulk builds usually consume a lot more resources,
2146: both space and time, than builds for some practical sets of packages.
1.290 gutterid 2147: A number of particularly heavy packages exist that are not actually
2148: interesting to a wide audience. (The approximate resource consumption for a
2149: 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>.)
2150: For limited bulk builds you need to make a list of packages you want to build.
1.223 rillig 2151: Note that all their dependencies will be built, so you don't need to track them manually.
1.180 wiz 2152: </p>
2153: <p>During bulk builds various packages are installed and deinstalled
2154: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2155: so make sure that you don't need any package during the builds.
1.223 rillig 2156: Essentially, you should provide a fresh system, either a chroot environment
1.180 wiz 2157: or something even more restrictive, depending on what the operating system provides,
2158: or dedicate the whole physical machine.
2159: As a useful side effect this makes sure that bulk builds cannot
2160: break anything in your system. There have been numerous cases where
1.106 rillig 2161: certain packages tried to install files outside the
2162: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2163: <code class="filename">/etc</code>.
2164: </p>
1.106 rillig 2165: </div>
1.148 asau 2166: <div class="sect1">
1.106 rillig 2167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.295 rillig 2168: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
2169: <p>Running a bulk build works roughly as follows:</p>
1.148 asau 2170: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2171: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2172: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2173: </ul></div>
1.148 asau 2174: <div class="sect2">
1.116 rillig 2175: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 2176: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223 rillig 2177: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178 asau 2178: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2179: Configure network access to fetch distribution files.
1.223 rillig 2180: Create a user with name "pbulk".</p>
1.178 asau 2181: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2182: <pre class="screen">
1.264 sevan 2183: <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>
2184: <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 2185: <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 2186: </pre>
2187: <p>Or any other way that fits (e.g., curl, wget).</p>
2188: <p>Deploy and configure pbulk tools, e.g.:</p>
2189: <pre class="screen">
1.230 sevan 2190: <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 2191: <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>
2192: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2193: </pre>
2194: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2195: <h3 class="title">Note</h3>
2196: <p><code class="filename">mk.conf.frag</code> is a fragment of
2197: <code class="filename">mk.conf</code> that contains settings you want to
2198: apply to packages you build. For instance,</p>
2199: <pre class="programlisting">
1.223 rillig 2200: PKG_DEVELOPER= yes # perform more checks
2201: X11_TYPE= modular # use pkgsrc X11
2202: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2203: # when building all packages)
1.178 asau 2204: </pre>
2205: </div>
2206: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223 rillig 2207: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178 asau 2208: <pre class="programlisting">
2209: www/firefox
2210: mail/thunderbird
2211: misc/libreoffice4
2212: </pre>
1.179 asau 2213: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2214: and make final amendments, if wanted.</p>
1.178 asau 2215: <p>Start it:</p>
2216: <pre class="screen">
2217: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2218: </pre>
2219: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2220: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2221: </p>
2222: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2223: <h3 class="title">Note</h3>
2224: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2225: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2226: The script is kept small enough for better understanding.</p>
2227: </div>
2228: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2229: <h3 class="title">Note</h3>
2230: <p>The <code class="filename">pbulk.sh</code> script supports running
1.320 wiz 2231: unprivileged bulk build and helps configuring distributed bulk builds.
2232: Distributed bulk builds support either building in worker chroots
2233: (each node is a path to a different chroot)
2234: that replicate the target system, including the pbulk prefix,
2235: or remote machines (each node is
2236: an IP address that must be accessible over SSH without a password).</p>
1.178 asau 2237: </div>
1.106 rillig 2238: </div>
2239: </div>
1.148 asau 2240: <div class="sect1">
1.106 rillig 2241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2242: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180 wiz 2243: <p>A complete bulk build requires lots of disk space. Some of the
2244: disk space can be read-only, some other must be writable. Some can be on
2245: remote filesystems (such as NFS) and some should be local. Some can be
2246: temporary filesystems, others must survive a sudden reboot.</p>
2247: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.320 wiz 2248: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2249: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.180 wiz 2250: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2251: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2252: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2253: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2254: </ul></div>
2255: </div>
2256: <div class="sect1">
2257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.293 rillig 2258: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2259: <p>To ensure that pkgsrc packages work in different configurations, it
2260: makes sense to run non-default bulk builds from time to time. This
2261: section lists some ideas for bulk builds that intentionally let packages
2262: fail if they don't follow the pkgsrc style.</p>
2263: <div class="sect2">
2264: <div class="titlepage"><div><div><h3 class="title">
1.294 rillig 2265: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.293 rillig 2266: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2267: <pre class="programlisting">
2268: GNU_CONFIGURE_STRICT= yes
2269: </pre>
2270: <p>When a package fails this additional check, the most common cause
2271: is that the configure option was valid for an older version of the
2272: package but does not apply anymore. In that case, just remove it.</p>
2273: </div>
2274: <div class="sect2">
2275: <div class="titlepage"><div><div><h3 class="title">
1.294 rillig 2276: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293 rillig 2277: <p>The job of a compiler is not restricted to producing executable
1.294 rillig 2278: code, most compilers also detect typical programming mistakes. The pkgsrc
2279: compiler wrappers make it easy to force compiler options when the package
2280: is built. This can be used to find typical bugs across all packages that
2281: are in pkgsrc. By reporting these bugs upstream, the packages will be
2282: more reliable with the next updates.</p>
2283: <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 2284: <pre class="programlisting">
2285: CFLAGS+= -Werror=char-subscripts
1.294 rillig 2286: CFLAGS+= -Werror=implicit-function-declaration
1.293 rillig 2287: </pre>
1.294 rillig 2288: <p>When a package fails to build using these stricter compiler
2289: options, document the circumstances in which the compiler produced the
2290: error message. This includes:</p>
1.293 rillig 2291: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2292: <li class="listitem"><p>The platform
2293: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2294: <li class="listitem"><p>The source file</p></li>
2295: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2296: part of the diagnostic.</p></li>
1.294 rillig 2297: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293 rillig 2298: </ul></div>
2299: <p>If a package produces these error messages, but the package is
1.294 rillig 2300: 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
2301: in the next builds:</p>
1.293 rillig 2302: <pre class="programlisting">
1.294 rillig 2303: .if ${PKGPATH} == category/package
1.293 rillig 2304: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2305: # error message
2306: # code
1.294 rillig 2307: # Reason why the code does not need to be fixed.
1.293 rillig 2308: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.294 rillig 2309: .endif
1.293 rillig 2310: </pre>
2311: <p>If the error messages from the compiler are valid and the code
1.294 rillig 2312: needs to be fixed, prepare a local patch (see
2313: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2314: authors of the package, providing them with the information you collected
2315: above.</p>
2316: <p>Patches that are not essential for the package to work should only
2317: be reported upstream but not committed to pkgsrc, to make future updates
2318: easier.</p>
1.293 rillig 2319: </div>
2320: <div class="sect2">
2321: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2322: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
2323: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2324: these apply to all phases of the package build process. Especially in the
2325: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2326: decisions. The GNU configure scripts feed many small test programs to the
2327: C compiler to see whether certain headers are available, functions are
2328: defined in a library and programs can be run. In many cases these
2329: programs would not survive a strict compiler run with <code class="literal">-Wall
2330: -Wextra -Werror</code>.</p>
2331: <p>The pkgsrc infrastructure is flexible enough to support compiler
2332: options being added between the <code class="literal">configure</code> and
2333: <code class="literal">build</code> phases. It's a little more complicated than the
2334: other examples in this section but still easy enough.</p>
2335: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2336: desired compiler options. The compiler wrapper's original task is to hide
2337: unwanted directories of include files and to normalize compiler options.
2338: It does this by wrapping the compiler command and rewriting the command
2339: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2340: package directory and examine the
2341: <code class="filename">work/.cwrappers/config</code> directory. It contains
2342: individual configurations for the C compiler and the related tools. The
2343: plan is to find a hook between the configure and build phases, and to
2344: modify these configuration files at that point.</p>
2345: <p>To find this hook, have a look at
2346: <code class="filename">mk/build/build.mk</code>, which contains among others the
2347: <code class="literal">pre-build-checks-hook</code>. The word
2348: <code class="literal">checks</code> doesn't quite fit, but the
2349: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2350: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2351: <pre class="programlisting">
2352: # Just a few example options.
2353: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2354:
2355: .if ${BUILD_ONLY_CFLAGS:U:M*}
2356: pre-build-checks-hook: add-build-only-cflags
2357:
2358: add-build-only-cflags: .PHONY
2359: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2360: ${TEST} ! -f ${.TARGET} || exit 0; \
2361: for flag in ${BUILD_ONLY_CFLAGS}; do \
2362: ${ECHO} "append=$$flag" >> cc; \
2363: done; \
2364: > ${.TARGET}
2365: .endif
2366: </pre>
2367: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2368: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2369: not with spaces.)</p>
2370: <p>The condition in the <code class="literal">.if</code> statement contains the
2371: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2372: should be undefined, possibly because it is only defined for a subset of
2373: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2374: at least one compiler option, to prevent a syntax error in the shell
2375: parser.</p>
2376: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2377: that the additional compiler options are only appended once, even if
2378: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2379: creates a marker file.</p>
2380: <p>To verify that this setup works, run <span class="command"><strong>bmake
2381: configure</strong></span> in a package directory. Up to now, everything works
2382: as usual. Examine the directory
2383: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2384: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2385: the file <code class="filename">cc</code>. Examine the tail of the
2386: <code class="filename">work/.work.log</code> file to see that the normal compiler
2387: options are used.</p>
2388: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2389: options to the file <code class="filename">cc</code> and will create the marker
2390: file in the same directory. After that, the build starts as usual, but
2391: with the added compiler options. Examine the tail of the file
2392: <code class="filename">work/.work.log</code> to see that the lines starting with
2393: <code class="literal">[*]</code> don't contain the compiler options, but the
2394: corresponding lines starting with <code class="literal"><.></code> do end
2395: with these options.</p>
2396: <p>Building packages using this setup variant and fixing the resulting
2397: 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>
2398: </div>
2399: <div class="sect2">
2400: <div class="titlepage"><div><div><h3 class="title">
2401: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.293 rillig 2402: <p>Some directories like <code class="varname">PREFIX</code>,
2403: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2404: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2405: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2406: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2407: <pre class="programlisting">
2408: PREFIX= /a-random-uuid
2409: PKG_SYSCONFDIR= /a-random-uuid
2410: VARBASE= /a-random-uuid
2411: PKGMANDIR= a-random-uuid
2412: PKG_INFODIR= a-random-uuid
2413: </pre>
2414: </div>
2415: <div class="sect2">
2416: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2417: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.293 rillig 2418: <p>When building a package, warnings are typically ignored since they
2419: just flow by and do not cause the build to fail immediately. To find
2420: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2421: <pre class="programlisting">
2422: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2423: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2424: </pre>
2425: <p>(There are many more classes of warnings in pkgsrc, and most of
2426: them can be redefined with a simple definition like above.</p>
1.294 rillig 2427: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293 rillig 2428: the package Makefile, research whether the package actually needs Perl.
2429: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2430: Makefile, and if it doesn't, add
2431: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2432: </div>
2433: <div class="sect2">
2434: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2435: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293 rillig 2436: <p>Using pkglint as part of the regular build process is mostly a
2437: waste of time. If you want to fix some of the warnings, just run pkglint
2438: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2439: 10), which is much faster than a complete bulk build.</p>
2440: </div>
2441: <div class="sect2">
2442: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2443: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293 rillig 2444: <p>To ensure that the binary packages don't contain references to the
2445: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2446: that variable includes the item <code class="literal">extra</code>, it is
2447: possible to define additional patterns that must not appear in any
2448: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2449: <pre class="programlisting">
2450: CHECK_WRKREF= extra
2451: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2452: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2453: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2454: </pre>
2455: <p>The above patterns will probably generate many false positives,
2456: therefore the results need to be taken with a grain of salt.</p>
2457: </div>
2458: <div class="sect2">
2459: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2460: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.293 rillig 2461: <p>To run the test suites that come with each package, add this line
2462: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2463: <pre class="programlisting">
2464: PKGSRC_RUN_TEST= yes
2465: </pre>
2466: <p>Be prepared that even the most basic packages fail this test. When
2467: doing a bulk build with this, it will often abort in the early phase
2468: where the packages are scanned for their dependencies since there are
2469: cyclic dependencies. There is still a lot to do in this area.</p>
2470: </div>
2471: <div class="sect2">
2472: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2473: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293 rillig 2474: <p>To catch typos in the shell snippets from the Makefile fragments,
2475: add the <code class="literal">-u</code> flag to most of the commands by adding this
2476: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2477: <pre class="programlisting">
2478: RUN= @set -eu;
2479: </pre>
1.296 rillig 2480: <p>After that, ensure that none of the bulk build log files (even
2481: those for successfully built packages) contains the string
2482: <code class="literal">parameter not set</code> or whatever error message the
2483: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293 rillig 2484: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2485: definition.</p>
2486: </div>
2487: <div class="sect2">
2488: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2489: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.293 rillig 2490: <p>The build logs of a package are often quite long. This allows error
2491: messages or other interesting details to hide between the noise. To make
2492: the actual error message stand out more, add these lines to
2493: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2494: <pre class="programlisting">
2495: GNU_CONFIGURE_QUIET= yes
2496: MAKE_FLAGS+= -s
2497: </pre>
2498: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2499: Make. On exotic platforms with their own make, it may be a little
2500: different.</p>
2501: </div>
2502: </div>
2503: <div class="sect1">
2504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2505: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2506: <p>After your pkgsrc bulk-build has completed, you may wish to
2507: create a CD-ROM set of the resulting binary packages to assist
2508: in installing packages on other machines. The
1.322 leot 2509: <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 2510: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2511: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2512: way that keeps all the dependencies for a given package on the same
2513: CD as that package.</p>
1.148 asau 2514: <div class="sect2">
1.75 rillig 2515: <div class="titlepage"><div><div><h3 class="title">
1.293 rillig 2516: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2517: <p>Complete documentation for cdpack is found in the cdpack(1)
2518: man page. The following short example assumes that the binary
2519: packages are left in
2520: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2521: sufficient disk space exists in <code class="filename">/u2</code> to
2522: hold the ISO 9660 images.</p>
2523: <pre class="screen">
2524: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2525: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2526: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2527: </pre>
2528: <p>If you wish to include a common set of files
2529: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2530: etc.) on each CD in the collection, then you need to create a
1.290 gutterid 2531: directory which contains these files, e.g.:</p>
1.87 wiz 2532: <pre class="screen">
2533: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2534: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2535: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2536: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2537: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2538: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2539: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2540: </pre>
1.75 rillig 2541: <p>Now create the images:</p>
2542: <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 2543: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2544: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2545: in their root directories.</p>
1.75 rillig 2546: </div>
2547: </div>
2548: </div>
1.148 asau 2549: <div class="chapter">
1.75 rillig 2550: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2551: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2552: <div class="toc">
2553: <p><b>Table of Contents</b></p>
1.210 leot 2554: <dl class="toc">
1.267 rillig 2555: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2556: <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 2557: </dl>
2558: </div>
2559: <p>The files that are installed by pkgsrc are organized in a way that
2560: is similar to what you find in the <code class="filename">/usr</code> directory
2561: of the base system. But some details are different. This is because
2562: pkgsrc initially came from FreeBSD and had adopted its file system
2563: hierarchy. Later it was largely influenced by NetBSD. But no matter
2564: which operating system you are using pkgsrc with, you can expect the
2565: same layout for pkgsrc.</p>
1.91 rillig 2566: <p>There are mainly four root directories for pkgsrc, which are all
2567: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2568: When pkgsrc has been installed as root, the default locations
2569: are:</p>
2570: <pre class="programlisting">
1.100 rillig 2571: LOCALBASE= /usr/pkg
2572: PKG_SYSCONFBASE= /usr/pkg/etc
2573: VARBASE= /var
1.231 sevan 2574: PKG_DBDIR= /usr/pkg/pkgdb
1.91 rillig 2575: </pre>
2576: <p>In unprivileged mode (when pkgsrc has been installed as any other
2577: user), the default locations are:</p>
2578: <pre class="programlisting">
1.100 rillig 2579: LOCALBASE= ${HOME}/pkg
2580: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2581: VARBASE= ${HOME}/pkg/var
1.231 sevan 2582: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.91 rillig 2583: </pre>
2584: <p>What these four directories are for, and what they look like is
2585: explained below.</p>
1.148 asau 2586: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2587: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2588: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2589: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2590: the well-known subdirectories like <code class="filename">bin</code>,
2591: <code class="filename">include</code>, <code class="filename">lib</code>,
2592: <code class="filename">share</code> and
2593: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2594: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2595: <code class="filename">/var</code> in the base system. Some programs (especially
2596: games, network daemons) need write access to it during normal
2597: operation.</p></li>
1.128 wiz 2598: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2599: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2600: 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 2601: itself.</p></li>
2602: </ul></div>
1.148 asau 2603: <div class="sect1">
1.90 rillig 2604: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2605: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2606: </h2></div></div></div>
1.90 rillig 2607: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2608: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2609: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2610: <dt><span class="term"><code class="filename">bin</code></span></dt>
2611: <dd><p>Contains executable programs that are intended to be
2612: directly used by the end user.</p></dd>
2613: <dt><span class="term"><code class="filename">emul</code></span></dt>
2614: <dd><p>Contains files for the emulation layers of various other
2615: operating systems, especially for
2616: NetBSD.</p></dd>
2617: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2618: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2619: <dd><p>Contains
2620: the configuration files.</p></dd>
2621: <dt><span class="term"><code class="filename">include</code></span></dt>
2622: <dd><p>Contains headers for the C and C++ programming
2623: languages.</p></dd>
2624: <dt><span class="term"><code class="filename">info</code></span></dt>
2625: <dd><p>Contains GNU info files of various
2626: packages.</p></dd>
2627: <dt><span class="term"><code class="filename">lib</code></span></dt>
2628: <dd><p>Contains shared and static
2629: libraries.</p></dd>
2630: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2631: <dd><p>Contains data files that don't change after
2632: installation. Other data files belong into
2633: <code class="filename">${VARBASE}</code>.</p></dd>
2634: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2635: <dd><p>Contains programs that are not intended to be used by
2636: end users, such as helper programs or network
2637: daemons.</p></dd>
2638: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2639: <dd><p>Contains programs that are intended to be executed as
2640: CGI scripts by a web server.</p></dd>
2641: <dt><span class="term"><code class="filename">man</code> (the usual value of
2642: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2643: <dd><p>Contains brief
2644: documentation in form of manual pages.</p></dd>
2645: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2646: <dd><p>Contains programs that are intended to be used only by
2647: the super-user.</p></dd>
2648: <dt><span class="term"><code class="filename">share</code></span></dt>
2649: <dd><p>Contains platform-independent data files that don't
2650: change after installation.</p></dd>
2651: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2652: <dd><p>Contains documentation files provided by the
2653: packages.</p></dd>
2654: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2655: <dd><p>Contains example files provided by the packages. Among
2656: others, the original configuration files are saved here and copied to
2657: <code class="filename">${PKG_SYSCONFDIR}</code> during
2658: installation.</p></dd>
2659: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2660: <dd><p>Contains the original files for rc.d
2661: scripts.</p></dd>
2662: <dt><span class="term"><code class="filename">var</code> (the usual location of
2663: <code class="filename">${VARBASE}</code>)</span></dt>
2664: <dd><p>Contains files
2665: that may be modified after
2666: installation.</p></dd>
2667: </dl></div>
2668: </div>
1.148 asau 2669: <div class="sect1">
1.90 rillig 2670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2671: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2672: </h2></div></div></div>
1.148 asau 2673: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2674: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2675: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2676: <dd><p>Contains
2677: information about the currently installed
2678: packages.</p></dd>
2679: <dt><span class="term"><code class="filename">games</code></span></dt>
2680: <dd><p>Contains highscore
2681: files.</p></dd>
2682: <dt><span class="term"><code class="filename">log</code></span></dt>
2683: <dd><p>Contains log files.</p></dd>
2684: <dt><span class="term"><code class="filename">run</code></span></dt>
2685: <dd><p>Contains informational files about daemons that are
2686: currently running.</p></dd>
2687: </dl></div>
2688: </div>
2689: </div>
1.148 asau 2690: <div class="chapter">
1.90 rillig 2691: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2692: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2693: <div class="toc">
2694: <p><b>Table of Contents</b></p>
1.210 leot 2695: <dl class="toc">
1.267 rillig 2696: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2697: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2698: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2699: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2700: <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>
2701: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2702: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2703: <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>
2704: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2705: <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 2706: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 2707: <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 2708: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.267 rillig 2709: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2710: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2711: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2712: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2713: <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 2714: </dl>
2715: </div>
2716: <p>This section contains hints, tips & tricks on special things in
2717: pkgsrc that we didn't find a better place for in the previous chapters, and
2718: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2719: <div class="sect1">
1.75 rillig 2720: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2721: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2722: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2723: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2724: <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 2725: This is a general purpose list for most issues regarding
2726: pkgsrc, regardless of platform, e.g. soliciting user help
2727: for pkgsrc configuration, unexpected build failures, using
2728: particular packages, upgrading pkgsrc installations,
2729: questions regarding the pkgsrc release branches, etc. General announcements or
2730: proposals for changes that impact the pkgsrc user community,
2731: e.g. major infrastructure changes, new features, package
2732: removals, etc., may also be posted.</p></li>
1.289 leot 2733: <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 2734: A list where the results of pkgsrc bulk builds are sent and
2735: discussed.</p></li>
1.289 leot 2736: <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 2737: This list is for those who are interested in getting a
2738: commit message for every change committed to pkgsrc. It is
2739: also available in digest form, meaning one daily message
2740: containing all commit messages for changes to the package
2741: source tree in that 24 hour period.</p></li>
2742: </ul></div>
2743: <p>To subscribe, do:</p>
2744: <pre class="programlisting">
1.100 rillig 2745: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2746: </pre>
2747: <p>Archives for all these mailing lists are available from
1.289 leot 2748: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2749: </div>
1.148 asau 2750: <div class="sect1">
1.75 rillig 2751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2752: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2753: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2754: a number of useful utilities for both users and developers of pkgsrc. This
1.233 sevan 2755: section attempts only to make the reader aware of some of the utilities and when
1.75 rillig 2756: they might be useful, and not to duplicate the documentation that comes
2757: with each package.</p>
2758: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.322 leot 2759: <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 2760: Symlinks for use by buildlink.</p></li></ul></div>
2761: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2762: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2763: <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 2764: Calculates various kinds of checksums (including SHA3).</p></li>
1.322 leot 2765: <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 2766: Compatibility library for pkgsrc tools.</p></li>
1.322 leot 2767: <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 2768: non-BSD systems due to lack of native mtree.</p></li>
1.322 leot 2769: <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 2770: Up-to-date replacement for
1.76 rillig 2771: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2772: systems where pkg_install is not present.</p></li>
2773: </ul></div>
2774: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2775: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2776: <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 2777: Create a binary package from an
1.110 hubertf 2778: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2779: save the old package.</p></li>
1.322 leot 2780: <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 2781: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2782: from multiple locations. It currently supports the following
2783: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.322 leot 2784: <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 2785: the best compiler flags to optimise code for your current
1.128 wiz 2786: CPU and compiler. </p></li>
1.75 rillig 2787: </ul></div>
2788: <p>Utilities for keeping track of installed packages, being up to date,
2789: etc:</p>
1.148 asau 2790: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2791: <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 2792: update tool similar to apt(1). Download, install, and upgrade
2793: binary packages easily.</p></li>
1.322 leot 2794: <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 2795: packages whose installed versions do not match the latest pkgsrc
2796: entries.</p></li>
1.322 leot 2797: <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 2798: dependency graphs of packages, to aid in choosing a strategy for
2799: updating.</p></li>
1.322 leot 2800: <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
2801: 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>
2802: <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 2803: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.322 leot 2804: <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 2805: does various checks on the complete pkgsrc system.</p></li>
1.322 leot 2806: <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 2807: packages you have installed.</p></li>
2808: </ul></div>
2809: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2810: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2811: <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 2812: making and maintaining patches for a package (includes pkgdiff,
2813: pkgvi, mkpatches, etc.).</p></li>
1.322 leot 2814: <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 2815: converting to pkgsrc.</p></li>
2816: </ul></div>
2817: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2818: utilities)</p>
1.148 asau 2819: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2820: <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 2821: packages in a chrooted area.</p></li>
1.322 leot 2822: <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 2823: kernel version for chrooted cross builds.</p></li>
2824: </ul></div>
2825: </div>
1.148 asau 2826: <div class="sect1">
1.75 rillig 2827: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2828: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219 rillig 2829: <p>To install packages from source as a non-root user, download
1.267 rillig 2830: 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 2831: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2832: --unprivileged</strong></span>.</p>
2833: <p>This will install the binary part of pkgsrc to
2834: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2835: into <code class="filename">~/pkg/etc</code>.</p>
2836: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75 rillig 2837: </div>
1.148 asau 2838: <div class="sect1">
1.75 rillig 2839: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2840: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 2841: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2842: enable this feature by adding the option
2843: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 2844: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 2845: distfile is found, pkgsrc will try to resume it.</p>
2846: <p>You can also
1.168 wiz 2847: use a different program than the platform default program by changing the
1.117 jnemeth 2848: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2849: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2850: by using the value manual. A value of custom disables the system defaults
2851: and dependency tracking for the fetch program. In that case you have to
2852: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2853: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2854: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 2855: <p>For example, if you want to use
1.117 jnemeth 2856: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 2857: like:</p>
2858: <pre class="programlisting">
1.223 rillig 2859: FETCH_USING= wget
1.1 grant 2860: </pre>
1.75 rillig 2861: </div>
1.148 asau 2862: <div class="sect1">
1.75 rillig 2863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2864: <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 2865: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 2866: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 2867: you will have to add the following line into
1.110 hubertf 2868: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 2869: <pre class="programlisting">
1.103 wiz 2870: X11_TYPE=modular
1.1 grant 2871: </pre>
1.75 rillig 2872: </div>
1.148 asau 2873: <div class="sect1">
1.75 rillig 2874: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2875: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 2876: <p>If you are sitting behind a firewall which does not allow direct
2877: connections to Internet hosts (i.e. non-NAT), you may specify the
2878: relevant proxy hosts. This is done using an environment variable in the
2879: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 2880: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 2881: port 80 as the proxy port number. So the proxy environment variables
2882: are:</p>
2883: <pre class="programlisting">
1.100 rillig 2884: ftp_proxy=ftp://orpheus.amdahl.com:80/
2885: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 2886: </pre>
1.75 rillig 2887: </div>
1.148 asau 2888: <div class="sect1">
1.75 rillig 2889: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2890: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 wiz 2891: <p>Some fetch tools are not prepared to support HTTPS by default
2892: (for example, the one in NetBSD 6.0), or the one installed by the
2893: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2894: dependency graph).</p>
2895: <p>Usually you won't notice, because distribution files are
2896: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2897: be often enough if you are following pkgsrc-current. In that case, set
2898: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2899: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2900: with HTTPS support by default. Of course, these tools need to be
2901: installed before you can use them this way.</p>
2902: </div>
2903: <div class="sect1">
2904: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2905: <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 2906: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 2907: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 2908: the first available command from the following list:</p>
1.148 asau 2909: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2910: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2911: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 2912: </ul></div>
2913: <p>On a default NetBSD installation, this will be
1.76 rillig 2914: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 2915: connections first, and falls back to active connections if the server
2916: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 2917: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 2918: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2919: <p>Having that option present will prevent
1.76 rillig 2920: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 2921: transfers.</p>
2922: </div>
1.148 asau 2923: <div class="sect1">
1.75 rillig 2924: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2925: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 2926: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 2927: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 2928: 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 2929: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 2930: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 2931: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 2932: resulting list to your machine at work/school and use it there. If you
1.322 leot 2933: 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 2934: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2935: URL:</p>
2936: <p>At home:</p>
2937: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2938: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2939: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2940: <p>At work:</p>
2941: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 2942: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 2943: home.</p>
2944: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 2945: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2946: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 2947: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 2948: directly by running:</p>
1.75 rillig 2949: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2950: <p>If you even decide to ignore
2951: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2952: by running:</p>
2953: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2954: </div>
1.148 asau 2955: <div class="sect1">
1.75 rillig 2956: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2957: <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 2958: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.322 leot 2959: <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 2960: package, you get the error from make that it doesn't know how to make
1.76 rillig 2961: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 2962: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 2963: the NetBSD base distribution on your machine. It is recommended to do
2964: that to format man pages.</p>
1.322 leot 2965: <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 2966: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 2967: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 2968: </div>
1.148 asau 2969: <div class="sect1">
1.75 rillig 2970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2971: <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 2972: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 2973: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 2974: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 2975: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2976: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 2977: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 2978: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 2979: -r</strong></span>).</p>
2980: </div>
1.148 asau 2981: <div class="sect1">
1.75 rillig 2982: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.336 nia 2983: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.75 rillig 2984: <p>When installing packages as non-root user and using the just-in-time
1.322 leot 2985: <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 2986: password for each required package installed. To avoid this, the sudo
2987: package can be used, which does password caching over a limited time. To
1.336 nia 2988: use it, install <span class="command"><strong>sudo</strong></span> or
2989: <span class="command"><strong>priv</strong></span> (either as binary package, from
2990: <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 2991: <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 2992: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 2993: <span class="emphasis"><em>after</em></span> the definition of the
2994: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 2995: <pre class="programlisting">
1.100 rillig 2996: .if exists(${LOCALBASE}/bin/sudo)
2997: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2998: .endif
1.1 grant 2999: </pre>
1.75 rillig 3000: </div>
1.148 asau 3001: <div class="sect1">
1.75 rillig 3002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3003: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3004: <p>As the system administrator, you can choose where configuration files
3005: are installed. The default settings make all these files go into
1.76 rillig 3006: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3007: be suboptimal depending on your expectations (e.g., a read-only,
3008: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3009: configuration of the provided packages).</p>
3010: <p>In order to change the defaults, you can modify the
3011: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3012: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3013: directory; some common examples include <code class="filename">/etc</code> or
3014: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3015: <p>Furthermore, you can change this value on a per-package basis by
3016: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3017: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3018: package you would like to modify, that is, the contents of
3019: <code class="varname">PKGBASE</code>.</p>
3020: <p>Note that after changing these settings, you must rebuild and
3021: reinstall any affected packages.</p>
3022: </div>
1.148 asau 3023: <div class="sect1">
1.75 rillig 3024: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3025: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75 rillig 3026: <p>Please be aware that there can often be bugs in third-party software,
3027: and some of these bugs can leave a machine vulnerable to exploitation by
3028: attackers. In an effort to lessen the exposure, the NetBSD packages team
3029: maintains a database of known-exploits to packages which have at one time
3030: been included in pkgsrc. The database can be downloaded automatically, and
3031: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3032: do this, refer to the following two tools (installed as part of the
1.322 leot 3033: <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 3034: <div class="orderedlist"><ol class="orderedlist" type="1">
3035: <li class="listitem">
1.122 reed 3036: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3037: download a list of the security vulnerabilities information. This list
1.132 spz 3038: is kept up to date by the pkgsrc security team, and is distributed
3039: from the NetBSD ftp server:</p>
1.292 leot 3040: <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 3041: </li>
1.128 wiz 3042: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3043: current machine, checking each known vulnerability. If a
1.75 rillig 3044: vulnerable package is installed, it will be shown by output to stdout,
3045: including a description of the type of vulnerability, and a URL
3046: containing more information.</p></li>
3047: </ol></div>
1.233 sevan 3048: <p>Use of these tools is strongly recommended!
1.317 nia 3049: 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 3050: reporting.</p>
3051: <p>If this database is installed, pkgsrc builds will use it to
3052: perform a security check before building any package.</p>
1.75 rillig 3053: </div>
1.148 asau 3054: <div class="sect1">
1.75 rillig 3055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3056: <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 3057: <p>When you add your own preferences to the
3058: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3059: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3060: environment variables to the <code class="filename">./configure</code>
1.322 leot 3061: 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 3062: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3063: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3064: package.</p>
3065: <p>Currently there is no solution to this problem. If you
3066: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3067: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3068: directory and then inspect any <code class="filename">Makefile</code> and
3069: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3070: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3071: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3072: programmers write so bad code that it only works for the
3073: specific combination of <code class="varname">CFLAGS</code> they have
3074: chosen.</p>
1.287 rillig 3075: <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>
3076: <pre class="programlisting">
3077: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3078: CFLAGS+= -Dpkgsrc___CFLAGS
3079: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3080: </pre>
3081: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3082: to see whether the above flags are passed to the actual build
3083: commands in general.</p>
3084: <p>To find out whether the flags are passed to individual compiler
3085: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3086: most cases, the flags from the original command lines (the lines starting
3087: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3088: (the lines starting with <code class="literal"><.></code>). If the flag is
3089: missing from the actual compiler command, it must have been removed by
1.299 rillig 3090: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75 rillig 3091: </div>
1.148 asau 3092: <div class="sect1">
1.80 rillig 3093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3094: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3095: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3096: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3097: case that occurs often is that people only update pkgsrc in
3098: parts, because of performance reasons. Since pkgsrc is one large
3099: system, not a collection of many small systems, there are
3100: sometimes changes that only work when the whole pkgsrc tree is
3101: updated.</p></li>
1.148 asau 3102: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3103: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3104: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3105: files.</p></li>
1.148 asau 3106: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3107: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3108: verify this.</p></li>
1.218 rillig 3109: <li class="step"><p>If you are a package developer who wants to invest
1.267 rillig 3110: 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 3111: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3112: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3113: </ol></div>
3114: </div>
1.148 asau 3115: <div class="sect1">
1.88 wiz 3116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3117: <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 3118: <p>You have modified a file from pkgsrc, and someone else has
3119: modified that same file afterwards in the CVS repository. Both changes
3120: are in the same region of the file, so when you updated pkgsrc, the
3121: <code class="literal">cvs</code> command marked the conflicting changes in the
3122: file. Because of these markers, the file is no longer a valid
3123: <code class="filename">Makefile</code>.</p>
3124: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3125: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3126: -dP</strong></span> in that directory to download the current version.</p>
3127: </div>
1.75 rillig 3128: </div>
3129: </div>
1.148 asau 3130: <div class="part">
1.75 rillig 3131: <div class="titlepage"><div><div><h1 class="title">
3132: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3133: <div class="partintro">
1.77 rillig 3134: <div></div>
3135: <p>This part of the book deals with creating and
1.128 wiz 3136: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3137: guide on creating a new package. The remaining chapters are more
3138: like a reference manual for pkgsrc.</p>
1.75 rillig 3139: <div class="toc">
3140: <p><b>Table of Contents</b></p>
1.210 leot 3141: <dl class="toc">
1.267 rillig 3142: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299 rillig 3143: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91 rillig 3144: <dd><dl>
1.299 rillig 3145: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3146: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3147: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91 rillig 3148: <dd><dl>
1.299 rillig 3149: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3150: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3151: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3152: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3153: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91 rillig 3154: </dl></dd>
1.299 rillig 3155: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3156: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3157: <dd><dl>
3158: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3159: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3160: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3161: </dl></dd>
3162: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3163: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3164: </dl></dd>
1.299 rillig 3165: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106 rillig 3166: <dd><dl>
1.299 rillig 3167: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3168: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3169: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3170: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3171: <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 3172: <dd><dl>
1.299 rillig 3173: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3174: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106 rillig 3175: </dl></dd>
1.299 rillig 3176: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3177: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3178: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3179: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3180: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3181: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3182: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3183: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3184: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3185: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3186: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3187: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3188: </dl></dd>
3189: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3190: <dd><dl>
3191: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106 rillig 3192: <dd><dl>
1.334 nia 3193: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
3194: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
3195: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.106 rillig 3196: </dl></dd>
1.299 rillig 3197: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3198: <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 3199: </dl></dd>
1.299 rillig 3200: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3201: <dd><dl>
1.299 rillig 3202: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3203: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3204: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3205: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106 rillig 3206: <dd><dl>
1.299 rillig 3207: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3208: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3209: <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>
3210: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106 rillig 3211: </dl></dd>
3212: </dl></dd>
1.299 rillig 3213: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106 rillig 3214: <dd><dl>
1.299 rillig 3215: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3216: <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>
3217: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3218: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3219: </dl></dd>
1.299 rillig 3220: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106 rillig 3221: <dd><dl>
1.299 rillig 3222: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3223: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3224: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3225: </dl></dd>
3226: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3227: <dd><dl>
3228: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3229: <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 3230: <dd><dl>
1.299 rillig 3231: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3232: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133 wiz 3233: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3234: and
3235: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3236: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3237: </dl></dd>
1.299 rillig 3238: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3239: <dd><dl>
3240: <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>
3241: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3242: </dl></dd>
3243: </dl></dd>
3244: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106 rillig 3245: <dd><dl>
1.299 rillig 3246: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3247: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3248: <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>
3249: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3250: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3251: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3252: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3253: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3254: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106 rillig 3255: </dl></dd>
1.299 rillig 3256: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3257: <dd><dl>
3258: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3259: <dd><dl>
3260: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3261: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106 rillig 3262: </dl></dd>
1.299 rillig 3263: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106 rillig 3264: <dd><dl>
1.299 rillig 3265: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3266: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
3267: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
3268: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
3269: </dl></dd>
3270: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3271: <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>
3272: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3273: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3274: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3275: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3276: <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 3277: </dl></dd>
3278: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3279: <dd><dl>
3280: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3281: <dd><dl>
3282: <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>
3283: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3284: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3285: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3286: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3287: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3288: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3289: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3290: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3291: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3292: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3293: </dl></dd>
3294: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3295: <dd><dl>
3296: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3297: <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>
3298: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3299: </dl></dd>
3300: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3301: <dd><dl>
3302: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3303: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3304: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
3305: </dl></dd>
3306: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3307: <dd><dl>
3308: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3309: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 3310: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
3311: <dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
3312: <dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
3313: <dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
1.267 rillig 3314: </dl></dd>
3315: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3316: <dd><dl>
3317: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3318: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 3319: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3320: <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>
3321: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 3322: </dl></dd>
3323: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3324: <dd><dl>
3325: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3326: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3327: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3328: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3329: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 3330: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 3331: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
3332: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 3333: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
3334: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
3335: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
3336: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
3337: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
3338: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
3339: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 3340: emulation</a></span></dt>
1.318 nia 3341: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
3342: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.77 rillig 3343: </dl></dd>
1.267 rillig 3344: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3345: </dl></dd>
1.299 rillig 3346: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3347: <dd><dl>
3348: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3349: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3350: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3351: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3352: </dl></dd>
1.267 rillig 3353: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 3354: <dd><dl>
1.267 rillig 3355: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3356: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3357: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3358: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3359: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3360: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3361: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3362: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3363: </dl></dd>
3364: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75 rillig 3365: </dl>
3366: </div>
1.77 rillig 3367: </div>
1.148 asau 3368: <div class="chapter">
1.77 rillig 3369: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 3370: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3371: <p>
3372: To get help when developing pkgsrc, the definitive source is this
3373: document, the pkgsrc guide. If you don't find anything here,
3374: there are alternatives:
3375: </p>
3376: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3377: <li class="listitem">
3378: <p>
3379: The built-in pkgsrc help, which is available after bootstrapping
3380: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3381: help for any topic, such as a variable name like
3382: <code class="varname">BUILD_DEFS</code>, a make target like
3383: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3384: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322 leot 3385: <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 3386: </li>
3387: <li class="listitem"><p>
1.278 rillig 3388: To see the value of a single variable, run <span class="command"><strong>bmake
3389: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3390: </p></li>
3391: <li class="listitem"><p>
3392: To see the values of the most common variables, run
3393: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3394: topic. To see the variables for a single topic, run
3395: <span class="command"><strong>bmake
3396: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3397: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3398: </p></li>
3399: <li class="listitem"><p>
1.267 rillig 3400: The tech-pkg mailing list, to which
3401: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3402: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3403: questions</a>.</p></li>
3404: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3405: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3406: or by using a specialized chat program such as
3407: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3408: Pick any user name and join the channel #pkgsrc.</p></li>
3409: </ul></div>
3410: </div>
3411: <div class="chapter">
3412: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 3413: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91 rillig 3414: <div class="toc">
3415: <p><b>Table of Contents</b></p>
1.210 leot 3416: <dl class="toc">
1.299 rillig 3417: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3418: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3419: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3420: <dd><dl>
3421: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3422: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3423: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3424: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3425: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3426: </dl></dd>
3427: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3428: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3429: <dd><dl>
3430: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3431: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3432: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91 rillig 3433: </dl></dd>
1.299 rillig 3434: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3435: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91 rillig 3436: </dl>
3437: </div>
1.299 rillig 3438: <p>Whenever you're preparing a package, there are a number of
3439: files involved which are described in the following
3440: sections.</p>
3441: <div class="sect1">
3442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3443: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3444: </h2></div></div></div>
3445: <p>Building, installation and creation of a binary package are all
3446: controlled by the package's <code class="filename">Makefile</code>.
3447: The <code class="filename">Makefile</code> describes various things about
3448: a package, for example from where to get it, how to configure,
3449: build, and install it.</p>
3450: <p>A package <code class="filename">Makefile</code> contains several
3451: sections that describe the package.</p>
3452: <p>In the first section there are the following variables, which
3453: should appear exactly in the order given here. The order and
3454: grouping of the variables is mostly historical and has no further
3455: meaning.</p>
3456: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3457: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3458: distribution file to be downloaded from the package's
3459: website.</p></li>
3460: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3461: package, as used by pkgsrc. You need to provide it if
3462: <code class="varname">DISTNAME</code> (which is the default) is not a good
3463: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3464: provided (no distribution file is required). Usually it is the pkgsrc
3465: directory name together with the version number. It must match the
3466: regular expression
3467: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3468: starts with a letter or digit, and contains only letters, digits,
1.319 nia 3469: dashes, underscores, dots and plus signs.
3470: New packages should have entirely lower-case names, with the exception
3471: of some that must follow pre-existing conventions
3472: (e.g. R packages begin with <code class="varname">R-</code>).
3473: You can use the <code class="code">:tl</code> variable modifier to lower-case
3474: the package name.</p></li>
1.299 rillig 3475: <li class="listitem">
3476: <p><code class="varname">CATEGORIES</code> is a list of categories
3477: which the package fits in. You can choose any of the top-level
3478: directories of pkgsrc for it.</p>
3479: <p>Currently the following values are available for
3480: <code class="varname">CATEGORIES</code>. If more than
3481: one is used, they need to be separated by spaces:</p>
1.77 rillig 3482: <pre class="programlisting">
1.299 rillig 3483: archivers cross geography meta-pkgs security
3484: audio databases graphics misc shells
3485: benchmarks devel ham multimedia sysutils
3486: biology editors inputmethod net textproc
3487: cad emulators lang news time
3488: chat finance mail parallel wm
3489: comms fonts math pkgtools www
3490: converters games mbone print x11
1.77 rillig 3491: </pre>
3492: </li>
1.299 rillig 3493: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3494: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3495: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3496: and <code class="varname">DISTFILES</code> are discussed in detail in
3497: <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>
3498: </ul></div>
3499: <p>The second section contains information about separately
3500: downloaded patches, if any.
3501: </p>
3502: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3503: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3504: Name(s) of additional files that contain distribution patches.
3505: There is no default. pkgsrc will look for them at
3506: <code class="varname">PATCH_SITES</code>.
3507: They will automatically be uncompressed before patching if
3508: the names end with <code class="filename">.gz</code> or
3509: <code class="filename">.Z</code>.</p></li>
3510: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3511: Primary location(s) for distribution patch files (see
3512: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3513: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.322 leot 3514: 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 3515: help find the correct files to patch. It defaults to
3516: <span class="command"><strong>-p0</strong></span>.</p></li>
3517: </ul></div>
3518: <p>The third section contains the following variables.
3519: </p>
3520: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3521: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
3522: address of the person who feels responsible for this package,
3523: and who is most likely to look at problems or questions regarding
1.322 leot 3524: 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 3525: Other developers may contact the <code class="varname">MAINTAINER</code>
3526: before making changes to the package, but are not required to
3527: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3528: to yourself. If you really can't maintain the package for future
3529: updates, set it to
3530: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
3531: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
3532: of <code class="varname">MAINTAINER</code> when you do not want other
3533: developers to update or change the package without contacting
3534: you first. A package Makefile should contain one of
3535: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3536: not both. </p></li>
3537: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3538: find more information about the package.</p></li>
3539: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3540: description of the package (should not include the package
3541: name).</p></li>
3542: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3543: 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>
3544: </ul></div>
3545: <p>Other variables that affect the build:
3546: </p>
3547: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3548: <p><code class="varname">WRKSRC</code>: The directory where the
3549: interesting distribution files of the package are found. The
3550: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3551: works for most packages.</p>
3552: <p>If a package doesn't create a subdirectory for itself
3553: (most GNU software does, for instance), but extracts itself in
3554: the current directory, you should set
3555: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3556: <p>If a package doesn't create a subdirectory with the
3557: name of <code class="varname">DISTNAME</code> but some different name,
3558: set <code class="varname">WRKSRC</code> to point to the proper name in
3559: <code class="filename">${WRKDIR}</code>, for example
3560: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.322 leot 3561: <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 3562: <p>The name of the working directory created by pkgsrc is
3563: taken from the <code class="varname">WRKDIR_BASENAME</code>
3564: variable. By default, its value is
3565: <code class="filename">work</code>. If you want to use the same
3566: pkgsrc tree for building different kinds of binary packages,
3567: you can change the variable according to your needs. Two
3568: other variables handle common cases of setting
3569: <code class="varname">WRKDIR_BASENAME</code> individually. If
3570: <code class="varname">OBJHOSTNAME</code> is defined in
3571: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3572: the host's name is attached to the directory name. If
3573: <code class="varname">OBJMACHINE</code> is defined, the platform name
3574: is attached, which might look like
3575: <code class="filename">work.i386</code> or
3576: <code class="filename">work.sparc</code>.</p>
3577: </li></ul></div>
3578: <p>Please pay attention to the following gotchas:</p>
3579: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3580: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3581: installed in compressed form by the package. For packages using
3582: BSD-style makefiles which honor MANZ, there is
3583: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3584: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3585: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3586: below).</p></li>
3587: <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>
3588: </ul></div>
3589: </div>
1.148 asau 3590: <div class="sect1">
1.91 rillig 3591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 3592: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3593: </h2></div></div></div>
3594: <p>The <code class="filename">distinfo</code> file contains the message
3595: digest, or checksum, of each distfile needed for the package. This
3596: ensures that the distfiles retrieved from the Internet have not been
3597: corrupted during transfer or altered by a malign force to introduce
3598: a security hole. To provide maximum security, all distfiles are
3599: protected using three different message digest algorithms (SHA1,
3600: RMD160, SHA512), as well as the file size.</p>
3601: <p>The <code class="filename">distinfo</code> file also contains the
3602: checksums for all the patches found in the
3603: <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
3604: are only applied intentionally and that they don't accidentally change,
3605: e.g. when merging different changes together. They also make sure that
3606: new patches are actually added to CVS and old ones are removed.
3607: Too see whether the patches and the <code class="filename">distinfo</code> file
3608: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3609: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3610: <span class="command"><strong>make distinfo</strong></span> command.</p>
3611: <p>Some packages have different sets of distfiles depending on
1.322 leot 3612: 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 3613: <code class="filename">distinfo</code> file and care should be taken when
3614: upgrading such a package to ensure distfile information is not
3615: lost.</p>
3616: </div>
3617: <div class="sect1">
3618: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3619: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3620: </h2></div></div></div>
3621: <p>Some packages don't work out-of-the box on the various
3622: platforms that are supported by pkgsrc. These packages need
3623: to be patched to make them work. The patch files can be
3624: found in the <code class="filename">patches/</code> directory.</p>
3625: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3626: applied to the files in <code class="varname">WRKSRC</code> directory after
3627: extracting them, in alphabetic order.</p>
1.148 asau 3628: <div class="sect2">
1.91 rillig 3629: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3630: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3631: <p>The <code class="filename">patch-*</code> files should be in
3632: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3633: problems. (To force patches to apply with fuzz you can set
3634: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3635: should contain only changes for a single file, and no file should be
3636: patched by more than one patch file. This helps to keep future
3637: modifications simple.</p>
3638: <p>Each patch file is structured as follows: In the first line,
3639: there is the RCS Id of the patch itself. The second line should be
3640: empty for aesthetic reasons. After that, there should be a comment for
3641: each change that the patch does. There are a number of standard
3642: cases:</p>
3643: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3644: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3645: mention the vulnerability ID (CAN, CVE).</p></li>
3646: <li class="listitem"><p>Patches that change source code should mention the
3647: platform and other environment (for example, the compiler) that the
3648: patch is needed for.</p></li>
3649: </ul></div>
3650: <p>The patch should be commented so that any
3651: developer who knows the code of the application can make some use of
3652: the patch. Special care should be taken for the upstream developers,
3653: since we generally want that they accept our patches, so we have less
3654: work in the future.</p>
1.91 rillig 3655: </div>
1.148 asau 3656: <div class="sect2">
1.91 rillig 3657: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3658: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3659: <p>One important thing to mention is to pay attention that no RCS
3660: IDs get stored in the patch files, as these will cause problems when
3661: later checked into the NetBSD CVS tree. Use the
1.322 leot 3662: <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 3663: problems.</p>
3664: <p>For even more automation, we recommend using
3665: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.337 ! gutterid 3666: whole set of patches. You just have to back up files before you
! 3667: edit them to <code class="filename">filename.orig</code>, e.g., with
1.299 rillig 3668: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3669: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3670: you upgrade a package this way, you can easily compare the new
3671: set of patches with the previously existing one with
3672: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3673: are replaced by new files, so carefully check if you want to take all
3674: the changes.</p>
3675: <p>When you have finished a package, remember to generate
3676: the checksums for the patch files by using the <span class="command"><strong>make
3677: 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>
3678: <p>When adding a patch that corrects a problem in the
3679: distfile (rather than e.g. enforcing pkgsrc's view of where
3680: man pages should go), send the patch as a bug report to the
3681: maintainer. This benefits non-pkgsrc users of the package,
3682: and usually makes it possible to remove the patch in future
3683: version.</p>
3684: <p>The file names of the patch files are usually of the form
3685: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3686: Many packages still use the previous convention
3687: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3688: but new patches should be of the form containing the filename.
1.322 leot 3689: <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 3690: automatically.</p>
1.337 ! gutterid 3691: <p>When updating pre-existing patch files, if a file uses the old
! 3692: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
! 3693: convention, it's best not to change it to the new form, as that will
! 3694: just cause churn that makes it harder to track changes to patching
! 3695: over time. Similarly, if a patch now applies at different line offsets,
! 3696: but still applies cleanly as-is, there's no need to update it, as that
! 3697: also unnecessarily complicates the patch history.</p>
1.118 imil 3698: </div>
1.275 brook 3699: <div class="sect2">
3700: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3701: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3702: <p>If you want to share patches between multiple packages
3703: in pkgsrc, e.g. because they use the same distfiles, set
3704: <code class="varname">PATCHDIR</code> to the path where the patch files
3705: can be found, e.g.:</p>
3706: <pre class="programlisting">
3707: PATCHDIR= ../../editors/xemacs/patches
3708: </pre>
3709: <p>Patch files that are distributed by the author or other
3710: maintainers can be listed in
3711: <code class="varname">PATCHFILES</code>.</p>
3712: <p>If it is desired to store any patches that should not be
3713: committed into pkgsrc, they can be kept outside the pkgsrc
3714: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3715: directory tree there is expected to have the same
3716: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3717: patches are expected to be stored inside these dirs (also
3718: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3719: example, if you want to keep a private patch for
3720: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3721: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3722: files in the named directory are expected to be patch files,
3723: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3724: applied</em></span>.</p>
1.275 brook 3725: </div>
3726: <div class="sect2">
3727: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3728: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3729: <p>When fixing a portability issue in the code do not use
3730: preprocessor magic to check for the current operating system nor
3731: platform. Doing so hurts portability to other platforms because
3732: the OS-specific details are not abstracted appropriately.</p>
3733: <p>The general rule to follow is: instead of checking for the
3734: operating system the application is being built on, check for the
3735: specific <span class="emphasis"><em>features</em></span> you need. For example,
3736: instead of assuming that kqueue is available under NetBSD and
3737: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3738: kqueue support, add a check that detects kqueue itself —
3739: yes, this generally involves patching the
3740: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3741: that prevents some OSes from adopting interfaces from other OSes
3742: (e.g. Linux implementing kqueue), something that the above checks
3743: cannot take into account.</p>
3744: <p>Of course, checking for features generally involves more
3745: work on the developer's side, but the resulting changes are
3746: cleaner and there are chances they will work on many other
3747: platforms. Not to mention that there are higher chances of being
3748: later integrated into the mainstream sources. Remember:
3749: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3750: <p>Some typical examples:</p>
3751: <div class="table">
3752: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3753: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3754: <colgroup>
3755: <col>
3756: <col>
3757: <col>
3758: </colgroup>
3759: <thead><tr>
3760: <th>Where</th>
3761: <th>Incorrect</th>
3762: <th>Correct</th>
3763: </tr></thead>
3764: <tbody>
3765: <tr>
3766: <td>configure script</td>
3767: <td>
1.275 brook 3768: <pre class="programlisting">
1.299 rillig 3769: case ${target_os} in
3770: netbsd*) have_kvm=yes ;;
3771: *) have_kvm=no ;;
3772: esac
1.275 brook 3773: </pre>
1.299 rillig 3774: </td>
3775: <td>
1.275 brook 3776: <pre class="programlisting">
1.299 rillig 3777: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275 brook 3778: </pre>
1.299 rillig 3779: </td>
3780: </tr>
3781: <tr>
3782: <td>C source file</td>
3783: <td>
1.91 rillig 3784: <pre class="programlisting">
1.299 rillig 3785: #if defined(__NetBSD__)
3786: # include <sys/event.h>
3787: #endif
1.91 rillig 3788: </pre>
1.299 rillig 3789: </td>
3790: <td>
1.91 rillig 3791: <pre class="programlisting">
1.299 rillig 3792: #if defined(HAVE_SYS_EVENT_H)
3793: # include <sys/event.h>
3794: #endif
1.91 rillig 3795: </pre>
1.299 rillig 3796: </td>
3797: </tr>
3798: <tr>
3799: <td>C source file</td>
3800: <td>
1.91 rillig 3801: <pre class="programlisting">
1.299 rillig 3802: int
3803: monitor_file(...)
3804: {
3805: #if defined(__NetBSD__)
3806: int fd = kqueue();
3807: ...
3808: #else
3809: ...
3810: #endif
3811: }
1.91 rillig 3812: </pre>
1.299 rillig 3813: </td>
3814: <td>
1.91 rillig 3815: <pre class="programlisting">
1.299 rillig 3816: int
3817: monitor_file(...)
3818: {
3819: #if defined(HAVE_KQUEUE)
3820: int fd = kqueue();
3821: ...
3822: #else
3823: ...
3824: #endif
3825: }
1.91 rillig 3826: </pre>
1.299 rillig 3827: </td>
3828: </tr>
3829: </tbody>
3830: </table></div>
3831: </div>
3832: <br class="table-break">
3833: </div>
3834: <div class="sect2">
3835: <div class="titlepage"><div><div><h3 class="title">
3836: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3837: <p>Always, always, <span class="strong"><strong>always</strong></span>
3838: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3839: improvements you do to a package to the mainstream developers.
3840: This is the only way to get their attention on portability issues
3841: and to ensure that future versions can be built out-of-the box on
3842: NetBSD. Furthermore, any user that gets newer distfiles will get
3843: the fixes straight from the packaged code.</p>
3844: <p>This generally involves cleaning up the patches
3845: (because sometimes the patches that are
3846: added to pkgsrc are quick hacks), filing bug reports in the
3847: appropriate trackers for the projects and working with the
3848: mainstream authors to accept your changes. It is
3849: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3850: the packages in pkgsrc are kept simple and thus further changes
3851: can be done without much hassle.</p>
3852: <p>When you have done this, please add a URL to the upstream
3853: bug report to the patch comment.</p>
3854: <p>Support the idea of free software!</p>
3855: </div>
1.91 rillig 3856: </div>
1.299 rillig 3857: <div class="sect1">
3858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3859: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3860: <div class="variablelist"><dl class="variablelist">
3861: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3862: <dd><p>A multi-line description of the piece of software. This should include
3863: any credits where they are due. Please bear in mind that others do not
3864: share your sense of humour (or spelling idiosyncrasies), and that others
3865: will read everything that you write here.</p></dd>
3866: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3867: <dd><p>This file governs the files that are installed on your
3868: system: all the binaries, manual pages, etc. There are other
3869: directives which may be entered in this file, to control the
3870: creation and deletion of directories, and the location of
3871: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3872: information.</p></dd>
3873: </dl></div>
3874: </div>
3875: <div class="sect1">
3876: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3877: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3878: <div class="sect2">
3879: <div class="titlepage"><div><div><h3 class="title">
3880: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3881: <div class="variablelist"><dl class="variablelist">
3882: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3883: <dd>
1.322 leot 3884: <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 3885: First time after package extraction and before files are
3886: moved in place, the second time after the files to install
3887: are moved in place. This can be used to do any custom
3888: procedures not possible with @exec commands in
1.322 leot 3889: <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
3890: <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 3891: Please note that you can modify variables in it easily by using
3892: <code class="varname">FILES_SUBST</code> in the package's
3893: <code class="filename">Makefile</code>:</p>
1.91 rillig 3894: <pre class="programlisting">
1.299 rillig 3895: FILES_SUBST+= SOMEVAR="somevalue"
1.91 rillig 3896: </pre>
1.299 rillig 3897: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3898: <code class="filename">INSTALL</code>. By default, substitution is
3899: performed for <code class="varname">PREFIX</code>,
3900: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3901: <code class="varname">VARBASE</code>, and a few others, type
3902: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3903: complete list.</p>
3904: </dd>
3905: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3906: <dd><p>This script is executed before and after any files are removed. It is
3907: this script's responsibility to clean up any additional messy details
3908: around the package's installation, since all pkg_delete knows is how to
3909: delete the files created in the original distribution.
1.322 leot 3910: 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>
3911: 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 3912: The same methods to replace variables can be used as for
3913: the <code class="filename">INSTALL</code> file.</p></dd>
3914: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3915: <dd>
3916: <p>This file is displayed after installation of the package.
1.312 gdt 3917: While this was used often in the past, it has two
3918: problems: the display will be missed if many packages are
3919: intalled at once, and the person installing the package
3920: and the one using or configuring it may be different. It
3921: should therefore be used only in exceptional circumstances
3922: where lasting negative consequences would result from
3923: someone not reading it.</p>
3924: <p>MESSAGE should not be used for:</p>
3925: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3926: <li class="listitem"><p>exhortations to read the documentation</p></li>
3927: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
3928: <li class="listitem"><p>anything that should be explained in the
3929: installation/configuration documentation that should
3930: come with the package</p></li>
3931: </ul></div>
3932: <p>If the documentation provided by upstream needs
1.313 leot 3933: enhancing, create e.g. files/README.pkgsrc and install it
3934: in the package's documentation directory.
1.312 gdt 3935: </p>
3936: <p>Note that MESSAGE is shown for all operating
3937: systems and all init systems. If a MESSAGE is necessary,
1.313 leot 3938: it should be narrowed to only those operating systems and
1.312 gdt 3939: init systems to which it applies.</p>
3940: <p>Note that you can modify variables in it easily by using
1.299 rillig 3941: <code class="varname">MESSAGE_SUBST</code> in the package's
3942: <code class="filename">Makefile</code>:</p>
1.91 rillig 3943: <pre class="programlisting">
1.299 rillig 3944: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.91 rillig 3945: </pre>
1.299 rillig 3946: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
3947: <code class="filename">MESSAGE</code>. By default, substitution is
3948: performed for <code class="varname">PKGNAME</code>,
3949: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
3950: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3951: <code class="varname">PKG_SYSCONFDIR</code>,
3952: <code class="varname">ROOT_GROUP</code>, and
3953: <code class="varname">ROOT_USER</code>.</p>
3954: <p>You can display a different or additional files by
3955: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3956: default is <code class="filename">MESSAGE</code>, if the file
3957: exists.</p>
3958: </dd>
3959: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
3960: <dd>
3961: <p>This file is used by the alternatives framework.
3962: It creates, configures, and destroys generic wrappers used to
3963: run programs with similar interfaces.
3964: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3965: for more information.</p>
3966: <p>Each line of the file contains two filenames, first
3967: the wrapper and then the alternative provided by the package.
3968: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3969: </dd>
3970: </dl></div>
3971: </div>
3972: <div class="sect2">
3973: <div class="titlepage"><div><div><h3 class="title">
3974: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
3975: <div class="variablelist"><dl class="variablelist">
3976: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3977: <dd><p>This file contains arbitrary things that could
3978: also go into a <code class="filename">Makefile</code>, but its purpose is
3979: to be used by more than one package. This file should only be
3980: used when the packages that will use the file are known in
3981: advance. For other purposes it is often better to write a
3982: <code class="filename">*.mk</code> file and give it a good name that
3983: describes what it does.</p></dd>
3984: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3985: <dd><p>This file contains the dependency information
3986: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
3987: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3988: <dd><p>This file contains workarounds for compiler bugs
3989: and similar things. It is included automatically by the pkgsrc
3990: infrastructure, so you don't need an extra
3991: <code class="literal">.include</code> line for
3992: it.</p></dd>
3993: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3994: <dd><p>This file contains the code for the
3995: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
3996: selected by the user. If a package has only one or two options,
3997: it is equally acceptable to put the code directly into the
3998: <code class="filename">Makefile</code>.</p></dd>
3999: </dl></div>
4000: </div>
4001: <div class="sect2">
4002: <div class="titlepage"><div><div><h3 class="title">
4003: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
4004: <div class="variablelist"><dl class="variablelist">
4005: <dt><span class="term"><code class="filename">README*</code></span></dt>
4006: <dd><p>These files do not take place in the creation of
4007: a package and thus are purely informative to the package
4008: developer.</p></dd>
4009: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4010: <dd><p>This file contains things that need to be done
4011: to make the package even
4012: better.</p></dd>
4013: </dl></div>
4014: </div>
4015: </div>
4016: <div class="sect1">
4017: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4018: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
4019: </h2></div></div></div>
4020: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4021: unpacked into the directory denoted by
4022: <code class="varname">WRKDIR</code>. It can be removed by running
4023: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4024: directory is also used to keep various timestamp files.
4025: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4026: The default is <code class="filename">${.CURDIR}/work</code>
4027: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4028: if <code class="varname">OBJMACHINE</code> is set.</p>
1.91 rillig 4029: </div>
1.299 rillig 4030: <div class="sect1">
4031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4032: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
4033: </h2></div></div></div>
4034: <p>If you have any files that you wish to be placed in the package
4035: prior to configuration or building, you can place these files here
4036: and use a <span class="command"><strong>${CP}</strong></span> command in the
4037: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4038: <p>If you want to share files in this way with other
4039: packages, set the <code class="varname">FILESDIR</code> variable to point
4040: to the other package's <code class="filename">files</code> directory,
4041: e.g.:</p>
1.91 rillig 4042: <pre class="programlisting">
1.299 rillig 4043: FILESDIR= ../../editors/xemacs/files
1.91 rillig 4044: </pre>
4045: </div>
4046: </div>
1.148 asau 4047: <div class="chapter">
1.75 rillig 4048: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 4049: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75 rillig 4050: <div class="toc">
4051: <p><b>Table of Contents</b></p>
1.210 leot 4052: <dl class="toc">
1.299 rillig 4053: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4054: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4055: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4056: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4057: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4058: <dd><dl>
4059: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4060: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4061: </dl></dd>
4062: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4063: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4064: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4065: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4066: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4067: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4068: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4069: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4070: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4071: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4072: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4073: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75 rillig 4074: </dl>
4075: </div>
1.148 asau 4076: <div class="sect1">
1.75 rillig 4077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4078: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4079: <p>This chapter gives a detailed description on how a package is
4080: built. Building a package is separated into different
4081: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4082: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4083: described in the following sections. Each phase is split into
4084: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4085: containing phase, prefixed by one of <code class="varname">pre-</code>,
4086: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4087: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4088: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4089: <p>Never override the regular targets (like
4090: <code class="varname">fetch</code>), if you have to, override the
4091: <code class="varname">do-*</code> ones instead.</p>
4092: <p>The basic steps for building a program are always the same. First
4093: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4094: the local system and then extracted. After any pkgsrc-specific patches
4095: to compile properly are applied, the software can be configured, then
4096: built (usually by compiling), and finally the generated binaries, etc.
4097: can be put into place on the system.</p>
4098: <p>To get more details about what is happening at each step,
4099: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4100: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4101: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4102: </div>
4103: <div class="sect1">
4104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4105: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4106: <p>Before outlining the process performed by the NetBSD package system in
4107: the next section, here's a brief discussion on where programs are
4108: installed, and which variables influence this.</p>
4109: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4110: where all files of the final program shall be installed. It is
4111: usually set to <code class="varname">LOCALBASE</code>
4112: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4113: for pkgs in the <code class="filename">cross</code> category. The value of
4114: <code class="varname">PREFIX</code> needs to be put
4115: into the various places in the program's source where paths to
4116: 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>
4117: <p>When choosing which of these variables to use,
4118: follow the following rules:</p>
1.148 asau 4119: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 4120: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4121: where the current pkg will be installed. When referring to a
4122: pkg's own installation path, use
4123: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
4124: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
4125: are installed. If you need to construct a -I or -L argument
4126: to the compiler to find includes and libraries installed by
4127: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
4128: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4129: installed all packages in <code class="filename">/usr/local</code>. As
4130: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4131: administrator, this variable is a misnomer.</p></li>
4132: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4133: distribution (from xsrc, etc.) is installed. When looking for
4134: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4135: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4136: <li class="listitem"><p>X11-based packages using imake must set
4137: <code class="varname">USE_IMAKE</code> to be installed correctly under
4138: <code class="varname">LOCALBASE</code>.</p></li>
4139: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.322 leot 4140: 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 4141: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4142: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4143: </ul></div>
4144: </div>
4145: <div class="sect1">
4146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4147: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4148: <p>When building a package, various directories are used to store
4149: source files, temporary files, pkgsrc-internal files, and so on. These
4150: directories are explained here.</p>
4151: <p>Some of the directory variables contain relative pathnames. There
4152: are two common base directories for these relative directories:
4153: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4154: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4155: inside the package itself.</p>
4156: <div class="variablelist"><dl class="variablelist">
4157: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4158: <dd><p>This is an absolute pathname that points to the pkgsrc
4159: root directory. Generally, you don't need
4160: it.</p></dd>
4161: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4162: <dd><p>This is an absolute pathname that points to the
4163: current package.</p></dd>
4164: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
4165: <dd><p>This is a pathname relative to
4166: <code class="varname">PKGSRCDIR</code> that points to the current
4167: package.</p></dd>
4168: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4169: <dd><p>This is an absolute pathname pointing to the directory
4170: where all work takes place. The distfiles are extracted to this
4171: directory. It also contains temporary directories and log files used by
4172: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4173: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4174: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4175: <dd><p>This is an absolute pathname pointing to the directory
4176: where the distfiles are extracted. It is usually a direct subdirectory
4177: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4178: that isn't hidden. This variable may be changed by a package
4179: <code class="filename">Makefile</code>.</p></dd>
4180: </dl></div>
4181: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4182: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4183: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4184: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4185: If users would like to have their pkgsrc trees behave in a
4186: read-only manner, then the value of
4187: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4188: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 4189: </div>
1.148 asau 4190: <div class="sect1">
1.75 rillig 4191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4192: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4193: <p>You can run a particular phase by typing <span class="command"><strong>make
4194: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
4195: phase. This will automatically run all phases that are required for this
4196: phase. The default phase is <code class="varname">build</code>, that is, when you
4197: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
4198: the package will be built, but not installed.</p>
1.75 rillig 4199: </div>
1.148 asau 4200: <div class="sect1">
1.75 rillig 4201: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4202: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4203: <p>The first step in building a package is to fetch the
4204: distribution files (distfiles) from the sites that are providing
4205: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4206: phase.</p>
1.148 asau 4207: <div class="sect2">
1.93 rillig 4208: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 4209: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4210: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4211: defines all URLs from where the distfile, whose name is
4212: derived from the <code class="varname">DISTNAME</code> variable, is
4213: fetched. The more complicated cases are described
4214: below.</p>
4215: <p>The variable <code class="varname">DISTFILES</code> specifies
4216: the list of distfiles that have to be fetched. Its value
4217: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4218: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4219: so that most packages don't need to define it at all.
4220: <code class="varname">EXTRACT_SUFX</code> is
4221: <code class="literal">.tar.gz</code> by default, but can be changed
4222: freely. Note that if your package requires additional
4223: distfiles to the default one, you cannot just append the
4224: additional filenames using the <code class="literal">+=</code>
4225: operator, but you have write for example:</p>
4226: <pre class="programlisting">
4227: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4228: </pre>
4229: <p>Each distfile is fetched from a list of sites, usually
4230: <code class="varname">MASTER_SITES</code>. If the package has multiple
4231: <code class="varname">DISTFILES</code> or multiple
4232: <code class="varname">PATCHFILES</code> from different sites, you can
4233: set
4234: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4235: to the list of URLs where the file
4236: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4237: (including the suffix) can be found.</p>
4238: <pre class="programlisting">
4239: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4240: DISTFILES+= foo-file.tar.gz
4241: SITES.foo-file.tar.gz= \
4242: https://www.somewhere.com/somehow/ \
4243: https://www.somewhereelse.com/mirror/somehow/
4244: </pre>
4245: <p>When actually fetching the distfiles, each item from
4246: <code class="varname">MASTER_SITES</code> or
4247: <code class="varname">SITES.*</code> gets the name of each distfile
4248: appended to it, without an intermediate slash. Therefore,
4249: all site values have to end with a slash or other separator
4250: character. This allows for example to set
4251: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4252: that gets the name of the distfile as a parameter. In this
4253: case, the definition would look like:</p>
4254: <pre class="programlisting">
4255: MASTER_SITES= https://www.example.com/download.cgi?file=
4256: </pre>
4257: <p> The exception to this rule are URLs starting with a dash.
4258: In that case the URL is taken as is, fetched and the result
4259: stored under the name of the distfile. You can use this style
4260: for the case when the download URL style does not match the
4261: above common case. For example, if permanent download URL is a
4262: redirector to the real download URL, or the download file name
4263: is offered by an HTTP Content-Disposition header. In the
4264: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4265: created instead of the default
4266: <code class="filename">v1.0.0.tar.gz</code>.</p>
4267: <pre class="programlisting">
4268: DISTNAME= foo-1.0.0
4269: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4270: </pre>
4271: <p>There are some predefined values for
4272: <code class="varname">MASTER_SITES</code>, which can be used in
4273: packages. The names of the variables should speak for
4274: themselves.</p>
4275: <table border="0" summary="Simple list" class="simplelist">
4276: <tr>
4277: <td>MASTER_SITE_APACHE</td>
4278: <td>MASTER_SITE_BACKUP</td>
4279: </tr>
4280: <tr>
4281: <td>MASTER_SITE_CRATESIO</td>
4282: <td>MASTER_SITE_CYGWIN</td>
4283: </tr>
4284: <tr>
4285: <td>MASTER_SITE_DEBIAN</td>
4286: <td>MASTER_SITE_FREEBSD</td>
4287: </tr>
4288: <tr>
4289: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4290: <td>MASTER_SITE_GENTOO</td>
4291: </tr>
4292: <tr>
4293: <td>MASTER_SITE_GITHUB</td>
4294: <td>MASTER_SITE_GNOME</td>
4295: </tr>
4296: <tr>
4297: <td>MASTER_SITE_GNU</td>
4298: <td>MASTER_SITE_GNUSTEP</td>
4299: </tr>
4300: <tr>
4301: <td>MASTER_SITE_HASKELL_HACKAGE</td>
4302: <td>MASTER_SITE_IFARCHIVE</td>
4303: </tr>
4304: <tr>
4305: <td>MASTER_SITE_KDE</td>
4306: <td>MASTER_SITE_MOZILLA</td>
4307: </tr>
4308: <tr>
4309: <td>MASTER_SITE_MOZILLA_ALL</td>
4310: <td>MASTER_SITE_MYSQL</td>
4311: </tr>
4312: <tr>
4313: <td>MASTER_SITE_NETLIB</td>
4314: <td>MASTER_SITE_OPENBSD</td>
4315: </tr>
4316: <tr>
4317: <td>MASTER_SITE_OPENOFFICE</td>
4318: <td>MASTER_SITE_OSDN</td>
4319: </tr>
4320: <tr>
4321: <td>MASTER_SITE_PERL_CPAN</td>
4322: <td>MASTER_SITE_PGSQL</td>
4323: </tr>
4324: <tr>
4325: <td>MASTER_SITE_PYPI</td>
4326: <td>MASTER_SITE_RUBYGEMS</td>
4327: </tr>
4328: <tr>
4329: <td>MASTER_SITE_R_CRAN</td>
4330: <td>MASTER_SITE_SOURCEFORGE</td>
4331: </tr>
1.85 jmmv 4332: <tr>
1.299 rillig 4333: <td>MASTER_SITE_SUNSITE</td>
4334: <td>MASTER_SITE_SUSE</td>
1.85 jmmv 4335: </tr>
4336: <tr>
1.299 rillig 4337: <td>MASTER_SITE_TEX_CTAN</td>
4338: <td>MASTER_SITE_XCONTRIB</td>
1.85 jmmv 4339: </tr>
4340: <tr>
1.299 rillig 4341: <td>MASTER_SITE_XEMACS</td>
4342: <td>MASTER_SITE_XORG</td>
4343: </tr>
4344: </table>
4345: <p>Some explanations for the less self-explaining ones:
4346: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
4347: 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
4348: 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>
4349: <p>If you choose one of these predefined sites, you may
4350: want to specify a subdirectory of that site. Since these
4351: macros may expand to more than one actual site, you
4352: <span class="emphasis"><em>must</em></span> use the following construct to
4353: specify a subdirectory:</p>
1.100 rillig 4354: <pre class="programlisting">
1.299 rillig 4355: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4356: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100 rillig 4357: </pre>
1.299 rillig 4358: <p>Note the trailing slash after the subdirectory
4359: name.</p>
4360: </div>
4361: <div class="sect2">
4362: <div class="titlepage"><div><div><h3 class="title">
4363: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4364: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4365: all the distfiles exist in a local directory
4366: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4367: user). If the files do not exist, they are fetched using
4368: commands of the form</p>
1.100 rillig 4369: <pre class="programlisting">
1.299 rillig 4370: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4371: </pre>
4372: <p>where <code class="literal">${site}</code> varies through
4373: several possibilities in turn: first,
4374: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4375: sites specified in either <code class="varname">SITES.file</code> if
4376: defined, else <code class="varname">MASTER_SITES</code> or
4377: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4378: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4379: all except the first and the last can be optionally sorted
4380: by the user, via setting either
4381: <code class="varname">MASTER_SORT_RANDOM</code>, and
4382: <code class="varname">MASTER_SORT_AWK</code> or
4383: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4384: <p> The specific command and arguments used depend on the
4385: <code class="varname">FETCH_USING</code> parameter. The example above is
4386: for <code class="literal">FETCH_USING=custom</code>.</p>
4387: <p>The distfiles mirror run by the NetBSD Foundation uses the
4388: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4389: distfiles, if they are freely distributable. Packages setting
4390: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4391: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4392: mirrored.</p>
1.85 jmmv 4393: </div>
4394: </div>
1.299 rillig 4395: <div class="sect1">
4396: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4397: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4398: <p>After the distfile(s) are fetched, their checksum is
4399: generated and compared with the checksums stored in the
4400: distinfo file. If the checksums don't match, the build is
4401: aborted. This is to ensure the same distfile is used for
4402: building, and that the distfile wasn't changed, e.g. by some
4403: malign force, deliberately changed distfiles on the master
4404: distribution site or network lossage.</p>
1.75 rillig 4405: </div>
1.148 asau 4406: <div class="sect1">
1.75 rillig 4407: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4408: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4409: <p>When the distfiles are present on the local system, they
4410: need to be extracted, as they usually come in the form of some
4411: compressed archive format.</p>
4412: <p>By default, all <code class="varname">DISTFILES</code> are
4413: extracted. If you only need some of them, you can set the
4414: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4415: files.</p>
4416: <p>Extracting the files is usually done by a little
4417: program, <code class="filename">mk/extract/extract</code>, which
4418: already knows how to extract various archive formats, so most
4419: likely you will not need to change anything here. But if you
4420: need, the following variables may help you:</p>
1.148 asau 4421: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4422: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4423: <dd><p>Use these variables to override the default
4424: options for an extract command, which are defined in
4425: <code class="filename">mk/extract/extract</code>.</p></dd>
4426: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4427: <dd><p>This variable can be set to
4428: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4429: (which is the default value), <code class="literal">pax</code>, or an
4430: absolute pathname pointing to the command with which tar
4431: archives should be extracted. It is preferred to choose bsdtar over gtar
4432: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 4433: </dl></div>
1.299 rillig 4434: <p>If the <code class="filename">extract</code> program doesn't
4435: serve your needs, you can also override the
4436: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4437: command used for extracting the files. This command is
4438: executed in the <code class="filename">${WRKSRC}</code>
4439: directory. During execution of this command, the shell
4440: variable <code class="varname">extract_file</code> holds the absolute
4441: pathname of the file that is going to be extracted.</p>
4442: <p>And if that still does not suffice, you can override the
4443: <code class="varname">do-extract</code> target in the package
4444: Makefile.</p>
1.75 rillig 4445: </div>
1.148 asau 4446: <div class="sect1">
1.75 rillig 4447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4448: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4449: <p>After extraction, all the patches named by the
4450: <code class="varname">PATCHFILES</code>, those present in the patches
4451: subdirectory of the package as well as in
4452: $LOCALPATCHES/$PKGPATH (e.g.
4453: <code class="filename">/usr/local/patches/graphics/png</code>) are
4454: applied. Patchfiles ending in <code class="filename">.Z</code> or
4455: <code class="filename">.gz</code> are uncompressed before they are
4456: applied, files ending in <code class="filename">.orig</code> or
4457: <code class="filename">.rej</code> are ignored. Any special options to
1.322 leot 4458: <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 4459: <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 4460: <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 4461: fail if the expected text from the patch context is not found in the
4462: patched file. If that happens, fix the patch file by comparing it
4463: with the actual text in the file to be patched.</p>
1.78 rillig 4464: </div>
1.148 asau 4465: <div class="sect1">
1.75 rillig 4466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4467: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4468: <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>.
4469: </p>
1.75 rillig 4470: </div>
1.148 asau 4471: <div class="sect1">
1.75 rillig 4472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4473: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4474: <p>This phase creates wrapper programs for the compilers and
4475: linkers. The following variables can be used to tweak the
4476: wrappers.</p>
4477: <div class="variablelist"><dl class="variablelist">
4478: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4479: <dd><p>The command used to print progress
4480: messages. Does nothing by default. Set to
4481: <code class="literal">${ECHO}</code> to see the progress
4482: messages.</p></dd>
4483: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4484: <dd><p>This variable can be set to
4485: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4486: depending on whether you want additional information in the
4487: wrapper log file.</p></dd>
4488: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4489: <dd><p>This variable can be set to
4490: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4491: on whether the wrapper should use its cache, which will
4492: improve the speed. The default value is
4493: <code class="literal">yes</code>, but is forced to
4494: <code class="literal">no</code> if the platform does not support
4495: it.</p></dd>
4496: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4497: <dd><p>A list of reordering commands. A reordering
4498: command has the form
4499: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4500: It ensures that that
4501: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4502: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4503: </p></dd>
4504: </dl></div>
4505: </div>
4506: <div class="sect1">
4507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4508: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4509: <p>Most pieces of software need information on the header
4510: files, system calls, and library routines which are available
4511: on the platform they run on. The process of determining this
4512: information is known as configuration, and is usually
4513: automated. In most cases, a script is supplied with the
4514: distfiles, and its invocation results in generation of header
4515: files, Makefiles, etc.</p>
4516: <p>If the package contains a configure script, this can be
4517: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4518: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4519: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.301 rillig 4520: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4521: <p>In the <code class="literal">do-configure</code> stage, a rough
4522: equivalent of the following command is run. See
4523: <code class="filename">mk/configure/configure.mk</code>, target
4524: <code class="literal">do-configure-script</code> for the exact
4525: definition.</p>
4526: <pre class="programlisting">
4527: .for dir in ${CONFIGURE_DIRS}
4528: cd ${WRKSRC} && cd ${dir} \
4529: && env ${CONFIGURE_ENV} \
4530: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299 rillig 4531: .endfor
1.100 rillig 4532: </pre>
1.299 rillig 4533: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4534: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4535: <code class="varname">WRKSRC</code>. In each of these directories, the
4536: configure script is run with the environment
4537: <code class="varname">CONFIGURE_ENV</code> and arguments
4538: <code class="varname">CONFIGURE_ARGS</code>. The variables
4539: <code class="varname">CONFIGURE_ENV</code>,
4540: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4541: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4542: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4543: package.</p>
4544: <p>If the program uses the Perl way of configuration (mainly Perl
4545: modules, but not only), i.e. a file called
4546: <code class="filename">Makefile.PL</code>, it should include
4547: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4548: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4549: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4550: <p>If the program uses an <code class="filename">Imakefile</code>
4551: for configuration, the appropriate steps can be invoked by
4552: setting <code class="varname">USE_IMAKE</code> to
4553: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4554: You can add variables to xmkmf's environment by adding them to the
4555: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4556: <p>If the program uses <code class="filename">cmake</code>
4557: for configuration, the appropriate steps can be invoked by
4558: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
4559: You can add variables to cmake's environment by adding them to the
4560: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
4561: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
4562: The top directory argument is given by the
4563: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
4564: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
4565: <p>If there is no configure step at all, set
4566: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 4567: </div>
1.148 asau 4568: <div class="sect1">
1.75 rillig 4569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4570: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301 rillig 4571: <p>For building a package, a rough equivalent of the following
4572: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4573: <code class="literal">do-build</code> for the exact definition.</p>
1.97 rillig 4574: <pre class="programlisting">
1.301 rillig 4575: .for dir in ${BUILD_DIRS}
4576: cd ${WRKSRC} && cd ${dir} \
1.299 rillig 4577: && env ${MAKE_ENV} \
1.301 rillig 4578: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299 rillig 4579: -f ${MAKE_FILE} \
4580: ${BUILD_TARGET}
4581: .endfor
1.97 rillig 4582: </pre>
1.299 rillig 4583: <p><code class="varname">BUILD_DIRS</code> (default:
4584: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4585: <code class="varname">WRKSRC</code>. In each of these directories,
4586: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4587: <code class="varname">MAKE_ENV</code> and arguments
4588: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4589: <code class="varname">MAKE_ENV</code>,
4590: <code class="varname">BUILD_MAKE_FLAGS</code>,
4591: <code class="varname">MAKE_FILE</code> and
4592: <code class="varname">BUILD_TARGET</code> may all be changed by the
4593: package.</p>
4594: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4595: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4596: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4597: default value of <code class="varname">MAKE_FILE</code> is
4598: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4599: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4600: <p>If there is no build step at all, set
4601: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.97 rillig 4602: </div>
1.148 asau 4603: <div class="sect1">
1.97 rillig 4604: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4605: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4606: <p>[TODO]</p>
1.75 rillig 4607: </div>
1.148 asau 4608: <div class="sect1">
1.75 rillig 4609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4610: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4611: <p>Once the build stage has completed, the final step is to
4612: install the software in public directories, so users can
4613: access the programs and files.</p>
1.301 rillig 4614: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4615: of the following code is executed; see
4616: <code class="filename">mk/install/install.mk</code>, target
4617: <code class="literal">do-install</code> for the exact definition. Additionally,
4618: before and after this code, several consistency checks are run
4619: against the files-to-be-installed, see
4620: <code class="filename">mk/check/*.mk</code> for details.</p>
4621: <pre class="programlisting">
4622: .for dir in ${INSTALL_DIRS}
4623: cd ${WRKSRC} && cd ${dir} \
4624: && env ${INSTALL_ENV} ${MAKE_ENV} \
4625: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4626: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299 rillig 4627: .endfor
1.220 wiz 4628: </pre>
1.299 rillig 4629: <p>The variable's meanings are analogous to the ones in the
4630: <span class="emphasis"><em>build</em></span> phase.
4631: <code class="varname">INSTALL_DIRS</code> defaults to
4632: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4633: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4634: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4635: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4636: defined.</p>
4637: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4638: variables are useful. They are all variations of the
1.322 leot 4639: <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 4640: permissions preset. <code class="varname">INSTALL</code> is the plain
4641: install command. The specialized variants, together with their
4642: intended use, are:</p>
4643: <div class="variablelist"><dl class="variablelist">
4644: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4645: <dd><p>directories that contain
4646: binaries</p></dd>
4647: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4648: <dd><p>directories that contain
4649: scripts</p></dd>
4650: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4651: <dd><p>directories that contain shared and static
4652: libraries</p></dd>
4653: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4654: <dd><p>directories that contain data
4655: files</p></dd>
4656: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4657: <dd><p>directories that contain man
4658: pages</p></dd>
4659: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4660: <dd><p>directories that contain data files for games
4661: </p></dd>
4662: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4663: <dd><p>binaries that can be stripped from debugging
4664: symbols</p></dd>
4665: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4666: <dd><p>binaries that cannot be
4667: stripped</p></dd>
4668: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4669: <dd><p>game
4670: binaries</p></dd>
4671: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4672: <dd><p>shared and static
4673: libraries</p></dd>
4674: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4675: <dd><p>data files</p></dd>
4676: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4677: <dd><p>data files for
4678: games</p></dd>
4679: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4680: <dd><p>man pages</p></dd>
4681: </dl></div>
4682: <p>Some other variables are:</p>
4683: <div class="variablelist"><dl class="variablelist">
4684: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.322 leot 4685: <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 4686: when installing binaries. Any debugging sections and symbols present in
4687: binaries will be preserved.
4688: </p></dd>
4689: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4690: <dd><p>A list of directories relative to
4691: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4692: beginning of the <span class="emphasis"><em>install</em></span> phase.
4693: The package is supposed to create all needed directories itself
4694: before installing files to it and list all other directories here.
4695: </p></dd>
4696: </dl></div>
4697: <p>In the rare cases that a package shouldn't install anything,
4698: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4699: mostly relevant for packages in the <code class="filename">regress</code>
4700: category.</p>
1.75 rillig 4701: </div>
1.148 asau 4702: <div class="sect1">
1.75 rillig 4703: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4704: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4705: <p>Once the install stage has completed, a binary package of
4706: the installed files can be built. These binary packages can be
4707: used for quick installation without previous compilation, e.g. by
4708: the <span class="command"><strong>make bin-install</strong></span> or by using
4709: <span class="command"><strong>pkg_add</strong></span>.</p>
4710: <p>By default, the binary packages are created in
4711: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4712: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4713: one for each category in the <code class="varname">CATEGORIES</code>
4714: variable. <code class="varname">PACKAGES</code> defaults to
4715: <code class="filename">pkgsrc/packages</code>.</p>
1.75 rillig 4716: </div>
1.148 asau 4717: <div class="sect1">
1.75 rillig 4718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4719: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4720: <p>Once you're finished with a package, you can clean the work
4721: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4722: to clean the work directories of all dependencies too, use
4723: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 4724: </div>
1.148 asau 4725: <div class="sect1">
1.75 rillig 4726: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4727: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148 asau 4728: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4729: <dt><span class="term">pre/post-*</span></dt>
4730: <dd>
4731: <p>For any of the main targets described in the previous
4732: section (configure, build, install, etc.), two auxiliary
4733: targets exist with
4734: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4735: prefix for the main target's name. These targets are
4736: invoked before and after the main target is called,
4737: allowing extra configuration or installation steps be
4738: performed from a package's Makefile, for example, which
4739: a program's configure script or install target
4740: omitted.</p>
4741: <p>About 5% of the pkgsrc packages define their custom
4742: post-extract target, another 5% define pre-configure, and 10%
4743: define post-install. The other pre/post-* targets are defined
4744: even less often.</p>
4745: </dd>
4746: <dt><span class="term">do-*</span></dt>
1.75 rillig 4747: <dd>
1.299 rillig 4748: <p>Should one of the main targets do the wrong thing,
4749: and should there be no variable to fix this, you can
4750: redefine it with the do-* target. (Note that redefining
4751: the target itself instead of the do-* target is a bad
4752: idea, as the pre-* and post-* targets won't be called
4753: anymore, etc.)</p>
4754: <p>About 15% of the pkgsrc packages override the default
4755: do-install, the other do-* targets are overridden even less
4756: often.</p>
1.75 rillig 4757: </dd>
1.299 rillig 4758: <dt><span class="term">reinstall</span></dt>
1.75 rillig 4759: <dd>
1.299 rillig 4760: <p>If you did a <span class="command"><strong>make install</strong></span> and
4761: you noticed some file was not installed properly, you
4762: can repeat the installation with this target, which will
4763: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4764: <p>This is the default value of
4765: <code class="varname">DEPENDS_TARGET</code> except in the case of
4766: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4767: package</strong></span>, where the defaults are
4768: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4769: respectively.</p>
1.75 rillig 4770: </dd>
1.299 rillig 4771: <dt><span class="term">deinstall</span></dt>
4772: <dd>
1.322 leot 4773: <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 4774: current directory, effectively de-installing the
4775: package. The following variables can be used to tune the
4776: behaviour:</p>
4777: <div class="variablelist"><dl class="variablelist">
4778: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.322 leot 4779: <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 4780: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4781: <dd><p>Remove all packages that require (depend on)
4782: the given package. This can be used to remove any
4783: packages that may have been pulled in by a given
4784: package, e.g. if <span class="command"><strong>make deinstall
4785: DEINSTALLDEPENDS=1</strong></span> is done in
4786: <code class="filename">pkgsrc/x11/kde</code>, this is
4787: likely to remove whole KDE. Works by adding
1.322 leot 4788: <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 4789: command line.</p></dd>
4790: </dl></div>
4791: </dd>
4792: <dt><span class="term">bin-install</span></dt>
4793: <dd><p>Install a binary package from local disk and via FTP
4794: from a list of sites (see the
4795: <code class="varname">BINPKG_SITES</code> variable), and do a
4796: <span class="command"><strong>make package</strong></span> if no binary package is
4797: available anywhere. The arguments given to
4798: <span class="command"><strong>pkg_add</strong></span> can be set via
4799: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4800: operation, etc.</p></dd>
4801: <dt><span class="term">install-clean</span></dt>
4802: <dd><p>This target removes the state files for the "install" and later
4803: phases so that the "install" target may be re-invoked. This can be
4804: used after editing the PLIST to install the package without
4805: rebuilding it.</p></dd>
4806: <dt><span class="term">build-clean</span></dt>
4807: <dd><p>This target removes the state files for the "build" and later
4808: phases so that the "build" target may be re-invoked.</p></dd>
4809: <dt><span class="term">update</span></dt>
4810: <dd>
4811: <p>This target causes the current package to be
4812: updated to the latest version. The package and all
4813: depending packages first get de-installed, then current
4814: versions of the corresponding packages get compiled and
4815: installed. This is similar to manually noting which
4816: packages are currently installed, then performing a
4817: series of <span class="command"><strong>make deinstall</strong></span> and
4818: <span class="command"><strong>make install</strong></span> (or whatever
4819: <code class="varname">UPDATE_TARGET</code> is set to) for these
4820: packages.</p>
4821: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4822: resume package updating in case a previous <span class="command"><strong>make
4823: update</strong></span> was interrupted for some reason.
4824: However, in this case, make sure you don't call
4825: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4826: list of dependent packages in <code class="varname">WRKDIR</code>.
4827: Otherwise, you lose the ability to automatically update
4828: the current package along with the dependent packages
4829: you have installed.</p>
4830: <p>Resuming an interrupted <span class="command"><strong>make
4831: update</strong></span> will only work as long as the package
4832: tree remains unchanged. If the source code for one of
4833: the packages to be updated has been changed, resuming
4834: <span class="command"><strong>make update</strong></span> will most certainly
4835: fail!</p>
4836: <p>The following variables can be used either on the
4837: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4838: alter the behaviour of <span class="command"><strong>make
4839: update</strong></span>:</p>
4840: <div class="variablelist"><dl class="variablelist">
4841: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4842: <dd><p>Install target to recursively use for the
4843: updated package and the dependent packages.
4844: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4845: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4846: <span class="command"><strong>make update</strong></span>. Other good
4847: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4848: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4849: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4850: endless loop!</p></dd>
4851: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4852: <dd><p>Don't clean up after updating. Useful if
4853: you want to leave the work sources of the updated
4854: packages around for inspection or other purposes.
4855: Be sure you eventually clean up the source tree
4856: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4857: or you may run into troubles with old source code
4858: still lying around on your next
4859: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4860: update</strong></span>.</p></dd>
4861: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4862: <dd><p>Deinstall each package before installing
4863: (making <code class="varname">DEPENDS_TARGET</code>). This
4864: may be necessary if the
4865: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4866: called after interrupting a running <span class="command"><strong>make
4867: update</strong></span>.</p></dd>
4868: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4869: <dd><p>Allows you to disable recursion and hardcode
4870: the target for packages. The default is
4871: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4872: facilitating a recursive update of prerequisite
4873: packages. Only set
4874: <code class="varname">DEPENDS_TARGET</code> if you want to
4875: disable recursive updates. Use
4876: <code class="varname">UPDATE_TARGET</code> instead to just
4877: set a specific target for each package to be
4878: installed during <span class="command"><strong>make update</strong></span>
4879: (see above).</p></dd>
4880: </dl></div>
4881: </dd>
4882: <dt><span class="term">clean-update</span></dt>
4883: <dd>
4884: <p>Clean the source tree for all packages that would
4885: get updated if <span class="command"><strong>make update</strong></span> was called
4886: from the current directory. This target should not be
4887: used if the current package (or any of its depending
4888: packages) have already been de-installed (e.g., after
4889: calling <span class="command"><strong>make update</strong></span>) or you may lose
4890: some packages you intended to update. As a rule of
4891: thumb: only use this target <span class="emphasis"><em>before</em></span>
4892: the first time you run <span class="command"><strong>make update</strong></span>
4893: and only if you have a dirty package tree (e.g., if you
4894: used <code class="varname">NOCLEAN</code>).</p>
4895: <p>If you are unsure about whether your tree is
4896: clean, you can either perform a <span class="command"><strong>make
4897: clean</strong></span> at the top of the tree, or use the
4898: following sequence of commands from the directory of the
4899: package you want to update (<span class="emphasis"><em>before</em></span>
4900: running <span class="command"><strong>make update</strong></span> for the first
4901: time, otherwise you lose all the packages you wanted to
4902: update!):</p>
4903: <pre class="screen">
4904: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
4905: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
4906: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
4907: </pre>
4908: <p>The following variables can be used either on the
4909: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
4910: <span class="command"><strong>make clean-update</strong></span>:</p>
4911: <div class="variablelist"><dl class="variablelist">
4912: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
4913: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
4914: reconstruct the list of directories to update for
4915: this package. Only use this if <span class="command"><strong>make
4916: update</strong></span> successfully installed all
4917: packages you wanted to update. Normally, this is
4918: done automatically on <span class="command"><strong>make
4919: update</strong></span>, but may have been suppressed by
4920: the <code class="varname">NOCLEAN</code> variable (see
4921: above).</p></dd>
4922: </dl></div>
4923: </dd>
4924: <dt><span class="term">replace</span></dt>
4925: <dd>
4926: <p>Update the installation of the current package. This
4927: differs from update in that it does not replace dependent
1.322 leot 4928: 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 4929: target to work.</p>
4930: <p><span class="emphasis"><em>Be careful when using this
4931: target!</em></span> There are no guarantees that dependent
4932: packages will still work, in particular they will most
4933: certainly break if you <span class="command"><strong>make replace</strong></span> a
4934: library package whose shared library major version changed
4935: between your installed version and the new one. For this
4936: reason, this target is not officially supported and only
4937: recommended for advanced users.</p>
4938: </dd>
4939: <dt><span class="term">info</span></dt>
1.322 leot 4940: <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 4941: package. You can use this to check which version of a
4942: package is installed.</p></dd>
4943: <dt><span class="term">index</span></dt>
4944: <dd>
4945: <p>This is a top-level command, i.e. it should be used in
4946: the <code class="filename">pkgsrc</code> directory. It creates a
4947: database of all packages in the local pkgsrc tree, including
4948: dependencies, comment, maintainer, and some other useful
4949: information. Individual entries are created by running
4950: <span class="command"><strong>make describe</strong></span> in the packages'
4951: directories. This index file is saved as
4952: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
4953: verbose format by running <span class="command"><strong>make
4954: print-index</strong></span>. You can search in it with
4955: <span class="command"><strong>make search
4956: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
4957: extract a list of all packages that depend on a particular
4958: one by running <span class="command"><strong>make show-deps
4959: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
4960: <p>Running this command takes a very long time, some
4961: hours even on fast machines!</p>
4962: </dd>
4963: <dt><span class="term">readme</span></dt>
4964: <dd>
4965: <p>This target generates a
1.314 nia 4966: <code class="filename">index.html</code> file, which can be
1.322 leot 4967: 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 4968: contain references to any packages which are in the
4969: <code class="varname">PACKAGES</code> directory on the local
4970: host. The generated files can be made to refer to URLs
4971: based on <code class="varname">FTP_PKG_URL_HOST</code> and
4972: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314 nia 4973: wanted to generate <code class="filename">index.html</code>
1.299 rillig 4974: files which pointed to binary packages on the local
4975: machine, in the directory
4976: <code class="filename">/usr/packages</code>, set
4977: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
4978: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
4979: <code class="varname">${PACKAGES}</code> directory and its
4980: subdirectories will be searched for all the binary
4981: packages.</p>
4982: <p>The target can be run at the toplevel or in category
4983: directories, in which case it descends recursively.</p>
4984: </dd>
4985: <dt><span class="term">readme-all</span></dt>
4986: <dd><p>This is a top-level command, run it in
4987: <code class="filename">pkgsrc</code>. Use this target to create a
4988: file <code class="filename">README-all.html</code> which contains a
4989: list of all packages currently available in the NetBSD
4990: Packages Collection, together with the category they belong
4991: to and a short description. This file is compiled from the
1.314 nia 4992: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299 rillig 4993: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
4994: readme</strong></span>.</p></dd>
4995: <dt><span class="term">cdrom-readme</span></dt>
4996: <dd><p>This is very much the same as the
4997: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
4998: used when generating a pkgsrc tree to be written to a
4999: CD-ROM. This target also produces
1.314 nia 5000: <code class="filename">index.html</code> files, and can be made
1.299 rillig 5001: to refer to URLs based on
5002: <code class="varname">CDROM_PKG_URL_HOST</code> and
5003: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
5004: <dt><span class="term">show-distfiles</span></dt>
5005: <dd><p>This target shows which distfiles and patchfiles
5006: are needed to build the package
5007: (<code class="varname">ALLFILES</code>, which contains all
5008: <code class="varname">DISTFILES</code> and
5009: <code class="varname">PATCHFILES</code>, but not
5010: <code class="filename">patches/*</code>).</p></dd>
5011: <dt><span class="term">show-downlevel</span></dt>
5012: <dd><p>This target shows nothing if the package is not
5013: installed. If a version of this package is installed,
5014: but is not the version provided in this version of
5015: pkgsrc, then a warning message is displayed. This target
5016: can be used to show which of your installed packages are
5017: downlevel, and so the old versions can be deleted, and
5018: the current ones added.</p></dd>
5019: <dt><span class="term">show-pkgsrc-dir</span></dt>
5020: <dd><p>This target shows the directory in the pkgsrc
5021: hierarchy from which the package can be built and
5022: installed. This may not be the same directory as the one
5023: from which the package was installed. This target is
5024: intended to be used by people who may wish to upgrade
5025: many packages on a single host, and can be invoked from
5026: the top-level pkgsrc Makefile by using the
5027: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
5028: <dt><span class="term">show-installed-depends</span></dt>
5029: <dd><p>This target shows which installed packages match
5030: the current package's <code class="varname">DEPENDS</code>. Useful
5031: if out of date dependencies are causing build
5032: problems.</p></dd>
5033: <dt><span class="term">print-build-depends-list</span></dt>
5034: <dd><p>This target shows the list of packages that the current package
5035: depends on for building.</p></dd>
5036: <dt><span class="term">print-run-depends-list</span></dt>
5037: <dd><p>This target shows the list of packages that the current package
5038: depends on for running.</p></dd>
5039: <dt><span class="term">check-shlibs</span></dt>
5040: <dd><p>After a package is installed, check all its
5041: binaries and (on ELF platforms) shared libraries to see
5042: if they find the shared libs they need. Run by default
5043: 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>
5044: <dt><span class="term">print-PLIST</span></dt>
5045: <dd>
5046: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5047: upgraded pkg, this prints out an attempt to generate a
5048: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5049: -newer work/.extract_done</strong></span>. An attempt is made
5050: to care for shared libs etc., but it is
5051: <span class="emphasis"><em>strongly</em></span> recommended to review the
5052: result before putting it into
5053: <code class="filename">PLIST</code>. On upgrades, it's useful to
5054: diff the output of this command against an already
5055: existing <code class="filename">PLIST</code> file.</p>
1.322 leot 5056: <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 5057: other methods that don't update file access times, be
5058: sure to add these files manually to your
5059: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5060: -newer</span>”</span> command used by this target won't catch
5061: them!</p>
5062: <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
5063: information on this target.</p>
5064: </dd>
5065: </dl></div>
5066: </div>
5067: </div>
5068: <div class="chapter">
5069: <div class="titlepage"><div><div><h2 class="title">
5070: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5071: <div class="toc">
5072: <p><b>Table of Contents</b></p>
5073: <dl class="toc">
5074: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5075: <dd><dl>
1.334 nia 5076: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
5077: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
5078: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.299 rillig 5079: </dl></dd>
5080: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5081: <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>
5082: </dl>
5083: </div>
5084: <p>When you find a package that is not yet in pkgsrc, you
5085: most likely have a URL from where you can download the source
5086: code. Starting with this URL, creating a package involves only a
5087: few steps.</p>
5088: <div class="procedure"><ol class="procedure" type="1">
5089: <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
5090: enable the basic quality checks.</p></li>
5091: <li class="step">
1.322 leot 5092: <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 5093: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5094: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5095: <span class="command"><strong>mkpatches</strong></span>:</p>
5096: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5097: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5098: </li>
5099: <li class="step">
5100: <p>Choose one of the top-level directories as the category in
5101: which you want to place your package. You can also create a directory of
1.334 nia 5102: your own (maybe called <code class="filename">local</code>). Change into that
5103: category directory:</p>
5104: <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 5105: </li>
5106: <li class="step">
1.334 nia 5107: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
5108: argument the URL of the distribution file (in most cases a
5109: <code class="filename">.tar.gz</code> file). This will download the distribution
5110: file and create the necessary files of the package, based on what's in
5111: the distribution file:</p>
1.299 rillig 5112: <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>
5113: </li>
5114: <li class="step">
5115: <p>Examine the extracted files to determine the dependencies of
5116: your package. Ideally, this is mentioned in some
5117: <code class="filename">README</code> file, but things may differ. For each of
5118: these dependencies, look where it exists in pkgsrc, and if there is a
5119: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5120: line to your package <code class="filename">Makefile</code> which includes that
5121: file just before the last line. If the
5122: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5123: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5124: that the package's include files and libraries are provided.</p>
1.334 nia 5125: <p>If you just need binaries from a dependent package, add a
1.299 rillig 5126: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5127: version of the dependency and where it can be found in pkgsrc. This line
5128: should be placed in the third paragraph. If the dependency is only
5129: needed for building the package, but not when using it, use
5130: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5131: instead of <code class="varname">DEPENDS</code>.
5132: The difference between <code class="varname">TOOL_DEPENDS</code> and
5133: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5134: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.334 nia 5135: packages, i.e. packages for the platform where the package is built;
1.299 rillig 5136: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.334 nia 5137: packages, i.e. packages for the platform for which the package
5138: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
5139: specifies a dependency used only for testing the resulting package
5140: built, using the upstream project's included test suite, on the native
5141: platform.
1.299 rillig 5142: Your package may then look like this:</p>
5143: <pre class="programlisting">
5144: [...]
5145:
5146: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5147: DEPENDS+= screen-[0-9]*:../../misc/screen
5148: DEPENDS+= screen>=4.0:../../misc/screen
5149:
5150: [...]
5151:
5152: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5153: .include "../../devel/glib2/buildlink3.mk"
5154: .include "../../mk/bsd.pkg.mk"
5155: </pre>
5156: </li>
5157: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5158: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5159: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5160: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5161: additional explanations.</p></li>
5162: <li class="step"><p>In many cases the package is not yet ready to build. You can
5163: 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
5164: over there, you can hopefully continue here.</p></li>
5165: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5166: directory from the extracted files. Besides these files, a lot of cache
1.334 nia 5167: files and other system information have been saved in the working
5168: directory, which may have become outdated after you edited the
1.299 rillig 5169: <code class="filename">Makefile</code>.</p></li>
5170: <li class="step">
5171: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5172: 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 5173: <p>If the extracted files from the package need to be fixed, run
5174: multiple rounds of these commands:</p>
5175: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.299 rillig 5176: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5177: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.334 nia 5178: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
5179: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.299 rillig 5180: </li>
5181: <li class="step"><p>When the package builds fine, the next step is to install
5182: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5183: everything works.</p></li>
5184: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5185: contains a list of the files that are installed by the package, is
5186: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5187: >PLIST</strong></span> to generate a probably correct list. Check
5188: the file using your preferred text editor to see if the list of
5189: files looks plausible.</p></li>
5190: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5191: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5192: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5193: had been registered in the database of installed files, but with an
5194: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5195: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5196: registered with the list of files from
5197: <code class="filename">PLIST</code>.</p></li>
5198: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5199: from above again in a single step, making sure that the PLIST is correct
5200: and the whole package is created as intended.</p></li>
1.334 nia 5201: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
5202: left to do.</p></li>
1.299 rillig 5203: <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>
5204: </ol></div>
5205: <div class="sect1">
5206: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5207: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5208: <div class="sect2">
5209: <div class="titlepage"><div><div><h3 class="title">
1.334 nia 5210: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.299 rillig 5211: <p>Python modules and programs packages are easily created using a
5212: set of predefined variables.</p>
5213: <p>
5214: If some Python versions are not supported by the software, set the
5215: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5216: that are not supported, e.g.
5217: </p>
5218: <pre class="programlisting">
5219: PYTHON_VERSIONS_INCOMPATIBLE= 27
5220: </pre>
5221: <p>
5222: If the packaged software is a Python module, include one of
1.330 wiz 5223: <code class="filename">../../lang/python/egg.mk</code> or
1.299 rillig 5224: <code class="filename">../../lang/python/extension.mk</code>.</p>
1.330 wiz 5225: <p>Most Python packages use setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
1.299 rillig 5226: If the packaged software is using setuptools, you only need
5227: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
1.330 wiz 5228: </p>
1.299 rillig 5229: <p>Either way, the package directory should be called
5230: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5231: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5232: </p>
5233: <pre class="programlisting">
5234: DISTNAME= foopymodule-1.2.10
5235: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5236: </pre>
5237: <p>If it is an application, include
5238: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5239: In order to correctly set the path to the Python interpreter, use the
5240: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5241: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5242: For example:
5243: </p>
5244: <pre class="programlisting">
5245: REPLACE_PYTHON= *.py
5246: </pre>
5247: <p>Some Python modules have separate distributions for Python-2.x
5248: and Python-3.x support. In pkgsrc this is handled by the
5249: <code class="filename">versioned_dependencies.mk</code> file. Set
5250: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
5251: packages that should be depended upon and include
5252: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
5253: then the pkgsrc infrastructure will depend on the appropriate package
5254: version. For example:
5255: </p>
5256: <pre class="programlisting">
5257: PYTHON_VERSIONED_DEPENDENCIES=dialog
5258: </pre>
5259: <p>
5260: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
5261: of supported packages.</p>
5262: </div>
5263: <div class="sect2">
5264: <div class="titlepage"><div><div><h3 class="title">
1.334 nia 5265: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.299 rillig 5266: <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>
5267: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.322 leot 5268: 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 5269: Individual packages (and optionally their dependencies) may be created
5270: and updated. R packages generally follow the same form, and most of
5271: the relevant information needed is contained in a
5272: <code class="filename">DESCRIPTION</code> file as part of each R package on
5273: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5274: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5275: creates or updates a package in the canonical form. The resulting
5276: package should be reviewed for correctness.</p>
5277: </div>
5278: <div class="sect2">
5279: <div class="titlepage"><div><div><h3 class="title">
1.334 nia 5280: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.299 rillig 5281: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.322 leot 5282: <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 5283: <p>If the TeXlive package name is not known, it may be useful to
5284: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5285: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5286: 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
5287: archive</a>.</p>
5288: <p>If the TeXlive package name is known, download the files from
5289: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5290: archive</a>. For package <code class="filename">foo</code>, you will need
5291: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5292: also have associated documentation packages, so download
5293: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5294: should be placed in the appropriate category directory, which is often
5295: but not always <code class="filename">print</code>. Then run the following
5296: command in the category directory.</p>
5297: <pre class="programlisting">
5298: texlive2pkg foo.tar.xz foo.doc.tar.xz
5299: </pre>
5300: <p>This will create two packages, <code class="filename">tex-foo</code> and
5301: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5302: are correct.</p>
5303: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5304: currently does not include version information in package filenames
5305: and changes their contents periodically when updates occur.
5306: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5307: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5308: main one and the corresponding documentation, upload the distfiles
5309: with the following command in each package directory.</p>
5310: <pre class="programlisting">
5311: make upload-distfiles
5312: </pre>
5313: </div>
5314: </div>
5315: <div class="sect1">
5316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5317: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5318: <div class="sect2">
5319: <div class="titlepage"><div><div><h3 class="title">
5320: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5321: <div class="sect3">
5322: <div class="titlepage"><div><div><h4 class="title">
5323: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5324: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5325: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5326: pkgsrc. As the description says it has to do with the web, the obvious
5327: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5328: <pre class="programlisting">
5329: <code class="prompt">$</code> mkdir www/nvu
5330: <code class="prompt">$</code> cd www/nvu
5331: </pre>
5332: <p>The web site says that the sources are available as a tar file, so
5333: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5334: <pre class="programlisting">
5335: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5336: </pre>
5337: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5338: below the <code class="varname">DISTNAME</code> line, as the package name should
5339: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5340: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5341: <code class="varname">COMMENT</code> fields. Then the package
5342: <code class="filename">Makefile</code> looked like that:</p>
5343: <pre class="programlisting">
5344: # $NetBSD $
5345: #
5346:
5347: DISTNAME= nvu-1.0-sources
5348: PKGNAME= nvu-1.0
5349: CATEGORIES= www
5350: MASTER_SITES= http://cvs.nvu.com/download/
5351: EXTRACT_SUFX= .tar.bz2
5352:
5353: MAINTAINER= rillig@NetBSD.org
5354: HOMEPAGE= http://cvs.nvu.com/
5355: COMMENT= Web Authoring System
5356:
5357: # url2pkg-marker (please do not remove this line.)
5358: .include "../../mk/bsd.pkg.mk"
5359: </pre>
5360: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5361: this is a workaround to prevent CVS expanding to the filename of the
5362: guide.</p>
5363: <p>Then, I quit the editor and watched pkgsrc downloading a large
5364: source archive:</p>
5365: <pre class="programlisting">
5366: url2pkg> Running "make makesum" ...
5367: => Required installed package digest>=20010302: digest-20060826 found
5368: => Fetching nvu-1.0-sources.tar.bz2
5369: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5370: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5371: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5372: url2pkg> Running "make extract" ...
5373: => Required installed package digest>=20010302: digest-20060826 found
5374: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5375: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5376: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5377: ===> Installing dependencies for nvu-1.0
5378: ===> Overriding tools for nvu-1.0
5379: ===> Extracting for nvu-1.0
5380: url2pkg> Adjusting the Makefile.
5381:
5382: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5383:
5384: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5385: </pre>
5386: </div>
5387: <div class="sect3">
5388: <div class="titlepage"><div><div><h4 class="title">
5389: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5390: <p>Now that the package has been extracted, let's see what's inside
5391: it. The package has a <code class="filename">README.txt</code>, but that only
5392: says something about mozilla, so it's probably useless for seeing what
5393: dependencies this package has. But since there is a GNU configure script
5394: in the package, let's hope that it will complain about everything it
5395: needs.</p>
5396: <pre class="programlisting">
5397: <code class="prompt">$</code> bmake
5398: => Required installed package digest>=20010302: digest-20060826 found
5399: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5400: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5401: ===> Patching for nvu-1.0
5402: ===> Creating toolchain wrappers for nvu-1.0
5403: ===> Configuring for nvu-1.0
5404: [...]
5405: configure: error: Perl 5.004 or higher is required.
5406: [...]
5407: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5408: [...]
5409: </pre>
5410: <p>That worked quite well. So I opened the package Makefile in my
5411: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5412: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5413: package have changed now, and since a perl wrapper is automatically
5414: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5415: from scratch.</p>
5416: <pre class="programlisting">
5417: <code class="prompt">$</code> bmake clean
5418: ===> Cleaning for nvu-1.0
5419: <code class="prompt">$</code> bmake
5420: [...]
5421: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5422: GNU Make. You will not be able to build Mozilla without GNU Make.
5423: [...]
5424: </pre>
5425: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5426: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5427: <pre class="programlisting">
5428: [...]
5429: checking for GTK - version >= 1.2.0... no
5430: *** Could not run GTK test program, checking why...
5431: [...]
5432: </pre>
5433: <p>Now to the other dependencies. The first question is: Where is the
5434: GTK package hidden in pkgsrc?</p>
5435: <pre class="programlisting">
5436: <code class="prompt">$</code> echo ../../*/gtk*
5437: [many packages ...]
5438: <code class="prompt">$</code> echo ../../*/gtk
5439: ../../x11/gtk
5440: <code class="prompt">$</code> echo ../../*/gtk2
5441: ../../x11/gtk2
5442: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5443: ../../x11/gtk2/buildlink3.mk
5444: </pre>
5445: <p>The first try was definitely too broad. The second one had exactly
5446: one result, which is very good. But there is one pitfall with GNOME
5447: packages. Before GNOME 2 had been released, there were already many
5448: GNOME 1 packages in pkgsrc. To be able to continue to use these
5449: packages, the GNOME 2 packages were imported as separate packages, and
5450: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5451: whether this was the case here, and indeed it was.</p>
5452: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5453: file, adding the dependency is very easy. I just inserted an
5454: <code class="literal">.include</code> line before the last line of the package
5455: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5456: <pre class="programlisting">
5457: [...]
5458: .include "../../x11/gtk2/buildlink3.mk"
5459: .include "../../mk/bsd.pkg.mk
5460: </pre>
5461: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5462: was:</p>
1.75 rillig 5463: <pre class="programlisting">
1.299 rillig 5464: [...]
5465: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5466: checking for GTK - version >= 1.2.0... no
5467: *** Could not run GTK test program, checking why...
5468: *** The test program failed to compile or link. See the file config.log for the
5469: *** exact error that occured. This usually means GTK was incorrectly installed
5470: *** or that you have moved GTK since it was installed. In the latter case, you
5471: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5472: configure: error: Test for GTK failed.
5473: [...]
1.222 sevan 5474: </pre>
1.299 rillig 5475: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5476: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5477: told me that this package really wanted to have the GNOME 1 version of
5478: GTK. If the package had looked for GTK2, it would have looked for
5479: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5480: So I changed the <code class="literal">x11/gtk2</code> to
5481: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5482: and tried again.</p>
1.119 mishka 5483: <pre class="programlisting">
1.299 rillig 5484: [...]
5485: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5486: In file included from xpidl.c:42:
5487: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5488: In file included from xpidl.c:42:
5489: xpidl.h:132: error: parse error before "IDL_ns"
5490: [...]
1.222 sevan 5491: </pre>
1.299 rillig 5492: <p>The package still does not find all of its dependencies. Now the
5493: question is: Which package provides the
5494: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119 mishka 5495: <pre class="programlisting">
1.299 rillig 5496: <code class="prompt">$</code> echo ../../*/*idl*
5497: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5498: <code class="prompt">$</code> echo ../../*/*IDL*
5499: ../../net/libIDL
1.222 sevan 5500: </pre>
1.299 rillig 5501: <p>Let's take the one from the second try. So I included the
5502: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5503: again. But the error didn't change. After digging through some of the
5504: code, I concluded that the build process of the package was broken and
5505: couldn't have ever worked, but since the Mozilla source tree is quite
5506: large, I didn't want to fix it. So I added the following to the package
5507: <code class="filename">Makefile</code> and tried again:</p>
1.197 wiz 5508: <pre class="programlisting">
1.299 rillig 5509: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5510: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.222 sevan 5511: </pre>
1.299 rillig 5512: <p>The latter line is needed because the package expects the library
5513: <code class="filename">libIDL.so</code>, but only
5514: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5515: wrapper to rewrite that on the fly.</p>
5516: <p>The next problem was related to a recent change of the FreeType
1.322 leot 5517: 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 5518: which patch files were relevant for this issue and copied them to the
5519: <code class="filename">patches</code> directory. Then I retried, fixed the
5520: patches so that they applied cleanly and retried again. This time,
5521: everything worked.</p>
1.197 wiz 5522: </div>
1.299 rillig 5523: <div class="sect3">
5524: <div class="titlepage"><div><div><h4 class="title">
5525: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87 wiz 5526: <pre class="programlisting">
1.299 rillig 5527: <code class="prompt">$</code> bmake CHECK_FILES=no install
5528: [...]
5529: <code class="prompt">$</code> bmake print-PLIST >PLIST
5530: <code class="prompt">$</code> bmake deinstall
5531: <code class="prompt">$</code> bmake install
1.222 sevan 5532: </pre>
1.299 rillig 5533: </div>
5534: </div>
1.75 rillig 5535: </div>
5536: </div>
1.148 asau 5537: <div class="chapter">
1.75 rillig 5538: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 5539: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 5540: <div class="toc">
5541: <p><b>Table of Contents</b></p>
1.210 leot 5542: <dl class="toc">
1.299 rillig 5543: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5544: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5545: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5546: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5547: <dd><dl>
5548: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5549: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5550: <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>
5551: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.75 rillig 5552: </dl></dd>
5553: </dl>
5554: </div>
1.299 rillig 5555: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5556: each of which forms a well-defined part of the pkgsrc system. Using
1.322 leot 5557: 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 5558: like pkgsrc requires some discipline to keep the code correct and
5559: understandable.</p>
5560: <p>The basic ingredients for <code class="filename">Makefile</code>
5561: programming are variables and shell
5562: commands. Among these shell commands may even be more complex ones
1.322 leot 5563: 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 5564: as intended it is necessary to quote all variables correctly when they
5565: are used.</p>
5566: <p>This chapter describes some patterns that appear quite often in
5567: <code class="filename">Makefile</code>s, including the pitfalls that come along
5568: with them.</p>
1.148 asau 5569: <div class="sect1">
1.75 rillig 5570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5571: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5572: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5573: <p>When you are creating a file as a
5574: target of a rule, always write the data to a temporary file first
5575: and finally rename that file. Otherwise there might occur an error
5576: in the middle of generating the file, and when the user runs
1.322 leot 5577: <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 5578: regenerated properly. Example:</p>
1.75 rillig 5579: <pre class="programlisting">
1.299 rillig 5580: wrong:
5581: @echo "line 1" > ${.TARGET}
5582: @echo "line 2" >> ${.TARGET}
5583: @false
5584:
5585: correct:
5586: @echo "line 1" > ${.TARGET}.tmp
5587: @echo "line 2" >> ${.TARGET}.tmp
5588: @false
5589: @mv ${.TARGET}.tmp ${.TARGET}
1.100 rillig 5590: </pre>
1.299 rillig 5591: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5592: <code class="filename">wrong</code> will exist, although there was an error
5593: message in the first run. On the other hand, running <span class="command"><strong>make
5594: correct</strong></span> gives an error message twice, as expected.</p>
1.322 leot 5595: <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 5596: <code class="literal">${.TARGET}</code> in case of error, but this only
5597: happens when it is interrupted, for example by pressing
5598: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.322 leot 5599: 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 5600: </li></ul></div>
5601: </div>
5602: <div class="sect1">
5603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5604: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5605: <p><code class="filename">Makefile</code> variables contain strings that
5606: can be processed using the five operators <code class="code">=</code>,
5607: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.322 leot 5608: <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 5609: page.</p>
5610: <p>When a variable's value is parsed from a
5611: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5612: the backslash character <code class="code">\</code> are handled specially. If a
5613: backslash is the last character in a line, that backslash is removed
5614: from the line and the line continues with the next line of the file.</p>
5615: <p>The <code class="code">#</code> character starts a comment that reaches
5616: until the end of the line. To get an actual <code class="code">#</code> character,
5617: such as in a URL, write <code class="code">\#</code> instead.</p>
5618: <p>The evaluation of variables either happens immediately or lazy.
5619: It happens immediately when the variable occurs on the right-hand
5620: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5621: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5622: In the other cases, it is evaluated lazily.</p>
5623: <p>Some of the modifiers split the string into words and then
5624: operate on the words, others operate on the string as a whole. When a
5625: string is split into words, double quotes and single quotes are
1.322 leot 5626: 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 5627: <div class="sect2">
5628: <div class="titlepage"><div><div><h3 class="title">
5629: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5630: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5631: <li class="listitem"><p>All variable names starting with an underscore
5632: are reserved for use by the pkgsrc infrastructure. They shall
5633: not be used by packages.</p></li>
5634: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5635: lowercase variable names for the iteration
5636: variables.</p></li>
5637: <li class="listitem"><p>All list variables should have a plural name,
5638: such as <code class="varname">PKG_OPTIONS</code> or
5639: <code class="varname">DISTFILES</code>.</p></li>
5640: </ul></div>
5641: </div>
5642: </div>
5643: <div class="sect1">
5644: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5645: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5646: <div class="sect2">
5647: <div class="titlepage"><div><div><h3 class="title">
5648: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5649: <p>When adding a string that possibly contains whitespace or quotes to
5650: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5651: modifier.</p>
5652: <p>When adding another list to a list (example 2), it must not be
5653: quoted, since its elements are already quoted.</p>
1.75 rillig 5654: <pre class="programlisting">
1.299 rillig 5655: STRING= foo * bar `date`
5656: LIST= # empty
5657: ANOTHER_LIST= a=b c=d
5658:
5659: LIST+= ${STRING:Q} # 1
5660: LIST+= ${ANOTHER_LIST} # 2
1.100 rillig 5661: </pre>
1.299 rillig 5662: </div>
5663: <div class="sect2">
5664: <div class="titlepage"><div><div><h3 class="title">
5665: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5666: <p>Echoing a string containing special characters needs special
5667: work.</p>
1.75 rillig 5668: <pre class="programlisting">
1.299 rillig 5669: STRING= foo bar < > * `date` $$HOME ' "
5670: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5671:
5672: all:
5673: echo ${STRING} # 1
5674: echo ${STRING:Q} # 2
5675: printf '%s\n' ${STRING:Q}'' # 3
5676: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.100 rillig 5677: </pre>
1.299 rillig 5678: <p>Example 1 leads to a syntax error in the shell, as the characters
5679: are just copied.</p>
5680: <p>Example 2 quotes the string so that the shell interprets it
5681: correctly. But the echo command may additionally interpret strings with a
5682: leading dash or those containing backslashes.</p>
1.322 leot 5683: <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 5684: interprets the format string, but not the next argument. The trailing
5685: single quotes handle the case when the string is empty. In that case, the
5686: :Q modifier would result in an empty string too, which would then be
1.322 leot 5687: 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 5688: but other programs may care.</p>
5689: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5690: need to be quoted because the quoting has already been done
5691: when adding elements to the list.</p>
1.75 rillig 5692: </div>
1.148 asau 5693: <div class="sect2">
1.75 rillig 5694: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 5695: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5696: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5697: GNU-style configure script (especially those that call other configure
5698: scripts), it must not have leading or trailing whitespace, since
5699: otherwise the configure script gets confused. To trim leading and
5700: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5701: following example:</p>
1.75 rillig 5702: <pre class="programlisting">
1.299 rillig 5703: CPPFLAGS= # empty
5704: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5705: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 grant 5706:
1.299 rillig 5707: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 grant 5708:
1.299 rillig 5709: all:
5710: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5711: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5712: </pre>
5713: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5714: trailing whitespace because the <code class="code">+=</code> operator always adds a
5715: space.</p>
5716: </div>
5717: <div class="sect2">
5718: <div class="titlepage"><div><div><h3 class="title">
5719: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5720: <p>When a possibly empty variable is used in a shell program, it may
5721: lead to a syntax error.</p>
5722: <pre class="programlisting">
5723: EGFILES= # empty
1.87 wiz 5724:
1.299 rillig 5725: install-examples: # produces a syntax error in the shell
5726: for egfile in ${EGFILES}; do \
5727: echo "Installing $$egfile"; \
5728: done
5729: </pre>
5730: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.322 leot 5731: <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 5732: To fix this syntax error, use one of the snippets below.</p>
5733: <pre class="programlisting">
5734: EMPTY= # empty
1.87 wiz 5735:
1.299 rillig 5736: install-examples:
5737: for egfile in ${EGFILES} ""; do \
5738: [ -n "$$egfile" ] || continue; \
5739: echo "Installing $$egfile"; \
5740: done
5741: </pre>
5742: <p>In this case, an empty string is appended to the iteration list (to
5743: prevent the syntax error) and filtered out later.</p>
5744: <pre class="programlisting">
5745: EGFILES= # empty
1.87 wiz 5746:
1.299 rillig 5747: install-examples:
5748: .for egfile in ${EGFILES}
5749: echo "Installing ${egfile}"
5750: .endfor
1.100 rillig 5751: </pre>
1.299 rillig 5752: <p>If one of the filenames contains special characters, it should be
5753: enclosed in single or double quotes.</p>
5754: <p>To have a shell command test whether a make variable is empty, use
5755: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5756: </div>
5757: </div>
5758: </div>
5759: <div class="chapter">
5760: <div class="titlepage"><div><div><h2 class="title">
5761: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5762: <div class="toc">
5763: <p><b>Table of Contents</b></p>
5764: <dl class="toc">
5765: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5766: <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>
5767: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5768: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5769: </dl>
1.75 rillig 5770: </div>
1.299 rillig 5771: <p>Many packages have the ability to be built to support different
5772: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5773: in pkgsrc that provides generic handling of those options that
5774: determine different ways in which the packages can be built. It's
5775: possible for the user to specify exactly which sets of options will be
5776: built into a package or to allow a set of global default options
5777: apply.</p>
5778: <p>There are two broad classes of behaviors that one might want to
5779: control via options. One is whether some particular feature is
5780: enabled in a program that will be built anyway, often by including or
5781: not including a dependency on some other package. The other is
5782: whether or not an additional program will be built as part of the
5783: package. Generally, it is better to make a split package for such
5784: additional programs instead of using options, because it enables
5785: binary packages to be built which can then be added separately. For
5786: example, the foo package might have minimal dependencies (those
5787: packages without which foo doesn't make sense), and then the foo-gfoo
5788: package might include the GTK frontend program gfoo. This is better
5789: than including a gtk option to foo that adds gfoo, because either that
5790: option is default, in which case binary users can't get foo without
5791: gfoo, or not default, in which case they can't get gfoo. With split
5792: packages, they can install foo without having GTK, and later decide to
5793: install gfoo (pulling in GTK at that time). This is an advantage to
5794: source users too, avoiding the need for rebuilds.</p>
5795: <p>Plugins with widely varying dependencies should usually be split
5796: instead of options.</p>
5797: <p>It is often more work to maintain split packages, especially if
5798: the upstream package does not support this. The decision of split
5799: vs. option should be made based on the likelihood that users will want
5800: or object to the various pieces, the size of the dependencies that are
5801: included, and the amount of work.</p>
5802: <p>A further consideration is licensing. Non-free parts, or parts
5803: that depend on non-free dependencies (especially plugins) should
5804: almost always be split if feasible.</p>
5805: <div class="sect1">
5806: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5807: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5808: <p>Global default options are listed in
5809: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5810: that should be built into every package if that option is supported.
5811: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 5812: </div>
1.148 asau 5813: <div class="sect1">
1.75 rillig 5814: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5815: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5816: </h2></div></div></div>
5817: <p>The following example shows how
5818: <code class="filename">bsd.options.mk</code> should be used
5819: by the hypothetical ``wibble'' package, either in the package
5820: <code class="filename">Makefile</code>, or in a file,
5821: e.g. <code class="filename">options.mk</code>, that is included by the
5822: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 5823: <pre class="programlisting">
1.299 rillig 5824: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5825: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5826: PKG_OPTIONS_OPTIONAL_GROUPS= database
5827: PKG_OPTIONS_GROUP.database= mysql pgsql
5828: PKG_SUGGESTED_OPTIONS= wibble-foo
5829: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5830: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5831:
5832: .include "../../mk/bsd.prefs.mk"
5833:
5834: # this package was previously named wibble2
5835: .if defined(PKG_OPTIONS.wibble2)
5836: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5837: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5838: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5839: .endif
5840:
5841: .include "../../mk/bsd.options.mk"
5842:
5843: # Package-specific option-handling
1.100 rillig 5844:
1.299 rillig 5845: ###
5846: ### FOO support
5847: ###
5848: .if !empty(PKG_OPTIONS:Mwibble-foo)
5849: CONFIGURE_ARGS+= --enable-foo
5850: .endif
1.100 rillig 5851:
1.299 rillig 5852: ###
5853: ### LDAP support
5854: ###
5855: .if !empty(PKG_OPTIONS:Mldap)
5856: . include "../../databases/openldap-client/buildlink3.mk"
5857: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5858: .endif
1.100 rillig 5859:
1.299 rillig 5860: ###
5861: ### database support
5862: ###
5863: .if !empty(PKG_OPTIONS:Mmysql)
5864: . include "../../mk/mysql.buildlink3.mk"
5865: .endif
5866: .if !empty(PKG_OPTIONS:Mpgsql)
5867: . include "../../mk/pgsql.buildlink3.mk"
5868: .endif
5869: </pre>
5870: <p>The first section contains the information about which build
5871: options are supported by the package, and any default options settings
5872: if needed.</p>
5873: <div class="orderedlist"><ol class="orderedlist" type="1">
5874: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.322 leot 5875: <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 5876: options. It should be set to
5877: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5878: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5879: at the point where the options are processed.</p></li>
5880: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
5881: build options supported by the package.</p></li>
5882: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
5883: list of names of groups of mutually exclusive options. The options in
5884: each group are listed in
5885: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5886: The most specific setting of any option from the group takes
5887: precedence over all other options in the group. Options from the
5888: groups will be automatically added to
5889: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
5890: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
5891: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5892: packages will fail if no option from the group is
5893: selected.</p></li>
5894: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
5895: of names of sets of options. At least one option from each set must
5896: be selected. The options in each set are listed in
5897: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5898: Options from the sets will be automatically added to
5899: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5900: fail if no option from the set is selected.</p></li>
5901: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
5902: build options which are enabled by default.</p></li>
5903: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
5904: of
5905: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
5906: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
5907: their option counterparts. Pairs should be added with
5908: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
5909: warning will be issued if the user uses a legacy
5910: variable.</p></li>
5911: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
5912: of
5913: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
5914: pairs that map options that have been renamed to their new
5915: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
5916: the listing of global legacy options. A warning will be issued if
5917: the user uses a legacy option.</p></li>
5918: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
5919: options implied by deprecated variables used. This can be used for
5920: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5921: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5922: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
5923: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
5924: a list of warnings about deprecated variables or options used, and
5925: what to use instead.</p></li>
5926: </ol></div>
5927: <p>A package should never modify
5928: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5929: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5930: To suggest a default set of options, use
5931: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5932: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5933: including <code class="filename">bsd.options.mk</code>. If none of
5934: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5935: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5936: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5937: happen with platform-specific options if none of them is supported on
5938: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5939: empty list and the package is otherwise treated as not using the
5940: options framework.</p>
5941: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5942: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5943: build options, properly filtered to remove unsupported and duplicate
5944: options.</p>
5945: <p>The remaining sections contain the logic that is specific to
5946: each option. The correct way to check for an option is to check
5947: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5948: <pre class="programlisting">
5949: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100 rillig 5950: </pre>
1.75 rillig 5951: </div>
1.299 rillig 5952: <div class="sect1">
5953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5954: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
5955: <p>Options that enable similar features in different packages (like
5956: optional support for a library) should use a common name in all
5957: packages that support it (like the name of the library). If another
5958: package already has an option with the same meaning, use the same
5959: name.</p>
5960: <p>Options that enable features specific to one package, where it's
5961: unlikely that another (unrelated) package has the same (or a similar)
5962: optional feature, should use a name prefixed with
5963: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5964: <p>If a group of related packages share an optional feature
5965: specific to that group, prefix it with the name of the
5966: <span class="quote">“<span class="quote">main</span>”</span> package
5967: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5968: <p>For new options, add a line to
5969: <code class="filename">mk/defaults/options.description</code>. Lines have two
5970: fields, separated by tab. The first field is the option name, the
5971: second its description. The description should be a whole sentence
5972: (starting with an uppercase letter and ending with a period) that
5973: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5974: support.</span>”</span> The file is sorted by option names.</p>
5975: </div>
5976: <div class="sect1">
5977: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5978: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
5979: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
5980: different dependencies based on the options with which the package was
5981: built. For querying these options, the file
5982: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5983: typical example looks like this:</p>
1.87 wiz 5984: <pre class="programlisting">
1.299 rillig 5985: pkgbase := libpurple
5986: .include "../../mk/pkg-build-options.mk"
5987:
5988: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5989: ...
5990: .endif
1.229 sevan 5991: </pre>
1.299 rillig 5992: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5993: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5994: options of the libpurple package, which can then be queried like
5995: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5996: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5997: details.</p>
1.75 rillig 5998: </div>
5999: </div>
1.148 asau 6000: <div class="chapter">
1.75 rillig 6001: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 6002: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 6003: <div class="toc">
6004: <p><b>Table of Contents</b></p>
1.210 leot 6005: <dl class="toc">
1.299 rillig 6006: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
6007: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
6008: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75 rillig 6009: </dl>
6010: </div>
1.299 rillig 6011: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6012: by pkgsrc and also for individual packages to define what commands
6013: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6014: or for later run-time of an installed packaged (such as
6015: <code class="varname">DEPENDS</code>).
6016: If the native system provides an adequate tool, then in many cases, a pkgsrc
6017: package will not be used.</p>
6018: <p>When building a package, the replacement tools are
6019: made available in a directory (as symlinks or wrapper scripts)
6020: that is early in the executable search path. Just like the buildlink
6021: system, this helps with consistent builds.</p>
6022: <p>A tool may be needed to help build a specific package. For example,
6023: perl, GNU make (gmake) or yacc may be needed.</p>
6024: <p>Also a tool may be needed, for example, because the native system's supplied
6025: tool may be inefficient for building a package with pkgsrc.
6026: For example, a package may need GNU awk, bison (instead of
6027: yacc) or a better sed.</p>
6028: <p>The tools used by a package can be listed by running
6029: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 6030: <div class="sect1">
1.75 rillig 6031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6032: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6033: <p>The default set of tools used by pkgsrc is defined in
6034: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6035: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6036: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6037: These can be seen by running:
6038: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6039: <p>If a package needs a specific program to build
6040: then the <code class="varname">USE_TOOLS</code> variable can be used
6041: to define the tools needed.</p>
1.75 rillig 6042: </div>
1.299 rillig 6043: <div class="sect1">
6044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6045: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6046: <p>In the following examples, the :run means that it is needed at
6047: run-time (and becomes a DEPENDS).
6048: The default is a build dependency which can be set with
6049: :build. (So in this example, it is the same as gmake:build
6050: and pkg-config:build.)</p>
1.75 rillig 6051: <pre class="programlisting">
1.299 rillig 6052: USE_TOOLS+= gmake perl:run pkg-config
1.1 grant 6053: </pre>
1.299 rillig 6054: <p>When using the tools framework, a
6055: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6056: which contains the full path to the appropriate tool. For example,
6057: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6058: on Linux systems.</p>
6059: <p>If you always need a pkgsrc version of the
6060: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6061: </p>
1.75 rillig 6062: </div>
1.299 rillig 6063: <div class="sect1">
6064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6065: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6066: <p>When improving or porting pkgsrc to a new platform, have a look
6067: at (or create) the corresponding platform specific make file fragment under
6068: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6069: the name of the common tools. For example:</p>
1.75 rillig 6070: <pre class="programlisting">
1.299 rillig 6071: .if exists(/usr/bin/bzcat)
6072: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6073: .elif exists(/usr/bin/bzip2)
6074: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6075: .endif
6076:
6077: TOOLS_PLATFORM.true?= true # shell builtin
1.1 grant 6078: </pre>
1.75 rillig 6079: </div>
6080: </div>
1.299 rillig 6081: <div class="chapter">
6082: <div class="titlepage"><div><div><h2 class="title">
6083: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6084: <div class="toc">
6085: <p><b>Table of Contents</b></p>
6086: <dl class="toc">
6087: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6088: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6089: <dd><dl>
6090: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6091: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6092: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6093: and
6094: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6095: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6096: </dl></dd>
6097: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
6098: <dd><dl>
6099: <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>
6100: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
6101: </dl></dd>
6102: </dl>
1.75 rillig 6103: </div>
1.299 rillig 6104: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6105: are seen by a package's configure and build processes. This is implemented
6106: in a two step process:</p>
6107: <div class="orderedlist"><ol class="orderedlist" type="1">
6108: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6109: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6110: of <code class="varname">WRKDIR</code>.</p></li>
6111: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6112: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6113: <code class="option">-L${LOCALBASE}/lib</code> into references to
6114: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6115: native compiler on some operating systems look like GCC, so that
6116: packages that expect GCC won't require modifications to build with
6117: those native compilers.</p></li>
6118: </ol></div>
6119: <p>This normalizes the environment in which a package is built so that the
6120: package may be built consistently despite what other software may be
6121: installed. Please note that the normal system header and library paths,
6122: e.g. <code class="filename">/usr/include</code>,
6123: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6124: designed to insulate the package build from non-system-supplied
6125: software.</p>
1.148 asau 6126: <div class="sect1">
1.75 rillig 6127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6128: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6129: <p>The process of converting packages to use the buildlink3
6130: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6131: The things to keep in mind are:</p>
1.128 wiz 6132: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299 rillig 6133: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6134: instead of the actual toolchain. Some packages are tricky,
6135: and the only way to know for sure is the check
6136: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6137: wrappers are being invoked.</p></li>
6138: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6139: the package Makefile, e.g. Java VMs, standalone shells,
6140: etc., because the code to symlink files into
6141: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6142: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6143: </p></li>
6144: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6145: <code class="filename">buildlink3.mk</code> files that you list in a
6146: package's Makefile are added as dependencies for that package.
6147: </p></li>
6148: </ol></div>
6149: <p>If a dependency on a particular package is required for its libraries and
6150: headers, then we replace:</p>
6151: <pre class="programlisting">
6152: DEPENDS+= foo>=1.1.0:../../category/foo
6153: </pre>
6154: <p>with</p>
6155: <pre class="programlisting">
6156: .include "../../category/foo/buildlink3.mk"
6157: </pre>
6158: <p>The buildlink3.mk files usually define the required dependencies.
6159: If you need a newer version of the dependency when using buildlink3.mk
6160: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 6161: <pre class="programlisting">
1.299 rillig 6162: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6163: .include "../../category/foo/buildlink3.mk"
1.1 grant 6164: </pre>
1.299 rillig 6165: <p>There are several <code class="filename">buildlink3.mk</code>
6166: files in <code class="filename">pkgsrc/mk</code>
6167: that handle special package issues:</p>
6168: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6169: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6170: the native or a pkgsrc Berkeley DB implementation based on
6171: the values of <code class="varname">BDB_ACCEPTED</code> and
6172: <code class="varname">BDB_DEFAULT</code>.</p></li>
6173: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6174: comes with neither Curses nor NCurses, this will take care
1.322 leot 6175: 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 6176: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6177: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6178: adding a dependency on Heimdal or MIT-krb5 for packages that
6179: require a Kerberos 5 implementation.</p></li>
6180: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6181: system-provided Motif installation or adds a dependency on
1.322 leot 6182: <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 6183: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6184: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6185: to choose which Motif version will be used.</p></li>
6186: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6187: system-provided GNU readline or editline (libedit) installation,
1.322 leot 6188: 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>,
6189: <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 6190: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6191: If your package really needs GNU readline library, its Makefile
6192: should include <code class="filename">devel/readline/buildlink3.mk</code>
6193: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6194: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6195: variables that may be used by packages that use the
6196: Open Sound System (OSS) API.</p></li>
6197: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6198: any of the Postgres versions in the variable
6199: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6200: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6201: the file for more information.</p></li>
6202: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6203: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.322 leot 6204: 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 6205: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6206: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6207: library.</p></li>
6208: </ul></div>
6209: <p>The comments in those <code class="filename">buildlink3.mk</code>
6210: files provide a more complete
6211: description of how to use them properly.</p>
1.75 rillig 6212: </div>
1.148 asau 6213: <div class="sect1">
1.75 rillig 6214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6215: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6216: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6217: included by Makefiles to indicate the need to compile and link
6218: against header files and libraries provided by the package. A
6219: <code class="filename">buildlink3.mk</code> file should always provide
6220: enough information to add the correct type of dependency
6221: relationship and include any other
6222: <code class="filename">buildlink3.mk</code> files that it needs to find
6223: headers and libraries that it needs in turn.</p>
6224: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.322 leot 6225: 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 6226: package is highly recommended. For most packages, the following
6227: command will generate a good starting point for
6228: <code class="filename">buildlink3.mk</code> files:</p>
6229: <pre class="screen">
6230: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6231: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6232: </pre>
1.148 asau 6233: <div class="sect2">
1.75 rillig 6234: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6235: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6236: <p>The following real-life example
6237: <code class="filename">buildlink3.mk</code> is taken
6238: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 6239: <pre class="programlisting">
1.299 rillig 6240: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
6241:
6242: BUILDLINK_TREE+= tiff
6243:
6244: .if !defined(TIFF_BUILDLINK3_MK)
6245: TIFF_BUILDLINK3_MK:=
6246:
6247: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6248: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6249: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6250:
6251: .include "../../devel/zlib/buildlink3.mk"
6252: .include "../../graphics/jpeg/buildlink3.mk"
6253: .endif # TIFF_BUILDLINK3_MK
6254:
6255: BUILDLINK_TREE+= -tiff
1.1 grant 6256: </pre>
1.299 rillig 6257: <p>The header and footer manipulate
6258: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6259: <code class="filename">buildlink3.mk</code> files and is used to track
6260: the dependency tree.</p>
6261: <p>The main section is protected from multiple inclusion
6262: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6263: added. Several important variables are set in the section:</p>
6264: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6265: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6266: is the dependency version recorded in the installed
1.299 rillig 6267: package; this should always be set using
6268: <span class="command"><strong>+=</strong></span> to ensure that
6269: we're appending to any pre-existing list of values. This
1.300 wiz 6270: variable should be set to the last version of the
1.299 rillig 6271: package that had an backwards-incompatible API change.
6272: </p></li>
6273: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6274: is the location of the <em class="replaceable"><code>pkg</code></em>
6275: pkgsrc directory.</p></li>
6276: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6277: (not shown above) controls whether we use
6278: <code class="varname">BUILD_DEPENDS</code> or
6279: <code class="varname">DEPENDS</code> to add the dependency on
6280: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6281: selected by setting
6282: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6283: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
6284: used.</p></li>
6285: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6286: and
6287: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6288: (not shown above) are lists of subdirectories of
6289: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6290: to add to the header and library search paths. These
6291: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6292: respectively.</p></li>
6293: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6294: (not shown above) is the list of preprocessor flags to add
6295: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6296: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6297: should be avoided and instead be handled using
6298: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6299: above.</p></li>
6300: </ul></div>
6301: <p>The following variables are all optionally defined within
6302: this second section (protected against multiple inclusion) and
6303: control which package files are symlinked into
6304: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6305: transformed during the symlinking:</p>
6306: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6307: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6308: (not shown above) is a shell glob pattern relative to
6309: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6310: to be symlinked into
6311: <code class="filename">${BUILDLINK_DIR}</code>,
6312: e.g. <code class="filename">include/*.h</code>.</p></li>
6313: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6314: (not shown above) is a shell pipeline that
6315: outputs to stdout a list of files relative to
6316: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6317: The resulting files are to be symlinked
6318: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6319: this takes the <code class="filename">+CONTENTS</code> of a
6320: <em class="replaceable"><code>pkg</code></em> and filters it through
6321: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6322: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6323: (not shown above) is a filter command that filters
6324: <code class="filename">+CONTENTS</code> input into a list of files
6325: relative to
6326: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6327: on stdout. By default,
6328: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6329: outputs the contents of the <code class="filename">include</code>
6330: and <code class="filename">lib</code> directories in the package
6331: <code class="filename">+CONTENTS</code>.</p></li>
6332: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6333: (not shown above) is a list of sed arguments used to
6334: transform the name of the source filename into a
6335: destination filename, e.g. <span class="command"><strong>-e
6336: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6337: </ul></div>
6338: <p>This section can additionally include any
6339: <code class="filename">buildlink3.mk</code> needed for
6340: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6341: Including these <code class="filename">buildlink3.mk</code> files
6342: means that the headers and libraries for these
6343: dependencies are also symlinked into
6344: <code class="filename">${BUILDLINK_DIR}</code>
6345: whenever the <em class="replaceable"><code>pkg</code></em>
6346: <code class="filename">buildlink3.mk</code>
6347: file is included. Dependencies are only added for directly
6348: include <code class="filename">buildlink3.mk</code> files.</p>
6349: <p>When providing a <code class="filename">buildlink3.mk</code> and
6350: including other <code class="filename">buildlink3.mk</code> files in it,
6351: please only add necessary ones, i.e., those whose libraries or
6352: header files are automatically exposed when the package is
6353: use.</p>
6354: <p>In particular, if only an executable
6355: (<code class="filename">bin/foo</code>) is linked against a library, that
6356: library does not need to be propagated in the
6357: <code class="filename">buildlink3.mk</code> file.</p>
6358: <p>The following steps should help you decide if a
6359: <code class="filename">buildlink3.mk</code> file needs to be included:
6360: </p>
6361: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6362: <li class="listitem"><p>Look at the installed header files: What
6363: headers do they include? The packages providing these files
6364: must be buildlinked.</p></li>
6365: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6366: libraries and look against what other libraries they link.
6367: Some of the packages providing these probably need to be
6368: buildlinked; however, it's not automatic, since e.g. GTK on
6369: some systems pulls in the X libraries, so they will show up in
6370: the <code class="filename">ldd</code> output, while on others (like OS
6371: X) it won't. <code class="filename">ldd</code> output can thus only be
6372: used as a hint.</p></li>
6373: </ul></div>
6374: <p>
6375: </p>
6376: </div>
1.148 asau 6377: <div class="sect2">
1.75 rillig 6378: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6379: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6380: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6381: and
6382: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6383: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300 wiz 6384: <p>Both variables set lower bounds for a version of this package.
6385: The two variables differ in that one describes source
1.299 rillig 6386: compatibility (API) and the other binary compatibility (ABI).
6387: The difference is that a change in the API breaks compilation of
6388: programs while changes in the ABI stop compiled programs from
6389: running.</p>
1.300 wiz 6390: <p>The
6391: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6392: variable in a <code class="filename">buildlink3.mk</code> should be
6393: changed very rarely. (One possible scenario: If all packages
6394: using this package need a higher version than defined in the
6395: <code class="filename">buildlink3.mk</code>,
1.299 rillig 6396: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6397: could be updated to that higher version.)</p>
6398: <p>On the other hand, changes to
1.299 rillig 6399: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6400: are more common. The variable will need to be updated every
6401: time the major version of one of its shared libraries is changed,
6402: or any other change where a binary built against the previous
6403: version of the package will not run against the new version any
6404: longer.</p>
6405: <p>In such a case, the package's
1.299 rillig 6406: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6407: must be increased to require the new package version. Then the
6408: <code class="varname">PKGREVISION</code> of all packages
6409: <em class="replaceable"><code>foo</code></em> that depend on this package need
6410: to be increased, and if they have
6411: <code class="filename">buildlink3.mk</code> files,
6412: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6413: in their <code class="filename">buildlink3.mk</code> files must be
6414: increased to the new version as well. This is required so that a
6415: package will pull in the versions of the packages that use the
6416: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6417: uniquely identify the packages built against the new ABI. The
1.322 leot 6418: <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 6419: help with these updates.</p>
6420: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6421: about dependencies on other packages, including the
6422: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299 rillig 6423: <p>Please take careful consideration before adjusting
6424: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6425: or
6426: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6427: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6428: cause unneeded package deletions and rebuilds. In many cases,
6429: new versions of packages work just fine with older
6430: dependencies.</p>
1.326 gutterid 6431: <p>Also, it is not needed to set
1.299 rillig 6432: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6433: when it is identical to
1.326 gutterid 6434: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
6435: <p>Note there is also the distinction that users are able to disable
6436: enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
6437: variable, but there is no equivalent option for API dependencies.</p>
1.75 rillig 6438: </div>
6439: </div>
1.148 asau 6440: <div class="sect1">
1.75 rillig 6441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6442: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6443: <p>Some packages in pkgsrc install headers and libraries that
6444: coincide with headers and libraries present in the base system.
6445: Aside from a <code class="filename">buildlink3.mk</code> file, these
6446: packages should also include a <code class="filename">builtin.mk</code>
6447: file that includes the necessary checks to decide whether using
6448: the built-in software or the pkgsrc software is
6449: appropriate.</p>
6450: <p>The only requirements of a builtin.mk file for
6451: <em class="replaceable"><code>pkg</code></em> are:</p>
6452: <div class="orderedlist"><ol class="orderedlist" type="1">
6453: <li class="listitem"><p>It should set
6454: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6455: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6456: after it is included.</p></li>
6457: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6458: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6459: which is already set before the
6460: <code class="filename">builtin.mk</code> file is included.</p></li>
6461: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6462: is <span class="emphasis"><em>very</em></span> important and takes careful
6463: attention to <code class="filename">Makefile</code> coding.</p></li>
6464: </ol></div>
6465: <div class="sect2">
6466: <div class="titlepage"><div><div><h3 class="title">
6467: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6468: <p>The following is the recommended template for builtin.mk
6469: files:</p>
1.75 rillig 6470: <pre class="programlisting">
1.299 rillig 6471: .if !defined(IS_BUILTIN.foo)
6472: #
6473: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6474: # genuinely exists in the system or not.
6475: #
6476: IS_BUILTIN.foo?= no
1.100 rillig 6477:
1.299 rillig 6478: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6479: # version can be determined.
6480: #
6481: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6482: BUILTIN_PKG.foo?= foo-1.0
6483: . endif
6484: .endif # IS_BUILTIN.foo
1.100 rillig 6485:
1.299 rillig 6486: .if !defined(USE_BUILTIN.foo)
6487: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6488: . if defined(BUILTIN_PKG.foo)
6489: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6490: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6491: USE_BUILTIN.foo!= \
6492: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6493: && ${ECHO} "yes" || ${ECHO} "no"
6494: . endif
6495: . endfor
6496: . endif
6497: .endif # USE_BUILTIN.foo
1.100 rillig 6498:
1.299 rillig 6499: CHECK_BUILTIN.foo?= no
6500: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6501: #
6502: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6503: # "yes" or "no".
6504: #
6505: .endif # CHECK_BUILTIN.foo
1.75 rillig 6506: </pre>
1.299 rillig 6507: <p>The first section sets
6508: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6509: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6510: in the base system. This should not be a base system software
6511: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6512: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6513: included as part of the base system. This variable is only
6514: used internally within the <code class="filename">builtin.mk</code>
6515: file.</p>
6516: <p>The second section sets
6517: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6518: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6519: system if it exists (if
6520: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6521: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6522: within the <code class="filename">builtin.mk</code> file.</p>
6523: <p>The third section sets
6524: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6525: and is <span class="emphasis"><em>required</em></span> in all
6526: <code class="filename">builtin.mk</code> files. The code in this
6527: section must make the determination whether the built-in
6528: software is adequate to satisfy the dependencies listed in
6529: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6530: This is typically done by comparing
6531: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6532: against each of the dependencies in
6533: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6534: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6535: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6536: end of the <code class="filename">builtin.mk</code> file. Note that
6537: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6538: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6539: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6540: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6541: that the built-in version of the software is similar enough to
6542: be used as a replacement.</p>
6543: <p>The last section is guarded by
6544: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6545: and includes code that uses the value of
6546: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6547: set in the previous section. This typically includes, e.g.,
6548: adding additional dependency restrictions and listing additional
6549: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6550: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6551: </div>
6552: <div class="sect2">
6553: <div class="titlepage"><div><div><h3 class="title">
6554: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
6555: <p>When building packages, it's possible to choose whether to set
6556: a global preference for using either the built-in (native)
6557: version or the pkgsrc version of software to satisfy a
6558: dependency. This is controlled by setting
6559: <code class="varname">PREFER_PKGSRC</code> and
6560: <code class="varname">PREFER_NATIVE</code>. These variables take values
6561: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
6562: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
6563: use the pkgsrc versions of software, while
6564: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
6565: built-in versions. Preferences are determined by the most
6566: specific instance of the package in either
6567: <code class="varname">PREFER_PKGSRC</code> or
6568: <code class="varname">PREFER_NATIVE</code>. If a package is specified
6569: in neither or in both variables, then
6570: <code class="varname">PREFER_PKGSRC</code> has precedence over
6571: <code class="varname">PREFER_NATIVE</code>. For example, to require
6572: using pkgsrc versions of software for all but the most basic
6573: bits on a NetBSD system, you can set:</p>
1.75 rillig 6574: <pre class="programlisting">
1.299 rillig 6575: PREFER_PKGSRC= yes
6576: PREFER_NATIVE= getopt skey tcp_wrappers
6577: </pre>
6578: <p>A package <span class="emphasis"><em>must</em></span> have a
6579: <code class="filename">builtin.mk</code>
6580: file to be listed in <code class="varname">PREFER_NATIVE</code>,
6581: otherwise it is simply ignored in that list.</p>
1.305 bacon 6582: <p><code class="varname">PREFER_PKGSRC</code> and
6583: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
6584: to ensure that the bootstrap process does not use inapropriate
6585: native tools as dependencies for core packages.
6586:
6587: </p>
6588: <pre class="screen">
6589: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
6590: </pre>
6591: <p>
6592:
1.299 rillig 6593: Switching between settings globally at a later date can introduce
6594: complications with dependency resolution. This is caused by packages
1.305 bacon 6595: built with the opposite preference being installed alongside each
6596: other. Hence, any changes to these variables after bootstrap will
6597: necessitate rebuilding all packages depending on one whose preference
6598: has been changed. This is not trivial and should be avoided.</p>
6599: <p>When using pkgsrc on Linux systems, there is high risk of
6600: "leakage", where programs installed by pkgsrc may inadvertently use a
6601: command or library not installed by pkgsrc, e.g. those installed by
6602: yum or apt. Such foreign dependencies may be installed, removed, or
6603: upgraded to a version incompatible with the pkgsrc package at any
6604: time, causing pkgsrc packages to subsequently malfunction. Pkgsrc
6605: cannot prevent this, as it has no control over other package managers.
6606: Another potential problem is that under Redhat Enterprise and related
6607: Linux systems, yum packages are only patched and never upgraded, so
6608: eventually they may become too outdated for use by pkgsrc. Even
6609: intentionally using foreign dependencies, not considered leakage, can
6610: lead to these problems, so it is generally discouraged. In order to
6611: minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
6612: This ensures that pkgsrc is aware of any changes to dependency packages
6613: and can rebuild or upgrade the entire dependency tree as needed. This
6614: default can be overridden by setting --prefer-pkgsrc to "no" or a list of
6615: packages, or by setting --prefer-native to "yes".</p>
1.75 rillig 6616: </div>
1.107 rillig 6617: </div>
1.75 rillig 6618: </div>
1.148 asau 6619: <div class="chapter">
1.75 rillig 6620: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 6621: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75 rillig 6622: <div class="toc">
6623: <p><b>Table of Contents</b></p>
1.210 leot 6624: <dl class="toc">
1.299 rillig 6625: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6626: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6627: <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>
6628: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6629: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6630: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6631: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6632: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6633: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75 rillig 6634: </dl>
6635: </div>
1.299 rillig 6636: <p>The <code class="filename">PLIST</code> file contains a package's
6637: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6638: the package (relative to the <code class="filename">${PREFIX}</code>
6639: directory it's been installed in) plus some additional statements
1.322 leot 6640: - 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 6641: This chapter addresses some issues that need attention when
6642: dealing with the <code class="filename">PLIST</code> file (or files, see
6643: below!).</p>
1.148 asau 6644: <div class="sect1">
1.75 rillig 6645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6646: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6647: <p>Be sure to add a RCS ID line as the first thing in any
6648: <code class="filename">PLIST</code> file you write:</p>
6649: <pre class="programlisting">
6650: @comment $NetBSD $
6651: </pre>
6652: <p>An artificial space has been added between NetBSD and $, this is a
6653: workaround here to prevent CVS expanding to the filename of the guide. When
6654: adding the RCS ID the space should be omitted.</p>
1.75 rillig 6655: </div>
1.148 asau 6656: <div class="sect1">
1.75 rillig 6657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6658: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6659: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6660: to output a PLIST that matches any new files since the package
6661: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6662: more information on this target.</p>
1.75 rillig 6663: </div>
1.148 asau 6664: <div class="sect1">
1.75 rillig 6665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6666: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6667: </h2></div></div></div>
6668: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6669: of AWK patterns and actions that are used to filter the output of
6670: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6671: scripting you like to it, but be careful with quoting.</p>
6672: <p>For example, to get all files inside the
6673: <code class="filename">libdata/foo</code> directory removed from the
6674: resulting PLIST:</p>
1.88 wiz 6675: <pre class="programlisting">
1.299 rillig 6676: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.100 rillig 6677: </pre>
1.300 wiz 6678: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6679: evaluated after the file list and directory list are sorted.
6680: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6681: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6682: list and directory list are sorted.</p>
1.299 rillig 6683: </div>
6684: <div class="sect1">
6685: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6686: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6687: <p>A number of variables are substituted automatically in
6688: PLISTs when a package is installed on a system. This includes the
6689: following variables:</p>
6690: <div class="variablelist"><dl class="variablelist">
6691: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6692: <dd>
6693: <p>Some packages like emacs and perl embed information
6694: about which architecture they were built on into the
6695: pathnames where they install their files. To handle this
6696: case, PLIST will be preprocessed before actually used, and
6697: the symbol
6698: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6699: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6700: same is done if the string
6701: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6702: PLIST somewhere - use this on packages that have GNU
6703: autoconf-created configure scripts.</p>
6704: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6705: <h3 class="title">Legacy note</h3>
6706: <p>There used to be a symbol
6707: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6708: was replaced by the output of <span class="command"><strong>uname
6709: -m</strong></span>, but that's no longer supported and has
6710: been removed.</p>
6711: </div>
6712: </dd>
6713: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6714: <dd>
6715: <p>Some packages want to embed the OS name and version
6716: into some paths. To do this, use these variables in the
6717: <code class="filename">PLIST</code>:
6718: </p>
6719: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6720: <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>
6721: <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>
6722: <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>
6723: </ul></div>
6724: </dd>
6725: </dl></div>
6726: <p>For a list of values which are replaced by
6727: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6728: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6729: <code class="varname">PLIST_SUBST</code> should help.</p>
6730: <p>If you want to change other variables not listed above, you
6731: can add variables and their expansions to this variable in the
6732: 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 6733: <pre class="programlisting">
1.299 rillig 6734: PLIST_SUBST+= SOMEVAR="somevalue"
1.100 rillig 6735: </pre>
1.299 rillig 6736: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6737: in the <code class="filename">PLIST</code> with
6738: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6739: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6740: the common case of conditionally including some
6741: <code class="filename">PLIST</code> entries. It can be done by adding
6742: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6743: setting the corresponding <code class="varname">PLIST.foo</code> variable
6744: to <code class="literal">yes</code> if the entry should be included.
6745: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6746: in the <code class="filename">PLIST</code> with either
6747: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6748: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6749: For example, in <code class="filename">Makefile</code>:</p>
1.174 asau 6750: <pre class="programlisting">
1.299 rillig 6751: PLIST_VARS+= foo
6752: .if <em class="replaceable"><code>condition</code></em>
6753: PLIST.foo= yes
6754: .else
1.174 asau 6755: </pre>
1.299 rillig 6756: <p>And then in <code class="filename">PLIST</code>:</p>
1.81 rillig 6757: <pre class="programlisting">
1.299 rillig 6758: @comment $NetBSD $
6759: bin/bar
6760: man/man1/bar.1
6761: ${PLIST.foo}bin/foo
6762: ${PLIST.foo}man/man1/foo.1
6763: ${PLIST.foo}share/bar/foo.data
1.100 rillig 6764: </pre>
1.299 rillig 6765: <p>An artificial space has been added between NetBSD and $, this is a
6766: workaround here to prevent CVS expanding to the filename of the guide. When
1.309 gutterid 6767: adding the RCS ID the space should be omitted.</p>
1.81 rillig 6768: </div>
1.299 rillig 6769: <div class="sect1">
6770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6771: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6772: <p>Man pages should be installed in compressed form if
6773: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6774: and uncompressed otherwise. To handle this in the
6775: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6776: appended/removed automatically for man pages according to
6777: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6778: or not, see above for details. This modification of the
6779: <code class="filename">PLIST</code> file is done on a copy of it, not
6780: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 6781: </div>
1.148 asau 6782: <div class="sect1">
1.75 rillig 6783: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6784: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6785: </h2></div></div></div>
6786: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6787: in generating the binary package, set the variable
6788: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.322 leot 6789: 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 6790: important. The default for <code class="varname">PLIST_SRC</code> is
6791: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 6792: </div>
1.148 asau 6793: <div class="sect1">
1.75 rillig 6794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6795: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6796: <p>Some packages decide to install a different set of files based on
6797: the operating system being used. These differences can be
6798: automatically handled by using the following files:</p>
6799: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6800: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6801: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6802: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6803: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6804: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6805: </ul></div>
1.75 rillig 6806: </div>
1.148 asau 6807: <div class="sect1">
1.75 rillig 6808: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6809: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6810: <p>Some packages decide to generate hard-to-guess file names
6811: during installation that are hard to wire down.</p>
6812: <p>In such cases, you can set the
6813: <code class="varname">GENERATE_PLIST</code> variable to shell code
6814: terminated (with a semicolon) that will output PLIST entries which
6815: will be appended to the PLIST</p>
6816: <p>You can find one example in editors/xemacs:</p>
6817: <pre class="programlisting">
6818: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6819: </pre>
6820: <p>which will append something like
6821: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6822: <code class="filename">PLIST</code>.
6823: </p>
1.75 rillig 6824: </div>
1.148 asau 6825: <div class="sect1">
1.75 rillig 6826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6827: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6828: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6829: multiple (and unrelated) packages install files. These
6830: directories were problematic because you had to add special
6831: tricks in the PLIST to conditionally remove them, or have some
6832: centralized package handle them.</p>
6833: <p>In pkgsrc, it is now easy: Each package should create
6834: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6835: will remove any directories left empty after uninstalling a
6836: package.</p>
6837: <p>If a package needs an empty directory to work, create
6838: the directory during installation as usual, and also add an
6839: entry to the PLIST:
6840:
6841: </p>
6842: <pre class="programlisting">
6843: @pkgdir path/to/empty/directory
6844: </pre>
6845: <p>
6846:
6847: or take a look at <code class="varname">MAKE_DIRS</code> and
6848: <code class="varname">OWN_DIRS</code>.
1.88 wiz 6849: </p>
1.75 rillig 6850: </div>
1.299 rillig 6851: </div>
6852: <div class="chapter">
6853: <div class="titlepage"><div><div><h2 class="title">
6854: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6855: <div class="toc">
6856: <p><b>Table of Contents</b></p>
6857: <dl class="toc">
6858: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6859: <dd><dl>
6860: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6861: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6862: </dl></dd>
6863: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6864: <dd><dl>
6865: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6866: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
6867: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
6868: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
6869: </dl></dd>
6870: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6871: <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>
6872: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6873: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6874: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6875: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6876: <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>
6877: </dl>
6878: </div>
6879: <p>This chapter describes the framework known as
6880: <code class="literal">pkginstall</code>, whose key features are:</p>
6881: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6882: <li class="listitem"><p>Generic installation and manipulation of directories and files
6883: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6884: <li class="listitem"><p>Automatic handling of configuration files during installation,
6885: provided that packages are correctly designed.</p></li>
6886: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6887: <li class="listitem"><p>Registration of system users and groups.</p></li>
6888: <li class="listitem"><p>Registration of system shells.</p></li>
6889: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6890: </ul></div>
6891: <p>The following sections inspect each of the above points in detail.</p>
6892: <p>You may be thinking that many of the things described here could be
6893: easily done with simple code in the package's post-installation target
6894: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6895: as the code in them is only executed when building from source. Machines
6896: using binary packages could not benefit from it at all (as the code itself
6897: could be unavailable). Therefore, the only way to achieve any of the items
6898: described above is by means of the installation scripts, which are
6899: automatically generated by pkginstall.</p>
1.148 asau 6900: <div class="sect1">
1.75 rillig 6901: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6902: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6903: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6904: of files and directories that belong to a package. The names used in it
6905: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6906: which means that it cannot register files outside this directory (absolute
6907: path names are not allowed). Despite this restriction, some packages need
6908: to install files outside this location; e.g., under
6909: <code class="filename">${VARBASE}</code> or
6910: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6911: is to create such files during installation time by using
6912: installation scripts.</p>
6913: <p>The generic installation scripts are shell scripts that can
6914: contain arbitrary code. The list of scripts to execute is taken from
6915: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6916: <code class="filename">INSTALL</code>. A similar variable exists for package
6917: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6918: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6919: commands, so they have the potential to create and manage files
6920: anywhere in the file system.</p>
6921: <p>Using these general installation files is not recommended, but
6922: may be needed in some special cases. One reason for avoiding them is
6923: that the user has to trust the packager that there is no unwanted or
6924: simply erroneous code included in the installation script. Also,
6925: previously there were many similar scripts for the same functionality,
6926: and fixing a common error involved finding and changing all of
6927: them.</p>
6928: <p>The pkginstall framework offers another, standardized way. It
6929: provides generic scripts to abstract the manipulation of such files
6930: and directories based on variables set in the package's
6931: <code class="filename">Makefile</code>. The rest of this section describes
6932: these variables.</p>
6933: <div class="sect2">
6934: <div class="titlepage"><div><div><h3 class="title">
6935: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
6936: <p>The following variables can be set to request the creation of
6937: directories anywhere in the file system:</p>
6938: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6939: <li class="listitem">
6940: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
6941: contain a list of directories that should be created and should attempt
6942: to be destroyed by the installation scripts. The difference between
6943: the two is that the latter prompts the administrator to remove any
6944: directories that may be left after deinstallation (because they were
6945: not empty), while the former does not. Example:</p>
6946: <pre class="programlisting">
6947: MAKE_DIRS+= ${VARBASE}/foo/private
6948: </pre>
6949: </li>
6950: <li class="listitem">
6951: <p><code class="varname">MAKE_DIRS_PERMS</code> and
6952: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
6953: which directories should be created and should attempt to be destroyed
6954: by the installation scripts. Each tuple holds the following values,
6955: separated by spaces: the directory name, its owner, its group and its
6956: numerical mode. For example:</p>
6957: <pre class="programlisting">
6958: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
6959: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
6960: </pre>
6961: <p>The difference between the two is exactly the same as their
6962: non-<code class="varname">PERMS</code> counterparts.</p>
6963: </li>
6964: </ul></div>
1.75 rillig 6965: </div>
1.299 rillig 6966: <div class="sect2">
6967: <div class="titlepage"><div><div><h3 class="title">
6968: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
6969: <p>Creating non-empty files outside the installation prefix is tricky
6970: because the <code class="filename">PLIST</code> forces all files to be inside it.
6971: To overcome this problem, the only solution is to extract the file in the
6972: known place (i.e., inside the installation prefix) and copy it to the
6973: appropriate location during installation (done by the installation scripts
6974: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
6975: file</em></span> in the following paragraphs, which describe the variables
6976: that can be used to automatically and consistently handle files outside the
6977: installation prefix:</p>
6978: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6979: <li class="listitem">
6980: <p><code class="varname">CONF_FILES</code> and
6981: <code class="varname">REQD_FILES</code> are pairs of master and target files.
6982: During installation time, the master file is copied to the target one
6983: if and only if the latter does not exist. Upon deinstallation, the
6984: target file is removed provided that it was not modified by the
6985: installation.</p>
6986: <p>The difference between the two is that the latter prompts the
6987: administrator to remove any files that may be left after
6988: deinstallation (because they were not empty), while the former does
6989: not.</p>
6990: </li>
6991: <li class="listitem">
6992: <p><code class="varname">CONF_FILES_PERMS</code> and
6993: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
6994: files as well as their target locations. For each of them, it also
6995: specifies their owner, their group and their numeric permissions, in
6996: this order. For example:</p>
1.88 wiz 6997: <pre class="programlisting">
1.299 rillig 6998: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
6999: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100 rillig 7000: </pre>
1.299 rillig 7001: <p>The difference between the two is exactly the same as their
7002: non-<code class="varname">PERMS</code> counterparts.</p>
7003: </li>
7004: </ul></div>
7005: </div>
1.75 rillig 7006: </div>
1.148 asau 7007: <div class="sect1">
1.75 rillig 7008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7009: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
7010: <p>Configuration files are special in the sense that they are installed
7011: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
7012: need special treatment during installation (most of which is automated by
7013: pkginstall). The main concept you must bear in mind is that files marked
7014: as configuration files are automatically copied to the right place (somewhere
7015: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
7016: and only if</em></span> they didn't exist before. Similarly, they will not
7017: be removed if they have local modifications. This ensures that
7018: administrators never lose any custom changes they may have made.</p>
7019: <div class="sect2">
7020: <div class="titlepage"><div><div><h3 class="title">
7021: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7022: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7023: specifies where configuration files shall be installed. Its contents are
7024: set based upon the following variables:</p>
7025: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7026: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7027: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
7028: be overridden by the user to point to his preferred location (e.g.,
7029: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7030: Packages must not use it directly.</p></li>
7031: <li class="listitem">
7032: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7033: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7034: for the package being built shall be installed. The definition of this
7035: variable only makes sense in the package's
7036: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7037: <p>As an example, consider the Apache package,
1.322 leot 7038: <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 7039: configuration files under the
7040: <code class="filename">httpd/</code> subdirectory of
7041: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7042: Makefile.</p>
7043: </li>
7044: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7045: variable that holds this package's configuration directory (if
7046: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7047: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7048: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7049: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7050: directory where the configuration files for the package identified by
7051: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7052: </ul></div>
7053: <p>Based on the above variables, pkginstall determines the value of
7054: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
7055: variable that can be used within a package to refer to its configuration
7056: directory. The algorithm used to set its value is basically the
7057: following:</p>
7058: <div class="orderedlist"><ol class="orderedlist" type="1">
7059: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7060: its value is used.</p></li>
7061: <li class="listitem"><p>If the previous variable is not defined but
7062: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7063: <code class="filename">Makefile</code>, the resulting value is
7064: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7065: <li class="listitem"><p>Otherwise, it is set to
7066: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7067: </ol></div>
7068: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
7069: 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
7070: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
7071: be created with OWN_DIRS or MAKE_DIRS.</p>
7072: </div>
7073: <div class="sect2">
7074: <div class="titlepage"><div><div><h3 class="title">
7075: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7076: <p>Given that pkgsrc (and users!) expect configuration files to be in a
7077: known place, you need to teach each package where it shall install its
7078: files. In some cases you will have to patch the package Makefiles to
7079: achieve it. If you are lucky, though, it may be as easy as passing an
7080: extra flag to the configuration script; this is the case of GNU Autoconf-
7081: generated files:</p>
1.75 rillig 7082: <pre class="programlisting">
1.299 rillig 7083: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100 rillig 7084: </pre>
1.299 rillig 7085: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
7086: for</em></span> its configuration files, not where they will be originally
7087: installed (although the difference is never explicit,
7088: unfortunately).</p>
1.75 rillig 7089: </div>
1.299 rillig 7090: <div class="sect2">
7091: <div class="titlepage"><div><div><h3 class="title">
7092: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
7093: <p>As said before, pkginstall automatically handles configuration files.
7094: This means that <span class="strong"><strong>the packages themselves must not
7095: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7096: directly</strong></span>. Bad news is that many software installation scripts
7097: will, out of the box, mess with the contents of that directory. So what is
7098: the correct procedure to fix this issue?</p>
7099: <p>You must teach the package (usually by manually patching it) to
7100: install any configuration files under the examples hierarchy,
7101: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7102: <code class="filename">PLIST</code> registers them and the administrator always
7103: has the original copies available.</p>
7104: <p>Once the required configuration files are in place (i.e., under the
7105: examples hierarchy), the pkginstall framework can use them as master copies
7106: during the package installation to update what is in
7107: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7108: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
7109: 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
7110: about their syntax and their purpose. Here is an example, taken from the
1.322 leot 7111: <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 7112: <pre class="programlisting">
1.299 rillig 7113: EGDIR= ${PREFIX}/share/doc/mutt/samples
7114: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.100 rillig 7115: </pre>
1.299 rillig 7116: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
7117: package and has no meaning outside it.</p>
1.75 rillig 7118: </div>
1.299 rillig 7119: <div class="sect2">
7120: <div class="titlepage"><div><div><h3 class="title">
7121: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
7122: <p>The automatic copying of config files can be toggled by setting the
7123: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7124: installation.</p>
1.88 wiz 7125: </div>
1.75 rillig 7126: </div>
1.148 asau 7127: <div class="sect1">
1.75 rillig 7128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7129: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7130: <p>System startup scripts are special files because they must be
7131: installed in a place known by the underlying OS, usually outside the
7132: 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
7133: can be used. However, pkginstall provides a special mechanism to handle
7134: these files.</p>
7135: <p>In order to provide system startup scripts, the package has
7136: to:</p>
7137: <div class="orderedlist"><ol class="orderedlist" type="1">
7138: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7139: the <code class="literal">.sh</code> suffix appended. Considering the
1.322 leot 7140: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/index.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.299 rillig 7141: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
7142: <li class="listitem">
7143: <p>Tell pkginstall to handle it, appending the name of the script,
7144: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7145: Continuing the previous example:</p>
7146: <pre class="programlisting">
7147: RCD_SCRIPTS+= cupsd
7148: </pre>
7149: </li>
7150: </ol></div>
7151: <p>Once this is done, pkginstall will do the following steps for each
7152: script in an automated fashion:</p>
7153: <div class="orderedlist"><ol class="orderedlist" type="1">
7154: <li class="listitem"><p>Process the file found in the files directory applying all the
7155: substitutions described in the <code class="filename">FILES_SUBST</code>
7156: variable.</p></li>
7157: <li class="listitem"><p>Copy the script from the files directory to the examples
7158: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
7159: that this master file must be explicitly registered in the
7160: <code class="filename">PLIST</code>.</p></li>
7161: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7162: from the examples hierarchy into the system-wide startup scripts
7163: directory.</p></li>
7164: </ol></div>
7165: <div class="sect2">
7166: <div class="titlepage"><div><div><h3 class="title">
7167: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7168: <p>The automatic copying of config files can be toggled by setting the
7169: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7170: installation. Note that the scripts will be always copied inside the
7171: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7172: matter what the value of this variable is.</p>
1.75 rillig 7173: </div>
7174: </div>
1.299 rillig 7175: <div class="sect1">
7176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7177: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7178: <p>If a package needs to create special users and/or groups during
7179: installation, it can do so by using the pkginstall framework.</p>
7180: <p>Users can be created by adding entries to the
7181: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7182: syntax:</p>
7183: <pre class="programlisting">
7184: user:group
7185: </pre>
7186: <p>Further specification of user details may be done by setting
7187: per-user variables.
7188: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7189: numeric UID for the user.
7190: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7191: user's description or comment.
7192: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7193: user's home directory, and defaults to
7194: <code class="filename">/nonexistent</code> if not specified.
7195: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7196: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7197: not specified.</p>
7198: <p>Similarly, groups can be created by adding entries to the
7199: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7200: <pre class="programlisting">
7201: group
7202: </pre>
7203: <p>The numeric GID of the group may be set by defining
7204: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7205: <p>If a package needs to create the users and groups at an earlier
7206: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7207: <code class="literal">configure</code>,<code class="literal">build</code>, or
7208: <code class="literal">pre-install</code> to indicate the phase before which the
7209: users and groups are created. In this case, the numeric UIDs and GIDs
7210: of the created users and groups are automatically hardcoded into the
7211: final installation scripts.</p>
1.75 rillig 7212: </div>
1.148 asau 7213: <div class="sect1">
1.75 rillig 7214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7215: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7216: <p>Packages that install system shells should register them in the shell
7217: database, <code class="filename">/etc/shells</code>, to make things easier to the
7218: administrator. This must be done from the installation scripts to keep
7219: binary packages working on any system. pkginstall provides an easy way to
7220: accomplish this task.</p>
7221: <p>When a package provides a shell interpreter, it has to set the
7222: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7223: add some hooks to the installation scripts to handle it. Consider the
1.322 leot 7224: 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 7225: <pre class="programlisting">
7226: PKG_SHELL= ${PREFIX}/bin/zsh
7227: </pre>
7228: <div class="sect2">
7229: <div class="titlepage"><div><div><h3 class="title">
7230: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7231: <p>The automatic registration of shell interpreters can be disabled by
7232: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7233: environment variable to <code class="literal">NO</code>.</p>
7234: </div>
1.75 rillig 7235: </div>
1.148 asau 7236: <div class="sect1">
1.75 rillig 7237: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7238: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7239: <p>Packages that install X11 fonts should update the database files
7240: that index the fonts within each fonts directory. This can easily be
7241: accomplished within the pkginstall framework.</p>
7242: <p>When a package installs X11 fonts, it must list the directories in
7243: which fonts are installed in the
7244: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7245: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7246: <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
7247: installation scripts to run the appropriate commands to update the fonts
7248: database files within each of those directories. For convenience, if the
7249: directory path is relative, it is taken to be relative to the package's
1.322 leot 7250: 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 7251: <pre class="programlisting">
1.299 rillig 7252: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75 rillig 7253: </pre>
1.299 rillig 7254: <div class="sect2">
7255: <div class="titlepage"><div><div><h3 class="title">
7256: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7257: <p>The automatic update of fonts databases can be disabled by
7258: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7259: environment variable to <code class="literal">NO</code>.</p>
1.75 rillig 7260: </div>
7261: </div>
7262: </div>
1.148 asau 7263: <div class="chapter">
1.75 rillig 7264: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 7265: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75 rillig 7266: <div class="toc">
7267: <p><b>Table of Contents</b></p>
1.210 leot 7268: <dl class="toc">
1.267 rillig 7269: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75 rillig 7270: <dd><dl>
1.267 rillig 7271: <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>
7272: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7273: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7274: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7275: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7276: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7277: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7278: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7279: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7280: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7281: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7282: </dl></dd>
7283: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7284: <dd><dl>
7285: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7286: <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>
7287: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7288: </dl></dd>
7289: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7290: <dd><dl>
7291: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7292: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7293: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
7294: </dl></dd>
7295: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7296: <dd><dl>
7297: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7298: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 7299: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
7300: <dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
7301: <dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
7302: <dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
1.267 rillig 7303: </dl></dd>
7304: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7305: <dd><dl>
7306: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7307: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 7308: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7309: <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>
7310: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 7311: </dl></dd>
7312: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7313: <dd><dl>
7314: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7315: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7316: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7317: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7318: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 7319: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 7320: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
7321: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 7322: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
7323: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
7324: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
7325: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
7326: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
7327: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
7328: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 7329: emulation</a></span></dt>
1.318 nia 7330: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
7331: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.75 rillig 7332: </dl></dd>
1.267 rillig 7333: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7334: </dl>
7335: </div>
1.148 asau 7336: <div class="sect1">
1.75 rillig 7337: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 7338: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78 rillig 7339: <p>One appealing feature of pkgsrc is that it runs on many
1.218 rillig 7340: different platforms. As a result, it is important to ensure,
7341: where possible, that packages in pkgsrc are portable. This
7342: chapter mentions some particular details you should pay
7343: attention to while working on pkgsrc.</p>
1.148 asau 7344: <div class="sect2">
1.78 rillig 7345: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7346: <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 7347: </h3></div></div></div>
1.78 rillig 7348: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7349: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7350: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7351: want to use those variables in the preprocessor directives of
1.322 leot 7352: <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 7353: <code class="literal">.for</code>), you need to include the file
7354: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7355: loads the user preferences.</p>
1.78 rillig 7356: <p>But note that some variables may not be completely defined
1.219 rillig 7357: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7358: included, as they may contain references to variables that are
7359: not yet defined. In shell commands (the lines in
7360: <code class="filename">Makefile</code> that are indented with a tab) this
7361: is no problem, since variables are only expanded when they are
7362: used. But in the preprocessor directives mentioned above and in
7363: dependency lines (of the form <code class="literal">target:
7364: dependencies</code>) the variables are expanded at load
7365: time.</p>
1.148 asau 7366: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7367: <h3 class="title">Note</h3>
1.218 rillig 7368: <p>To check whether a variable can be used at load time,
7369: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78 rillig 7370: </div>
7371: </div>
1.148 asau 7372: <div class="sect2">
1.78 rillig 7373: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7374: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88 wiz 7375: <p>Occasionally, packages require interaction from the user,
7376: and this can be in a number of ways:</p>
1.148 asau 7377: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7378: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7379: interaction such as entering username/password or accepting a
7380: license on a web page.</p></li>
1.128 wiz 7381: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7382: passwords.</p></li>
1.128 wiz 7383: <li class="listitem"><p>help to configure the package before it is built</p></li>
7384: <li class="listitem"><p>help during the build process</p></li>
7385: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7386: </ul></div>
1.218 rillig 7387: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7388: variable to define which stages need interaction. This should be
7389: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7390: <pre class="programlisting">
1.100 rillig 7391: INTERACTIVE_STAGE= configure install
1.222 sevan 7392: </pre>
1.88 wiz 7393: <p>The user can then decide to skip this package by setting the
1.218 rillig 7394: <code class="varname">BATCH</code> variable. Packages that require interaction
7395: are also excluded from bulk builds.</p>
1.75 rillig 7396: </div>
1.148 asau 7397: <div class="sect2">
1.75 rillig 7398: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7399: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222 sevan 7400: <p>Authors of software can choose the licence under which software
7401: can be copied. The Free Software Foundation has declared some
7402: licenses "Free", and the Open Source Initiative has a definition of
7403: "Open Source".</p>
7404: <p>By default, pkgsrc allows packages with Free or Open Source
7405: licenses to be built. To allow packages with other licenses to be
7406: built as well, the pkgsrc user needs to add these licenses to the
7407: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7408: that this variable only affects which packages may be
7409: <span class="emphasis"><em>built</em></span>, while the license terms often also
7410: restrict the actual use of the package and its redistribution.</p>
1.98 wiz 7411: <p>One might want to only install packages with a BSD license,
1.218 rillig 7412: or the GPL, and not the other. The free licenses are added to the
1.222 sevan 7413: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.121 jnemeth 7414: user can override the default by setting the
7415: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222 sevan 7416: of "+=". The licenses accepted by default are defined in the
7417: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7418: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78 rillig 7419: <p>The license tag mechanism is intended to address
1.87 wiz 7420: copyright-related issues surrounding building, installing and
7421: using a package, and not to address redistribution issues (see
7422: <code class="varname">RESTRICTED</code> and
1.222 sevan 7423: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121 jnemeth 7424: Packages with redistribution restrictions should set these
7425: tags.</p>
1.98 wiz 7426: <p>Denoting that a package may be copied according to a
7427: particular license is done by placing the license in
1.87 wiz 7428: <code class="filename">pkgsrc/licenses</code> and setting the
7429: <code class="varname">LICENSE</code> variable to a string identifying the
1.322 leot 7430: 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 7431: <pre class="programlisting">
1.100 rillig 7432: LICENSE= xv-license
1.222 sevan 7433: </pre>
1.87 wiz 7434: <p>When trying to build, the user will get a notice that the
1.98 wiz 7435: package is covered by a license which has not been placed in the
7436: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7437: <pre class="programlisting">
1.100 rillig 7438: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7439: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7440: ===> To view the license, enter "/usr/bin/make show-license".
7441: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7442: ===> ACCEPTABLE_LICENSES+=xv-license
7443: *** Error code 1
1.222 sevan 7444: </pre>
1.110 hubertf 7445: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7446: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7447: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7448: convey to pkgsrc that it should not in the future fail because of
7449: that license:</p>
1.78 rillig 7450: <pre class="programlisting">
1.100 rillig 7451: ACCEPTABLE_LICENSES+=xv-license
1.222 sevan 7452: </pre>
7453: <p>The use of <code class="varname">LICENSE=shareware</code>,
7454: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7455: is deprecated because it does not crisply refer to a particular
7456: license text. Another problem with such usage is that it does not
7457: enable a user to tell pkgsrc to proceed for a single package
7458: without also telling pkgsrc to proceed for all packages with that
7459: tag.</p>
7460: <div class="sect3">
7461: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7462: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154 rodent 7463: <p>When adding a package with a new license, the following steps
7464: are required:</p>
7465: <div class="orderedlist"><ol class="orderedlist" type="1">
7466: <li class="listitem">
1.284 rillig 7467: <p>Check whether the license qualifies as Free or Open Source by
7468: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7469: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222 sevan 7470: Open Source Initiative</a>. If this is the case, the filename in
7471: <code class="filename">pkgsrc/licenses/</code> does not need the
7472: <code class="filename">-license</code> suffix, and the license name should be
7473: added to:</p>
1.154 rodent 7474: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7475: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7476: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7477: <li class="listitem"><p>default_acceptable_licenses in
7478: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154 rodent 7479: </ul></div>
7480: </li>
1.284 rillig 7481: <li class="listitem"><p>The license text should be added to
7482: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7483: licenses can be seen in this directory.</p></li>
1.154 rodent 7484: </ol></div>
1.222 sevan 7485: </div>
7486: <div class="sect3">
7487: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7488: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98 wiz 7489: <p>When the license changes (in a way other than formatting),
1.222 sevan 7490: make sure that the new license has a different name (e.g.,
1.98 wiz 7491: append the version number if it exists, or the date). Just
7492: because a user told pkgsrc to build programs under a previous
7493: version of a license does not mean that pkgsrc should build
1.99 rillig 7494: programs under the new licenses. The higher-level point is that
1.98 wiz 7495: pkgsrc does not evaluate licenses for reasonableness; the only
7496: test is a mechanistic test of whether a particular text has been
1.222 sevan 7497: approved by either of two bodies (FSF or OSI).</p>
7498: </div>
1.75 rillig 7499: </div>
1.148 asau 7500: <div class="sect2">
1.75 rillig 7501: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7502: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75 rillig 7503: <p>Some licenses restrict how software may be re-distributed.
1.222 sevan 7504: By declaring the restrictions, package tools can
1.98 wiz 7505: automatically refrain from e.g. placing binary packages on FTP
7506: sites.</p>
1.222 sevan 7507: <p>There are four possible restrictions, which are
1.98 wiz 7508: the cross product of sources (distfiles) and binaries not being
7509: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7510: language in any license, and because non-Free licenses tend to be
7511: different from each other, pkgsrc adopts a definition of FTP and
1.222 sevan 7512: CD-ROM.
7513:
7514: "FTP" means making the source or binary file available over the
7515: Internet at no charge.
7516:
7517: "CD-ROM" means making the source or binary available on some kind of
7518: media, together with other source and binary packages, which is sold
7519: for a distribution charge.
1.98 wiz 7520: </p>
7521: <p>In order to encode these restrictions, the package system
1.87 wiz 7522: defines five make variables that can be set to note these
7523: restrictions:</p>
1.148 asau 7524: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7525: <li class="listitem">
1.75 rillig 7526: <p><code class="varname">RESTRICTED</code></p>
7527: <p>This variable should be set whenever a restriction
1.87 wiz 7528: exists (regardless of its kind). Set this variable to a
1.98 wiz 7529: string containing the reason for the restriction. It should
7530: be understood that those wanting to understand the restriction
7531: will have to read the license, and perhaps seek advice of
7532: counsel.</p>
1.75 rillig 7533: </li>
1.128 wiz 7534: <li class="listitem">
1.75 rillig 7535: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7536: <p>Binaries may not be placed on CD-ROM containing other
7537: binary packages, for which a distribution charge may be made.
7538: In this case, set this variable to
7539: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7540: </li>
1.128 wiz 7541: <li class="listitem">
1.75 rillig 7542: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7543: <p>Binaries may not made available on the Internet without
7544: charge. In this case, set this variable to
7545: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7546: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7547: </li>
1.128 wiz 7548: <li class="listitem">
1.75 rillig 7549: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7550: <p>Distfiles may not be placed on CD-ROM, together with
7551: other distfiles, for which a fee may be charged. In this
7552: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7553: </p>
1.75 rillig 7554: </li>
1.128 wiz 7555: <li class="listitem">
1.75 rillig 7556: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7557: <p>Distfiles may not made available via FTP at no charge.
7558: In this case, set this variable to
7559: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7560: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7561: </li>
7562: </ul></div>
1.222 sevan 7563: <p>Please note that packages will be removed from pkgsrc when the
7564: distfiles are not distributable and cannot be obtained for a period
7565: of one full quarter branch. Packages with manual/interactive fetch
7566: must have a maintainer and it is his/her responsibility to ensure
7567: this.</p>
1.75 rillig 7568: </div>
1.148 asau 7569: <div class="sect2">
1.75 rillig 7570: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7571: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290 gutterid 7572: <p>Your package may depend on some other package being present,
7573: and there are various ways of expressing this dependency.
7574: pkgsrc supports the <code class="varname">DEPENDS</code>,
7575: <code class="varname">BUILD_DEPENDS</code>,
7576: <code class="varname">TOOL_DEPENDS</code>, and
7577: <code class="varname">TEST_DEPENDS</code> definitions, the
1.88 wiz 7578: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7579: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7580: to handle dependencies, and which uses the variables named above.
1.299 rillig 7581: 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 7582: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7583: definition registers that pre-requisite in the binary package so it
7584: will be pulled in when the binary package is later installed, whilst
7585: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7586: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7587: dependency that is only needed for building or testing the resulting
1.299 rillig 7588: 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 7589: <p>This means that if you only need a package present whilst
1.290 gutterid 7590: you are building or testing, it should be noted as a
7591: <code class="varname">TOOL_DEPENDS</code>,
7592: <code class="varname">BUILD_DEPENDS</code>, or
7593: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.269 leot 7594: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7595: packages, i.e. packages for the architecture where the package
7596: is built;
7597: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290 gutterid 7598: packages, i.e., packages for the architecture for which the package
1.269 leot 7599: is built.</p>
1.290 gutterid 7600: <p>The format for a <code class="varname">DEPENDS</code>,
7601: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7602: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75 rillig 7603: <pre class="programlisting">
1.100 rillig 7604: <pre-req-package-name>:../../<category>/<pre-req-package>
1.222 sevan 7605: </pre>
1.128 wiz 7606: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7607: may include any of the wildcard version numbers recognized by
1.322 leot 7608: <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 7609: <div class="orderedlist"><ol class="orderedlist" type="1">
7610: <li class="listitem">
1.75 rillig 7611: <p>If your package needs another package's binaries or
1.160 wiz 7612: libraries to build and run, and if that package has a
1.87 wiz 7613: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7614: <pre class="programlisting">
1.100 rillig 7615: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7616: </pre>
1.75 rillig 7617: </li>
1.128 wiz 7618: <li class="listitem">
1.160 wiz 7619: <p>If your package needs another package's binaries or
7620: libraries only for building, and if that package has a
7621: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7622: <pre class="programlisting">
7623: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7624: </pre>
1.160 wiz 7625: <p>but set
7626: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7627: to make it a build dependency only. This case is rather
7628: rare.</p>
7629: </li>
7630: <li class="listitem">
1.132 spz 7631: <p>If your package needs binaries from another package to build,
1.269 leot 7632: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75 rillig 7633: <pre class="programlisting">
1.269 leot 7634: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222 sevan 7635: </pre>
1.75 rillig 7636: </li>
1.269 leot 7637: <li class="listitem"><p>If your package needs static libraries to link against, header
7638: files to include, etc. from another package to build,
7639: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132 spz 7640: <li class="listitem"><p>If your package needs a library with which to link and
7641: there is no <code class="filename">buildlink3.mk</code> file
7642: available, create one. Using
7643: <code class="varname">DEPENDS</code> won't be sufficient because the
7644: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7645: <li class="listitem">
1.132 spz 7646: <p>If your package needs some executable to be able to run
7647: correctly and if there's no
7648: <code class="filename">buildlink3.mk</code> file, this is specified
7649: using the <code class="varname">DEPENDS</code> variable. The
1.322 leot 7650: <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 7651: be able to execute the latex binary from the tex-latex-bin package
1.132 spz 7652: when it runs, and that is specified:</p>
1.75 rillig 7653: <pre class="programlisting">
1.242 wiz 7654: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222 sevan 7655: </pre>
1.132 spz 7656: </li>
1.290 gutterid 7657: <li class="listitem"><p>If your package includes a test suite that has extra
7658: dependencies only required for this purpose (frequently this
7659: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7660: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132 spz 7661: <li class="listitem">
7662: <p>You can use wildcards in package dependencies. Note that
7663: such wildcard dependencies are retained when creating binary
7664: packages. The dependency is checked when installing the binary
7665: package and any package which matches the pattern will be
7666: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7667: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7668: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7669: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7670: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7671: <p>Wildcards can also be used to specify that a package
1.87 wiz 7672: will only build against a certain minimum version of a
7673: pre-requisite:</p>
1.75 rillig 7674: <pre class="programlisting">
1.132 spz 7675: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.222 sevan 7676: </pre>
1.132 spz 7677: <p>This means that the package will build using version 6.0
7678: of ImageMagick or newer. Such a dependency may be warranted
7679: if, for example, the command line options of an executable
7680: have changed.</p>
7681: <p>If you need to depend on minimum versions of libraries,
1.298 wiz 7682: set
7683: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7684: to the appropriate pattern before including its
7685: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7686: <pre class="programlisting">
7687: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7688: .include "../../graphics/jpeg/buildlink3.mk"
7689: </pre>
1.75 rillig 7690: <p>For security fixes, please update the package
1.267 rillig 7691: 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 7692: information.</p>
1.75 rillig 7693: </li>
7694: </ol></div>
7695: <p>If your package needs files from another package to build,
1.87 wiz 7696: add the relevant distribution files to
7697: <code class="varname">DISTFILES</code>, so they will be extracted
1.322 leot 7698: 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 7699: (It relies on the jpeg sources being present in source form
7700: during the build.)</p>
1.75 rillig 7701: </div>
1.148 asau 7702: <div class="sect2">
1.75 rillig 7703: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7704: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7705: <p>Your package may conflict with other packages a user might
1.87 wiz 7706: already have installed on his system, e.g. if your package
1.88 wiz 7707: installs the same set of files as another package in the pkgsrc
1.190 wiz 7708: tree or has the same <code class="varname">PKGNAME</code>.</p>
1.322 leot 7709: <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>
7710: 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 7711: install the same shared library, thus you set in
7712: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7713: <pre class="programlisting">
7714: CONFLICTS= Xaw-Xpm-[0-9]*
7715: </pre>
7716: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7717: <pre class="programlisting">
7718: CONFLICTS= libXaw3d-[0-9]*
7719: </pre>
1.322 leot 7720: <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 7721: that conflict with existing packages and abort. However, in many
7722: situations this is too late in the process. Binary package managers
7723: will not know about the conflict until they attempt to install the
7724: package after already downloading it and all its dependencies.
7725: Users may also waste time building a package and its dependencies
7726: only to find out at the end that it conflicts with another package
7727: they have installed.</p>
7728: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7729: should be added in all cases where it is known that packages conflict
7730: with each other. These <code class="varname">CONFLICTS</code> entries are
1.322 leot 7731: 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 7732: managers to inform users that packages cannot be installed onto
7733: the target system.</p>
1.75 rillig 7734: </div>
1.148 asau 7735: <div class="sect2">
1.75 rillig 7736: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7737: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7738: <p>There are several reasons why a package might be
1.88 wiz 7739: instructed to not build under certain circumstances. If the
1.87 wiz 7740: package builds and runs on most platforms, the exceptions
1.193 dholland 7741: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7742: the package builds and runs on a small handful of platforms,
7743: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7744: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7745: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7746: (OS-version-platform) that can use glob-style
7747: wildcards.</p>
7748: <p>If a package is not appropriate for some platforms (as
1.225 maya 7749: opposed to merely broken), a different set of variables should be
1.193 dholland 7750: used as this affects failure reporting and statistics.
7751: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7752: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 dholland 7753: the package is appropriate for only a small handful of platforms
7754: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7755: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7756: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7757: (OS-version-platform) that can use glob-style
7758: wildcards.</p>
1.88 wiz 7759: <p>Some packages are tightly bound to a specific version of an
1.322 leot 7760: 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 7761: backwards compatible with other versions of the OS, and should be
7762: uploaded to a version specific directory on the FTP server. Mark
7763: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7764: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7765: the package system internals, but may be used in the
7766: future.</p>
1.75 rillig 7767: <p>If the package should be skipped (for example, because it
1.87 wiz 7768: provides functionality already provided by the system), set
1.88 wiz 7769: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7770: the package should fail because some preconditions are not met,
7771: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7772: message.</p>
1.75 rillig 7773: </div>
1.148 asau 7774: <div class="sect2">
1.75 rillig 7775: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7776: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7777: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7778: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7779: be set in the package Makefile. This will be carried into any
7780: binary package that is made from this pkgsrc entry. A
1.128 wiz 7781: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.322 leot 7782: 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 7783: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7784: </div>
1.148 asau 7785: <div class="sect2">
1.75 rillig 7786: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7787: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7788: <p>When a vulnerability is found, this should be noted in
1.320 wiz 7789: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>.
7790: Entries in that file consist of three parts:</p>
7791: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7792: <li class="listitem"><p>package version pattern</p></li>
7793: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
7794: <li class="listitem"><p>URL providing additional information about the issue</p></li>
7795: </ul></div>
7796: <p>For the package version pattern please always use `<' to
7797: mark an upper bound (not `<='!). This will avoid possible
7798: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
7799: related to security fixes. Lower bounds can be added too, using
7800: '>' or '>='. For example,
1.321 wiz 7801: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.320 wiz 7802: versions 1.0 (included) to 1.2 (excluded) of
7803: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
7804: issue.</p>
7805: <p>Entries should always be added at the bottom of the file.</p>
7806: <p>When fixing packages, please modify the upper bound of the
7807: corresponding entry. To continue the previous example, if a fix
7808: was backported to version 1.1nb2, change the previous pattern to
1.321 wiz 7809: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.320 wiz 7810: <p>To locally test a package version pattern against a
7811: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
7812: pmatch</strong></span> command.</p>
7813: <p>The URL should be as permanent as possible and provide as
7814: much information about the issue as possible. CVE entries are
7815: preferred.</p>
7816: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.138 wiz 7817: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7818: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7819: <code class="varname">PKGREVISION</code> should be increased (this is of
7820: course not necessary if the problem is fixed by using a newer
7821: release of the software), and the pattern in the
7822: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7823: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7824: branch, be sure to submit a pullup request!</p>
1.75 rillig 7825: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7826: semi-automatically by a weekly cron job.</p>
1.320 wiz 7827: <p>In case a security issue is disputed, please contact
7828: pkgsrc-security@NetBSD.org.</p>
1.75 rillig 7829: </div>
1.148 asau 7830: <div class="sect2">
1.75 rillig 7831: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7832: <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 7833: <p>When making fixes to an existing package it can be useful
1.87 wiz 7834: to change the version number in <code class="varname">PKGNAME</code>. To
7835: avoid conflicting with future versions by the original author, a
1.128 wiz 7836: <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 7837: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7838: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7839: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7840: <pre class="programlisting">
1.100 rillig 7841: DISTNAME= foo-17.42
7842: PKGREVISION= 9
1.222 sevan 7843: </pre>
1.75 rillig 7844: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7845: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7846: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7847: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7848: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7849: <p>When a new release of the package is released, the
1.87 wiz 7850: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7851: minor release of the above package, things should be like:</p>
1.75 rillig 7852: <pre class="programlisting">
1.100 rillig 7853: DISTNAME= foo-17.43
1.222 sevan 7854: </pre>
1.87 wiz 7855: <p><code class="varname">PKGREVISION</code> should be incremented for any
7856: non-trivial change in the resulting binary package. Without a
7857: <code class="varname">PKGREVISION</code> bump, someone with the previous
7858: version installed has no way of knowing that their package is out
7859: of date. Thus, changes without increasing
7860: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7861: trivial that no reasonable person would want to upgrade", and this
7862: is the rough test for when increasing
7863: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7864: changes that do not merit increasing
7865: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 7866: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7867: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284 rillig 7868: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7869: comments in Makefile.</p></li>
7870: <li class="listitem"><p>Changing build variables if the resulting binary
7871: package is the same.</p></li>
7872: <li class="listitem"><p>Changing
7873: <code class="filename">DESCR</code>.</p></li>
7874: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7875: default options don't change.</p></li>
1.100 rillig 7876: </ul></div>
1.87 wiz 7877: <p>Examples of changes that do merit an increase to
7878: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 7879: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7880: <li class="listitem"><p>Security fixes</p></li>
7881: <li class="listitem"><p>Changes or additions to a patch
7882: file</p></li>
7883: <li class="listitem"><p>Changes to the
7884: <code class="filename">PLIST</code></p></li>
7885: <li class="listitem"><p>A dependency is changed or
7886: renamed.</p></li>
1.100 rillig 7887: </ul></div>
1.78 rillig 7888: <p>PKGREVISION must also be incremented when dependencies have ABI
7889: changes.</p>
1.75 rillig 7890: </div>
1.148 asau 7891: <div class="sect2">
1.79 rillig 7892: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7893: <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 7894: <p>When you want to replace the same text in multiple files, or
7895: multiple times in the same file, it is cumbersome to maintain a patch
7896: file for this. This is where the SUBST framework steps in. It provides an
7897: easy-to-use interface for replacing text in files. It just needs the
7898: following information:</p>
7899: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7900: <li class="listitem"><p>In which phase of the package build cycle should the
7901: replacement happen?</p></li>
7902: <li class="listitem"><p>In which files should the replacement
1.287 rillig 7903: happen?</p></li>
1.295 rillig 7904: <li class="listitem"><p>Which text should be replaced with
7905: what?</p></li>
1.287 rillig 7906: </ul></div>
7907: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295 rillig 7908: variables. A minimal example is:</p>
7909: <pre class="programlisting">
7910: SUBST_CLASSES+= paths
7911: SUBST_STAGE.paths= pre-configure
7912: SUBST_FILES.paths= src/*.c
7913: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
7914: </pre>
7915: <p>Translated into English, it means: In the pre-configure stage (that
7916: is, after applying the patches from the patches/ directory and before
7917: running the configure script and the portability check), replace the text
7918: <code class="literal">/usr/local</code> with the content of the variable
7919: <code class="varname">PREFIX</code>.</p>
7920: <p>Each SUBST block starts by appending an identifier to
7921: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
7922: identifier can be chosen freely by the package. If there should ever be
7923: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
7924: early, so don't worry about name collisions.</p>
7925: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
7926: SUBST block are parameterized using this identifier. In the remainder of
7927: this section, these parameterized variables are written as
7928: <code class="varname">SUBST_STAGE.*</code>.</p>
7929: <pre class="programlisting">
7930: SUBST_CLASSES+= paths
7931: SUBST_STAGE.paths= pre-configure
7932: SUBST_MESSAGE.paths= Fixing absolute paths.
7933: SUBST_FILES.paths= src/*.c
7934: SUBST_FILES.paths+= scripts/*.sh
7935: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
7936: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
7937: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
7938: </pre>
7939: <p>To get a complete picture about the SUBST substitutions, run
7940: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
7941: expected, run pkglint on the package, which detects several typical
7942: mistakes surrounding the SUBST blocks. For any questions that might
7943: remain after this, have a look at
7944: <code class="filename">mk/subst.mk</code>.</p>
7945: <div class="sect3">
7946: <div class="titlepage"><div><div><h4 class="title">
7947: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
7948: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
7949: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
7950: <code class="literal">pre-configure</code> is used most often, by far. The most
7951: popular stages are, in chronological order:</p>
7952: <div class="variablelist"><dl class="variablelist">
7953: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
7954: <dd>
7955: <p>The substitutions are applied immediately after the
7956: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
7957: package will leave no traces of the original files.</p>
7958: <p>When the substitution applies to files for which there is also a
7959: patch in the <code class="filename">patches/</code> directory, this means that the
7960: patches will be computed based on the result of the substitution. When
7961: these patches are sent to the upstream maintainer later, to be fixed in
7962: the upstream package, these patches may no longer match what the upstream
7963: author is used to. Because of this, <code class="literal">pre-configure</code> is
7964: often a better choice.</p>
7965: </dd>
7966: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
7967: <dd>
7968: <p>The substitutions are applied after the patches from the
7969: <code class="filename">patches/</code> directory. This makes it possible to run
7970: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.322 leot 7971: 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 7972: <p>When updating the patches, it is helpful to explicitly separate the
7973: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
7974: configure</strong></span>, and to only edit the patches between these commands.
7975: Otherwise the substitutions from the SUBST block will end up in the patch
7976: file. When this happens in really obvious ways, pkglint will complain
7977: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
7978: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
7979: can only detect these really obvious
7980: cases.</p>
7981: </dd>
7982: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
7983: <dd><p>This stage should only be used if the package defines a
7984: <code class="literal">pre-configure</code> action itself, and the substitution must
7985: happen after that. Typical examples are packages that use the
7986: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
7987: script from
7988: <code class="filename">configure.ac</code>.</p></dd>
7989: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
7990: <dd><p>This stage is used to fix up any mistakes by the
7991: configure stage.</p></dd>
7992: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
7993: <dd><p>This stage should only be used for substitutions that are
7994: clearly related to building the package, not for fixing the
7995: configuration. Substitutions for pathnames (such as replacing
7996: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
7997: user names (such as replacing <code class="literal">@MY_USER@</code> with the
7998: actual username) belong in pre-configure or post-configure
7999: instead.</p></dd>
8000: <dt><span class="term"><code class="literal">post-build</code></span></dt>
8001: <dd>
8002: <p>Just as with pre-build, this stage should only be used
8003: for substitutions that are clearly related to building the package, not
8004: for fixing the configuration. Substitutions for pathnames (such as
8005: replacing <code class="filename">/usr/local</code> with
8006: <code class="literal">${PREFIX}</code>) or user names (such as replacing
8007: <code class="literal">@MY_USER@</code> with the actual username) belong in
8008: pre-configure or post-configure instead.</p>
8009: <p>A typical use is to update pkg-config files to include the rpath
8010: compiler options.</p>
8011: </dd>
8012: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8013: <dd><p>In general, the install phase should be as simple as
8014: possible. As with the pre-build and post-build stages, it should not be
8015: used to fix pathnames or user names, these belong in pre-configure
8016: instead. There are only few legitimate use cases for applying
8017: substitutions in this stage.</p></dd>
8018: </dl></div>
8019: </div>
8020: <div class="sect3">
8021: <div class="titlepage"><div><div><h4 class="title">
1.296 rillig 8022: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295 rillig 8023: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8024: filename patterns. These patterns are relative to
8025: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8026: A typical example is:</p>
8027: <pre class="programlisting">
8028: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8029: </pre>
8030: <p>The above patterns, especially the last, are quite broad. The SUBST
8031: implementation checks that each filename pattern that is mentioned here
8032: has an effect. For example, if none of the
8033: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8034: and substituted, that filename pattern is redundant and should be left
1.296 rillig 8035: out. By default, the SUBST framework will complain with an error message.
8036: If the text to be substituted occurs in some of the files from a single
8037: pattern, but not in all of them, that is totally ok, and the SUBST
1.295 rillig 8038: framework will only print an INFO message for those files.</p>
8039: <p>If there is a good reason for having redundant filename patterns,
1.296 rillig 8040: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295 rillig 8041: <p>Another popular way of choosing the files for the substitutions is
8042: via a shell command, like this:</p>
8043: <pre class="programlisting">
1.296 rillig 8044: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.295 rillig 8045: SUBST_FILES.path= ${C_FILES_CMD:sh}
8046: </pre>
8047: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8048: freely chosen and independent of the SUBST framework.</p>
8049: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8050: lists each file individually. Thereby chances are higher that there are
8051: filename patterns in which no substitution happens. Since the SUBST
8052: framework cannot know whether the filename patterns in
8053: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8054: Makefile (where any redundant filename pattern would be suspicious) or
8055: been generated by a shell command (in which redundant filename patterns
8056: are more likely and to be expected), it will complain about these
8057: redundant filename patterns. Therefore, SUBST blocks that use a shell
8058: command to generate the list of filename patterns often need to set
8059: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8060: </div>
8061: <div class="sect3">
8062: <div class="titlepage"><div><div><h4 class="title">
8063: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8064: <p>In most cases, the substitutions are given using one or more
1.322 leot 8065: <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 8066: <pre class="programlisting">
8067: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8068: </pre>
8069: <p>Each of the sed commands needs to be preceded by the
8070: <code class="literal">-e</code> option and should be specified on a line of its
8071: own, to avoid hiding short sed commands at the end of a line.</p>
8072: <p>Since the sed commands often contain shell metacharacters as the
8073: separator (the <code class="literal">|</code> in the above example), it is common
8074: to enclose them in single quotes.</p>
8075: <p>A common substitution is to replace placeholders of the form
8076: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8077: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8078: <pre class="programlisting">
8079: SUBST_VARS.path= PREFIX
8080: </pre>
8081: <p>This type of substitutions is typically done by the GNU configure
1.296 rillig 8082: scripts during the do-configure stage, but in some cases these need to be
8083: overridden. The same pattern is also used when a package defines patches
8084: that replace previously hard-coded paths like
8085: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8086: placeholder first, which then gets substituted by the actual
8087: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8088: cases, it works equally well to just use the SUBST framework to directly
8089: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8090: thereby omitting the intermediate patch file.</p>
1.295 rillig 8091: <p>If the above is not flexible enough, it is possible to not use sed
8092: at all for the substitution but to specify an entirely different command,
8093: like this:</p>
1.87 wiz 8094: <pre class="programlisting">
1.295 rillig 8095: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8096: </pre>
8097: <p>This is used for the few remaining packages in which the
8098: distributed files use Windows-style line endings that need to be
8099: converted to UNIX-style line endings.</p>
8100: </div>
8101: <div class="sect3">
8102: <div class="titlepage"><div><div><h4 class="title">
8103: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8104: <p>When a SUBST block is applied during a package build, a message is
8105: logged. The default message is fine for most purposes but can be
8106: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8107: message.</p>
8108: </div>
1.79 rillig 8109: </div>
1.75 rillig 8110: </div>
1.148 asau 8111: <div class="sect1">
1.75 rillig 8112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8113: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 8114: <div class="sect2">
1.75 rillig 8115: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8116: <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 8117: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8118: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8119: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8120: with the name of each file to download as an argument, expecting
8121: it to output the URL of the directory from which to download
1.322 leot 8122: 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 8123: example of this usage.</p>
1.75 rillig 8124: <p>If the download can't be automated, because the user must
1.87 wiz 8125: submit personal information to apply for a password, or must pay
8126: for the source, or whatever, you can set
8127: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8128: displayed to the user before aborting the build. Example:</p>
8129: <pre class="programlisting">
1.100 rillig 8130: FETCH_MESSAGE= "Please download the files"
8131: FETCH_MESSAGE+= " "${DISTFILES:Q}
8132: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222 sevan 8133: </pre>
1.75 rillig 8134: </div>
1.148 asau 8135: <div class="sect2">
1.75 rillig 8136: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8137: <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 8138: <p>Sometimes authors of a software package make some
1.87 wiz 8139: modifications after the software was released, and they put up a
8140: new distfile without changing the package's version number. If a
8141: package is already in pkgsrc at that time, the checksum will
8142: no longer match. The contents of the new distfile should be
8143: compared against the old one before changing anything, to make
8144: sure the distfile was really updated on purpose, and that
8145: no trojan horse or so crept in.
1.97 rillig 8146: Please mention that the distfiles were compared and what was found
1.159 rodent 8147: in your commit message.</p>
1.220 wiz 8148: <p>Then, the correct way to work around this is to set
8149: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8150: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8151: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8152: a variable prefix). All <code class="varname">DISTFILES</code> and
1.93 rillig 8153: <code class="varname">PATCHFILES</code> for this package will be put in that
1.267 rillig 8154: 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 8155: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220 wiz 8156: including the <code class="filename">nbX</code> suffix) or a date stamp can
8157: be appended, like
8158: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284 rillig 8159: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8160: name does not contain a version and the distfile is apt to change. In
8161: cases where the likelihood of this is very small,
8162: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8163: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8164: distfile name changes, even if a package is being moved or
8165: renamed.</p>
1.159 rodent 8166: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8167: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8168: path in the filenames.
1.159 rodent 8169: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8170: Furthermore, a mail to the package's authors seems appropriate
8171: telling them that changing distfiles after releases without
8172: changing the file names is not good practice.</p>
1.75 rillig 8173: </div>
1.199 tnn 8174: <div class="sect2">
8175: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8176: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284 rillig 8177: <p>Helper methods exist for packages hosted on github.com which
8178: will often have distfile names that clash with other packages, for
8179: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8180: from below:</p>
1.199 tnn 8181: <div class="sect3">
8182: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8183: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284 rillig 8184: <p>If your distfile URL looks similar to
1.303 bacon 8185: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284 rillig 8186: then you are packaging a tagged release.</p>
1.199 tnn 8187: <pre class="programlisting">
1.303 bacon 8188: DISTNAME= example-1.0
1.200 tnn 8189: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8190: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8191: GITHUB_TAG= v${PKGVERSION_NOREV}
1.199 tnn 8192: EXTRACT_SUFX= .zip
8193: </pre>
8194: </div>
8195: <div class="sect3">
8196: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8197: <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>
8198: <p>If your distfile looks similar to
8199: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8200: release, then set the package version to 0.0.0.N, where N is the number
8201: of commits to the repository, and set GITHUB_TAG to the commit hash.
8202: This will (almost) ensure that the first tagged release will have a
8203: version greater than this one so that package upgrades will function
8204: properly.</p>
8205: <pre class="programlisting">
8206: DISTNAME= example-0.0.0.347
8207: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8208: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8209: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8210: </pre>
8211: </div>
8212: <div class="sect3">
8213: <div class="titlepage"><div><div><h4 class="title">
8214: <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>
8215: <p>If your distfile looks similar to
8216: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8217: then include the last release version and the commit count since that
8218: release in the package version and set GITHUB_TAG to the commit hash.
8219: The latest release and commit count are shown in the output of
8220: "git describe --tags":
8221: </p>
8222: <pre class="screen">
8223: # git clone https://github.com/username/example
8224: # cd example
8225: # git describe --tags
8226: 1.2.3-5-g988881a
8227: </pre>
1.199 tnn 8228: <pre class="programlisting">
1.303 bacon 8229: DISTNAME= example-1.2.3.5
8230: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8231: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8232: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222 sevan 8233: </pre>
1.199 tnn 8234: </div>
8235: <div class="sect3">
8236: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8237: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284 rillig 8238: <p>If your distfile URL looks similar to
1.303 bacon 8239: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284 rillig 8240: then you are packaging a release.</p>
1.199 tnn 8241: <pre class="programlisting">
8242: DISTNAME= offensive-1.6
1.200 tnn 8243: PKGNAME= ${DISTNAME:S/offensive/proper/}
8244: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8245: GITHUB_PROJECT= example
1.200 tnn 8246: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8247: EXTRACT_SUFX= .zip
1.222 sevan 8248: </pre>
1.199 tnn 8249: </div>
8250: </div>
1.75 rillig 8251: </div>
1.148 asau 8252: <div class="sect1">
1.75 rillig 8253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8254: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 8255: <div class="sect2">
1.75 rillig 8256: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8257: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8258: <p>pkgsrc supports many different machines, with different
1.87 wiz 8259: object formats like a.out and ELF, and varying abilities to do
8260: shared library and dynamic loading at all. To accompany this,
8261: varying commands and options have to be passed to the
8262: compiler, linker, etc. to get the Right Thing, which can be
8263: pretty annoying especially if you don't have all the machines
8264: at your hand to test things. The
1.322 leot 8265: <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 8266: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8267: both static and dynamic libraries from a set of source files,
8268: thus being platform-independent.</p>
8269: <p>Here's how to use libtool in a package in seven simple
8270: steps:</p>
1.128 wiz 8271: <div class="orderedlist"><ol class="orderedlist" type="1">
8272: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8273: Makefile.</p></li>
1.128 wiz 8274: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8275: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8276: add it to the definition of <code class="varname">CC</code>, if only
8277: libraries are being built in a given Makefile. This one command
8278: will build both PIC and non-PIC library objects, so you need not
8279: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8280: <li class="listitem">
1.75 rillig 8281: <p>For the linking of the library, remove any
1.128 wiz 8282: <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
8283: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8284: <pre class="programlisting">
1.100 rillig 8285: ${LIBTOOL} --mode=link \
8286: ${CC} -o ${.TARGET:.a=.la} \
8287: ${OBJS:.o=.lo} \
8288: -rpath ${PREFIX}/lib \
8289: -version-info major:minor
1.222 sevan 8290: </pre>
1.75 rillig 8291: <p>Note that the library is changed to have a
1.87 wiz 8292: <code class="filename">.la</code> extension, and the objects are
8293: changed to have a <code class="filename">.lo</code>
8294: extension. Change <code class="varname">OBJS</code> as
8295: necessary. This automatically creates all of the
8296: <code class="filename">.a</code>,
8297: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8298: necessary) in the build directory. Be sure to include
1.128 wiz 8299: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8300: minor are zero, as libtool will otherwise strip off the
8301: shared library version.</p>
1.75 rillig 8302: <p>From the libtool manual:</p>
8303: <pre class="programlisting">
1.100 rillig 8304: So, libtool library versions are described by three integers:
1.69 rillig 8305:
1.100 rillig 8306: CURRENT
8307: The most recent interface number that this library implements.
1.69 rillig 8308:
1.100 rillig 8309: REVISION
8310: The implementation number of the CURRENT interface.
1.69 rillig 8311:
1.100 rillig 8312: AGE
8313: The difference between the newest and oldest interfaces that
8314: this library implements. In other words, the library implements
8315: all the interface numbers in the range from number `CURRENT -
8316: AGE' to `CURRENT'.
1.1 grant 8317:
1.100 rillig 8318: If two libraries have identical CURRENT and AGE numbers, then the
8319: dynamic linker chooses the library with the greater REVISION number.
1.222 sevan 8320: </pre>
1.128 wiz 8321: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8322: different results for a.out and ELF (excluding symlinks)
8323: in only one case. An ELF library of the form
1.128 wiz 8324: <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 8325: will have a symlink of
1.128 wiz 8326: <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 8327: on an a.out platform. This is handled
8328: automatically.</p>
1.128 wiz 8329: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8330: directory of the library being built.</p>
1.76 rillig 8331: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8332: <code class="filename">.la</code> file, the other files will be
8333: added automatically.</p>
1.75 rillig 8334: </li>
1.128 wiz 8335: <li class="listitem">
1.76 rillig 8336: <p>When linking shared object (<code class="filename">.so</code>)
1.322 leot 8337: 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 8338: shared libraries, use <span class="quote">“<span class="quote">-module
8339: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8340: tacked on.</p>
1.76 rillig 8341: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8342: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8343: </li>
1.128 wiz 8344: <li class="listitem">
1.75 rillig 8345: <p>When linking programs that depend on these libraries
1.87 wiz 8346: <span class="emphasis"><em>before</em></span> they are installed, preface
1.322 leot 8347: 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 8348: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8349: libraries (static or shared), but please be aware that
8350: libtool will not allow you to specify a relative path in
1.128 wiz 8351: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8352: expects you to change that argument to be the
8353: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8354: <pre class="programlisting">
1.100 rillig 8355: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222 sevan 8356: </pre>
1.75 rillig 8357: <p>should be changed to:</p>
8358: <pre class="programlisting">
1.100 rillig 8359: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222 sevan 8360: </pre>
1.75 rillig 8361: <p>and it will do the right thing with the libraries.</p>
8362: </li>
1.128 wiz 8363: <li class="listitem">
1.322 leot 8364: <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>
8365: 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 8366: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8367: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8368: <pre class="programlisting">
1.126 jakllsch 8369: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222 sevan 8370: </pre>
1.76 rillig 8371: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8372: shared library, any needed symlinks, and run
1.322 leot 8373: <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 8374: </li>
1.128 wiz 8375: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8376: the <code class="filename">.la</code>
8377: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8378: </ol></div>
8379: </div>
1.148 asau 8380: <div class="sect2">
1.75 rillig 8381: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8382: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8383: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8384: package Makefile. This will override the package's own libtool
8385: in most cases. For older libtool using packages, libtool is
8386: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8387: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8388: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8389: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8390: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8391: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8392: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8393: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8394: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8395: libraries built and installed, then use
8396: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8397: <p>If your package makes use of the platform-independent library
1.87 wiz 8398: for loading dynamic shared objects, that comes with libtool
8399: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8400: <p>Some packages use libtool incorrectly so that the package
8401: may not work or build in some circumstances. Some of the more
8402: common errors are:</p>
1.148 asau 8403: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8404: <li class="listitem">
1.75 rillig 8405: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8406: executable or library. This in itself isn't a problem if one of two things
8407: has been done:</p>
1.128 wiz 8408: <div class="orderedlist"><ol class="orderedlist" type="1">
8409: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8410: <code class="filename">libfoo.la</code>, not
8411: <code class="filename">foo.la</code></p></li>
1.128 wiz 8412: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8413: </ol></div>
8414: </li>
1.128 wiz 8415: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8416: The function lt_dlinit() should be called and the macro
8417: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8418: executables.</p></li>
1.75 rillig 8419: </ul></div>
8420: </div>
1.148 asau 8421: <div class="sect2">
1.75 rillig 8422: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8423: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8424: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8425: to regenerate the configure script and Makefile.in makefile
8426: templates, then they should be executed in a pre-configure
8427: target.</p>
1.75 rillig 8428: <p>For packages that need only autoconf:</p>
8429: <pre class="programlisting">
1.100 rillig 8430: AUTOCONF_REQD= 2.50 # if default version is not good enough
8431: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8432: ...
1.1 grant 8433:
1.100 rillig 8434: pre-configure:
8435: cd ${WRKSRC} && autoconf
1.1 grant 8436:
1.100 rillig 8437: ...
1.222 sevan 8438: </pre>
1.75 rillig 8439: <p>and for packages that need automake and autoconf:</p>
8440: <pre class="programlisting">
1.100 rillig 8441: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8442: USE_TOOLS+= automake # use "automake14" for automake-1.4
8443: ...
8444:
8445: pre-configure:
8446: set -e; cd ${WRKSRC}; \
8447: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8448:
1.100 rillig 8449: ...
1.222 sevan 8450: </pre>
1.75 rillig 8451: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8452: require GNU Make.</p>
1.75 rillig 8453: <p>There are times when the configure process makes
1.87 wiz 8454: additional changes to the generated files, which then causes
8455: the build process to try to re-execute the automake sequence.
8456: This is prevented by touching various files in the configure
8457: stage. If this causes problems with your package you can set
8458: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8459: Makefile.</p>
1.75 rillig 8460: </div>
8461: </div>
1.148 asau 8462: <div class="sect1">
1.75 rillig 8463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8464: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148 asau 8465: <div class="sect2">
1.87 wiz 8466: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8467: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8468: <p>Compilers for the C, C++, and Fortran languages comes with
8469: the NetBSD base system. By default, pkgsrc assumes that a package
8470: is written in C and will hide all other compilers (via the wrapper
1.299 rillig 8471: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8472: <p>To declare which language's compiler a package needs, set
8473: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.327 wiz 8474: currently are:
8475: </p>
8476: <pre class="programlisting">
8477: c99, c++, c++03, gnu++03, c++0x, gnu++0x, c++11, gnu++11,
8478: c++14, gnu++14, c++17, gnu++17, c++20, gnu++20, fortran,
8479: fortran77, java, objc, obj-c++, and ada.
8480: </pre>
8481: <p>
8482: (and any combination). The default is
1.128 wiz 8483: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8484: written in C++, usually need a C compiler for the configure
8485: phase.</p>
8486: </div>
1.148 asau 8487: <div class="sect2">
1.87 wiz 8488: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8489: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87 wiz 8490: <p>If a program is written in Java, use the Java framework in
8491: pkgsrc. The package must include
8492: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8493: provides the following variables:</p>
1.148 asau 8494: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8495: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8496: dependency on the JDK is added. If
1.128 wiz 8497: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8498: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8499: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8500: JDK.</p></li>
1.128 wiz 8501: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8502: a package needs a Java2 implementation. The supported values
1.128 wiz 8503: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8504: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8505: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8506: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8507: above. This variable is not set by default.</p></li>
1.130 wiz 8508: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8509: automatically set to the runtime location of the used Java
8510: implementation dependency. It may be used to set
8511: <code class="varname">JAVA_HOME</code> to a good value if the program
8512: needs this variable to be defined.
8513: </p></li>
1.87 wiz 8514: </ul></div>
8515: </div>
1.148 asau 8516: <div class="sect2">
1.87 wiz 8517: <div class="titlepage"><div><div><h3 class="title">
1.320 wiz 8518: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
8519: <p>If a program is written in Go and has any dependencies on
8520: other Go modules, have the package include
8521: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8522: <div class="orderedlist"><ol class="orderedlist" type="1">
8523: <li class="listitem"><p>Generate a list of those dependencies with
8524: <span class="command"><strong>make clean && make patch && make show-go-modules >
8525: go-modules.mk</strong></span>.</p></li>
8526: <li class="listitem">
8527: <p>Prepend </p>
8528: <pre class="programlisting">.include
8529: "go-modules.mk"</pre>
8530: <p> to any other
8531: </p>
8532: <pre class="programlisting">.include</pre>
8533: <p>s.</p>
8534: </li>
8535: <li class="listitem"><p>Incorporate these modules in
8536: <code class="filename">distinfo</code> with <span class="command"><strong>make
8537: makesum</strong></span>.</p></li>
8538: </ol></div>
8539: </div>
8540: <div class="sect2">
8541: <div class="titlepage"><div><div><h3 class="title">
8542: <a name="perl-scripts"></a>21.4.4. Packages containing Perl scripts</h3></div></div></div>
1.318 nia 8543: <p>If your package contains interpreted Perl scripts, add
1.128 wiz 8544: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8545: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8546: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8547: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8548: that you want adjusted. Every occurrence of
8549: <code class="filename">*/bin/perl</code> in a she-bang line will be
1.325 gutterid 8550: replaced with the full path to the Perl executable.</p>
8551: <p>If a particular version of Perl is needed, set the
1.87 wiz 8552: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8553: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.318 nia 8554: <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 8555: about handling Perl modules.</p>
8556: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
8557: for the language now known as Raku.</p>
1.87 wiz 8558: </div>
1.148 asau 8559: <div class="sect2">
1.87 wiz 8560: <div class="titlepage"><div><div><h3 class="title">
1.320 wiz 8561: <a name="shell-scripts"></a>21.4.5. Packages containing shell scripts</h3></div></div></div>
1.147 wiz 8562: <p><code class="varname">REPLACE_SH</code>,
8563: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8564: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.309 gutterid 8565: hash bangs in files. Please use the appropriate one, preferring
1.147 wiz 8566: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183 wiz 8567: Each should contain a list of scripts, relative to
8568: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8569: occurrence of the matching shell in a she-bang line will be
8570: replaced with the full path to the shell executable.
1.147 wiz 8571: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8572: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8573: </div>
1.148 asau 8574: <div class="sect2">
1.147 wiz 8575: <div class="titlepage"><div><div><h3 class="title">
1.320 wiz 8576: <a name="other-programming-languages"></a>21.4.6. Other programming languages</h3></div></div></div>
1.325 gutterid 8577: <p>There are further similar REPLACE variables available, e.g.,
8578: <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
8579: and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.326 gutterid 8580: noted above, have their actions defined centrally in
1.325 gutterid 8581: <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.326 gutterid 8582: languages define the actions of these variables within their own
8583: dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
8584: actioned in <code class="filename">lang/php/phpversion.mk</code>, and
8585: <code class="varname">REPLACE_PYTHON</code> is actioned in
1.325 gutterid 8586: <code class="filename">lang/python/application.mk</code>. For other languages,
8587: consult the mk files found within their specific directories (the
1.331 gutterid 8588: naming convention varies), or check the list found in
8589: <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.325 gutterid 8590: <p>Currently, special handling for other languages varies
1.87 wiz 8591: in pkgsrc. If a compiler package provides a
8592: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8593: just add a (build) dependency on the appropriate compiler
8594: package.</p>
8595: </div>
8596: </div>
1.148 asau 8597: <div class="sect1">
1.87 wiz 8598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8599: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8600: <p>The most common failures when building a package are that
8601: some platforms do not provide certain header files, functions or
8602: libraries, or they provide the functions in a library that the
8603: original package author didn't know. To work around this, you
8604: can rewrite the source code in most cases so that it does not
8605: use the missing functions or provides a replacement function.</p>
1.148 asau 8606: <div class="sect2">
1.77 rillig 8607: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8608: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8609: <p>If a package already comes with a GNU configure script, the
8610: preferred way to fix the build failure is to change the
8611: configure script, not the code. In the other cases, you can
8612: utilize the C preprocessor, which defines certain macros
8613: depending on the operating system and hardware architecture it
8614: compiles for. These macros can be queried using for example
8615: <code class="varname">#if defined(__i386)</code>. Almost every operating
8616: system, hardware architecture and compiler has its own macro.
8617: For example, if the macros <code class="varname">__GNUC__</code>,
8618: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8619: are all defined, you know that you are using NetBSD on an i386
8620: compatible CPU, and your compiler is GCC.</p>
8621: <p>The list of the following macros for hardware and
8622: operating system depends on the compiler that is used. For
8623: example, if you want to conditionally compile code on Solaris,
8624: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8625: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8626: <div class="sect3">
1.75 rillig 8627: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8628: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75 rillig 8629: <p>To distinguish between 4.4 BSD-derived systems and the
8630: rest of the world, you should use the following code.</p>
8631: <pre class="programlisting">
1.100 rillig 8632: #include <sys/param.h>
8633: #if (defined(BSD) && BSD >= 199306)
8634: /* BSD-specific code goes here */
8635: #else
8636: /* non-BSD-specific code goes here */
8637: #endif
1.75 rillig 8638: </pre>
1.77 rillig 8639: <p>If this distinction is not fine enough, you can also test
8640: for the following macros.</p>
1.75 rillig 8641: <pre class="programlisting">
1.151 obache 8642: Cygwin __CYGWIN__
8643: DragonFly __DragonFly__
1.100 rillig 8644: FreeBSD __FreeBSD__
1.151 obache 8645: Haiku __HAIKU__
1.100 rillig 8646: Interix __INTERIX
8647: IRIX __sgi (TODO: get a definite source for this)
8648: Linux linux, __linux, __linux__
1.193 dholland 8649: Mac OS X __APPLE__
1.151 obache 8650: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8651: Minix3 __minix
1.100 rillig 8652: NetBSD __NetBSD__
8653: OpenBSD __OpenBSD__
8654: Solaris sun, __sun
1.75 rillig 8655: </pre>
8656: </div>
1.148 asau 8657: <div class="sect3">
1.75 rillig 8658: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8659: <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 8660: <pre class="programlisting">
1.100 rillig 8661: i386 i386, __i386, __i386__
8662: MIPS __mips
8663: SPARC sparc, __sparc
1.75 rillig 8664: </pre>
8665: </div>
1.148 asau 8666: <div class="sect3">
1.75 rillig 8667: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8668: <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 8669: <pre class="programlisting">
1.100 rillig 8670: GCC __GNUC__ (major version), __GNUC_MINOR__
8671: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8672: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8673: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8674: </pre>
8675: </div>
8676: </div>
1.148 asau 8677: <div class="sect2">
1.78 rillig 8678: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8679: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8680: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8681: combinations of compiler version and architecture and almost
8682: always relation to optimisation being enabled. Common symptoms
8683: are gcc internal errors or never finishing compiling a
1.78 rillig 8684: file.</p>
8685: <p>Typically, a workaround involves testing the
8686: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8687: optimisation for that combination of file,
1.198 tnn 8688: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8689: <p>This used to be a big problem in the past, but is rarely
8690: needed now as compiler technology has matured. If you still need
8691: to add a compiler specific workaround, please do so in the file
8692: <code class="filename">hacks.mk</code> and describe the symptom and
8693: compiler version as detailed as possible.</p>
1.78 rillig 8694: </div>
1.148 asau 8695: <div class="sect2">
1.78 rillig 8696: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 8697: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8698: <p>Compilation sometimes fails with an error message like this:</p>
8699: <pre class="programlisting">
8700: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8701: fatal error: pango/pango.h: No such file or directory
8702: </pre>
8703: <p>The proper way to fix this problem depends on the type of the
8704: header, which is described in the following sections.</p>
8705: <div class="sect3">
8706: <div class="titlepage"><div><div><h4 class="title">
8707: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8708: <p>If the header name looks like it comes from a different package,
8709: that other package should be included via the buildlink3
8710: framework.</p>
8711: <p>First, look whether the header is somewhere in the buildlink3
8712: directory below <code class="varname">WRKDIR</code>. In the above case of
8713: the missing Pango header:</p>
8714: <pre class="programlisting">
8715: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8716: </pre>
8717: <p>In the case of Pango, the output is:</p>
8718: <pre class="programlisting">
8719: work/.buildlink/include/pango-1.0/pango/pango.h
8720: </pre>
8721: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8722: in the <code class="filename">.buildlink</code> directory, it would have been
8723: found automatically. There is an extra <code class="filename">pango-1.0</code>
8724: path component though, which means that the compiler command line must
8725: contain an option of the form
8726: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8727: most cases this option is generated by the configure script, which can be examined using:</p>
8728: <pre class="programlisting">
8729: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8730: -I/usr/pkg/include/pango-1.0
8731: -I/usr/pkg/include/pango-1.0
8732: -I/usr/pkg/include/pango-1.0
8733: -I/usr/pkg/include/pango-1.0
8734: -I/usr/pkg/include/pango-1.0
8735: </pre>
8736: <p>This looks good. These options are transformed by the buildlink
8737: wrapper to refer to the correct path inside
8738: <code class="filename">work/.buildlink</code>.</p>
8739: <p>Since the compilation fails though, examine the compiler command
8740: lines in <code class="filename">work/.work.log</code> to see whether the
8741: <code class="literal">-I</code> option is included in the particular command
8742: line.</p>
8743: <p>To further analyze the situation, run <span class="command"><strong>bmake
8744: build-env</strong></span>, which sets up an interactive, realistic environment
8745: including all the pkgsrc wrapper commands and environment variables. From
8746: there, try to compile some simple example programs that use the
8747: header.</p>
8748: </div>
8749: <div class="sect3">
8750: <div class="titlepage"><div><div><h4 class="title">
8751: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8752: <p>If the name of the header seems to come from the package itself,
8753: and if the build is run with parallel jobs, the package may have some
8754: undeclared dependencies between the <code class="filename">.c</code> and the
8755: <code class="filename">.h</code> files, and a C file is compiled before its
8756: required header is generated.</p>
8757: <p>To see whether the build runs with parallel jobs, run
8758: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8759: like this:</p>
8760: <pre class="programlisting">
8761: usr MAKE_JOBS= 7
8762: pkg MAKE_JOBS_SAFE # undefined
8763: def _MAKE_JOBS_N= 7
8764: </pre>
8765: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8766: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8767: package could have disabled parallel builds by setting
8768: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8769: in this case it hasn't.</p>
8770: <p>To see whether the build failure is caused by parallel builds,
8771: first save the exact error message and a bit of context, maybe you need
8772: it later for reporting a bug. Next, run:</p>
8773: <pre class="programlisting">
8774: MAKE_JOBS_SAFE=no bmake clean build
8775: </pre>
8776: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8777: report</a> against the pkgsrc package, including the exact error
8778: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8779: </div>
1.288 rillig 8780: <div class="sect3">
8781: <div class="titlepage"><div><div><h4 class="title">
8782: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
8783: <p>Pkgsrc does not work reliably if any of
8784: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
8785: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
8786: bootstrap program prevents installing pkgsrc in symlink-based
8787: directories. Existing pkgsrc installations are not checked for symlinks
8788: though.</p>
8789: <p>The "No such file or directory" error messages are a typical
8790: symptom of symlinks, and it's quite difficult to find out that this is
8791: the actual cause.</p>
8792: </div>
8793: <div class="sect3">
8794: <div class="titlepage"><div><div><h4 class="title">
8795: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
8796: <p>When building a hierarchy of packages, it may happen that one
8797: package is built and then pkgsrc is updated. This situation can provoke
8798: various hard to diagnose build errors. To clean up the situation:</p>
8799: <pre class="programlisting">
8800: <code class="prompt">$</code> (cd ../../ && test -f mk/bsd.pkg.mk && rm -rf */*/work)
8801: </pre>
8802: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
8803: this command in the wrong directory.)</p>
8804: <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
8805: that directory as well.</p>
8806: </div>
8807: <div class="sect3">
8808: <div class="titlepage"><div><div><h4 class="title">
8809: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
8810: <p>On platforms other than BSD, third-party packages are installed in
8811: <code class="filename">/usr/include</code>, together with the base system. This
8812: means that pkgsrc cannot distinguish between headers provided by the base
8813: system (which it needs) and headers from third-party packages (which are
8814: often included in pkgsrc as well). This can lead to subtle version
8815: mismatches.</p>
8816: <p>In pkgsrc installations that have been active for several years, it
8817: may happen that some files are manually deleted. To exclude this unlikely
8818: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
8819: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
8820: check/fix dependencies.</p>
8821: <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>
8822: for contact information. Be prepared to describe what you have tried so
8823: far and what any error messages were.</p>
8824: </div>
1.287 rillig 8825: </div>
8826: <div class="sect2">
8827: <div class="titlepage"><div><div><h3 class="title">
8828: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.128 wiz 8829: </h3></div></div></div>
1.92 rillig 8830: <p>This error message often means that a package did not
1.78 rillig 8831: link to a shared library it needs. The following functions are
8832: known to cause this error message over and over.</p>
8833: <div class="informaltable">
1.216 tnn 8834: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78 rillig 8835: <colgroup>
8836: <col>
8837: <col>
8838: <col>
8839: </colgroup>
8840: <thead><tr>
8841: <th>Function</th>
8842: <th>Library</th>
8843: <th>Affected platforms</th>
8844: </tr></thead>
8845: <tbody>
8846: <tr>
8847: <td>accept, bind, connect</td>
8848: <td>-lsocket</td>
8849: <td>Solaris</td>
8850: </tr>
8851: <tr>
8852: <td>crypt</td>
8853: <td>-lcrypt</td>
8854: <td>DragonFly, NetBSD</td>
8855: </tr>
8856: <tr>
8857: <td>dlopen, dlsym</td>
8858: <td>-ldl</td>
8859: <td>Linux</td>
8860: </tr>
8861: <tr>
8862: <td>gethost*</td>
8863: <td>-lnsl</td>
8864: <td>Solaris</td>
8865: </tr>
8866: <tr>
8867: <td>inet_aton</td>
8868: <td>-lresolv</td>
8869: <td>Solaris</td>
8870: </tr>
8871: <tr>
8872: <td>nanosleep, sem_*, timer_*</td>
8873: <td>-lrt</td>
8874: <td>Solaris</td>
8875: </tr>
8876: <tr>
8877: <td>openpty</td>
8878: <td>-lutil</td>
8879: <td>Linux</td>
8880: </tr>
8881: </tbody>
8882: </table>
8883: </div>
8884: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8885: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8886: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8887: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8888: bmake</strong></span>.</p>
1.148 asau 8889: <div class="sect3">
1.92 rillig 8890: <div class="titlepage"><div><div><h4 class="title">
1.287 rillig 8891: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8892: <p>When you are using the SunPro compiler, there is another
8893: possibility. That compiler cannot handle the following code:</p>
8894: <pre class="programlisting">
1.100 rillig 8895: extern int extern_func(int);
1.93 rillig 8896:
1.100 rillig 8897: static inline int
8898: inline_func(int x)
8899: {
1.92 rillig 8900: return extern_func(x);
1.100 rillig 8901: }
1.93 rillig 8902:
1.100 rillig 8903: int main(void)
8904: {
1.92 rillig 8905: return 0;
1.100 rillig 8906: }
1.92 rillig 8907: </pre>
8908: <p>It generates the code for <code class="function">inline_func</code> even if
8909: that function is never used. This code then refers to
8910: <code class="function">extern_func</code>, which can usually not be resolved. To
8911: solve this problem you can try to tell the package to disable inlining
8912: of functions.</p>
8913: </div>
1.87 wiz 8914: </div>
1.148 asau 8915: <div class="sect2">
1.87 wiz 8916: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 8917: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87 wiz 8918: <p>Sometimes packages fail to build because the compiler runs
8919: into an operating system specific soft limit. With the
8920: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204 wiz 8921: to unlimit the resources. Currently, the allowed values are any combination of
8922: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8923: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.87 wiz 8924: Setting this variable is similar to running the shell builtin
1.110 hubertf 8925: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8926: segment size or maximum stack size of a process, respectively, to
8927: their hard limits.</p>
1.78 rillig 8928: </div>
1.75 rillig 8929: </div>
1.148 asau 8930: <div class="sect1">
1.75 rillig 8931: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8932: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 8933: <div class="sect2">
1.75 rillig 8934: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8935: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8936: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8937: with some operating systems cannot create more than one
8938: directory at a time. As such, you should call
8939: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8940: <pre class="programlisting">
1.100 rillig 8941: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8942: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222 sevan 8943: </pre>
1.128 wiz 8944: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8945: dir2</code></span>”</span> to the
1.87 wiz 8946: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8947: automatically do the right thing.</p>
1.75 rillig 8948: </div>
1.148 asau 8949: <div class="sect2">
1.75 rillig 8950: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8951: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8952: <p>In general, documentation should be installed into
1.87 wiz 8953: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8954: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8955: includes the version number of the package).</p>
1.84 wiz 8956: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8957: directory where HTML documentation is installed with the
1.128 wiz 8958: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8959: is needed because otherwise the documentation ends up in
8960: <code class="filename">${PREFIX}/share/doc/html</code> or other
8961: places.</p>
8962: <p>An exception to the above is that library API documentation
1.322 leot 8963: 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 8964: browsers (devhelp) should be left at their default location, which
8965: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8966: documentation can be recognized from files ending in
8967: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8968: (It is also acceptable to install such files in
8969: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8970: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8971: <code class="filename">.devhelp*</code> file must be directly in that
8972: directory then, no additional subdirectory level is allowed in
8973: this case. This is usually achieved by using
1.128 wiz 8974: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8975: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8976: though.)</p>
1.75 rillig 8977: </div>
1.148 asau 8978: <div class="sect2">
1.75 rillig 8979: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8980: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8981: <p>Certain packages, most of them in the games category, install
1.87 wiz 8982: a score file that allows all users on the system to record their
8983: highscores. In order for this to work, the binaries need to be
8984: installed setgid and the score files owned by the appropriate
1.142 wiz 8985: group and/or owner (traditionally the "games" user/group). Set
8986: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8987: following variables, documented in more detail in
8988: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 8989: behaviour: <code class="varname">GAMEDATAMODE</code>,
8990: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210 leot 8991: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8992: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8993: <code class="varname">GAMEDATA_PERMS</code> and
8994: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8995: <p>An example that illustrates some of the variables described above is
8996: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8997: used to properly set directory permissions of the directory where the
8998: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8999: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
9000: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
9001: binary:</p>
9002: <pre class="programlisting">
1.223 rillig 9003: USE_GAMESGROUP= yes
1.210 leot 9004:
1.223 rillig 9005: BUILD_DEFS+= VARBASE
1.210 leot 9006:
1.223 rillig 9007: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
9008: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
9009: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222 sevan 9010: </pre>
1.210 leot 9011: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
9012: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
9013: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
9014: needed to be accessed by setgid games and
9015: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114 jmcneill 9016: <p>A package should therefore never hard code file ownership or
1.210 leot 9017: access permissions but rely on <code class="varname">*_PERMS</code> as described above
9018: or alternatively on <code class="varname">INSTALL_GAME</code>,
9019: <code class="varname">INSTALL_GAME_DATA</code> and
9020: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75 rillig 9021: </div>
1.148 asau 9022: <div class="sect2">
1.75 rillig 9023: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9024: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 9025: <p><code class="varname">DESTDIR</code> support means that a package
9026: installs into a staging directory, not the final location of the
9027: files. Then a binary package is created which can be used for
9028: installation as usual. There are two ways: Either the package must
1.128 wiz 9029: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9030: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 9031: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9032: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224 leot 9033: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
9034: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145 wiz 9035: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9036: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 9037: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9038: the inclusion.</p></li>
1.128 wiz 9039: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 9040: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 9041: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 9042: automatically. Many manual rules and pre/post-install often are
9043: incorrect; fix them.</p></li>
1.128 wiz 9044: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 9045: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 9046: <li class="listitem"><p>In general, packages should support
1.103 wiz 9047: <code class="varname">UNPRIVILEGED</code> to be able to use
9048: DESTDIR.</p></li>
9049: </ul></div>
9050: </div>
1.148 asau 9051: <div class="sect2">
1.103 wiz 9052: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9053: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 9054: <p>Your package may also contain scripts with hardcoded paths to
1.318 nia 9055: other interpreters besides (or as well as) Perl. To correct the
1.87 wiz 9056: full pathname to the script interpreter, you need to set the
9057: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 9058: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 9059: <pre class="programlisting">
1.100 rillig 9060: REPLACE_INTERPRETER+= tcl
9061: REPLACE.tcl.old= .*/bin/tclsh
9062: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9063: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9064: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222 sevan 9065: </pre>
1.148 asau 9066: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9067: <h3 class="title">Note</h3>
9068: <p>Before March 2006, these variables were called
1.87 wiz 9069: <code class="varname">_REPLACE.*</code> and
9070: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 9071: </div>
9072: </div>
1.148 asau 9073: <div class="sect2">
1.75 rillig 9074: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9075: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.75 rillig 9076: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 9077: the Makefile fragment
9078: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 9079: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 9080: configuration for such modules as well as various hooks to tune
9081: this configuration. See comments in this file for
9082: details.</p>
1.75 rillig 9083: <p>Perl5 modules will install into different places depending
1.87 wiz 9084: on the version of perl used during the build process. To
9085: address this, pkgsrc will append lines to the
9086: <code class="filename">PLIST</code> corresponding to the files listed in
9087: the installed <code class="filename">.packlist</code> file generated by
9088: most perl5 modules. This is invoked by defining
9089: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 9090: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9091: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9092: e.g.:</p>
1.75 rillig 9093: <pre class="programlisting">
1.153 wiz 9094: PERL5_PACKLIST= auto/Pg/.packlist
1.222 sevan 9095: </pre>
1.153 wiz 9096: <p>The perl5 config variables
9097: <code class="varname">installarchlib</code>,
9098: <code class="varname">installscript</code>,
9099: <code class="varname">installvendorbin</code>,
9100: <code class="varname">installvendorscript</code>,
9101: <code class="varname">installvendorarch</code>,
9102: <code class="varname">installvendorlib</code>,
9103: <code class="varname">installvendorman1dir</code>, and
9104: <code class="varname">installvendorman3dir</code> represent those
9105: locations in which components of perl5 modules may be installed,
9106: provided as variable with uppercase and prefixed with
9107: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9108: and may be used by perl5 packages that don't have a packlist.
9109: These variables are also substituted for in the
9110: <code class="filename">PLIST</code> as uppercase prefixed with
9111: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 9112: </div>
1.148 asau 9113: <div class="sect2">
1.75 rillig 9114: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9115: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 9116: <p>Some packages install info files or use the
1.128 wiz 9117: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 9118: commands. <code class="varname">INFO_FILES</code> should be defined in
9119: the package Makefile so that <code class="filename">INSTALL</code> and
9120: <code class="filename">DEINSTALL</code> scripts will be generated to
9121: handle registration of the info files in the Info directory
1.128 wiz 9122: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 9123: files registration is either provided by the system, or by a
9124: special purpose package automatically added as dependency if
9125: needed.</p>
1.75 rillig 9126: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 9127: <code class="filename">${PREFIX}</code> where info files are primarily
9128: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 9129: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 9130: <p>The info files for the package should be listed in the
1.87 wiz 9131: package <code class="filename">PLIST</code>; however any split info files
9132: need not be listed.</p>
1.128 wiz 9133: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9134: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 9135: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 9136: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 9137: should be noted with the <code class="varname">TEXINFO_REQD</code>
9138: variable in the package <code class="filename">Makefile</code>. By
9139: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 9140: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 9141: does not match the required minimum, a build dependency on the
1.322 leot 9142: <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 9143: be added automatically.</p>
1.75 rillig 9144: <p>The build and installation process of the software provided
1.87 wiz 9145: by the package should not use the
1.110 hubertf 9146: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 9147: info files is the task of the package
9148: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 9149: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 9150: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 9151: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9152: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 9153: in <code class="varname">PATH</code>.</p>
1.110 hubertf 9154: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 9155: no effect except the logging of a message. The script overriding
1.110 hubertf 9156: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 9157: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 9158: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</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="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 9163: <p>All packages that install manual pages should install them
1.87 wiz 9164: into the same directory, so that there is one common place to look
9165: for them. In pkgsrc, this place is
9166: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9167: should be used in packages. The default for
9168: <code class="varname">PKGMANDIR</code> is
1.128 wiz 9169: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9170: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 9171: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9172: <h3 class="title">Note</h3>
1.87 wiz 9173: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9174: is far from complete.</p>
1.75 rillig 9175: </div>
1.81 rillig 9176: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 9177: <code class="filename">man/</code> as the top level directory for the man
9178: page file entries, and the pkgsrc framework will convert as
9179: needed. In all other places, the correct
9180: <code class="varname">PKGMANDIR</code> must be used.</p>
9181: <p>Packages that are
9182: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 9183: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 9184: <code class="filename">./configure</code>
9185: --mandir switch to set where the man pages should be installed.
9186: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9187: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9188: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9189: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 9190: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 9191: Or if the <code class="filename">./configure</code> script uses
9192: a non-standard use of --mandir, you can set
9193: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299 rillig 9194: <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 9195: information on installation of compressed manual pages.</p>
1.75 rillig 9196: </div>
1.148 asau 9197: <div class="sect2">
1.75 rillig 9198: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9199: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9200: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9201: the fonts database in the directory where they get installed at
9202: installation and deinstallation time. This can be automatically
9203: done by using the pkginstall framework.</p>
1.75 rillig 9204: <p>You can list the directories where fonts are installed in the
1.87 wiz 9205: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9206: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 9207: <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 9208: Also make sure that the database file
9209: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9210: <p>Note that you should not create new directories for fonts;
1.87 wiz 9211: instead use the standard ones to avoid that the user needs to
9212: manually configure his X server to find them.</p>
1.75 rillig 9213: </div>
1.148 asau 9214: <div class="sect2">
1.75 rillig 9215: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9216: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9217: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9218: registered in system-wide catalogs (like DTDs, sub-catalogs,
9219: etc.), you need to take some extra steps:</p>
1.128 wiz 9220: <div class="orderedlist"><ol class="orderedlist" type="1">
9221: <li class="listitem"><p>Include
1.87 wiz 9222: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9223: your <code class="filename">Makefile</code>, which takes care of
9224: registering those files in system-wide catalogs at
9225: installation and deinstallation time.</p></li>
1.128 wiz 9226: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9227: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9228: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9229: any XML catalogs installed by the package.</p></li>
1.128 wiz 9230: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9231: to be added to the SGML catalog. These come in groups of
9232: three strings; see xmlcatmgr(1) for more information
9233: (specifically, arguments recognized by the 'add' action).
9234: Note that you will normally not use this variable.</p></li>
1.128 wiz 9235: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9236: to be added to the XML catalog. These come in groups of three
9237: strings; see xmlcatmgr(1) for more information (specifically,
9238: arguments recognized by the 'add' action). Note that you will
9239: normally not use this variable.</p></li>
1.75 rillig 9240: </ol></div>
9241: </div>
1.148 asau 9242: <div class="sect2">
1.75 rillig 9243: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9244: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9245: <p>If a package provides extensions to the MIME database by
1.87 wiz 9246: installing <code class="filename">.xml</code> files inside
9247: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9248: need to take some extra steps to ensure that the database is kept
9249: consistent with respect to these new files:</p>
1.128 wiz 9250: <div class="orderedlist"><ol class="orderedlist" type="1">
9251: <li class="listitem"><p>Include
1.87 wiz 9252: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9253: (avoid using the <code class="filename">buildlink3.mk</code> file from
9254: this same directory, which is reserved for inclusion from
9255: other <code class="filename">buildlink3.mk</code> files). It takes
9256: care of rebuilding the MIME database at installation and
9257: deinstallation time, and disallows any access to it directly
9258: from the package.</p></li>
1.128 wiz 9259: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9260: <code class="filename">share/mime</code> directory,
9261: <span class="emphasis"><em>except</em></span> for files saved under
9262: <code class="filename">share/mime/packages</code>. The former are
9263: handled automatically by
9264: the update-mime-database program, but the latter are
9265: package-dependent and must be removed by the package that
9266: installed them in the first place.</p></li>
1.128 wiz 9267: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9268: from the PLIST. They will be handled by the shared-mime-info
9269: package.</p></li>
1.75 rillig 9270: </ol></div>
9271: </div>
1.148 asau 9272: <div class="sect2">
1.75 rillig 9273: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9274: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.93 rillig 9275: <p>If a package uses intltool during its build, add
9276: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9277: which forces it to use the intltool package provided by pkgsrc,
9278: instead of the one bundled with the distribution file.</p>
1.75 rillig 9279: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9280: latest available version; this way, the package benefits of any
9281: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9282: </div>
1.148 asau 9283: <div class="sect2">
1.75 rillig 9284: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9285: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9286: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9287: the startup directory by default, but you can enable it, by adding
9288: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9289: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9290: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9291: it will automatically remove the scripts when the package is
9292: deinstalled.</p>
1.75 rillig 9293: </div>
1.148 asau 9294: <div class="sect2">
1.75 rillig 9295: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9296: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9297: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9298: the <code class="filename">ls-R</code> database of the tree needs to be
9299: updated.</p>
1.148 asau 9300: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9301: <h3 class="title">Note</h3>
1.125 wiz 9302: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9303: packages should install files
1.125 wiz 9304: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9305: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9306: </div>
1.128 wiz 9307: <div class="orderedlist"><ol class="orderedlist" type="1">
9308: <li class="listitem"><p>Include
1.125 wiz 9309: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9310: takes care of rebuilding the <code class="filename">ls-R</code>
9311: database at installation and deinstallation time.</p></li>
1.128 wiz 9312: <li class="listitem">
1.75 rillig 9313: <p>If your package installs files into a texmf
1.87 wiz 9314: tree other than the one
1.125 wiz 9315: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9316: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9317: trees that need database update.</p>
1.75 rillig 9318: <p>If your package also installs font map files that need
1.110 hubertf 9319: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9320: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9321: set <code class="varname">TEX_MAP_FILES</code> and/or
9322: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9323: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9324: be run automatically at installation/deinstallation to
9325: enable/disable font map files for TeX output
9326: drivers.</p>
1.75 rillig 9327: </li>
1.128 wiz 9328: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9329: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9330: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9331: </ol></div>
9332: </div>
1.148 asau 9333: <div class="sect2">
1.85 jmmv 9334: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9335: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.87 wiz 9336: emulation</h3></div></div></div>
9337: <p>There are some packages that provide libraries and
9338: executables for running binaries from a one operating system
9339: on a different one (if the latter supports it). One example
9340: is running Linux binaries on NetBSD.</p>
1.322 leot 9341: <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 9342: helps in extracting and packaging Linux rpm packages.</p>
9343: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9344: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9345: if all libraries for each installed executable can be found by
9346: the dynamic linker. Since the standard dynamic linker is run,
9347: this fails for emulation packages, because the libraries used
9348: by the emulation are not in the standard directories.</p>
9349: </div>
1.299 rillig 9350: <div class="sect2">
9351: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9352: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.299 rillig 9353: <p>If a package installs images under the
9354: <code class="filename">share/icons/hicolor</code> and/or updates the
9355: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9356: database, you need to take some extra steps to make sure that the
9357: shared theme directory is handled appropriately and that the cache
9358: database is rebuilt:</p>
9359: <div class="orderedlist"><ol class="orderedlist" type="1">
9360: <li class="listitem"><p>Include
9361: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9362: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9363: entry that refers to the theme cache.</p></li>
9364: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9365: directories from the <code class="filename">share/icons/hicolor</code>
9366: hierarchy because they will be handled automatically.</p></li>
9367: </ol></div>
9368: <p>The best way to verify that the PLIST is correct with
9369: respect to the last two points is to regenerate it using
9370: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9371: </div>
9372: <div class="sect2">
9373: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9374: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.299 rillig 9375: <p>If a package installs <code class="filename">.desktop</code> files
9376: under <code class="filename">share/applications</code> and these include
9377: MIME information (MimeType key), you need to take extra steps to
9378: ensure that they are registered into the MIME database:</p>
9379: <div class="orderedlist"><ol class="orderedlist" type="1">
9380: <li class="listitem"><p>Include
9381: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9382: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9383: <code class="filename">share/applications/mimeinfo.cache</code> file.
9384: It will be handled automatically.</p></li>
9385: </ol></div>
9386: <p>The best way to verify that the PLIST is correct with
9387: respect to the last point is to regenerate it using <span class="command"><strong>make
9388: print-PLIST</strong></span>.</p>
9389: </div>
9390: </div>
9391: <div class="sect1">
9392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9393: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9394: <p>In some cases one does not have the time to solve a problem
9395: immediately. In this case, one can plainly mark a package as broken. For
9396: this, one just sets the variable <code class="varname">BROKEN</code> to the
9397: reason why the package is broken (similar to the
9398: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9399: the package will immediately be shown this message, and the build
9400: will not be even tried.</p>
9401: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9402: intervals.</p>
9403: </div>
9404: </div>
9405: <div class="chapter">
9406: <div class="titlepage"><div><div><h2 class="title">
9407: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9408: <div class="toc">
9409: <p><b>Table of Contents</b></p>
9410: <dl class="toc">
9411: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9412: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9413: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9414: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9415: </dl>
9416: </div>
9417: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9418: site</a>:</p>
9419: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9420: environment, an intuitive and attractive desktop for users, and the
9421: GNOME development platform, an extensive framework for building
9422: applications that integrate into the rest of the desktop.</p></blockquote></div>
9423: <p>pkgsrc provides a seamless way to automatically build and install
9424: a complete GNOME environment <span class="emphasis"><em>under many different
9425: platforms</em></span>. We can say with confidence that pkgsrc is one of
9426: the most advanced build and packaging systems for GNOME due to its
9427: included technologies buildlink3, the wrappers and tools framework and
9428: automatic configuration file management. Lots of efforts are put into
9429: achieving a completely clean deinstallation of installed software
9430: components.</p>
9431: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9432: the above also means that great efforts are put into making GNOME work
1.316 cirnatda 9433: under this operating system.</p>
1.299 rillig 9434: <p>This chapter is aimed at pkgsrc developers and other people
9435: interested in helping our GNOME porting and packaging efforts. It
9436: provides instructions on how to manage the existing packages and some
9437: important information regarding their internals.</p>
9438: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9439: <h3 class="title">We need your help!</h3>
9440: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9441: and GNOME and are willing to learn new exciting stuff, please jump
9442: straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9443: work</a> list! There is still a long way to go to get a
9444: fully-functional GNOME desktop under NetBSD and we need your help to
9445: achieve it!</p>
9446: </div>
9447: <div class="sect1">
9448: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9449: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9450: <p>pkgsrc includes three GNOME-related meta packages:</p>
9451: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 9452: <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 9453: the core GNOME desktop environment. It only includes the necessary
9454: bits to get it to boot correctly, although it may lack important
9455: functionality for daily operation. The idea behind this package is
9456: to let end users build their own configurations on top of this one,
9457: first installing this meta package to achieve a functional setup and
9458: then adding individual applications.</p></li>
1.322 leot 9459: <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 9460: complete installation of the GNOME platform and desktop as defined
9461: by the GNOME project; this is based on the components distributed in
9462: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9463: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9464: official FTP server. Developer-only tools found in those
9465: directories are not installed unless required by some other
9466: component to work properly. Similarly, packages from the bindings
9467: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9468: in unless required as a dependency for an end-user component. This
1.322 leot 9469: 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>
9470: <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 9471: Installs all the tools required to build a GNOME component when
9472: fetched from the CVS repository. These are required to let the
9473: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9474: </ul></div>
9475: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9476: sorted in a way that eases updates: a package may depend on other
9477: packages listed before it but not on any listed after it. It is very
9478: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9479: change it to alphabetical sorting!</em></span></p>
9480: </div>
9481: <div class="sect1">
9482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9483: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9484: <p>Almost all GNOME applications are written in C and use a common
9485: set of tools as their build system. Things get different with the new
9486: bindings to other languages (such as Python), but the following will
9487: give you a general idea on the minimum required tools:</p>
9488: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9489: <li class="listitem">
9490: <p>Almost all GNOME applications use the GNU Autotools as their
9491: build system. As a general rule you will need to tell this to your
9492: package:</p>
9493: <pre class="programlisting">
9494: GNU_CONFIGURE=yes
9495: USE_LIBTOOL=yes
9496: USE_TOOLS+=gmake
9497: </pre>
9498: </li>
9499: <li class="listitem">
9500: <p>If the package uses pkg-config to detect dependencies, add this
9501: tool to the list of required utilities:</p>
9502: <pre class="programlisting">
9503: USE_TOOLS+=pkg-config
9504: </pre>
1.322 leot 9505: <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 9506: the end of the build process to ensure that you did not miss to
9507: specify any dependency in your package and that the version
9508: requirements are all correct.</p>
9509: </li>
9510: <li class="listitem"><p>If the package uses intltool, be sure to add
9511: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9512: to handle dependencies and to force the package to use the latest
9513: available version.</p></li>
9514: <li class="listitem">
9515: <p>If the package uses gtk-doc (a documentation generation
9516: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9517: tool is rather big and the distfile should come with pregenerated
9518: documentation anyway; if it does not, it is a bug that you ought to
9519: report. For such packages you should disable gtk-doc (unless it is
9520: the default):</p>
9521: <pre class="programlisting">
9522: CONFIGURE_ARGS+=--disable-gtk-doc
9523: </pre>
9524: <p>The default location of installed HTML files
9525: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9526: and should not be changed unless the package insists on installing
9527: them somewhere else. Otherwise programs as
9528: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9529: do that with an entry similar to:</p>
9530: <pre class="programlisting">
9531: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9532: </pre>
9533: </li>
9534: </ul></div>
9535: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9536: files under the installation prefix to maintain databases. In this
9537: context, shared means that those exact same directories and files are
9538: used among several different packages, leading to conflicts in the
9539: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9540: handle the most common cases, so you have to forget about using
9541: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9542: omitting shared files from them. If you find yourself doing those,
9543: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9544: <p>The following table lists the common situations that result in
9545: using shared directories or files. For each of them, the appropriate
9546: solution is given. After applying the solution be sure to
9547: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9548: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9549: <div class="table">
9550: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9551: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9552: <colgroup>
9553: <col>
9554: <col>
9555: </colgroup>
9556: <thead><tr>
9557: <th>If the package...</th>
9558: <th>Then...</th>
9559: </tr></thead>
9560: <tbody>
9561: <tr>
9562: <td>Installs icons under the
9563: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9564: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.318 nia 9565: <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 9566: </tr>
9567: <tr>
9568: <td>Installs files under
9569: <code class="filename">share/mime/packages</code>.</td>
1.318 nia 9570: <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 9571: </tr>
9572: <tr>
9573: <td>Installs <code class="filename">.desktop</code> files under
9574: <code class="filename">share/applications</code> and these include MIME
9575: information.</td>
1.318 nia 9576: <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 9577: </tr>
9578: </tbody>
9579: </table></div>
1.75 rillig 9580: </div>
1.299 rillig 9581: <br class="table-break">
1.75 rillig 9582: </div>
1.148 asau 9583: <div class="sect1">
1.87 wiz 9584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 9585: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9586: <p>When seeing GNOME as a whole, there are two kinds of
9587: updates:</p>
9588: <div class="variablelist"><dl class="variablelist">
9589: <dt><span class="term">Major update</span></dt>
9590: <dd>
9591: <p>Given that there is still a very long way for GNOME 3 (if it
9592: ever appears), we consider a major update one that goes from a
9593: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9594: where <code class="literal">Y</code> is even and greater than
9595: <code class="literal">X</code>. These are hard to achieve because they
9596: introduce lots of changes in the components' code and almost all
9597: GNOME distfiles are updated to newer versions. Some of them can
9598: even break API and ABI compatibility with the previous major
9599: version series. As a result, the update needs to be done all at
9600: once to minimize breakage.</p>
9601: <p>A major update typically consists of around 80 package
9602: updates and the addition of some new ones.</p>
9603: </dd>
9604: <dt><span class="term">Minor update</span></dt>
9605: <dd>
9606: <p>We consider a minor update one that goes from a
9607: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9608: one where <code class="literal">Y</code> is greater than
9609: <code class="literal">X</code>. These are easy to achieve because they do
9610: not update all GNOME components, can be done in an incremental way
9611: and do not break API nor ABI compatibility.</p>
9612: <p>A minor update typically consists of around 50 package
9613: updates, although the numbers here may vary a lot.</p>
9614: </dd>
9615: </dl></div>
9616: <p>In order to update the GNOME components in pkgsrc to a new stable
9617: release (either major or minor), the following steps should be
9618: followed:</p>
9619: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128 wiz 9620: <li class="listitem">
1.299 rillig 9621: <p>Get a list of all the tarballs that form the new release by
9622: using the following commands. These will leave the full list of the
9623: components' distfiles into the <code class="filename">list.txt</code>
9624: file:</p>
9625: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9626: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9627: awk '{ print $9 }' >list.txt</code></strong>
9628: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9629: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9630: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.75 rillig 9631: </li>
1.299 rillig 9632: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9633: bump their version to the release you are updating them to. The
9634: three meta packages should be always consistent with versioning.
9635: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9636: in them.</p></li>
1.128 wiz 9637: <li class="listitem">
1.299 rillig 9638: <p>For each meta package, update all its
9639: <code class="varname">DEPENDS</code> lines to match the latest versions as
9640: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9641: newer version (even if found in the FTP) because the meta packages
9642: are supposed to list the exact versions that form a specific GNOME
9643: release. Exceptions are permitted here if a newer version solves a
9644: serious issue in the overall desktop experience; these typically
9645: come in the form of a revision bump in pkgsrc, not in newer versions
9646: from the developers.</p>
9647: <p>Packages not listed in the <code class="filename">list.txt</code> file
9648: should be updated to the latest version available (if found in
9649: pkgsrc). This is the case, for example, of the dependencies on the
1.322 leot 9650: 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 9651: </li>
1.128 wiz 9652: <li class="listitem">
1.299 rillig 9653: <p>Generate a patch from the modified meta packages and extract the
9654: list of "new" lines. This will provide you an outline on what
9655: packages need to be updated in pkgsrc and in what order:</p>
9656: <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 9657: </li>
1.299 rillig 9658: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9659: installed packages and start over from scratch at this point.</p></li>
9660: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9661: of <code class="filename">todo.txt</code> and update the packages listed in
9662: it in order. For major desktop updates none of these should be
9663: committed until the entire set is completed because there are chances
9664: of breaking not-yet-updated packages.</p></li>
9665: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9666: the tree one by one with appropriate log messages. At the end,
9667: commit the three meta package updates and all the corresponding
9668: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9669: <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>
9670: </ol></div>
9671: </div>
9672: <div class="sect1">
9673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9674: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9675: <p>GNOME is a very big component in pkgsrc which approaches 100
9676: packages. Please, it is very important that you always, always,
9677: <span class="strong"><strong>always</strong></span> feed back any portability
9678: 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
9679: their attention on portability issues and to ensure that future versions
9680: can be built out-of-the box on NetBSD. The less custom patches in
9681: pkgsrc, the easier further updates are. Those developers in charge of
9682: issuing major GNOME updates will be grateful if you do that.</p>
1.315 cirnatda 9683: <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
9684: GitLab</a>. Not all components use these to track bugs, but most
1.299 rillig 9685: of them do. Do not be short on your reports: always provide detailed
9686: explanations of the current failure, how it can be improved to achieve
1.315 cirnatda 9687: maximum portability and, if at all possible, provide a patch against the
9688: main Git branch. The more verbose you are, the higher chances of your
9689: patch being accepted.</p>
1.299 rillig 9690: <p>Also, please avoid using preprocessor magic to fix portability
9691: issues. While the FreeBSD GNOME people are doing a great job in porting
9692: GNOME to their operating system, the official GNOME sources are now
9693: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9694: and similar macros. This hurts portability. Please see our patching
9695: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9696: details.</p>
9697: </div>
1.75 rillig 9698: </div>
1.148 asau 9699: <div class="chapter">
1.75 rillig 9700: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9701: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75 rillig 9702: <div class="toc">
9703: <p><b>Table of Contents</b></p>
1.210 leot 9704: <dl class="toc">
1.267 rillig 9705: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9706: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9707: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9708: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9709: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9710: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9711: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9712: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9713: </dl>
9714: </div>
1.148 asau 9715: <div class="sect1">
1.75 rillig 9716: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9717: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9718: <p>Our policy is that we accept binaries only from pkgsrc
9719: developers to guarantee that the packages don't contain any
9720: trojan horses etc. This is not to annoy anyone but rather to
9721: protect our users! You're still free to put up your home-made
9722: binary packages and tell the world where to get them. NetBSD
9723: developers doing bulk builds and wanting to upload them please
1.267 rillig 9724: 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 9725: builds)</i></a>.</p>
1.75 rillig 9726: </div>
1.148 asau 9727: <div class="sect1">
1.75 rillig 9728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9729: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.333 nia 9730: <p>Firstly, you can import new packages into
9731: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
9732: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
9733: for details.</p>
9734: <p>Next, check that your package is complete, compiles and
1.299 rillig 9735: 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 9736: 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>
9737: tool and fix any errors that appear.</p>
9738: <p>Finally, send a report to the pkgsrc bug tracking system,
1.322 leot 9739: 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 9740: that, go to the web page
1.289 leot 9741: <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 9742: which contains some instructions and a link to a form where you
9743: can submit packages. The
1.322 leot 9744: <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 9745: also available as a substitute for either of the above two tools.
9746: </p>
1.87 wiz 9747: <p>In the form of the problem report, the category should be
1.128 wiz 9748: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9749: and version number, and the description field should contain a
9750: short description of your package (contents of the COMMENT
1.333 nia 9751: variable or DESCR file are OK).</p>
1.75 rillig 9752: </div>
1.148 asau 9753: <div class="sect1">
1.75 rillig 9754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9755: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9756: <p>Please note all package additions, updates, moves, and
1.93 rillig 9757: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9758: important to keep this file up to date and conforming to the
9759: existing format, because it will be used by scripts to
1.289 leot 9760: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9761: sites. Additionally, check the
1.76 rillig 9762: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9763: for the package you updated or removed, in case it was mentioned
9764: there.</p>
9765: <p>When the <code class="varname">PKGREVISION</code> of a package is
9766: bumped, the change should appear in
1.93 rillig 9767: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9768: related or otherwise relevant. Mass bumps that result from a
9769: dependency being updated should not be mentioned. In all other
9770: cases it's the developer's decision.</p>
9771: <p>There is a make target that helps in creating proper
1.110 hubertf 9772: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9773: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9774: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9775: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9776: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9777: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9778: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9779: For new packages, or package moves or removals, set the
9780: <code class="varname">CTYPE</code> variable on the command line to "Added",
9781: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9782: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9783: not the same as your NetBSD login name. The target also automatically
9784: removes possibly existing entries for the package in the
9785: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9786: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9787: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9788: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9789: makes the cvs commands use the main repository.
9790: </p>
1.75 rillig 9791: </div>
1.148 asau 9792: <div class="sect1">
1.75 rillig 9793: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9794: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243 wiz 9795: <p>For several years, there have been mirrors of pkgsrc in
9796: fossil, git, and hg. Standard practise when using these tools is to
9797: make the first line of a commit message function as a summary that
9798: can be read without the rest, such as is commonly done with "git log
9799: --oneline". For this reason, we have the following guidelines for
9800: pkgsrc commit messages:</p>
9801: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9802: <li class="listitem"><p>Start the commit message with a line that explains the
1.244 wiz 9803: big picture in 65 characters or less. When a commit is for one
1.243 wiz 9804: package, include the name of the package. For updates, include the
9805: version to which it is updated.</p></li>
9806: <li class="listitem"><p>Leave the next line empty.</p></li>
9807: <li class="listitem"><p>Then come the details for the commit (changes in that
9808: package, reason for a change) and any relevant PRs. Wrap this
9809: section.</p></li>
9810: </ul></div>
9811: <p>Here is an example:
9812: </p>
9813: <pre class="programlisting">
9814: libxslt: update to 1.0.30
9815:
9816: Changes since 1.0.29:
9817: ...
9818: </pre>
9819: <p>
9820: </p>
9821: <p>Here is another example:
9822: </p>
9823: <pre class="programlisting">
9824: mk/bsd.pkg.mk: enable SSP by default on NetBSD
9825:
9826: (rationale)
9827: </pre>
9828: <p>
9829: </p>
9830: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
9831: allowed on the pkgsrc repository to change commit messages.</p>
9832: </div>
9833: <div class="sect1">
9834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9835: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9836: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9837: access to the pkgsrc repository.</p>
9838: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9839: Start by adding the directory and then files in the directory. Don't
9840: forget to add the new package to the category's
9841: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9842: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9843: <pre class="programlisting">
9844: <code class="prompt">$</code> cd .../pkgsrc/category
9845: <code class="prompt">$</code> cvs add pkgname
9846: <code class="prompt">$</code> cd pkgname
9847: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9848: <code class="prompt">$</code> cvs add patches/p*
9849: <code class="prompt">$</code> cvs status | less
1.141 wiz 9850: <code class="prompt">$</code> cvs commit
1.140 wiz 9851: <code class="prompt">$</code> cd ..
9852: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9853: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 9854: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 9855: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 9856: </pre>
1.87 wiz 9857: <p>The commit message of the initial import should include part of the
1.76 rillig 9858: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9859: what the package is/does.</p>
1.140 wiz 9860: <p>Also mention the new package in
9861: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9862: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9863: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9864: </div>
1.148 asau 9865: <div class="sect1">
1.75 rillig 9866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9867: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9868: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9869: changes between old and new versions into the commit log when updating
1.87 wiz 9870: a package. There are various reasons for this:</p>
1.148 asau 9871: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9872: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9873: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9874: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9875: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9876: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9877: repository is very useful for people who read the pkgsrc-changes mailing
9878: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9879: the package.</p></li>
1.75 rillig 9880: </ul></div>
1.87 wiz 9881: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9882: has been released, it should not automatically be upgraded in the CVS
9883: repository. We prefer to be conservative in the packages that are
9884: included in pkgsrc - development or beta packages are not really the
9885: best thing for most places in which pkgsrc is used. Please use your
9886: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9887: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9888: </div>
1.148 asau 9889: <div class="sect1">
1.75 rillig 9890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9891: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122 reed 9892: <p>Renaming packages is not recommended.</p>
1.290 gutterid 9893: <p>When renaming packages, be sure to fix any references to the old name
1.122 reed 9894: in other Makefiles, options, buildlink files, etc.</p>
1.282 leot 9895: <p>
1.290 gutterid 9896: Also, when renaming a package, please add
1.282 leot 9897: the package name and version pattern(s) of the previous package
9898: to <code class="varname">SUPERSEDES</code>.
1.122 reed 9899: This may be repeated for multiple renames.
9900: The new package would be an exact replacement.
1.282 leot 9901: Example:
1.122 reed 9902: </p>
1.282 leot 9903: <pre class="programlisting">
9904: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
9905: SUPERSEDES+= optcomp-[0-9]*
9906: </pre>
1.128 wiz 9907: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9908: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9909: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9910: not be an exact replacement but is a suggestion for the replaced
9911: functionality.</p>
9912: </div>
1.148 asau 9913: <div class="sect1">
1.122 reed 9914: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9915: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122 reed 9916: <p>It is preferred that packages are not renamed or moved, but if needed
9917: please follow these steps.
9918: </p>
1.128 wiz 9919: <div class="orderedlist"><ol class="orderedlist" type="1">
9920: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9921: <li class="listitem">
1.75 rillig 9922: <p>Remove all CVS dirs.</p>
1.87 wiz 9923: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9924: <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 9925: <p>and use that for further work.</p>
1.75 rillig 9926: </li>
1.128 wiz 9927: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9928: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9929: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9930: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9931: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9932: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9933: for doing an update using pkgsrc building; for example, it can
1.322 leot 9934: 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 9935: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9936: new <code class="varname">PKGPATH</code> for that moved package. Note that
9937: it may have multiple matches, so the tool should also check on the
9938: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9939: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9940: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9941: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9942: place.</p></li>
1.128 wiz 9943: <li class="listitem">
1.75 rillig 9944: <p>Check if any package depends on it:
9945: </p>
9946: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9947: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9948: </li>
1.128 wiz 9949: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9950: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9951: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9952: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9953: <li class="listitem">
1.75 rillig 9954: <p>Commit the changed and removed files:</p>
9955: <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 9956: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9957: </li>
9958: </ol></div>
9959: </div>
9960: </div>
1.148 asau 9961: <div class="chapter">
1.75 rillig 9962: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9963: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9964: <p>This section contains the answers to questions that may
9965: arise when you are writing a package. If you don't find your
9966: question answered here, first have a look in the other chapters,
9967: and if you still don't have the answer, ask on the
9968: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 9969: <div class="qandaset">
1.289 leot 9970: <a name="devfaq.qandaset"></a><dl>
1.267 rillig 9971: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9972: MAKEFLAGS, .MAKEFLAGS and
9973: MAKE_FLAGS?</a>
9974: </dt>
1.267 rillig 9975: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9976: MAKE, GMAKE and
9977: MAKE_PROGRAM?</a>
9978: </dt>
1.267 rillig 9979: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9980: CC, PKG_CC and
9981: PKGSRC_COMPILER?</a>
9982: </dt>
1.267 rillig 9983: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9984: BUILDLINK_LDFLAGS,
9985: BUILDLINK_LDADD and
9986: BUILDLINK_LIBS?</a>
9987: </dt>
1.267 rillig 9988: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9989: VARNAME=BUILDLINK_PREFIX.foo
9990: say it's empty?</a>
9991: </dt>
1.267 rillig 9992: <dt>24.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9993: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9994: don't understand the := inside
9995: it.</a>
9996: </dt>
1.267 rillig 9997: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9998: developers?</a>
9999: </dt>
1.267 rillig 10000: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 10001: documentation?</a>
10002: </dt>
1.289 leot 10003: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill.
10004: What shall I do?</a>
1.92 rillig 10005: </dt>
1.75 rillig 10006: </dl>
1.148 asau 10007: <table border="0" style="width: 100%;">
10008: <colgroup>
1.75 rillig 10009: <col align="left" width="1%">
1.128 wiz 10010: <col>
1.148 asau 10011: </colgroup>
1.75 rillig 10012: <tbody>
1.148 asau 10013: <tr class="question">
1.75 rillig 10014: <td align="left" valign="top">
1.289 leot 10015: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75 rillig 10016: </td>
10017: <td align="left" valign="top"><p>What is the difference between
10018: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10019: <code class="varname">MAKE_FLAGS</code>?</p></td>
10020: </tr>
10021: <tr class="answer">
1.91 rillig 10022: <td align="left" valign="top"></td>
1.75 rillig 10023: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.322 leot 10024: 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>, while
1.75 rillig 10025: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
10026: the <code class="varname">MAKE_PROGRAM</code> when building the
10027: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
10028: </tr>
1.148 asau 10029: <tr class="question">
1.75 rillig 10030: <td align="left" valign="top">
1.289 leot 10031: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75 rillig 10032: </td>
10033: <td align="left" valign="top"><p>What is the difference between
10034: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10035: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10036: </tr>
10037: <tr class="answer">
1.91 rillig 10038: <td align="left" valign="top"></td>
1.75 rillig 10039: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.322 leot 10040: <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.75 rillig 10041: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
10042: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
10043: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
10044: Make program that is used for building the
10045: package.</p></td>
10046: </tr>
1.148 asau 10047: <tr class="question">
1.75 rillig 10048: <td align="left" valign="top">
1.289 leot 10049: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75 rillig 10050: </td>
10051: <td align="left" valign="top"><p>What is the difference between
10052: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10053: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10054: </tr>
10055: <tr class="answer">
1.91 rillig 10056: <td align="left" valign="top"></td>
1.75 rillig 10057: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
10058: compiler, which can be configured by the pkgsrc user.
10059: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
10060: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
10061: path to a compiler, but the type of compiler that should be
1.76 rillig 10062: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 10063: information about the latter variable.</p></td>
10064: </tr>
1.148 asau 10065: <tr class="question">
1.75 rillig 10066: <td align="left" valign="top">
1.289 leot 10067: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.75 rillig 10068: </td>
10069: <td align="left" valign="top"><p>What is the difference between
10070: <code class="varname">BUILDLINK_LDFLAGS</code>,
10071: <code class="varname">BUILDLINK_LDADD</code> and
10072: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
10073: </tr>
10074: <tr class="answer">
1.91 rillig 10075: <td align="left" valign="top"></td>
1.75 rillig 10076: <td align="left" valign="top"><p>[FIXME]</p></td>
10077: </tr>
1.148 asau 10078: <tr class="question">
1.75 rillig 10079: <td align="left" valign="top">
1.289 leot 10080: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.75 rillig 10081: </td>
1.110 hubertf 10082: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 10083: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10084: say it's empty?</p></td>
10085: </tr>
10086: <tr class="answer">
1.91 rillig 10087: <td align="left" valign="top"></td>
1.75 rillig 10088: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 10089: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10090: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 10091: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 10092: command.</p></td>
10093: </tr>
1.148 asau 10094: <tr class="question">
1.78 rillig 10095: <td align="left" valign="top">
1.289 leot 10096: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.78 rillig 10097: </td>
10098: <td align="left" valign="top"><p>What does
1.220 wiz 10099: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10100: don't understand the <code class="code">:=</code> inside
1.78 rillig 10101: it.</p></td>
10102: </tr>
10103: <tr class="answer">
1.91 rillig 10104: <td align="left" valign="top"></td>
1.220 wiz 10105: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
10106: assignment operator, although it looks like it.
1.78 rillig 10107: Instead, it is a degenerate form of
1.220 wiz 10108: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.322 leot 10109: 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 10110: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78 rillig 10111: case of <code class="varname">MASTER_SITE_*</code>,
10112: <em class="replaceable"><code>old_string</code></em> is the empty string and
10113: <em class="replaceable"><code>new_string</code></em> is
1.220 wiz 10114: <code class="code">package/</code>. That's where the
10115: <code class="code">:</code> and the <code class="code">=</code> fall
1.78 rillig 10116: together.</p></td>
10117: </tr>
1.148 asau 10118: <tr class="question">
1.78 rillig 10119: <td align="left" valign="top">
1.289 leot 10120: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.78 rillig 10121: </td>
10122: <td align="left" valign="top"><p>Which mailing lists are there for package
10123: developers?</p></td>
10124: </tr>
10125: <tr class="answer">
1.91 rillig 10126: <td align="left" valign="top"></td>
1.148 asau 10127: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289 leot 10128: <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 10129: <dd><p>This is a list for technical discussions related
10130: to pkgsrc development, e.g. soliciting feedback for changes to
10131: pkgsrc infrastructure, proposed new features, questions related
10132: to porting pkgsrc to a new platform, advice for maintaining a
10133: package, patches that affect many packages, help requests moved
10134: from pkgsrc-users when an infrastructure bug is found,
10135: etc.</p></dd>
1.289 leot 10136: <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 10137: <dd><p>All bug reports in category "pkg" sent with
1.322 leot 10138: <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 10139: directly; use one of the other mailing
10140: lists.</p></dd>
10141: </dl></div></td>
10142: </tr>
1.148 asau 10143: <tr class="question">
1.80 rillig 10144: <td align="left" valign="top">
1.289 leot 10145: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.80 rillig 10146: </td>
10147: <td align="left" valign="top"><p>Where is the pkgsrc
10148: documentation?</p></td>
10149: </tr>
10150: <tr class="answer">
1.91 rillig 10151: <td align="left" valign="top"></td>
1.80 rillig 10152: <td align="left" valign="top">
10153: <p>There are many places where you can find
10154: documentation about pkgsrc:</p>
1.148 asau 10155: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10156: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 10157: of chapters that explain large parts of pkgsrc, but some
10158: chapters tend to be outdated. Which ones they are is hard to
10159: say.</p></li>
1.289 leot 10160: <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 10161: about certain features, announcements of new parts of the pkgsrc
10162: infrastructure and sometimes even announcements that a certain
10163: feature has been marked as obsolete. The benefit here is that
10164: each message has a date appended to it.</p></li>
1.128 wiz 10165: <li class="listitem"><p>Many of the files in the
1.80 rillig 10166: <code class="filename">mk/</code> directory start with a comment that
10167: describes the purpose of the file and how it can be used by the
1.92 rillig 10168: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 10169: documentation is to run <span class="command"><strong>bmake
1.92 rillig 10170: help</strong></span>.</p></li>
1.128 wiz 10171: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 10172: information, but they tend to be highly abbreviated, especially
10173: for actions that occur often. Some contain a detailed
10174: description of what has changed, but they are geared towards the
10175: other pkgsrc developers, not towards an average pkgsrc user.
10176: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10177: don't know what has been before, these messages may not be worth
10178: too much to you.</p></li>
1.128 wiz 10179: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10180: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 10181: mind of the developer who wrote the code. To get this
1.110 hubertf 10182: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 10183: to see who has written it and ask on the
10184: <code class="literal">tech-pkg</code> mailing list, so that others can
10185: find your questions later (see above). To be sure that the
10186: developer in charge reads the mail, you may CC him or
10187: her.</p></li>
10188: </ul></div>
1.299 rillig 10189: </td>
10190: </tr>
10191: <tr class="question">
10192: <td align="left" valign="top">
10193: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
10194: </td>
10195: <td align="left" valign="top"><p>I have a little time to kill.
10196: What shall I do?</p></td>
10197: </tr>
10198: <tr class="answer">
10199: <td align="left" valign="top"></td>
10200: <td align="left" valign="top">
10201: <p>This is not really an FAQ yet, but here's the answer
10202: anyway.</p>
1.148 asau 10203: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 10204: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.322 leot 10205: <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 10206: will tell you about newer versions of installed packages that are
10207: available, but not yet updated in pkgsrc.</p></li>
10208: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10209: — it contains a list of suggested new packages and a list of
10210: cleanups and enhancements for pkgsrc that would be nice to
10211: have.</p></li>
10212: <li class="listitem"><p>Review packages for which review was requested on
10213: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10214: mailing list.</p></li>
1.85 jmmv 10215: </ul></div>
1.299 rillig 10216: </td>
1.85 jmmv 10217: </tr>
10218: </tbody>
1.299 rillig 10219: </table>
1.85 jmmv 10220: </div>
10221: </div>
1.75 rillig 10222: </div>
1.148 asau 10223: <div class="part">
1.75 rillig 10224: <div class="titlepage"><div><div><h1 class="title">
10225: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10226: <div class="partintro">
1.75 rillig 10227: <div></div>
10228: <p>This part of the guide deals with everything
10229: from the infrastructure that is behind the interfaces described
10230: in the developer's guide. A casual package maintainer should not
10231: need anything from this part.</p>
10232: <div class="toc">
10233: <p><b>Table of Contents</b></p>
1.210 leot 10234: <dl class="toc">
1.299 rillig 10235: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10236: <dd><dl>
1.299 rillig 10237: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10238: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10239: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.75 rillig 10240: <dd><dl>
1.299 rillig 10241: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10242: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.75 rillig 10243: </dl></dd>
1.299 rillig 10244: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10245: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10246: <dd><dl>
1.299 rillig 10247: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10248: <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 10249: </dl></dd>
1.299 rillig 10250: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10251: <dd><dl>
1.299 rillig 10252: <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>
10253: <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 10254: </dl></dd>
10255: </dl></dd>
1.299 rillig 10256: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 10257: <dd><dl>
1.299 rillig 10258: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10259: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10260: <dd><dl>
1.299 rillig 10261: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10262: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10263: </dl></dd>
10264: </dl></dd>
1.299 rillig 10265: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10266: <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 10267: </dl>
10268: </div>
10269: </div>
1.148 asau 10270: <div class="chapter">
1.75 rillig 10271: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10272: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10273: <div class="toc">
10274: <p><b>Table of Contents</b></p>
1.210 leot 10275: <dl class="toc">
1.299 rillig 10276: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10277: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10278: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81 rillig 10279: <dd><dl>
1.299 rillig 10280: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10281: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81 rillig 10282: </dl></dd>
1.299 rillig 10283: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10284: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10285: <dd><dl>
1.299 rillig 10286: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10287: <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 10288: </dl></dd>
1.299 rillig 10289: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10290: <dd><dl>
1.299 rillig 10291: <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>
10292: <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 10293: </dl></dd>
10294: </dl>
10295: </div>
10296: <p>The pkgsrc infrastructure consists of many small Makefile
10297: fragments. Each such fragment needs a properly specified
10298: interface. This chapter explains how such an interface looks
10299: like.</p>
1.148 asau 10300: <div class="sect1">
1.75 rillig 10301: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10302: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10303: <p>Whenever a variable is defined in the pkgsrc
10304: infrastructure, the location and the way of definition provide
10305: much information about the intended use of that variable.
10306: Additionally, more documentation may be found in a header
10307: comment or in this pkgsrc guide.</p>
10308: <p>A special file is
10309: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10310: variables that are intended to be user-defined. They are either
10311: defined using the <code class="literal">?=</code> operator or they are
10312: left undefined because defining them to anything would
1.128 wiz 10313: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10314: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10315: file.</p>
10316: <p>Outside this file, the following conventions apply:
10317: Variables that are defined using the <code class="literal">?=</code>
10318: operator may be overridden by a package.</p>
10319: <p>Variables that are defined using the <code class="literal">=</code>
10320: operator may be used read-only at run-time.</p>
10321: <p>Variables whose name starts with an underscore must not be
10322: accessed outside the pkgsrc infrastructure at all. They may
10323: change without further notice.</p>
1.148 asau 10324: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10325: <h3 class="title">Note</h3>
10326: <p>These conventions are currently not applied
10327: consistently to the complete pkgsrc
10328: infrastructure.</p>
10329: </div>
10330: </div>
1.148 asau 10331: <div class="sect1">
1.81 rillig 10332: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10333: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10334: <p>All variables that contain lists of things should default
10335: to being empty. Two examples that do not follow this rule are
10336: <code class="varname">USE_LANGUAGES</code> and
10337: <code class="varname">DISTFILES</code>. These variables cannot simply be
10338: modified using the <code class="literal">+=</code> operator in package
10339: <code class="filename">Makefile</code>s (or other files included by
10340: them), since there is no guarantee whether the variable is
10341: already set or not, and what its value is. In the case of
1.128 wiz 10342: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10343: the default value and just define it as in the following
10344: example.</p>
10345: <pre class="programlisting">
1.100 rillig 10346: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10347: </pre>
10348: <p>Because of the selection of this default value, the same
10349: value appears in many package Makefiles. Similarly for
10350: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10351: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10352: doesn't stand out. Nevertheless it is mentioned in many
10353: files.</p>
10354: </div>
1.148 asau 10355: <div class="sect1">
1.81 rillig 10356: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10357: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.148 asau 10358: <div class="sect2">
1.75 rillig 10359: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10360: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.75 rillig 10361: <p>Variable evaluation takes place either at load time or at
10362: runtime, depending on the context in which they occur. The
10363: contexts where variables are evaluated at load time are:</p>
1.148 asau 10364: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10365: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10366: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10367: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10368: <code class="literal">.for</code>,</p></li>
1.128 wiz 10369: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10370: </ul></div>
10371: <p>A special exception are references to the iteration
10372: variables of <code class="literal">.for</code> loops, which are expanded
10373: inline, no matter in which context they appear.</p>
10374: <p>As the values of variables may change during load time,
10375: care must be taken not to evaluate them by accident. Typical
10376: examples for variables that should not be evaluated at load time
10377: are <code class="varname">DEPENDS</code> and
10378: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10379: clear, here is an example:</p>
10380: <pre class="programlisting">
1.100 rillig 10381: CONFIGURE_ARGS= # none
10382: CFLAGS= -O
10383: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10384:
1.100 rillig 10385: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10386:
1.100 rillig 10387: CFLAGS+= -Wall
1.222 sevan 10388: </pre>
1.75 rillig 10389: <p>This code shows how the use of the <code class="literal">:=</code>
10390: operator can quickly lead to unexpected results. The first
10391: paragraph is fairly common code. The second paragraph evaluates
10392: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10393: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10394: <code class="literal">-Wall</code> is appended to the
10395: <code class="varname">CFLAGS</code>, but this addition will not appear in
10396: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10397: paragraphs from above typically occur in completely unrelated
10398: files.</p>
10399: </div>
1.148 asau 10400: <div class="sect2">
1.75 rillig 10401: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10402: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.75 rillig 10403: <p>After all the files have been loaded, the values of the
10404: variables cannot be changed anymore. Variables that are used in
10405: the shell commands are expanded at this point.</p>
10406: </div>
10407: </div>
1.148 asau 10408: <div class="sect1">
1.75 rillig 10409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10410: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10411: <p>There are many ways in which the definition and use of a
1.218 rillig 10412: variable can be restricted in order to detect bugs and violations
10413: of the (mostly unwritten) policies. A package can be checked with
10414: <code class="literal">pkglint -Wall</code> to see whether it meets these
10415: rules.</p>
1.78 rillig 10416: </div>
1.148 asau 10417: <div class="sect1">
1.78 rillig 10418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10419: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10420: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10421: of the following classes. Cases where a file falls into more
10422: than one class should be avoided as it often leads to subtle
10423: bugs.</p>
1.148 asau 10424: <div class="sect2">
1.75 rillig 10425: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10426: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10427: <p>In a traditional imperative programming language some of
1.76 rillig 10428: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10429: procedures. They take some input parameters and—after
10430: inclusion—provide a result in output parameters. Since all
1.76 rillig 10431: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10432: care must be taken not to use parameter names that have already
10433: another meaning. For example, <code class="varname">PKGNAME</code> is a
10434: bad choice for a parameter name.</p>
10435: <p>Procedures are completely evaluated at preprocessing time.
10436: That is, when calling a procedure all input parameters must be
10437: completely resolvable. For example,
10438: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10439: parameter since it is very likely that further text will be
10440: added after calling the procedure, which would effectively apply
10441: the procedure to only a part of the variable. Also, references
1.218 rillig 10442: to other variables will be modified after calling the
1.75 rillig 10443: procedure.</p>
10444: <p>A procedure can declare its output parameters either as
10445: suitable for use in preprocessing directives or as only
10446: available at runtime. The latter alternative is for variables
10447: that contain references to other runtime variables.</p>
10448: <p>Procedures shall be written such that it is possible to
10449: call the procedure more than once. That is, the file must not
10450: contain multiple-inclusion guards.</p>
10451: <p>Examples for procedures are
1.76 rillig 10452: <code class="filename">mk/bsd.options.mk</code> and
10453: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10454: that the parameters are evaluated at load time, they should be
10455: assigned using the <code class="literal">:=</code> operator, which should
10456: be used only for this purpose.</p>
10457: </div>
1.148 asau 10458: <div class="sect2">
1.75 rillig 10459: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10460: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10461: <p>Action files take some input parameters and may define
10462: runtime variables. They shall not define loadtime variables.
10463: There are action files that are included implicitly by the
10464: pkgsrc infrastructure, while other must be included
10465: explicitly.</p>
10466: <p>An example for action files is
1.76 rillig 10467: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10468: </div>
10469: </div>
1.148 asau 10470: <div class="sect1">
1.81 rillig 10471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10472: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10473: <p>Package <code class="filename">Makefile</code>s usually consist of
10474: a set of variable definitions, and include the file
10475: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10476: Before that, they may also include various other
10477: <code class="filename">*.mk</code> files if they need to query the
10478: availability of certain features like the type of compiler or
10479: the X11 implementation. Due to the heavy use of preprocessor
10480: directives like <code class="literal">.if</code> and
10481: <code class="literal">.for</code>, the order in which the files are loaded
10482: matters.</p>
10483: <p>This section describes at which point the various files
10484: are loaded and gives reasons for that order.</p>
1.148 asau 10485: <div class="sect2">
1.81 rillig 10486: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10487: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10488: </h3></div></div></div>
10489: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10490: is to define some essential variables like
10491: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10492: <code class="varname">MACHINE_ARCH</code>.</p>
10493: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10494: 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 10495: After that, those variables
1.81 rillig 10496: that have not been overridden by the user are loaded from
10497: <code class="filename">mk/defaults/mk.conf</code>.</p>
10498: <p>After the user settings, the system settings and platform
10499: settings are loaded, which may override the user
10500: settings.</p>
10501: <p>Then, the tool definitions are loaded. The tool wrappers
10502: are not yet in effect. This only happens when building a
10503: package, so the proper variables must be used instead of the
10504: direct tool names.</p>
10505: <p>As the last steps, some essential variables from the
10506: wrapper and the package system flavor are loaded, as well as the
10507: variables that have been cached in earlier phases of a package
10508: build.</p>
10509: </div>
1.148 asau 10510: <div class="sect2">
1.81 rillig 10511: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10512: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10513: </h3></div></div></div>
1.81 rillig 10514: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10515: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10516: loaded, which fill default values for those variables that have
1.93 rillig 10517: not been defined by the package. These variables may later
1.81 rillig 10518: be used even in unrelated files.</p>
10519: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10520: provides the target <code class="literal">error-check</code> that is added
10521: as a special dependency to all other targets that use
10522: <code class="varname">DELAYED_ERROR_MSG</code> or
10523: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10524: <p>Then, the package-specific hacks from
10525: <code class="filename">hacks.mk</code> are included.</p>
10526: <p>Then, various other files follow. Most of them don't have
10527: any dependencies on what they need to have included before or
10528: after them, though some do.</p>
10529: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10530: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10531: restricts the use of these variables to all the files that have
10532: been included before. Appearances in later files will be
10533: silently ignored.</p>
10534: <p>Then, the files for the main targets are included, in the
10535: order of later execution, though the actual order should not
10536: matter.</p>
10537: <p>At last, some more files are included that don't set any
10538: interesting variables but rather just define make targets to be
10539: executed.</p>
10540: </div>
10541: </div>
1.75 rillig 10542: </div>
1.148 asau 10543: <div class="chapter">
1.75 rillig 10544: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10545: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.75 rillig 10546: <div class="toc">
10547: <p><b>Table of Contents</b></p>
1.210 leot 10548: <dl class="toc">
1.299 rillig 10549: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10550: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10551: <dd><dl>
1.299 rillig 10552: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10553: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10554: </dl></dd>
10555: </dl>
10556: </div>
10557: <p>The pkgsrc infrastructure consists of a large codebase,
10558: and there are many corners where every little bit of a file is
10559: well thought out, making pkgsrc likely to fail as soon as
10560: anything is changed near those parts. To prevent most changes
10561: from breaking anything, a suite of regression tests should go
10562: along with every important part of the pkgsrc infrastructure.
10563: This chapter describes how regression tests work in pkgsrc and
10564: how you can add new tests.</p>
1.148 asau 10565: <div class="sect1">
1.75 rillig 10566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10567: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.322 leot 10568: <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 10569: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10570: can simply run that command, which will run all tests in the
1.283 rillig 10571: <code class="filename">regress/</code> directory.</p>
1.75 rillig 10572: </div>
1.148 asau 10573: <div class="sect1">
1.75 rillig 10574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10575: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.283 rillig 10576: <p>Every directory in the <code class="filename">regress/</code>
10577: directory that contains a file called <code class="filename">spec</code>
1.75 rillig 10578: is considered a regression test. This file is a shell program
1.110 hubertf 10579: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10580: The following functions can be overridden to suit your
10581: needs.</p>
1.148 asau 10582: <div class="sect2">
1.75 rillig 10583: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10584: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.218 rillig 10585: <p>These functions do not take any parameters. Although they
10586: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.289 leot 10587: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218 rillig 10588: question</a> for details.</p>
1.148 asau 10589: <div class="variablelist"><dl class="variablelist">
1.218 rillig 10590: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75 rillig 10591: <dd><p>This function prepares the environment for the
10592: test. By default it does nothing.</p></dd>
1.218 rillig 10593: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10594: <dd>
10595: <p>This function runs the actual test. By default,
1.75 rillig 10596: it calls <code class="varname">TEST_MAKE</code> with the arguments
10597: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10598: error messages into the file
1.218 rillig 10599: <code class="varname">TEST_OUTFILE</code>.</p>
10600: <p>When defining this function, make sure that all output that
10601: needs to be checked is written to the correct output file.
10602: Example:</p>
10603: <pre class="programlisting">
10604: do_test() {
1.223 rillig 10605: echo "Example output"
1.218 rillig 10606: } 1>$TEST_OUTFILE 2>&1
10607: </pre>
10608: </dd>
10609: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10610: <dd>
10611: <p>This function is run after the test and is
1.75 rillig 10612: typically used to compare the actual output from the one that is
10613: expected. It can make use of the various helper functions from
1.218 rillig 10614: the next section. Example:</p>
10615: <pre class="programlisting">
10616: check_result() {
1.223 rillig 10617: exit_status 0
10618: output_require "Example"
10619: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10620: output_prohibit "no such file or directory"
1.283 rillig 10621: regress_fail "expected $expected but got $actual for input $input"
1.218 rillig 10622: }
10623: </pre>
10624: </dd>
10625: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75 rillig 10626: <dd><p>This function cleans everything up after the
10627: test has been run. By default it does nothing.</p></dd>
10628: </dl></div>
10629: </div>
1.148 asau 10630: <div class="sect2">
1.75 rillig 10631: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10632: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.148 asau 10633: <div class="variablelist"><dl class="variablelist">
1.283 rillig 10634: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10635: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218 rillig 10636: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75 rillig 10637: <dd><p>This function compares the exitcode of the
1.218 rillig 10638: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75 rillig 10639: If they differ, the test will fail.</p></dd>
1.218 rillig 10640: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10641: <dd>
10642: <p>This function checks for each of its parameters
10643: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75 rillig 10644: extended regular expression. If it does not, the test will
1.218 rillig 10645: fail. Example:</p>
10646: <pre class="programlisting">
1.219 rillig 10647: output_require "looks fine"
10648: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218 rillig 10649: </pre>
10650: </dd>
1.292 leot 10651: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75 rillig 10652: <dd><p>This function checks for each of its parameters
1.110 hubertf 10653: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10654: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10655: If any of the regular expressions matches, the test will
10656: fail.</p></dd>
10657: </dl></div>
10658: </div>
10659: </div>
10660: </div>
1.148 asau 10661: <div class="chapter">
1.75 rillig 10662: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10663: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10664: <div class="toc">
10665: <p><b>Table of Contents</b></p>
1.299 rillig 10666: <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 10667: </div>
10668: <p>The pkgsrc system has already been ported to many
10669: operating systems, hardware architectures and compilers. This
10670: chapter explains the necessary steps to make pkgsrc even more
10671: portable.</p>
1.148 asau 10672: <div class="sect1">
1.75 rillig 10673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10674: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10675: <p>To port pkgsrc to a new operating system (called
10676: <code class="literal">MyOS</code> in this example), you need to touch the
10677: following files:</p>
1.148 asau 10678: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10679: <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 10680: <dd><p>This file contains some basic definitions, for
10681: example the name of the C
10682: compiler.</p></dd>
1.76 rillig 10683: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10684: <dd><p>Insert code that defines the variables
10685: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.327 wiz 10686: <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.75 rillig 10687: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10688: <code class="varname">APPEND_ELF</code>, and the other variables that
10689: appear in this file.</p></dd>
1.93 rillig 10690: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10691: <dd><p>This file contains the platform-specific
10692: definitions that are used by pkgsrc. Start by copying one of the
10693: other files and edit it to your
10694: needs.</p></dd>
1.93 rillig 10695: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10696: <dd><p>This file defines the paths to all the tools
10697: that are needed by one or the other package in pkgsrc, as well
10698: as by pkgsrc itself. Find out where these tools are on your
10699: platform and add them.</p></dd>
10700: </dl></div>
10701: <p>Now, you should be able to build some basic packages, like
1.322 leot 10702: <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 10703: </div>
10704: </div>
10705: </div>
1.148 asau 10706: <div class="appendix">
10707: <div class="titlepage"><div><div><h1 class="title">
10708: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10709: <div class="toc">
10710: <p><b>Table of Contents</b></p>
1.210 leot 10711: <dl class="toc">
1.75 rillig 10712: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10713: <dd><dl>
10714: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10715: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10716: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287 rillig 10717: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 10718: </dl></dd>
10719: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10720: </dl>
10721: </div>
10722: <p>We checked to find a piece of software that wasn't in the packages
10723: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10724: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10725: present in the tree is beyond us, but it's useful for the purposes of
10726: this exercise.</p>
1.148 asau 10727: <div class="sect1">
1.75 rillig 10728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10729: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10730: <div class="sect2">
1.75 rillig 10731: <div class="titlepage"><div><div><h3 class="title">
10732: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10733: <pre class="programlisting">
1.100 rillig 10734: # $NetBSD$
10735: #
1.1 grant 10736:
1.100 rillig 10737: DISTNAME= bison-1.25
10738: CATEGORIES= devel
1.286 rillig 10739: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 grant 10740:
1.136 dholland 10741: MAINTAINER= pkgsrc-users@NetBSD.org
1.289 leot 10742: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.100 rillig 10743: COMMENT= GNU yacc clone
1.1 grant 10744:
1.100 rillig 10745: GNU_CONFIGURE= yes
1.152 wiz 10746: INFO_FILES= yes
1.1 grant 10747:
1.100 rillig 10748: .include "../../mk/bsd.pkg.mk"
1.1 grant 10749: </pre>
1.75 rillig 10750: </div>
1.148 asau 10751: <div class="sect2">
1.75 rillig 10752: <div class="titlepage"><div><div><h3 class="title">
10753: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10754: <pre class="programlisting">
1.100 rillig 10755: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.322 leot 10756: 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 10757: of the NetBSD source tree is beyond me.
1.1 grant 10758: </pre>
1.75 rillig 10759: </div>
1.148 asau 10760: <div class="sect2">
1.75 rillig 10761: <div class="titlepage"><div><div><h3 class="title">
10762: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10763: <pre class="programlisting">
1.100 rillig 10764: @comment $NetBSD$
10765: bin/bison
10766: man/man1/bison.1.gz
10767: share/bison.simple
10768: share/bison.hairy
1.1 grant 10769: </pre>
1.75 rillig 10770: </div>
1.148 asau 10771: <div class="sect2">
1.75 rillig 10772: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 10773: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75 rillig 10774: <p>The NetBSD package system comes with
1.322 leot 10775: <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 10776: which helps to check the contents of these
10777: files. After installation it is quite easy to use, just change to the
1.286 rillig 10778: directory of the package you wish to examine and run
1.110 hubertf 10779: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10780: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286 rillig 10781: ERROR: Makefile: Each package must define its LICENSE.
10782: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10783: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10784: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10785: 1 error, 2 warnings and 1 note found.
10786: (Run "pkglint -e" to show explanations.)
10787: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287 rillig 10788: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75 rillig 10789: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285 rillig 10790: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75 rillig 10791: -Wall</strong></span> for a very thorough check.</p>
10792: </div>
10793: </div>
1.148 asau 10794: <div class="sect1">
1.75 rillig 10795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10796: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10797: <p>Create the directory where the package lives,
10798: plus any auxiliary directories:</p>
10799: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10800: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10801: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10802: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10803: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299 rillig 10804: <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 10805: then continue with fetching the distfile:</p>
10806: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10807: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10808: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10809: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10810: ftp: Error retrieving file: 500 Internal error
10811:
10812: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10813: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10814: ftp: Error retrieving file: 500 Internal error
10815:
10816: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10817: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10818: Successfully retrieved file.</pre>
10819: <p>Generate the checksum of the distfile into
1.76 rillig 10820: <code class="filename">distinfo</code>:</p>
1.88 wiz 10821: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10822: <p>Now compile:</p>
10823: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10824: >> Checksum OK for bison-1.25.tar.gz.
10825: ===> Extracting for bison-1.25
10826: ===> Patching for bison-1.25
10827: ===> Ignoring empty patch directory
10828: ===> Configuring for bison-1.25
10829: creating cache ./config.cache
10830: checking for gcc... cc
10831: checking whether we are using GNU C... yes
10832: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10833: checking how to run the C preprocessor... cc -E
10834: checking for minix/config.h... no
10835: checking for POSIXized ISC... no
10836: checking whether cross-compiling... no
10837: checking for ANSI C header files... yes
10838: checking for string.h... yes
10839: checking for stdlib.h... yes
10840: checking for memory.h... yes
10841: checking for working const... yes
10842: checking for working alloca.h... no
10843: checking for alloca... yes
10844: checking for strerror... yes
10845: updating cache ./config.cache
10846: creating ./config.status
10847: creating Makefile
10848: ===> Building for bison-1.25
10849: 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
10850: 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
10851: 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
10852: 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
10853: 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 10854: 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 10855: 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
10856: 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
10857: 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
10858: 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
10859: 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
10860: 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
10861: 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
10862: 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
10863: 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
10864: 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
10865: 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
10866: 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
10867: 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
10868: 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
10869: 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
10870: 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
10871: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10872: rm -f bison.s1
1.75 rillig 10873: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10874: <p>Everything seems OK, so install the files:</p>
10875: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10876: >> Checksum OK for bison-1.25.tar.gz.
10877: ===> Installing for bison-1.25
10878: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10879: rm -f /usr/pkg/bin/bison
10880: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10881: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10882: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10883: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10884: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10885: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10886: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10887: ===> Registering installation for bison-1.25</pre>
10888: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10889: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10890: binary package, do this now:</p>
10891: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10892: >> Checksum OK for bison-1.25.tar.gz.
10893: ===> Building package for bison-1.25
10894: Creating package bison-1.25.tgz
10895: Registering depends:.
1.75 rillig 10896: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10897: <p>Now that you don't need the source and object files
10898: any more, clean up:</p>
10899: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10900: ===> Cleaning for bison-1.25</pre>
10901: </div>
10902: </div>
1.148 asau 10903: <div class="appendix">
10904: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 10905: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.75 rillig 10906: <div class="toc">
10907: <p><b>Table of Contents</b></p>
1.210 leot 10908: <dl class="toc">
1.322 leot 10909: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
10910: <dd><dl>
10911: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
10912: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
10913: </dl></dd>
10914: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
10915: <dd><dl>
10916: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
10917: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
10918: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
10919: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
10920: </dl></dd>
10921: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
10922: <dd><dl>
10923: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
10924: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
10925: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
10926: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
10927: </dl></dd>
1.75 rillig 10928: </dl>
10929: </div>
1.322 leot 10930: <p>
10931: A number of mechanisms are available in pkgsrc to improve the security of the
10932: resulting system. This page describes the mechanisms, and gives hints
10933: about detecting and fixing problems.
10934: </p>
10935: <p>
10936: Mechanisms can be enabled individually in
10937: <code class="filename">mk.conf</code>, and are
10938: individually described below.
10939: </p>
10940: <p>
10941: Typically, a feature will cause some programs to fail to build or work
10942: when first enabled. This can be due to latent problems in the
10943: program, and can be due to other reasons. After enough testing to
10944: have confidence that user problems will be quite rare, individual
10945: mechanisms will be enabled by default.
10946: </p>
10947: <p>
10948: For each mechanism, see the Caveats section below for an explanation
10949: of what might go wrong at compile time and at run time, and how to
10950: notice and address these problems.
10951: </p>
1.148 asau 10952: <div class="sect1">
1.75 rillig 10953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 10954: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
10955: <div class="sect2">
10956: <div class="titlepage"><div><div><h3 class="title">
10957: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
10958: <div class="sect3">
10959: <div class="titlepage"><div><div><h4 class="title">
10960: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
10961: <p>
10962: This allows substitute wrappers to be used for some commonly used
10963: library functions that do not have built-in bounds checking - but
10964: could in some cases.
10965: </p>
10966: <p>
10967: Two mitigation levels are available:
10968: </p>
10969: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10970: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
10971: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
10972: </ul></div>
10973: <p>
10974: "strong" has been enabled by default since pkgsrc-2017Q3.
10975: </p>
10976: </div>
10977: <div class="sect3">
10978: <div class="titlepage"><div><div><h4 class="title">
10979: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
10980: <p>
10981: This enables a stack-smashing protection mitigation. It is done by adding a
10982: guard variable to functions with vulnerable objects. The guards are initialized
10983: when a function is entered and then checked when the function exits. The guard
10984: check will fail and the program forcibly exited if the variable was modified in
10985: the meantime. This can happen in case of buffer overflows or memory corruption,
10986: and therefore exposing these bugs.
10987: </p>
10988: <p>
10989: Different mitigation levels are available:
10990: </p>
10991: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10992: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
10993: by the compiler;</p></li>
10994: <li class="listitem"><p>"all", which will protect every function;</p></li>
10995: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
10996: two settings above.</p></li>
10997: </ul></div>
10998: <p>
10999: This mitigation is supported by both GCC and clang. It may be supported in
11000: additional compilers, possibly under a different name. It is particularly useful
11001: for unsafe programming languages, such as C/C++.
11002: </p>
11003: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11004: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
11005: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
11006: </ul></div>
11007: <p>More details can be found here:</p>
11008: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11009: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
11010: </p></li></ul></div>
11011: </div>
11012: <div class="sect3">
11013: <div class="titlepage"><div><div><h4 class="title">
11014: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
11015: <p>
11016: This requests the creation of PIE (Position Independent Executables) for all
11017: executables. The PIE mechanism is normally used for shared libraries, so that
11018: they can be loaded at differing addresses at runtime. PIE itself does not have
11019: useful security properties; however, it is necessary to fully leverage some,
11020: such as ASLR. Some operating systems support Address Space Layout Randomization
11021: (ASLR), which causes different addresses to be used each time a program is run.
11022: This makes it more difficult for an attacker to guess addresses and thus makes
11023: exploits harder to construct. With PIE, ASLR can really be applied to the entire
11024: program, instead of the stack and heap only.
11025: </p>
11026: <p>
11027: PIE executables will only be built for toolchains that are known to support PIE.
11028: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
11029: </p>
11030: <p>
11031: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
11032: </p>
1.75 rillig 11033: </div>
1.325 gutterid 11034: <div class="sect3">
11035: <div class="titlepage"><div><div><h4 class="title">
1.334 nia 11036: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.322 leot 11037: <p>
11038: This also makes the exploitation of some security vulnerabilities more
11039: difficult in some cases.
11040: </p>
11041: <p>Two different mitigation levels are available:</p>
11042: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11043: <li class="listitem"><p>
1.334 nia 11044: partial (the default): the ELF sections are reordered so that internal data sections
1.322 leot 11045: precede the program's own data sections, and non-PLT GOT is read-only;
11046: </p></li>
11047: <li class="listitem"><p>
11048: full: in addition to partial RELRO, every relocation is performed immediately
1.333 nia 11049: when starting the program, allowing the entire GOT to be read-only. This
11050: can greatly slow down startup of large programs.
1.322 leot 11051: </p></li>
11052: </ul></div>
11053: <p>
11054: This is currently supported by GCC. Many software distributions now enable this
1.335 nia 11055: feature by default, at the "partial" level.
1.322 leot 11056: </p>
11057: <p>
11058: More details can be found here:
11059: </p>
11060: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11061: <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>
11062: </p></li></ul></div>
1.75 rillig 11063: </div>
1.334 nia 11064: </div>
11065: <div class="sect2">
11066: <div class="titlepage"><div><div><h3 class="title">
11067: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
11068: <div class="sect3">
11069: <div class="titlepage"><div><div><h4 class="title">
11070: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
11071: <p>
11072: With this option, pkgsrc will try to build packages reproducibly. This allows
11073: packages built from the same tree and with the same options, to produce
11074: identical results bit by bit. This option should be combined with ASLR and
11075: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
11076: attackers attempting to exploit security vulnerabilities.
11077: </p>
11078: <p>
11079: More details can be found here:
11080: </p>
11081: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11082: <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>
11083: </p></li></ul></div>
11084: <p>
11085: More work likely needs to be done before pkgsrc is fully reproducible.
11086: </p>
11087: </div>
1.322 leot 11088: <div class="sect3">
11089: <div class="titlepage"><div><div><h4 class="title">
1.334 nia 11090: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.322 leot 11091: <p>
11092: This uses <code class="literal">-fstack-check</code> with GCC for
11093: another stack protection mitigation.
11094: </p>
11095: <p>
11096: It asks the compiler to generate code verifying that it does not corrupt the
11097: stack. According to GCC's manual page, this is really only useful for
11098: multi-threaded programs.
11099: </p>
1.76 rillig 11100: </div>
11101: </div>
11102: </div>
1.148 asau 11103: <div class="sect1">
1.76 rillig 11104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11105: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
11106: <div class="sect2">
11107: <div class="titlepage"><div><div><h3 class="title">
11108: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
11109: <div class="sect3">
11110: <div class="titlepage"><div><div><h4 class="title">
11111: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
11112: <p>
11113: A number of packages may fail to build with this option enabled. The
11114: failures are often related to the absence of the <code class="literal">-fPIC</code>
11115: compilation flag when building libraries or executables (or ideally
11116: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
11117: <code class="varname">CFLAGS</code> already, but requires the package to
11118: actually support it.
11119: </p>
11120: <div class="sect4">
11121: <div class="titlepage"><div><div><h5 class="title">
11122: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
11123: <p>
11124: These instructions are meant as a reference only; they likely need to be adapted
11125: for many packages individually.
11126: </p>
11127: <p>
11128: For packages using <code class="filename">Makefiles</code>:
11129: </p>
11130: <pre class="programlisting">
11131: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
11132: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
11133: </pre>
11134: <p>
11135: For packages using <code class="filename">Imakefiles</code>:
11136: </p>
11137: <pre class="programlisting">
11138: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
11139: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
11140: </pre>
11141: </div>
11142: </div>
11143: <div class="sect3">
11144: <div class="titlepage"><div><div><h4 class="title">
11145: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
11146: <p>
11147: Some programs may fail to run, or crash at random times once built as PIE. Two
11148: scenarios are essentially possible. This is nearly always due to a bug in
11149: the program being exposed due to ASLR.
11150: </p>
11151: </div>
11152: <div class="sect3">
11153: <div class="titlepage"><div><div><h4 class="title">
11154: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
11155: <p>
11156: Ideally, packages should be fixed for compatibility with MKPIE.
11157: However, in some cases this is very difficult, due to complex build systems,
11158: packages using non-standard toolchains, or programming languages with odd
11159: bootstrapping mechanisms.
11160: </p>
11161: <p>
11162: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
11163: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
11164: <code class="filename">bsd.prefs.mk</code> is included.
11165: </p>
11166: </div>
11167: </div>
11168: <div class="sect2">
11169: <div class="titlepage"><div><div><h3 class="title">
11170: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
11171: <div class="sect3">
11172: <div class="titlepage"><div><div><h4 class="title">
11173: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
11174: <p>
11175: This feature makes use of pre-processing directives to look for hardened,
11176: alternative implementations of essential library calls. Some programs may fail
11177: to build as a result; this usually happens for those trying too hard to be
11178: portable, or otherwise abusing definitions in the standard library.
11179: </p>
11180: </div>
11181: <div class="sect3">
11182: <div class="titlepage"><div><div><h4 class="title">
11183: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
11184: <p>
11185: This feature may cause some programs to crash, usually indicating an
11186: actual bug in the program. The fix will typically involve patching the
11187: original program's source code.
11188: </p>
11189: </div>
11190: <div class="sect3">
11191: <div class="titlepage"><div><div><h4 class="title">
11192: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
11193: <p>
11194: At least in the case of GCC, FORTIFY will only be applied if optimization is
11195: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
11196: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
11197: optimization level. This cannot easily be applied globally, as some packages
11198: may require specific optimization levels.
11199: </p>
11200: </div>
11201: <div class="sect3">
11202: <div class="titlepage"><div><div><h4 class="title">
11203: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
11204: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11205: <h3 class="title">Note</h3>
11206: <p>FORTIFY should not be disabled to work around runtime crashes in
11207: the program! This is a very bad idea and will expose you to security
11208: vulnerabilities.
11209: </p>
11210: </div>
11211: <p>
11212: To disable FORTIFY on a per-package basis, set the following
11213: in the package's <code class="filename">Makefile</code>
11214: before <code class="filename">bsd.prefs.mk</code> is included:
11215: </p>
11216: <pre class="programlisting">
11217: FORTIFY_SUPPORTED= no
11218: </pre>
11219: </div>
11220: </div>
11221: <div class="sect2">
11222: <div class="titlepage"><div><div><h3 class="title">
11223: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
11224: <div class="sect3">
11225: <div class="titlepage"><div><div><h4 class="title">
11226: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
11227: <p>
11228: For better protection, full RELRO requires every symbol to be resolved when the
11229: program starts, rather than simply when required at run-time. This will have
11230: more impact on programs using a lot of symbols, or linked to libraries exposing
11231: a lot of symbols. Therefore, daemons or programs otherwise running in
11232: background are affected only when started. Programs loading plug-ins at
11233: run-time are affected when loading the plug-ins.
11234: </p>
11235: <p>
11236: The impact is not expected to be noticeable on modern hardware, except in some
11237: cases for big programs.
11238: </p>
11239: </div>
11240: <div class="sect3">
11241: <div class="titlepage"><div><div><h4 class="title">
11242: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
11243: <p>
11244: Some programs handle plug-ins and dependencies in a way that conflicts with
11245: RELRO: for instance, with an initialization routine listing any other plug-in
11246: required. With full RELRO, the missing symbols are resolved before the
11247: initialization routine can run, and the dynamic loader will not be able to find
11248: them directly and abort as a result. Unfortunately, this is how Xorg loads its
11249: drivers. Partial RELRO can be applied instead in this case.
11250: </p>
11251: </div>
11252: <div class="sect3">
11253: <div class="titlepage"><div><div><h4 class="title">
11254: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
11255: <p>
11256: To disable RELRO on a per-package basis, set the following
11257: in the package's <code class="filename">Makefile</code>
11258: before <code class="filename">bsd.prefs.mk</code> is included:
11259: </p>
11260: <pre class="programlisting">
11261: RELRO_SUPPORTED= no
11262: </pre>
1.324 nia 11263: <p>
11264: It is also possible to at most enable partial RELRO, by
11265: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
11266: </p>
1.322 leot 11267: </div>
11268: </div>
11269: <div class="sect2">
11270: <div class="titlepage"><div><div><h3 class="title">
11271: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
11272: <div class="sect3">
11273: <div class="titlepage"><div><div><h4 class="title">
11274: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
11275: <p>
11276: The stack-smashing protection provided by this option does not work for some
11277: programs. The most common situation in which this happens is when the program
11278: allocates variables on the stack, with the size determined at run-time.
11279: </p>
11280: </div>
11281: <div class="sect3">
11282: <div class="titlepage"><div><div><h4 class="title">
11283: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
11284: <p>
11285: Again, this feature may cause some programs to crash via a
11286: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
11287: </p>
11288: <p>
11289: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
11290: messages are sent and - by default -
11291: appended to <code class="filename">/var/log/messages</code>, e.g.:
11292: </p>
11293: <pre class="programlisting">
11294: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
11295: </pre>
11296: <p>
11297: (where <code class="literal">hostname</code> is the hostname(1) and
11298: <code class="literal">program</code> is the basename(1) of the program crashed).
11299: </p>
11300: <p>
11301: Patching the original program is then required.
11302: </p>
11303: <p>
11304: Rebuilding the package via:
11305: </p>
11306: <pre class="programlisting">
11307: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
11308: </pre>
11309: <p>
11310: and inspecting the backtrace of the coredump via the debugger
11311: should point out the problematic call by inspecting the frame
11312: calling the _chk() (SSP) function.
11313: </p>
11314: </div>
11315: <div class="sect3">
11316: <div class="titlepage"><div><div><h4 class="title">
11317: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
11318: <p>
11319: The compiler emits extra code when using this feature: a check for buffer
11320: overflows is performed when entering and exiting functions, requiring an extra
11321: variable on the stack. The level of protection can otherwise be adjusted to
11322: affect only those functions considered more sensitive by the compiler (with
11323: -fstack-protector instead of -fstack-protector-all).
11324: </p>
11325: <p>
11326: The impact is not expected to be noticeable on modern hardware. However,
11327: programs with a hard requirement to run at the fastest possible speed should
11328: avoid using this feature, or using libraries built with this feature.
11329: </p>
11330: </div>
11331: <div class="sect3">
11332: <div class="titlepage"><div><div><h4 class="title">
11333: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
11334: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11335: <h3 class="title">Note</h3>
11336: <p>SSP should not be disabled to work around runtime crashes in
11337: the program! This is a very bad idea and will expose you to security
11338: vulnerabilities.</p>
11339: </div>
11340: <p>
11341: To disable SSP on a per-package basis, set the following
11342: in the package's <code class="filename">Makefile</code>
11343: before <code class="filename">bsd.prefs.mk</code> is included:
11344: </p>
11345: <pre class="programlisting">
11346: SSP_SUPPORTED= no
11347: </pre>
11348: </div>
11349: </div>
11350: </div>
11351: <div class="sect1">
11352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11353: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
11354: <p>
11355: The illusion of security is worse than having no security at all. This section
11356: lists a number of ways to ensure the security features requested are actually
11357: effective.
11358: </p>
11359: <p>
11360: These instructions were obtained and tested on a system derived from NetBSD 7
11361: (amd64). YMMV.
11362: </p>
11363: <div class="sect2">
11364: <div class="titlepage"><div><div><h3 class="title">
11365: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
11366: <p>
11367: The ELF executable type in use changes for binaries built as PIE; without:
11368: </p>
11369: <pre class="programlisting">
11370: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
11371: /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
11372: </pre>
11373: <p>as opposed to the following binary, built as PIE:</p>
11374: <pre class="programlisting">
11375: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
11376: /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
11377: </pre>
11378: <p>
11379: The latter result is then what is expected.
11380: </p>
11381: </div>
11382: <div class="sect2">
11383: <div class="titlepage"><div><div><h3 class="title">
11384: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
11385: <p>
11386: The following command should list a section called RELRO:
11387: </p>
11388: <pre class="programlisting">
11389: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
11390:
11391: /path/to/bin/ary: file format elf64-x86-64
11392:
11393: Program Header:
11394: [...]
11395: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
11396: </pre>
11397: <p>
11398: This check is now performed automatically if
11399: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
11400: </p>
11401: </div>
11402: <div class="sect2">
11403: <div class="titlepage"><div><div><h3 class="title">
11404: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
11405: <p>
11406: The dynamic loader will apply RELRO immediately when detecting the presence of
11407: the <code class="varname">BIND_NOW</code> flag:
11408: </p>
11409: <pre class="programlisting">
11410: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
11411:
11412: /path/to/bin/ary: file format elf64-x86-64
11413:
11414: Dynamic Section:
11415: [...]
11416: BIND_NOW 0x0000000000000000
11417: </pre>
11418: <p>
11419: This has to be combined with partial RELRO (see above) to be fully efficient.
11420: </p>
11421: <p>
11422: This check is now performed automatically (where supported) if
11423: <code class="varname">PKG_DEVELOPER</code> is set.
11424: </p>
11425: </div>
11426: <div class="sect2">
11427: <div class="titlepage"><div><div><h3 class="title">
11428: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.323 nia 11429: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11430: <h3 class="title">Note</h3>
11431: <p>
11432: Checking for SSP using this method only works where the operating system
11433: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
11434: on recent NetBSD/FreeBSD/Linux versions.
11435: </p>
11436: </div>
1.322 leot 11437: <p>
11438: Building objects, binaries and libraries with SSP will affect the presence of
11439: additional symbols in the resulting file:
11440: </p>
11441: <pre class="programlisting">
11442: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
11443: [...]
11444: U __stack_chk_fail
11445: 0000000000600ea0 B __stack_chk_guard
11446: </pre>
11447: <p>
11448: This is an indicator that the program was indeed built with support for SSP.
11449: </p>
11450: <p>
11451: This check is now performed automatically (where supported) if
11452: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
11453: </p>
11454: </div>
11455: </div>
11456: </div>
11457: <div class="appendix">
11458: <div class="titlepage"><div><div><h1 class="title">
11459: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
11460: <div class="toc">
11461: <p><b>Table of Contents</b></p>
11462: <dl class="toc">
11463: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
11464: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
11465: </dl>
11466: </div>
11467: <div class="sect1">
11468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11469: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
11470: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11471: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11472: => figlet221.tar.gz doesn't seem to exist on this system.
11473: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11474: => [172219 bytes]
11475: Connected to ftp.plig.net.
11476: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11477: 331 Guest login ok, send your complete e-mail address as password.
11478: 230-You are user #5 of 500 simultaneous users allowed.
11479: 230-
11480: 230- ___ _ _ _
11481: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11482: 230- | _| _| . |_| . | | | . |_| . | _| . |
11483: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11484: 230- |_| |_| |___| |___|
11485: 230-
11486: 230-** Welcome to ftp.plig.org **
11487: 230-
11488: 230-Please note that all transfers from this FTP site are logged. If you
11489: 230-do not like this, please disconnect now.
11490: 230-
11491: 230-This archive is available via
11492: 230-
11493: 230-HTTP: http://ftp.plig.org/
11494: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11495: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11496: 230-
11497: 230-Please email comments, bug reports and requests for packages to be
11498: 230-mirrored to ftp-admin@plig.org.
11499: 230-
11500: 230-
11501: 230 Logged in anonymously.
11502: Remote system type is UNIX.
11503: Using binary mode to transfer files.
11504: 200 Type okay.
11505: 250 "/pub" is new cwd.
11506: 250-"/pub/figlet" is new cwd.
11507: 250-
11508: 250-Welcome to the figlet archive at ftp.figlet.org
11509: 250-
11510: 250- ftp://ftp.figlet.org/pub/figlet/
11511: 250-
11512: 250-The official FIGlet web page is:
11513: 250- http://www.figlet.org/
11514: 250-
11515: 250-If you have questions, please mailto:info@figlet.org. If you want to
11516: 250-contribute a font or something else, you can email us.
11517: 250
11518: 250 "/pub/figlet/program" is new cwd.
11519: 250 "/pub/figlet/program/unix" is new cwd.
11520: local: figlet221.tar.gz remote: figlet221.tar.gz
11521: 502 Unimplemented command.
11522: 227 Entering Passive Mode (195,40,6,41,246,104)
11523: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11524: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11525: 226 Transfer completed.
11526: 172219 bytes received in 00:02 (75.99 KB/s)
11527: 221 Goodbye.
11528: => Checksum OK for figlet221.tar.gz.
11529: ===> Extracting for figlet-2.2.1nb2
11530: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11531: ===> Patching for figlet-2.2.1nb2
11532: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11533: ===> Overriding tools for figlet-2.2.1nb2
11534: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11535: ===> Configuring for figlet-2.2.1nb2
11536: ===> Building for figlet-2.2.1nb2
11537: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11538: chmod a+x figlet
11539: gcc -O2 -o chkfont chkfont.c
11540: => Unwrapping files-to-be-installed.
11541: <code class="prompt">#</code>
11542: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11543: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11544: ===> Installing for figlet-2.2.1nb2
11545: install -d -o root -g wheel -m 755 /usr/pkg/bin
11546: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11547: mkdir -p /usr/pkg/share/figlet
11548: cp figlet /usr/pkg/bin
11549: cp chkfont /usr/pkg/bin
11550: chmod 555 figlist showfigfonts
11551: cp figlist /usr/pkg/bin
11552: cp showfigfonts /usr/pkg/bin
11553: cp fonts/*.flf /usr/pkg/share/figlet
11554: cp fonts/*.flc /usr/pkg/share/figlet
11555: cp figlet.6 /usr/pkg/man/man6
11556: ===> Registering installation for figlet-2.2.1nb2
11557: <code class="prompt">#</code></pre>
11558: </div>
11559: <div class="sect1">
11560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11561: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
11562: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11563: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11564: ===> Packaging figlet-2.2.1nb2
11565: ===> Building binary package for figlet-2.2.1nb2
11566: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11567: Using SrcDir value of /usr/pkg
11568: Registering depends:.
11569: <code class="prompt">#</code></pre>
11570: </div>
11571: </div>
11572: <div class="appendix">
11573: <div class="titlepage"><div><div><h1 class="title">
11574: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
11575: <div class="toc">
11576: <p><b>Table of Contents</b></p>
11577: <dl class="toc">
11578: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11579: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11580: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11581: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11582: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
11583: <code class="filename">stable</code>,
11584: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11585: source packages</a></span></dt>
11586: </dl>
11587: </div>
11588: <p>As in other big projects, the directory layout of pkgsrc
11589: is quite complex for newbies. This chapter explains where you
11590: find things on the FTP server. The base directory on
11591: <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>.
11592: On other servers it may be different, but inside this directory,
11593: everything should look the same, no matter on which server you
11594: are. This directory contains some subdirectories, which are
11595: explained below.</p>
11596: <div class="sect1">
11597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11598: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
11599: <p>The directory <code class="filename">distfiles</code> contains lots
11600: of archive files from all pkgsrc packages, which are mirrored
11601: here. The subdirectories are called after their package names
11602: and are used when the distributed files have names that don't
11603: explicitly contain a version number or are otherwise too generic
11604: (for example <code class="filename">release.tar.gz</code>).</p>
11605: </div>
11606: <div class="sect1">
11607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11608: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
11609: <p>This directory contains things that individual pkgsrc
11610: developers find worth publishing.</p>
11611: </div>
11612: <div class="sect1">
11613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11614: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
11615: <p>This directory contains binary packages for the various
11616: platforms that are supported by pkgsrc.
11617: 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>
11618: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11619: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
11620: operating system for which the packages have been built. The
11621: name is taken from the output of the <span class="command"><strong>uname</strong></span>
11622: command, so it may differ from the one you are used to
11623: hear.</p></li>
11624: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
11625: architecture of the platform for which the packages have been
11626: built. It also includes the <code class="varname">ABI</code> (Application
11627: Binary Interface) for platforms that have several of
11628: them.</p></li>
11629: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
11630: the operating system. For version numbers that change often (for
11631: example NetBSD-current), the often-changing part should be
11632: replaced with an <code class="literal">x</code>, for example
11633: <code class="literal">4.99.x</code>.</p></li>
11634: <li class="listitem"><p><code class="varname">TAG</code> is either
11635: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11636: for a stable branch, or <code class="literal">head</code> for packages
11637: built from the HEAD branch. The latter should only be used when
11638: the packages are updated on a regular basis. Otherwise the date
11639: from checking out pkgsrc should be appended, for example
11640: <code class="literal">head_20071015</code>.</p></li>
11641: </ul></div>
11642: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11643: can quickly click through the directories on the
11644: server and find the best binary packages for their machines. Since they
11645: usually know the operating system and the hardware architecture, OPSYS
11646: and ARCH are placed first. After these choices, they can select the
11647: best combination of OSVERSION and TAG together, since it is usually the
11648: case that packages stay compatible between different version of the
11649: operating system.</p>
11650: <p>In each of these directories, there is a
11651: whole binary packages collection for a specific platform. It has a directory called
11652: <code class="filename">All</code> which contains all binary packages.
11653: Besides that, there are various category directories that
11654: contain symbolic links to the real binary packages.</p>
11655: </div>
11656: <div class="sect1">
11657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11658: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 11659: <p>Here are the reports from bulk builds, for those who want
11660: to fix packages that didn't build on some of the platforms. The
1.322 leot 11661: 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 11662: </div>
1.148 asau 11663: <div class="sect1">
1.108 rillig 11664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11665: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.261 leot 11666: <code class="filename">stable</code>,
1.126 jakllsch 11667: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11668: source packages</h2></div></div></div>
1.128 wiz 11669: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 11670: that is the files that define how to create binary packages from
11671: source archives.</p>
1.262 leot 11672: <p>Each of the <code class="filename">current</code>,
11673: <code class="filename">stable</code> and
11674: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11675: directories share the same structure. They each contain a
11676: <code class="filename">pkgsrc</code> directory and
11677: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76 rillig 11678: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11679: snapshot of the CVS repository, which is updated regularly. The
1.262 leot 11680: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11681: as the directory, ready to be downloaded as a whole.</p>
11682: <p>The <code class="filename">current</code> directory contains files
11683: related to the HEAD branch of the CVS repository.
11684: In this directory there is an additional file called
11685: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11686: all pkgsrc <code class="filename">README</code>s with information about
11687: categories and packages.
11688: </p>
11689: <p>The <code class="filename">stable</code> directory is a symlink to
11690: the latest
11691: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11692: </p>
11693: <p>The
11694: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11695: directories contain files related to the
11696: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11697: stable branch of the CVS repository. In these directories there is
11698: an additional file called
11699: <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 11700: which contains the state of pkgsrc when it was branched.</p>
11701: </div>
1.75 rillig 11702: </div>
1.148 asau 11703: <div class="appendix">
11704: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 11705: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.267 rillig 11706: <p>
11707: The following list contains all help topics that are available
11708: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11709: </p>
1.269 leot 11710: <table border="0" summary="Simple list" class="simplelist">
11711: <tr>
11712: <td>#!</td>
11713: <td>-lintl</td>
11714: </tr>
11715: <tr>
1.320 wiz 11716: <td>32bit</td>
1.269 leot 11717: <td>64bit</td>
1.320 wiz 11718: </tr>
11719: <tr>
1.269 leot 11720: <td>ABI</td>
1.320 wiz 11721: <td>ACCEPTABLE_LICENSES</td>
1.269 leot 11722: </tr>
11723: <tr>
11724: <td>ACROREAD_FONTPATH</td>
1.320 wiz 11725: <td>ADDITIONAL</td>
1.269 leot 11726: </tr>
11727: <tr>
11728: <td>AFAIK</td>
1.320 wiz 11729: <td>AIX</td>
1.269 leot 11730: </tr>
11731: <tr>
11732: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.320 wiz 11733: <td>ALL_ENV</td>
1.269 leot 11734: </tr>
11735: <tr>
1.315 cirnatda 11736: <td>ALTERNATIVES_SRC</td>
1.337 ! gutterid 11737: <td>AMANDA_TMP</td>
1.332 rillig 11738: </tr>
11739: <tr>
11740: <td>AMANDA_USER</td>
1.337 ! gutterid 11741: <td>AMANDA_VAR</td>
1.329 leot 11742: </tr>
11743: <tr>
1.332 rillig 11744: <td>APACHE_GROUP</td>
1.337 ! gutterid 11745: <td>APACHE_MODULE_NAME</td>
1.327 wiz 11746: </tr>
11747: <tr>
1.332 rillig 11748: <td>APACHE_MODULE_SRC</td>
1.337 ! gutterid 11749: <td>APACHE_MODULE_SRCDIR</td>
1.311 leot 11750: </tr>
11751: <tr>
1.332 rillig 11752: <td>APACHE_PKG_PREFIX</td>
1.337 ! gutterid 11753: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.292 leot 11754: </tr>
11755: <tr>
1.332 rillig 11756: <td>APACHE_SUEXEC_DOCROOT</td>
1.337 ! gutterid 11757: <td>APACHE_USER</td>
1.274 rillig 11758: </tr>
11759: <tr>
1.332 rillig 11760: <td>APPEND_ABI</td>
1.337 ! gutterid 11761: <td>APPEND_ELF</td>
1.269 leot 11762: </tr>
11763: <tr>
1.332 rillig 11764: <td>ARLA_CACHE</td>
1.337 ! gutterid 11765: <td>AUDIT_PACKAGES_FLAGS</td>
1.269 leot 11766: </tr>
11767: <tr>
1.332 rillig 11768: <td>AUTOCONF_REQD</td>
1.337 ! gutterid 11769: <td>AUTOMAKE_OVERRIDE</td>
1.269 leot 11770: </tr>
11771: <tr>
1.332 rillig 11772: <td>AUTOMAKE_REQD</td>
1.337 ! gutterid 11773: <td>AUTO_MKDIRS</td>
1.269 leot 11774: </tr>
11775: <tr>
1.332 rillig 11776: <td>BDB185_DEFAULT</td>
1.337 ! gutterid 11777: <td>BDBBASE</td>
1.269 leot 11778: </tr>
11779: <tr>
1.332 rillig 11780: <td>BDB_ACCEPTED</td>
1.337 ! gutterid 11781: <td>BDB_DEFAULT</td>
1.269 leot 11782: </tr>
11783: <tr>
1.332 rillig 11784: <td>BDB_LIBS</td>
1.337 ! gutterid 11785: <td>BDB_TYPE</td>
1.269 leot 11786: </tr>
11787: <tr>
1.332 rillig 11788: <td>BINCIMAP_GROUP</td>
1.337 ! gutterid 11789: <td>BINCIMAP_USER</td>
1.269 leot 11790: </tr>
11791: <tr>
1.332 rillig 11792: <td>BIND_DIR</td>
1.337 ! gutterid 11793: <td>BIND_GROUP</td>
1.269 leot 11794: </tr>
11795: <tr>
1.332 rillig 11796: <td>BIND_USER</td>
1.337 ! gutterid 11797: <td>BINOWN</td>
1.269 leot 11798: </tr>
11799: <tr>
1.332 rillig 11800: <td>BINPKG_SITES</td>
1.337 ! gutterid 11801: <td>BIN_INSTALL_FLAGS</td>
1.269 leot 11802: </tr>
11803: <tr>
1.332 rillig 11804: <td>BISON_PKGDATADIR</td>
1.337 ! gutterid 11805: <td>BLAS</td>
1.312 gdt 11806: </tr>
11807: <tr>
1.332 rillig 11808: <td>BLAS_ACCEPTED</td>
1.337 ! gutterid 11809: <td>BLAS_C_INTERFACE</td>
1.269 leot 11810: </tr>
11811: <tr>
1.332 rillig 11812: <td>BLAS_INCLUDES</td>
1.337 ! gutterid 11813: <td>BLAS_INDEX64</td>
1.269 leot 11814: </tr>
11815: <tr>
1.332 rillig 11816: <td>BLAS_LIBS</td>
1.337 ! gutterid 11817: <td>BLAS_TYPE</td>
1.303 bacon 11818: </tr>
11819: <tr>
1.332 rillig 11820: <td>BOOTSTRAP_DEPENDS</td>
1.337 ! gutterid 11821: <td>BROKEN</td>
1.320 wiz 11822: </tr>
11823: <tr>
1.332 rillig 11824: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.337 ! gutterid 11825: <td>BROKEN_ON_PLATFORM</td>
1.269 leot 11826: </tr>
11827: <tr>
1.332 rillig 11828: <td>BSDSRCDIR</td>
1.337 ! gutterid 11829: <td>BSDXSRCDIR</td>
1.292 leot 11830: </tr>
11831: <tr>
1.332 rillig 11832: <td>BSD_MAKE_ENV</td>
1.337 ! gutterid 11833: <td>BUILDLINK_AUTO_DIRS</td>
1.269 leot 11834: </tr>
11835: <tr>
1.332 rillig 11836: <td>BUILDLINK_AUTO_VARS</td>
1.337 ! gutterid 11837: <td>BUILDLINK_CFLAGS</td>
1.269 leot 11838: </tr>
11839: <tr>
1.332 rillig 11840: <td>BUILDLINK_CONTENTS_FILTER</td>
1.329 leot 11841: <td>BUILDLINK_CPPFLAGS</td>
1.269 leot 11842: </tr>
11843: <tr>
11844: <td>BUILDLINK_FILES</td>
1.331 gutterid 11845: <td>BUILDLINK_FILES_CMD</td>
1.320 wiz 11846: </tr>
11847: <tr>
11848: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.331 gutterid 11849: <td>BUILDLINK_LDFLAGS</td>
1.269 leot 11850: </tr>
11851: <tr>
1.320 wiz 11852: <td>BUILDLINK_LIBS</td>
1.331 gutterid 11853: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.269 leot 11854: </tr>
11855: <tr>
1.320 wiz 11856: <td>BUILDLINK_PKGNAME</td>
1.331 gutterid 11857: <td>BUILDLINK_PREFIX</td>
1.269 leot 11858: </tr>
11859: <tr>
1.320 wiz 11860: <td>BUILDLINK_RPATHDIRS</td>
1.331 gutterid 11861: <td>BUILDLINK_TREE</td>
1.269 leot 11862: </tr>
11863: <tr>
1.320 wiz 11864: <td>BUILD_DEFS</td>
1.331 gutterid 11865: <td>BUILD_DEFS_EFFECTS</td>
1.269 leot 11866: </tr>
11867: <tr>
1.320 wiz 11868: <td>BUILD_DEPENDS</td>
1.331 gutterid 11869: <td>BUILD_DIRS</td>
1.269 leot 11870: </tr>
11871: <tr>
1.320 wiz 11872: <td>BUILD_ENV_SHELL</td>
1.331 gutterid 11873: <td>BUILD_MAKE_CMD</td>
1.269 leot 11874: </tr>
11875: <tr>
1.320 wiz 11876: <td>BUILD_MAKE_FLAGS</td>
1.331 gutterid 11877: <td>BUILD_TARGET</td>
1.269 leot 11878: </tr>
11879: <tr>
1.320 wiz 11880: <td>BUILTIN_FIND_FILES</td>
1.331 gutterid 11881: <td>BUILTIN_FIND_FILES_VAR</td>
1.269 leot 11882: </tr>
11883: <tr>
1.320 wiz 11884: <td>BUILTIN_FIND_GREP</td>
1.331 gutterid 11885: <td>BUILTIN_FIND_HEADERS</td>
1.269 leot 11886: </tr>
11887: <tr>
1.320 wiz 11888: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.331 gutterid 11889: <td>BUILTIN_FIND_PKGCONFIG</td>
1.269 leot 11890: </tr>
11891: <tr>
1.320 wiz 11892: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.331 gutterid 11893: <td>BUILTIN_PKG</td>
1.309 gutterid 11894: </tr>
11895: <tr>
1.320 wiz 11896: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.331 gutterid 11897: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.269 leot 11898: </tr>
11899: <tr>
1.320 wiz 11900: <td>BUILTIN_VERSION_SCRIPT</td>
1.331 gutterid 11901: <td>BUILTIN_X11_TYPE</td>
1.269 leot 11902: </tr>
11903: <tr>
1.320 wiz 11904: <td>BUILTIN_X11_VERSION</td>
1.331 gutterid 11905: <td>CACTI_GROUP</td>
1.269 leot 11906: </tr>
11907: <tr>
1.320 wiz 11908: <td>CACTI_USER</td>
1.331 gutterid 11909: <td>CANNA_GROUP</td>
1.269 leot 11910: </tr>
11911: <tr>
1.320 wiz 11912: <td>CANNA_USER</td>
1.331 gutterid 11913: <td>CAT</td>
1.269 leot 11914: </tr>
11915: <tr>
1.320 wiz 11916: <td>CBLAS_LIBS</td>
1.331 gutterid 11917: <td>CCACHE_BASE</td>
1.269 leot 11918: </tr>
11919: <tr>
1.303 bacon 11920: <td>CCACHE_DIR</td>
1.331 gutterid 11921: <td>CCACHE_LOGFILE</td>
1.269 leot 11922: </tr>
11923: <tr>
1.303 bacon 11924: <td>CC_VERSION</td>
1.331 gutterid 11925: <td>CC_VERSION_STRING</td>
1.269 leot 11926: </tr>
11927: <tr>
1.303 bacon 11928: <td>CDRECORD_CONF</td>
1.331 gutterid 11929: <td>CDROM_PKG_URL_DIR</td>
1.269 leot 11930: </tr>
11931: <tr>
1.303 bacon 11932: <td>CDROM_PKG_URL_HOST</td>
1.337 ! gutterid 11933: <td>CHECK_COMPILER</td>
1.332 rillig 11934: </tr>
11935: <tr>
11936: <td>CHECK_FAKEHOME</td>
1.337 ! gutterid 11937: <td>CHECK_FILES</td>
1.329 leot 11938: </tr>
11939: <tr>
1.332 rillig 11940: <td>CHECK_FILES_SKIP</td>
1.337 ! gutterid 11941: <td>CHECK_FILES_STRICT</td>
1.327 wiz 11942: </tr>
11943: <tr>
1.332 rillig 11944: <td>CHECK_HEADERS</td>
1.337 ! gutterid 11945: <td>CHECK_HEADERS_SKIP</td>
1.320 wiz 11946: </tr>
11947: <tr>
1.332 rillig 11948: <td>CHECK_INTERPRETER</td>
1.337 ! gutterid 11949: <td>CHECK_INTERPRETER_SKIP</td>
1.311 leot 11950: </tr>
11951: <tr>
1.332 rillig 11952: <td>CHECK_PERMS</td>
1.337 ! gutterid 11953: <td>CHECK_PERMS_AUTOFIX</td>
1.292 leot 11954: </tr>
11955: <tr>
1.332 rillig 11956: <td>CHECK_PERMS_SKIP</td>
1.337 ! gutterid 11957: <td>CHECK_PIE</td>
1.274 rillig 11958: </tr>
11959: <tr>
1.332 rillig 11960: <td>CHECK_PIE_SKIP</td>
1.337 ! gutterid 11961: <td>CHECK_PIE_SUPPORTED</td>
1.331 gutterid 11962: </tr>
11963: <tr>
1.332 rillig 11964: <td>CHECK_PORTABILITY</td>
1.337 ! gutterid 11965: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.269 leot 11966: </tr>
11967: <tr>
1.332 rillig 11968: <td>CHECK_PORTABILITY_SKIP</td>
1.337 ! gutterid 11969: <td>CHECK_RELRO</td>
1.269 leot 11970: </tr>
11971: <tr>
1.332 rillig 11972: <td>CHECK_RELRO_SKIP</td>
1.337 ! gutterid 11973: <td>CHECK_RELRO_SUPPORTED</td>
1.269 leot 11974: </tr>
11975: <tr>
1.332 rillig 11976: <td>CHECK_SHLIBS</td>
1.337 ! gutterid 11977: <td>CHECK_SHLIBS_SKIP</td>
1.269 leot 11978: </tr>
11979: <tr>
1.332 rillig 11980: <td>CHECK_SHLIBS_SUPPORTED</td>
1.337 ! gutterid 11981: <td>CHECK_SHLIBS_TOXIC</td>
1.269 leot 11982: </tr>
11983: <tr>
1.332 rillig 11984: <td>CHECK_SSP</td>
1.337 ! gutterid 11985: <td>CHECK_SSP_SKIP</td>
1.269 leot 11986: </tr>
11987: <tr>
1.332 rillig 11988: <td>CHECK_SSP_SUPPORTED</td>
1.337 ! gutterid 11989: <td>CHECK_STRIPPED</td>
1.269 leot 11990: </tr>
11991: <tr>
1.332 rillig 11992: <td>CHECK_STRIPPED_SKIP</td>
1.337 ! gutterid 11993: <td>CHECK_WRKREF</td>
1.269 leot 11994: </tr>
11995: <tr>
1.332 rillig 11996: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.337 ! gutterid 11997: <td>CHECK_WRKREF_SKIP</td>
1.269 leot 11998: </tr>
11999: <tr>
1.332 rillig 12000: <td>CLAMAV_DBDIR</td>
1.337 ! gutterid 12001: <td>CLAMAV_GROUP</td>
1.269 leot 12002: </tr>
12003: <tr>
1.332 rillig 12004: <td>CLAMAV_USER</td>
1.337 ! gutterid 12005: <td>CLANGBASE</td>
1.269 leot 12006: </tr>
12007: <tr>
1.332 rillig 12008: <td>CLEANDEPENDS</td>
1.337 ! gutterid 12009: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.269 leot 12010: </tr>
12011: <tr>
1.332 rillig 12012: <td>CMAKE_INSTALL_NAME_DIR</td>
1.337 ! gutterid 12013: <td>CMAKE_INSTALL_PREFIX</td>
1.269 leot 12014: </tr>
12015: <tr>
1.332 rillig 12016: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.337 ! gutterid 12017: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.269 leot 12018: </tr>
12019: <tr>
1.332 rillig 12020: <td>CMAKE_PREFIX_PATH</td>
1.305 bacon 12021: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.292 leot 12022: </tr>
12023: <tr>
1.305 bacon 12024: <td>COMPILER_RPATH_FLAG</td>
1.269 leot 12025: <td>COMPILER_USE_SYMLINKS</td>
12026: </tr>
12027: <tr>
1.305 bacon 12028: <td>CONFIGURE_ARGS</td>
1.269 leot 12029: <td>CONFIGURE_DIRS</td>
12030: </tr>
12031: <tr>
1.305 bacon 12032: <td>CONFIGURE_ENV</td>
1.287 rillig 12033: <td>CONFIGURE_ENV_SHELL</td>
1.269 leot 12034: </tr>
12035: <tr>
1.305 bacon 12036: <td>CONFIGURE_HAS_INFODIR</td>
1.269 leot 12037: <td>CONFIGURE_HAS_MANDIR</td>
12038: </tr>
12039: <tr>
1.305 bacon 12040: <td>CONFIGURE_SCRIPT</td>
1.269 leot 12041: <td>CONFIG_SHELL</td>
12042: </tr>
12043: <tr>
1.305 bacon 12044: <td>CONFIG_SHELL_FLAGS</td>
1.269 leot 12045: <td>CONF_FILES</td>
12046: </tr>
12047: <tr>
1.305 bacon 12048: <td>CONF_FILES_MODE</td>
1.269 leot 12049: <td>CONF_FILES_PERMS</td>
12050: </tr>
12051: <tr>
1.305 bacon 12052: <td>CONSERVER_DEFAULTHOST</td>
1.269 leot 12053: <td>CONSERVER_DEFAULTPORT</td>
12054: </tr>
12055: <tr>
1.305 bacon 12056: <td>CP</td>
1.269 leot 12057: <td>CPP</td>
12058: </tr>
12059: <tr>
1.305 bacon 12060: <td>CPP_PRECOMP_FLAGS</td>
1.269 leot 12061: <td>CREATE_WRKDIR_SYMLINK</td>
12062: </tr>
12063: <tr>
1.305 bacon 12064: <td>CROSSBASE</td>
1.269 leot 12065: <td>CTFCONVERT</td>
12066: </tr>
12067: <tr>
1.305 bacon 12068: <td>CTF_FILES_SKIP</td>
1.269 leot 12069: <td>CTF_SUPPORTED</td>
12070: </tr>
12071: <tr>
1.305 bacon 12072: <td>CTYPE</td>
1.269 leot 12073: <td>CUPS_GROUP</td>
12074: </tr>
12075: <tr>
1.305 bacon 12076: <td>CUPS_SYSTEM_GROUPS</td>
1.269 leot 12077: <td>CUPS_USER</td>
12078: </tr>
12079: <tr>
1.305 bacon 12080: <td>CURSES_DEFAULT</td>
1.269 leot 12081: <td>CURSES_TYPE</td>
1.292 leot 12082: </tr>
12083: <tr>
1.273 brook 12084: <td>CXX</td>
1.337 ! gutterid 12085: <td>CYRUS_GROUP</td>
1.332 rillig 12086: </tr>
12087: <tr>
12088: <td>CYRUS_IDLE</td>
1.337 ! gutterid 12089: <td>CYRUS_USER</td>
1.329 leot 12090: </tr>
12091: <tr>
1.332 rillig 12092: <td>DAEMONTOOLS_GROUP</td>
1.337 ! gutterid 12093: <td>DAEMONTOOLS_LOG_USER</td>
1.327 wiz 12094: </tr>
12095: <tr>
1.332 rillig 12096: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.337 ! gutterid 12097: <td>DARWIN_REQUIRES_FILTER</td>
1.320 wiz 12098: </tr>
12099: <tr>
1.332 rillig 12100: <td>DBUS_GROUP</td>
1.337 ! gutterid 12101: <td>DBUS_USER</td>
1.311 leot 12102: </tr>
12103: <tr>
1.332 rillig 12104: <td>DEFANG_GROUP</td>
1.337 ! gutterid 12105: <td>DEFANG_USER</td>
1.269 leot 12106: </tr>
12107: <tr>
1.332 rillig 12108: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.337 ! gutterid 12109: <td>DEFAULT_DISTFILES</td>
1.269 leot 12110: </tr>
12111: <tr>
1.332 rillig 12112: <td>DEFAULT_IRC_SERVER</td>
1.337 ! gutterid 12113: <td>DEFAULT_SERIAL_DEVICE</td>
1.269 leot 12114: </tr>
12115: <tr>
1.332 rillig 12116: <td>DEF_UMASK</td>
1.337 ! gutterid 12117: <td>DEINSTALLDEPENDS</td>
1.309 gutterid 12118: </tr>
12119: <tr>
1.332 rillig 12120: <td>DEINSTALL_SRC</td>
1.337 ! gutterid 12121: <td>DEINSTALL_TEMPLATES</td>
1.269 leot 12122: </tr>
12123: <tr>
1.332 rillig 12124: <td>DELAYED_ERROR_MSG</td>
1.337 ! gutterid 12125: <td>DELAYED_WARNING_MSG</td>
1.269 leot 12126: </tr>
12127: <tr>
1.332 rillig 12128: <td>DEPENDS</td>
1.337 ! gutterid 12129: <td>DEPENDS_TARGET</td>
1.269 leot 12130: </tr>
12131: <tr>
1.332 rillig 12132: <td>DEPENDS_TYPE</td>
1.337 ! gutterid 12133: <td>DESTDIR</td>
1.269 leot 12134: </tr>
12135: <tr>
1.332 rillig 12136: <td>DESTDIR_VARNAME</td>
1.337 ! gutterid 12137: <td>DIALER_GROUP</td>
1.269 leot 12138: </tr>
12139: <tr>
1.332 rillig 12140: <td>DIGEST_REQD</td>
1.337 ! gutterid 12141: <td>DISTDIR</td>
1.269 leot 12142: </tr>
12143: <tr>
1.332 rillig 12144: <td>DISTFILES</td>
1.337 ! gutterid 12145: <td>DISTINFO_FILE</td>
1.269 leot 12146: </tr>
12147: <tr>
1.332 rillig 12148: <td>DISTNAME</td>
1.337 ! gutterid 12149: <td>DIST_PATH</td>
1.269 leot 12150: </tr>
12151: <tr>
1.332 rillig 12152: <td>DIST_SUBDIR</td>
1.337 ! gutterid 12153: <td>DJBDNS_AXFR_USER</td>
1.269 leot 12154: </tr>
12155: <tr>
1.332 rillig 12156: <td>DJBDNS_CACHE_USER</td>
1.337 ! gutterid 12157: <td>DJBDNS_DJBDNS_GROUP</td>
1.269 leot 12158: </tr>
12159: <tr>
1.332 rillig 12160: <td>DJBDNS_LOG_USER</td>
1.337 ! gutterid 12161: <td>DJBDNS_RBL_USER</td>
1.269 leot 12162: </tr>
12163: <tr>
1.332 rillig 12164: <td>DJBDNS_TINY_USER</td>
1.337 ! gutterid 12165: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.269 leot 12166: </tr>
12167: <tr>
1.332 rillig 12168: <td>DL_AUTO_VARS</td>
1.337 ! gutterid 12169: <td>DL_CFLAGS</td>
1.269 leot 12170: </tr>
12171: <tr>
1.332 rillig 12172: <td>DL_LDFLAGS</td>
1.337 ! gutterid 12173: <td>DL_LIBS</td>
1.269 leot 12174: </tr>
12175: <tr>
1.332 rillig 12176: <td>DNS</td>
1.337 ! gutterid 12177: <td>DOCOWN</td>
1.269 leot 12178: </tr>
12179: <tr>
1.332 rillig 12180: <td>DOWNLOADED_DISTFILE</td>
1.337 ! gutterid 12181: <td>DQCACHE_GROUP</td>
1.269 leot 12182: </tr>
12183: <tr>
1.333 nia 12184: <td>DQCACHE_USER</td>
1.337 ! gutterid 12185: <td>DT_LAYOUT</td>
1.333 nia 12186: </tr>
12187: <tr>
1.332 rillig 12188: <td>DYNAMIC_SITES_CMD</td>
1.337 ! gutterid 12189: <td>DYNAMIC_SITES_SCRIPT</td>
1.269 leot 12190: </tr>
12191: <tr>
1.332 rillig 12192: <td>ECHO</td>
1.337 ! gutterid 12193: <td>ECHO_N</td>
1.269 leot 12194: </tr>
12195: <tr>
1.332 rillig 12196: <td>ELK_GUI</td>
1.337 ! gutterid 12197: <td>EMACS_TYPE</td>
1.269 leot 12198: </tr>
12199: <tr>
1.332 rillig 12200: <td>EMULDIR</td>
1.337 ! gutterid 12201: <td>EMULSUBDIR</td>
1.269 leot 12202: </tr>
12203: <tr>
1.332 rillig 12204: <td>EMULSUBDIRSLASH</td>
1.337 ! gutterid 12205: <td>EMUL_ARCH</td>
1.269 leot 12206: </tr>
12207: <tr>
1.332 rillig 12208: <td>EMUL_DISTRO</td>
1.337 ! gutterid 12209: <td>EMUL_EXEC_FMT</td>
1.269 leot 12210: </tr>
12211: <tr>
1.332 rillig 12212: <td>EMUL_IS_NATIVE</td>
1.337 ! gutterid 12213: <td>EMUL_MODULES</td>
1.269 leot 12214: </tr>
12215: <tr>
1.332 rillig 12216: <td>EMUL_OPSYS</td>
1.337 ! gutterid 12217: <td>EMUL_PKG_FMT</td>
1.269 leot 12218: </tr>
12219: <tr>
1.332 rillig 12220: <td>EMUL_PLATFORM</td>
1.337 ! gutterid 12221: <td>EMUL_PLATFORMS</td>
1.269 leot 12222: </tr>
12223: <tr>
1.332 rillig 12224: <td>EMUL_PREFER</td>
1.337 ! gutterid 12225: <td>EMUL_REQD</td>
1.269 leot 12226: </tr>
12227: <tr>
1.332 rillig 12228: <td>EMUL_TYPE</td>
1.337 ! gutterid 12229: <td>ERROR_MSG</td>
1.269 leot 12230: </tr>
12231: <tr>
1.332 rillig 12232: <td>EXIM_GROUP</td>
1.337 ! gutterid 12233: <td>EXIM_USER</td>
1.269 leot 12234: </tr>
12235: <tr>
1.332 rillig 12236: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.337 ! gutterid 12237: <td>EXTRACTOR</td>
1.269 leot 12238: </tr>
12239: <tr>
1.332 rillig 12240: <td>EXTRACT_CMD</td>
1.337 ! gutterid 12241: <td>EXTRACT_CMD_DEFAULT</td>
1.269 leot 12242: </tr>
12243: <tr>
1.332 rillig 12244: <td>EXTRACT_DIR</td>
1.337 ! gutterid 12245: <td>EXTRACT_ELEMENTS</td>
1.269 leot 12246: </tr>
12247: <tr>
1.332 rillig 12248: <td>EXTRACT_ENV</td>
1.337 ! gutterid 12249: <td>EXTRACT_ONLY</td>
1.269 leot 12250: </tr>
12251: <tr>
1.332 rillig 12252: <td>EXTRACT_OPTS</td>
1.337 ! gutterid 12253: <td>EXTRACT_SUFX</td>
1.269 leot 12254: </tr>
12255: <tr>
1.332 rillig 12256: <td>EXTRACT_USING</td>
1.337 ! gutterid 12257: <td>FAIL</td>
1.269 leot 12258: </tr>
12259: <tr>
1.332 rillig 12260: <td>FAILOVER_FETCH</td>
1.337 ! gutterid 12261: <td>FAIL_MSG</td>
1.269 leot 12262: </tr>
12263: <tr>
1.332 rillig 12264: <td>FAKE_NCURSES</td>
1.337 ! gutterid 12265: <td>FAM</td>
1.269 leot 12266: </tr>
12267: <tr>
1.332 rillig 12268: <td>FAM_ACCEPTED</td>
1.337 ! gutterid 12269: <td>FAM_DEFAULT</td>
1.269 leot 12270: </tr>
12271: <tr>
1.332 rillig 12272: <td>FAM_SERVER</td>
1.337 ! gutterid 12273: <td>FCPATH</td>
1.269 leot 12274: </tr>
12275: <tr>
1.332 rillig 12276: <td>FEATURE_CPPFLAGS</td>
1.337 ! gutterid 12277: <td>FEATURE_LDFLAGS</td>
1.292 leot 12278: </tr>
12279: <tr>
1.332 rillig 12280: <td>FEATURE_LIBS</td>
1.337 ! gutterid 12281: <td>FETCH_AFTER_ARGS</td>
1.269 leot 12282: </tr>
12283: <tr>
1.332 rillig 12284: <td>FETCH_BEFORE_ARGS</td>
1.337 ! gutterid 12285: <td>FETCH_CMD</td>
1.269 leot 12286: </tr>
12287: <tr>
1.332 rillig 12288: <td>FETCH_OUTPUT_ARGS</td>
1.337 ! gutterid 12289: <td>FETCH_PROXY</td>
1.269 leot 12290: </tr>
12291: <tr>
1.332 rillig 12292: <td>FETCH_RESUME_ARGS</td>
1.337 ! gutterid 12293: <td>FETCH_TIMEOUT</td>
1.269 leot 12294: </tr>
12295: <tr>
1.332 rillig 12296: <td>FETCH_USE_IPV4_ONLY</td>
1.337 ! gutterid 12297: <td>FETCH_USING</td>
1.269 leot 12298: </tr>
12299: <tr>
1.332 rillig 12300: <td>FILES_SUBST</td>
1.337 ! gutterid 12301: <td>FILES_SUBST_SED</td>
1.269 leot 12302: </tr>
12303: <tr>
1.332 rillig 12304: <td>FIX_SYSTEM_HEADERS</td>
1.295 rillig 12305: <td>FONTS_DIRS</td>
1.274 rillig 12306: </tr>
12307: <tr>
1.305 bacon 12308: <td>FONTS_VERBOSE</td>
1.295 rillig 12309: <td>FOO_HACKS_MK</td>
1.292 leot 12310: </tr>
12311: <tr>
1.305 bacon 12312: <td>FOX_USE_XUNICODE</td>
1.295 rillig 12313: <td>FREEWNN_GROUP</td>
1.269 leot 12314: </tr>
12315: <tr>
1.305 bacon 12316: <td>FREEWNN_USER</td>
1.295 rillig 12317: <td>FTP_PKG_URL_DIR</td>
1.269 leot 12318: </tr>
12319: <tr>
1.305 bacon 12320: <td>FTP_PKG_URL_HOST</td>
1.295 rillig 12321: <td>GAMEDATAMODE</td>
1.269 leot 12322: </tr>
12323: <tr>
1.305 bacon 12324: <td>GAMEDATA_PERMS</td>
1.295 rillig 12325: <td>GAMEDIRMODE</td>
1.269 leot 12326: </tr>
12327: <tr>
1.305 bacon 12328: <td>GAMEDIR_PERMS</td>
1.295 rillig 12329: <td>GAMEGRP</td>
1.269 leot 12330: </tr>
12331: <tr>
1.305 bacon 12332: <td>GAMEMODE</td>
1.295 rillig 12333: <td>GAMEOWN</td>
1.269 leot 12334: </tr>
12335: <tr>
1.305 bacon 12336: <td>GAMES_GROUP</td>
1.295 rillig 12337: <td>GAMES_USER</td>
1.269 leot 12338: </tr>
12339: <tr>
1.305 bacon 12340: <td>GCC</td>
1.295 rillig 12341: <td>GCCBASE</td>
1.269 leot 12342: </tr>
12343: <tr>
1.305 bacon 12344: <td>GCC_REQD</td>
1.295 rillig 12345: <td>GCC_VERSION_SUFFIX</td>
1.269 leot 12346: </tr>
12347: <tr>
1.305 bacon 12348: <td>GEM_BUILD</td>
1.295 rillig 12349: <td>GEM_CLEANBUILD</td>
1.269 leot 12350: </tr>
12351: <tr>
1.305 bacon 12352: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.295 rillig 12353: <td>GEM_DOCDIR</td>
1.269 leot 12354: </tr>
12355: <tr>
1.305 bacon 12356: <td>GEM_EXTSDIR</td>
1.295 rillig 12357: <td>GEM_HOME</td>
1.292 leot 12358: </tr>
12359: <tr>
1.305 bacon 12360: <td>GEM_KEEPBUILD</td>
1.295 rillig 12361: <td>GEM_LIBDIR</td>
1.269 leot 12362: </tr>
12363: <tr>
1.305 bacon 12364: <td>GEM_NAME</td>
1.295 rillig 12365: <td>GEM_PATH</td>
1.269 leot 12366: </tr>
12367: <tr>
1.312 gdt 12368: <td>GEM_PLUGINSDIR</td>
1.305 bacon 12369: <td>GEM_SPECFILE</td>
1.269 leot 12370: </tr>
12371: <tr>
1.312 gdt 12372: <td>GENERATE_PLIST</td>
1.316 cirnatda 12373: <td>GHC</td>
1.269 leot 12374: </tr>
12375: <tr>
1.316 cirnatda 12376: <td>GHOSTSCRIPT_REQD</td>
1.312 gdt 12377: <td>GITHUB_PROJECT</td>
1.292 leot 12378: </tr>
12379: <tr>
1.316 cirnatda 12380: <td>GITHUB_RELEASE</td>
1.315 cirnatda 12381: <td>GITHUB_SUBMODULES</td>
1.311 leot 12382: </tr>
12383: <tr>
1.316 cirnatda 12384: <td>GITHUB_TAG</td>
1.313 leot 12385: <td>GITHUB_TYPE</td>
1.269 leot 12386: </tr>
12387: <tr>
1.316 cirnatda 12388: <td>GNU</td>
1.313 leot 12389: <td>GNU_CONFIGURE</td>
1.269 leot 12390: </tr>
12391: <tr>
1.316 cirnatda 12392: <td>GNU_CONFIGURE_INFODIR</td>
1.313 leot 12393: <td>GNU_CONFIGURE_MANDIR</td>
1.269 leot 12394: </tr>
12395: <tr>
1.316 cirnatda 12396: <td>GNU_CONFIGURE_QUIET</td>
1.313 leot 12397: <td>GNU_CONFIGURE_STRICT</td>
1.269 leot 12398: </tr>
12399: <tr>
1.316 cirnatda 12400: <td>GODEP_REDIRECTS</td>
1.313 leot 12401: <td>GO_BUILD_PATTERN</td>
1.276 leot 12402: </tr>
12403: <tr>
1.316 cirnatda 12404: <td>GO_DEPS</td>
1.313 leot 12405: <td>GO_DIST_BASE</td>
1.269 leot 12406: </tr>
12407: <tr>
1.324 nia 12408: <td>GO_EXTRA_MOD_DIRS</td>
1.316 cirnatda 12409: <td>GO_MODULE_FILES</td>
1.269 leot 12410: </tr>
12411: <tr>
1.324 nia 12412: <td>GO_SRCPATH</td>
1.316 cirnatda 12413: <td>GO_VERSION_DEFAULT</td>
1.269 leot 12414: </tr>
12415: <tr>
1.324 nia 12416: <td>GROUP_SPECIFIC_PKGS</td>
1.316 cirnatda 12417: <td>GRUB_NETWORK_CARDS</td>
1.311 leot 12418: </tr>
12419: <tr>
1.324 nia 12420: <td>GRUB_PRESET_COMMAND</td>
1.316 cirnatda 12421: <td>GRUB_SCAN_ARGS</td>
1.269 leot 12422: </tr>
12423: <tr>
1.324 nia 12424: <td>GZIP</td>
1.337 ! gutterid 12425: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.332 rillig 12426: </tr>
12427: <tr>
1.331 gutterid 12428: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.337 ! gutterid 12429: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.335 nia 12430: </tr>
12431: <tr>
12432: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.337 ! gutterid 12433: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.329 leot 12434: </tr>
12435: <tr>
1.335 nia 12436: <td>HAS_CONFIGURE</td>
1.332 rillig 12437: <td>HEADER_TEMPLATES</td>
1.320 wiz 12438: </tr>
12439: <tr>
1.316 cirnatda 12440: <td>HOMEPAGE</td>
1.335 nia 12441: <td>HOST_PKGTOOLS_ARGS</td>
1.269 leot 12442: </tr>
12443: <tr>
1.316 cirnatda 12444: <td>HOST_SPECIFIC_PKGS</td>
1.335 nia 12445: <td>HOWL_GROUP</td>
1.305 bacon 12446: </tr>
12447: <tr>
1.316 cirnatda 12448: <td>HOWL_USER</td>
1.335 nia 12449: <td>ICCBASE</td>
1.269 leot 12450: </tr>
12451: <tr>
1.316 cirnatda 12452: <td>ICECAST_CHROOTDIR</td>
1.335 nia 12453: <td>ICON_THEMES</td>
1.269 leot 12454: </tr>
12455: <tr>
1.316 cirnatda 12456: <td>IDOBASE</td>
1.335 nia 12457: <td>IGNORE_CCACHE</td>
1.269 leot 12458: </tr>
12459: <tr>
1.316 cirnatda 12460: <td>IGNORE_INFO_DIRS</td>
1.335 nia 12461: <td>IGNORE_INTERACTIVE_FETCH</td>
1.269 leot 12462: </tr>
12463: <tr>
1.316 cirnatda 12464: <td>IMAKE</td>
1.335 nia 12465: <td>IMAKEOPTS</td>
1.269 leot 12466: </tr>
12467: <tr>
1.316 cirnatda 12468: <td>IMAKE_MAKE</td>
1.335 nia 12469: <td>IMAKE_MANINSTALL</td>
1.269 leot 12470: </tr>
12471: <tr>
1.316 cirnatda 12472: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.335 nia 12473: <td>IMDICTDIR</td>
1.269 leot 12474: </tr>
12475: <tr>
1.316 cirnatda 12476: <td>INCOMPAT_CURSES</td>
1.335 nia 12477: <td>INFO_DIR</td>
1.269 leot 12478: </tr>
12479: <tr>
1.316 cirnatda 12480: <td>INFO_FILES</td>
1.335 nia 12481: <td>INFO_FILES_VERBOSE</td>
1.269 leot 12482: </tr>
12483: <tr>
1.316 cirnatda 12484: <td>INFO_MSG</td>
1.335 nia 12485: <td>INIT_SYSTEM</td>
1.287 rillig 12486: </tr>
12487: <tr>
1.316 cirnatda 12488: <td>INN_DATA_DIR</td>
1.335 nia 12489: <td>INN_GROUP</td>
1.269 leot 12490: </tr>
12491: <tr>
1.316 cirnatda 12492: <td>INN_USER</td>
1.335 nia 12493: <td>INSTALLATION_DIRS</td>
1.269 leot 12494: </tr>
12495: <tr>
1.316 cirnatda 12496: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.335 nia 12497: <td>INSTALL_ENV</td>
1.269 leot 12498: </tr>
12499: <tr>
1.316 cirnatda 12500: <td>INSTALL_SH_OVERRIDE</td>
1.335 nia 12501: <td>INSTALL_SRC</td>
1.269 leot 12502: </tr>
12503: <tr>
1.316 cirnatda 12504: <td>INSTALL_TEMPLATES</td>
1.335 nia 12505: <td>INSTALL_UNSTRIPPED</td>
1.269 leot 12506: </tr>
12507: <tr>
1.316 cirnatda 12508: <td>IRCD_HYBRID_IRC_GROUP</td>
1.335 nia 12509: <td>IRCD_HYBRID_IRC_USER</td>
1.269 leot 12510: </tr>
12511: <tr>
1.316 cirnatda 12512: <td>IRCD_HYBRID_MAXCONN</td>
1.335 nia 12513: <td>IRCD_HYBRID_NICLEN</td>
1.269 leot 12514: </tr>
12515: <tr>
1.316 cirnatda 12516: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.335 nia 12517: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.269 leot 12518: </tr>
12519: <tr>
1.316 cirnatda 12520: <td>IRCD_HYBRID_TOPICLEN</td>
1.335 nia 12521: <td>IRIX</td>
1.269 leot 12522: </tr>
12523: <tr>
1.316 cirnatda 12524: <td>IRRD_USE_PGP</td>
1.335 nia 12525: <td>JABBERD_GROUP</td>
1.269 leot 12526: </tr>
12527: <tr>
1.316 cirnatda 12528: <td>JABBERD_LOGDIR</td>
1.335 nia 12529: <td>JABBERD_PIDDIR</td>
1.292 leot 12530: </tr>
12531: <tr>
1.316 cirnatda 12532: <td>JABBERD_SPOOLDIR</td>
1.335 nia 12533: <td>JABBERD_USER</td>
1.311 leot 12534: </tr>
12535: <tr>
1.333 nia 12536: <td>JAVA_BINPREFIX</td>
1.335 nia 12537: <td>JAVA_CLASSPATH</td>
1.269 leot 12538: </tr>
12539: <tr>
1.333 nia 12540: <td>JAVA_HOME</td>
1.335 nia 12541: <td>JAVA_LD_LIBRARY_PATH</td>
1.332 rillig 12542: </tr>
12543: <tr>
1.333 nia 12544: <td>JAVA_NAME</td>
1.335 nia 12545: <td>JAVA_UNLIMIT</td>
1.332 rillig 12546: </tr>
12547: <tr>
1.333 nia 12548: <td>JAVA_WRAPPERS</td>
1.335 nia 12549: <td>JPEG_ACCEPTED</td>
1.269 leot 12550: </tr>
12551: <tr>
1.333 nia 12552: <td>JPEG_DEFAULT</td>
1.335 nia 12553: <td>KERBEROS</td>
1.269 leot 12554: </tr>
12555: <tr>
1.333 nia 12556: <td>KERMIT_SUID_UUCP</td>
1.335 nia 12557: <td>KJS_USE_PCRE</td>
1.269 leot 12558: </tr>
12559: <tr>
1.333 nia 12560: <td>KNEWS_DOMAIN_FILE</td>
1.335 nia 12561: <td>KNEWS_DOMAIN_NAME</td>
1.269 leot 12562: </tr>
12563: <tr>
1.333 nia 12564: <td>KRB5_ACCEPTED</td>
1.335 nia 12565: <td>KRB5_DEFAULT</td>
1.292 leot 12566: </tr>
12567: <tr>
1.333 nia 12568: <td>LANGUAGES</td>
1.335 nia 12569: <td>LAPACKE_LIBS</td>
1.271 brook 12570: </tr>
12571: <tr>
1.333 nia 12572: <td>LAPACK_LIBS</td>
1.335 nia 12573: <td>LATEX2HTML_ICONPATH</td>
1.269 leot 12574: </tr>
12575: <tr>
1.333 nia 12576: <td>LDCONFIG_ADD_CMD</td>
1.335 nia 12577: <td>LDCONFIG_REMOVE_CMD</td>
1.269 leot 12578: </tr>
12579: <tr>
1.333 nia 12580: <td>LDD</td>
1.335 nia 12581: <td>LEAFNODE_DATA_DIR</td>
1.269 leot 12582: </tr>
12583: <tr>
1.333 nia 12584: <td>LEAFNODE_GROUP</td>
1.335 nia 12585: <td>LEAFNODE_USER</td>
1.269 leot 12586: </tr>
12587: <tr>
1.333 nia 12588: <td>LIBDVDCSS_HOMEPAGE</td>
1.335 nia 12589: <td>LIBDVDCSS_MASTER_SITES</td>
1.320 wiz 12590: </tr>
12591: <tr>
1.333 nia 12592: <td>LIBRSVG_TYPE</td>
1.335 nia 12593: <td>LIBTOOL</td>
1.270 leot 12594: </tr>
12595: <tr>
1.333 nia 12596: <td>LIBTOOLIZE_PLIST</td>
1.335 nia 12597: <td>LIBTOOL_M4_OVERRIDE</td>
1.327 wiz 12598: </tr>
12599: <tr>
1.333 nia 12600: <td>LIBUSB_TYPE</td>
1.335 nia 12601: <td>LICENSE</td>
1.269 leot 12602: </tr>
12603: <tr>
1.333 nia 12604: <td>LINKER_RPATH_FLAG</td>
1.335 nia 12605: <td>LINK_RPATH_FLAG</td>
1.292 leot 12606: </tr>
12607: <tr>
1.335 nia 12608: <td>LINUX_LOCALES</td>
1.337 ! gutterid 12609: <td>LOCALBASE</td>
1.269 leot 12610: </tr>
12611: <tr>
1.335 nia 12612: <td>LOCALBASE_LOCKTYPE</td>
1.337 ! gutterid 12613: <td>LOCALPATCHES</td>
1.329 leot 12614: </tr>
12615: <tr>
1.335 nia 12616: <td>LOVE_DATA</td>
1.337 ! gutterid 12617: <td>LOVE_GAME</td>
1.269 leot 12618: </tr>
12619: <tr>
1.335 nia 12620: <td>LOVE_VERSION</td>
1.337 ! gutterid 12621: <td>LP32PLATFORMS</td>
1.269 leot 12622: </tr>
12623: <tr>
1.335 nia 12624: <td>LP64PLATFORMS</td>
1.337 ! gutterid 12625: <td>LUA_BUSTED_ARGS</td>
1.269 leot 12626: </tr>
12627: <tr>
1.333 nia 12628: <td>LUA_CDIR</td>
1.337 ! gutterid 12629: <td>LUA_COMPILER</td>
1.336 nia 12630: </tr>
12631: <tr>
12632: <td>LUA_DOCDIR</td>
1.337 ! gutterid 12633: <td>LUA_EXAMPLESDIR</td>
1.333 nia 12634: </tr>
12635: <tr>
1.336 nia 12636: <td>LUA_INCDIR</td>
1.337 ! gutterid 12637: <td>LUA_INTERPRETER</td>
1.333 nia 12638: </tr>
12639: <tr>
1.336 nia 12640: <td>LUA_LDIR</td>
1.337 ! gutterid 12641: <td>LUA_LINKER_MAGIC</td>
1.333 nia 12642: </tr>
12643: <tr>
1.336 nia 12644: <td>LUA_PKGPREFIX</td>
1.337 ! gutterid 12645: <td>LUA_SELF_CONFLICT</td>
1.333 nia 12646: </tr>
12647: <tr>
1.336 nia 12648: <td>LUA_USE_BUSTED</td>
1.337 ! gutterid 12649: <td>LUA_VERSIONS_ACCEPTED</td>
1.333 nia 12650: </tr>
12651: <tr>
1.336 nia 12652: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.337 ! gutterid 12653: <td>LUA_VERSION_DEFAULT</td>
1.333 nia 12654: </tr>
12655: <tr>
1.336 nia 12656: <td>LUA_VERSION_REQD</td>
1.337 ! gutterid 12657: <td>Lua</td>
1.333 nia 12658: </tr>
12659: <tr>
1.336 nia 12660: <td>MACHINE_PLATFORM</td>
1.337 ! gutterid 12661: <td>MAILAGENT_DOMAIN</td>
1.269 leot 12662: </tr>
12663: <tr>
1.336 nia 12664: <td>MAILAGENT_EMAIL</td>
1.337 ! gutterid 12665: <td>MAILAGENT_FQDN</td>
1.320 wiz 12666: </tr>
12667: <tr>
1.336 nia 12668: <td>MAILAGENT_ORGANIZATION</td>
1.332 rillig 12669: <td>MAJORDOMO_HOMEDIR</td>
1.269 leot 12670: </tr>
12671: <tr>
1.324 nia 12672: <td>MAKEINFO_ARGS</td>
1.336 nia 12673: <td>MAKE_DIRS</td>
1.327 wiz 12674: </tr>
12675: <tr>
12676: <td>MAKE_DIRS_PERMS</td>
1.336 nia 12677: <td>MAKE_ENV</td>
1.269 leot 12678: </tr>
12679: <tr>
1.327 wiz 12680: <td>MAKE_FILE</td>
1.336 nia 12681: <td>MAKE_FLAGS</td>
1.269 leot 12682: </tr>
12683: <tr>
1.327 wiz 12684: <td>MAKE_JOBS</td>
1.336 nia 12685: <td>MAKE_JOBS_SAFE</td>
1.269 leot 12686: </tr>
12687: <tr>
1.327 wiz 12688: <td>MAKE_PROGRAM</td>
1.336 nia 12689: <td>MANCOMPRESSED_IF_MANZ</td>
1.303 bacon 12690: </tr>
12691: <tr>
1.327 wiz 12692: <td>MANINSTALL</td>
1.336 nia 12693: <td>MANZ</td>
1.269 leot 12694: </tr>
12695: <tr>
1.327 wiz 12696: <td>MASTER_SITES</td>
1.336 nia 12697: <td>MASTER_SITE_BACKUP</td>
1.269 leot 12698: </tr>
12699: <tr>
1.327 wiz 12700: <td>MASTER_SITE_LOCAL</td>
1.336 nia 12701: <td>MASTER_SITE_MOZILLA</td>
1.269 leot 12702: </tr>
12703: <tr>
1.327 wiz 12704: <td>MASTER_SITE_OVERRIDE</td>
1.336 nia 12705: <td>MASTER_SITE_PERL_CPAN</td>
1.269 leot 12706: </tr>
12707: <tr>
1.327 wiz 12708: <td>MASTER_SORT</td>
1.336 nia 12709: <td>MASTER_SORT_RANDOM</td>
1.269 leot 12710: </tr>
12711: <tr>
1.327 wiz 12712: <td>MASTER_SORT_REGEX</td>
1.336 nia 12713: <td>MECAB_CHARSET</td>
1.269 leot 12714: </tr>
12715: <tr>
1.327 wiz 12716: <td>MEDIATOMB_GROUP</td>
1.336 nia 12717: <td>MEDIATOMB_USER</td>
1.269 leot 12718: </tr>
12719: <tr>
1.327 wiz 12720: <td>MIPSPROBASE</td>
1.336 nia 12721: <td>MIREDO_GROUP</td>
1.269 leot 12722: </tr>
12723: <tr>
1.327 wiz 12724: <td>MIREDO_USER</td>
1.336 nia 12725: <td>MISSING_FEATURES</td>
1.269 leot 12726: </tr>
12727: <tr>
1.327 wiz 12728: <td>MKDIR</td>
1.336 nia 12729: <td>MKPIE_SUPPORTED</td>
1.269 leot 12730: </tr>
12731: <tr>
1.327 wiz 12732: <td>MLDONKEY_GROUP</td>
1.336 nia 12733: <td>MLDONKEY_HOME</td>
1.322 leot 12734: </tr>
12735: <tr>
1.327 wiz 12736: <td>MLDONKEY_USER</td>
1.336 nia 12737: <td>MONOTONE_GROUP</td>
1.269 leot 12738: </tr>
12739: <tr>
1.327 wiz 12740: <td>MONOTONE_USER</td>
1.336 nia 12741: <td>MOTIFBASE</td>
1.269 leot 12742: </tr>
12743: <tr>
1.327 wiz 12744: <td>MOTIF_TYPE</td>
1.336 nia 12745: <td>MOTIF_TYPE_DEFAULT</td>
1.269 leot 12746: </tr>
12747: <tr>
1.327 wiz 12748: <td>MPI_TYPE</td>
1.336 nia 12749: <td>MSGFMT_STRIP_MSGCTXT</td>
1.269 leot 12750: </tr>
12751: <tr>
1.327 wiz 12752: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.336 nia 12753: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.311 leot 12754: </tr>
12755: <tr>
1.336 nia 12756: <td>MV</td>
1.337 ! gutterid 12757: <td>MYSQL_CHARSET</td>
1.329 leot 12758: </tr>
12759: <tr>
1.336 nia 12760: <td>MYSQL_DATADIR</td>
1.337 ! gutterid 12761: <td>MYSQL_EXTRA_CHARSET</td>
1.269 leot 12762: </tr>
12763: <tr>
1.336 nia 12764: <td>MYSQL_GROUP</td>
1.337 ! gutterid 12765: <td>MYSQL_USER</td>
1.320 wiz 12766: </tr>
12767: <tr>
1.336 nia 12768: <td>MYSQL_VERSION</td>
1.337 ! gutterid 12769: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.269 leot 12770: </tr>
12771: <tr>
1.336 nia 12772: <td>MYSQL_VERSIONS_ALL</td>
1.337 ! gutterid 12773: <td>MYSQL_VERSION_DEFAULT</td>
1.269 leot 12774: </tr>
12775: <tr>
1.336 nia 12776: <td>NAGIOSCMD_GROUP</td>
1.337 ! gutterid 12777: <td>NAGIOSDIR</td>
1.269 leot 12778: </tr>
12779: <tr>
1.336 nia 12780: <td>NAGIOS_GROUP</td>
1.337 ! gutterid 12781: <td>NAGIOS_USER</td>
1.309 gutterid 12782: </tr>
12783: <tr>
1.336 nia 12784: <td>NATIVE_APPEND_ABI</td>
1.337 ! gutterid 12785: <td>NATIVE_APPEND_ELF</td>
1.269 leot 12786: </tr>
12787: <tr>
1.336 nia 12788: <td>NATIVE_EXEC_FMT</td>
1.337 ! gutterid 12789: <td>NATIVE_MACHINE_PLATFORM</td>
1.269 leot 12790: </tr>
12791: <tr>
1.336 nia 12792: <td>NATIVE_OBJECT_FMT</td>
1.337 ! gutterid 12793: <td>NBPAX_PROGRAM_PREFIX</td>
1.269 leot 12794: </tr>
12795: <tr>
1.336 nia 12796: <td>NETBSD_LOGIN_NAME</td>
1.337 ! gutterid 12797: <td>NMH_EDITOR</td>
1.269 leot 12798: </tr>
12799: <tr>
1.336 nia 12800: <td>NMH_MTA</td>
1.337 ! gutterid 12801: <td>NMH_PAGER</td>
1.269 leot 12802: </tr>
12803: <tr>
1.336 nia 12804: <td>NODE_VERSIONS_ACCEPTED</td>
1.337 ! gutterid 12805: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.269 leot 12806: </tr>
12807: <tr>
1.336 nia 12808: <td>NODE_VERSION_DEFAULT</td>
1.337 ! gutterid 12809: <td>NODE_VERSION_REQD</td>
1.333 nia 12810: </tr>
12811: <tr>
1.336 nia 12812: <td>NOLOGIN</td>
1.337 ! gutterid 12813: <td>NOTE</td>
1.333 nia 12814: </tr>
12815: <tr>
1.336 nia 12816: <td>NOT_FOR_PLATFORM</td>
1.337 ! gutterid 12817: <td>NOT_PAX_ASLR_SAFE</td>
1.293 rillig 12818: </tr>
12819: <tr>
1.336 nia 12820: <td>NOT_PAX_MPROTECT_SAFE</td>
1.337 ! gutterid 12821: <td>NO_BUILD</td>
1.269 leot 12822: </tr>
12823: <tr>
1.336 nia 12824: <td>NO_CHECKSUM</td>
1.337 ! gutterid 12825: <td>NO_CONFIGURE</td>
1.269 leot 12826: </tr>
12827: <tr>
1.336 nia 12828: <td>NO_SKIP</td>
1.337 ! gutterid 12829: <td>NS_PREFERRED</td>
1.269 leot 12830: </tr>
12831: <tr>
1.336 nia 12832: <td>NULLMAILER_GROUP</td>
1.337 ! gutterid 12833: <td>NULLMAILER_USER</td>
1.269 leot 12834: </tr>
12835: <tr>
1.336 nia 12836: <td>OASIS</td>
1.337 ! gutterid 12837: <td>OASIS_BUILD_ARGS</td>
1.269 leot 12838: </tr>
12839: <tr>
1.336 nia 12840: <td>OBJHOSTNAME</td>
1.337 ! gutterid 12841: <td>OBJMACHINE</td>
1.269 leot 12842: </tr>
12843: <tr>
1.336 nia 12844: <td>OCAML_FINDLIB_DIRS</td>
1.337 ! gutterid 12845: <td>OCAML_FINDLIB_REGISTER</td>
1.269 leot 12846: </tr>
12847: <tr>
1.336 nia 12848: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.337 ! gutterid 12849: <td>OCAML_SITELIBDIR</td>
1.269 leot 12850: </tr>
12851: <tr>
1.336 nia 12852: <td>OCAML_TOPKG_DOCDIR</td>
1.337 ! gutterid 12853: <td>OCAML_USE_DUNE</td>
1.269 leot 12854: </tr>
12855: <tr>
1.336 nia 12856: <td>OCAML_USE_FINDLIB</td>
1.337 ! gutterid 12857: <td>OCAML_USE_OASIS</td>
1.269 leot 12858: </tr>
12859: <tr>
1.336 nia 12860: <td>OCAML_USE_OASIS_DYNRUN</td>
1.337 ! gutterid 12861: <td>OCAML_USE_OPAM</td>
1.269 leot 12862: </tr>
12863: <tr>
1.336 nia 12864: <td>OCAML_USE_OPT_COMPILER</td>
1.337 ! gutterid 12865: <td>OCAML_USE_TOPKG</td>
1.269 leot 12866: </tr>
12867: <tr>
1.336 nia 12868: <td>OMF</td>
1.337 ! gutterid 12869: <td>ONLY_FOR_COMPILER</td>
1.269 leot 12870: </tr>
12871: <tr>
1.336 nia 12872: <td>ONLY_FOR_PLATFORM</td>
1.337 ! gutterid 12873: <td>OPENSSH_CHROOT</td>
1.269 leot 12874: </tr>
12875: <tr>
1.336 nia 12876: <td>OPENSSH_GROUP</td>
1.337 ! gutterid 12877: <td>OPENSSH_USER</td>
1.269 leot 12878: </tr>
12879: <tr>
1.336 nia 12880: <td>OPSYS</td>
1.337 ! gutterid 12881: <td>OPSYS_EMULDIR</td>
1.269 leot 12882: </tr>
12883: <tr>
1.336 nia 12884: <td>OPSYS_VERSION</td>
1.337 ! gutterid 12885: <td>OS</td>
1.269 leot 12886: </tr>
12887: <tr>
1.336 nia 12888: <td>OSS_TYPE</td>
1.337 ! gutterid 12889: <td>OSX</td>
1.269 leot 12890: </tr>
12891: <tr>
1.336 nia 12892: <td>OSX_TOLERATE_SDK_SKEW</td>
1.337 ! gutterid 12893: <td>OS_VARIANT</td>
1.327 wiz 12894: </tr>
12895: <tr>
1.336 nia 12896: <td>OS_VERSION</td>
1.337 ! gutterid 12897: <td>OTF_FONTS_DIR</td>
1.329 leot 12898: </tr>
12899: <tr>
1.336 nia 12900: <td>OVERRIDE_DIRDEPTH</td>
1.337 ! gutterid 12901: <td>OVERRIDE_GEMSPEC</td>
1.269 leot 12902: </tr>
12903: <tr>
1.336 nia 12904: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
12905: <td>OWN_DIRS</td>
1.320 wiz 12906: </tr>
12907: <tr>
1.335 nia 12908: <td>OWN_DIRS_PERMS</td>
1.336 nia 12909: <td>P4GROUP</td>
1.269 leot 12910: </tr>
12911: <tr>
1.335 nia 12912: <td>P4PORT</td>
1.336 nia 12913: <td>P4ROOT</td>
1.269 leot 12914: </tr>
12915: <tr>
1.335 nia 12916: <td>P4USER</td>
1.336 nia 12917: <td>PACKAGES</td>
1.269 leot 12918: </tr>
12919: <tr>
1.335 nia 12920: <td>PALMOS_DEFAULT_SDK</td>
1.336 nia 12921: <td>PAMBASE</td>
1.269 leot 12922: </tr>
12923: <tr>
1.335 nia 12924: <td>PAM_DEFAULT</td>
1.336 nia 12925: <td>PAPERSIZE</td>
1.269 leot 12926: </tr>
12927: <tr>
1.335 nia 12928: <td>PASSIVE_FETCH</td>
1.336 nia 12929: <td>PATCHDIR</td>
1.269 leot 12930: </tr>
12931: <tr>
1.335 nia 12932: <td>PATCHFILES</td>
1.336 nia 12933: <td>PATCH_ARGS</td>
1.324 nia 12934: </tr>
12935: <tr>
1.335 nia 12936: <td>PATCH_DEBUG</td>
1.336 nia 12937: <td>PATCH_DIST_ARGS</td>
1.269 leot 12938: </tr>
12939: <tr>
1.335 nia 12940: <td>PATCH_DIST_CAT</td>
1.336 nia 12941: <td>PATCH_DIST_STRIP</td>
1.269 leot 12942: </tr>
12943: <tr>
1.335 nia 12944: <td>PATCH_FUZZ_FACTOR</td>
1.336 nia 12945: <td>PATCH_STRIP</td>
1.284 rillig 12946: </tr>
12947: <tr>
1.335 nia 12948: <td>PATH</td>
1.336 nia 12949: <td>PCCBASE</td>
1.269 leot 12950: </tr>
12951: <tr>
1.335 nia 12952: <td>PEAR_CMD</td>
1.336 nia 12953: <td>PEAR_LIB</td>
1.332 rillig 12954: </tr>
12955: <tr>
1.335 nia 12956: <td>PEAR_PACKAGE_XML</td>
1.336 nia 12957: <td>PERL5</td>
1.320 wiz 12958: </tr>
12959: <tr>
1.335 nia 12960: <td>PERL5_CONFIGURE</td>
1.336 nia 12961: <td>PERL5_CONFIGURE_DIRS</td>
1.292 leot 12962: </tr>
12963: <tr>
1.335 nia 12964: <td>PERL5_LDFLAGS</td>
1.336 nia 12965: <td>PERL5_LICENSE</td>
1.274 rillig 12966: </tr>
12967: <tr>
1.335 nia 12968: <td>PERL5_MODULE_TYPE</td>
1.336 nia 12969: <td>PERL5_PACKLIST</td>
1.274 rillig 12970: </tr>
12971: <tr>
1.335 nia 12972: <td>PERL5_PACKLIST_DIR</td>
1.336 nia 12973: <td>PERL5_PERLBASE</td>
1.269 leot 12974: </tr>
12975: <tr>
1.335 nia 12976: <td>PERL5_SITEBASE</td>
1.336 nia 12977: <td>PERL5_USE_PACKLIST</td>
1.269 leot 12978: </tr>
12979: <tr>
1.335 nia 12980: <td>PERL5_VENDORBASE</td>
1.336 nia 12981: <td>PFCTL</td>
1.269 leot 12982: </tr>
12983: <tr>
1.335 nia 12984: <td>PFVAR_H</td>
1.336 nia 12985: <td>PF_VERSION</td>
1.269 leot 12986: </tr>
12987: <tr>
1.335 nia 12988: <td>PGGROUP</td>
1.336 nia 12989: <td>PGHOME</td>
1.269 leot 12990: </tr>
12991: <tr>
1.335 nia 12992: <td>PGPKGSRCDIR</td>
1.336 nia 12993: <td>PGSQL_TYPE</td>
1.269 leot 12994: </tr>
12995: <tr>
1.335 nia 12996: <td>PGSQL_VERSION</td>
1.336 nia 12997: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.269 leot 12998: </tr>
12999: <tr>
1.335 nia 13000: <td>PGSQL_VERSION_DEFAULT</td>
1.336 nia 13001: <td>PGUSER</td>
1.269 leot 13002: </tr>
13003: <tr>
1.335 nia 13004: <td>PG_LIB_EXT</td>
1.336 nia 13005: <td>PHP</td>
1.269 leot 13006: </tr>
13007: <tr>
1.335 nia 13008: <td>PHPCOMMON_MK</td>
1.336 nia 13009: <td>PHPPKGSRCDIR</td>
1.269 leot 13010: </tr>
13011: <tr>
1.335 nia 13012: <td>PHP_BASE_VERS</td>
1.336 nia 13013: <td>PHP_CHECK_INSTALLED</td>
1.269 leot 13014: </tr>
13015: <tr>
1.335 nia 13016: <td>PHP_EXTENSION_DIR</td>
1.336 nia 13017: <td>PHP_INITIAL_TEENY</td>
1.269 leot 13018: </tr>
13019: <tr>
1.335 nia 13020: <td>PHP_PKG_PREFIX</td>
1.336 nia 13021: <td>PHP_VERSION</td>
1.269 leot 13022: </tr>
13023: <tr>
1.335 nia 13024: <td>PHP_VERSIONS_ACCEPTED</td>
1.336 nia 13025: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.269 leot 13026: </tr>
13027: <tr>
1.335 nia 13028: <td>PHP_VERSION_DEFAULT</td>
1.336 nia 13029: <td>PHP_VERSION_REQD</td>
1.269 leot 13030: </tr>
13031: <tr>
1.335 nia 13032: <td>PILRC_USE_GTK</td>
1.336 nia 13033: <td>PKGCONFIG_BASE</td>
1.269 leot 13034: </tr>
13035: <tr>
1.335 nia 13036: <td>PKGCONFIG_FILE</td>
1.336 nia 13037: <td>PKGCONFIG_OVERRIDE</td>
1.269 leot 13038: </tr>
13039: <tr>
1.335 nia 13040: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.336 nia 13041: <td>PKGDIR</td>
1.269 leot 13042: </tr>
13043: <tr>
1.335 nia 13044: <td>PKGGNUDIR</td>
1.336 nia 13045: <td>PKGINFODIR</td>
1.269 leot 13046: </tr>
13047: <tr>
1.335 nia 13048: <td>PKGLOCALEDIR</td>
1.336 nia 13049: <td>PKGMANDIR</td>
1.269 leot 13050: </tr>
13051: <tr>
1.335 nia 13052: <td>PKGNAME</td>
1.336 nia 13053: <td>PKGNAME_REQD</td>
1.269 leot 13054: </tr>
13055: <tr>
1.335 nia 13056: <td>PKGPATH</td>
1.336 nia 13057: <td>PKGREVISION</td>
1.269 leot 13058: </tr>
13059: <tr>
1.335 nia 13060: <td>PKGSRC_BLAS_TYPES</td>
1.336 nia 13061: <td>PKGSRC_CHANGES</td>
1.269 leot 13062: </tr>
13063: <tr>
1.335 nia 13064: <td>PKGSRC_COMPILER</td>
1.336 nia 13065: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.269 leot 13066: </tr>
13067: <tr>
1.335 nia 13068: <td>PKGSRC_LOCKTYPE</td>
1.336 nia 13069: <td>PKGSRC_MAKE_ENV</td>
1.292 leot 13070: </tr>
13071: <tr>
1.335 nia 13072: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.336 nia 13073: <td>PKGSRC_MKPIE</td>
1.269 leot 13074: </tr>
13075: <tr>
1.335 nia 13076: <td>PKGSRC_MKREPRO</td>
1.336 nia 13077: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.274 rillig 13078: </tr>
13079: <tr>
1.335 nia 13080: <td>PKGSRC_RUN_TEST</td>
1.336 nia 13081: <td>PKGSRC_SETENV</td>
1.269 leot 13082: </tr>
13083: <tr>
1.335 nia 13084: <td>PKGSRC_SLEEPSECS</td>
1.336 nia 13085: <td>PKGSRC_TODO</td>
1.269 leot 13086: </tr>
13087: <tr>
1.335 nia 13088: <td>PKGSRC_USE_CTF</td>
1.336 nia 13089: <td>PKGSRC_USE_FORTIFY</td>
1.269 leot 13090: </tr>
13091: <tr>
1.335 nia 13092: <td>PKGSRC_USE_RELRO</td>
1.336 nia 13093: <td>PKGSRC_USE_SSP</td>
1.269 leot 13094: </tr>
13095: <tr>
1.335 nia 13096: <td>PKGSRC_USE_STACK_CHECK</td>
1.336 nia 13097: <td>PKGTASKS_DATAFILE</td>
1.269 leot 13098: </tr>
13099: <tr>
1.335 nia 13100: <td>PKGTOOLS_ARGS</td>
1.336 nia 13101: <td>PKGTOOLS_ENV</td>
1.269 leot 13102: </tr>
13103: <tr>
1.335 nia 13104: <td>PKG_ALTERNATIVES</td>
1.336 nia 13105: <td>PKG_APACHE</td>
1.269 leot 13106: </tr>
13107: <tr>
1.335 nia 13108: <td>PKG_APACHE_ACCEPTED</td>
1.336 nia 13109: <td>PKG_APACHE_DEFAULT</td>
1.269 leot 13110: </tr>
13111: <tr>
1.335 nia 13112: <td>PKG_BEST_EXISTS</td>
1.336 nia 13113: <td>PKG_BUILD_OPTIONS</td>
1.269 leot 13114: </tr>
13115: <tr>
1.335 nia 13116: <td>PKG_COMPRESSION</td>
1.336 nia 13117: <td>PKG_CONFIG</td>
1.269 leot 13118: </tr>
13119: <tr>
1.335 nia 13120: <td>PKG_CONFIG_PERMS</td>
1.336 nia 13121: <td>PKG_CREATE_USERGROUP</td>
1.269 leot 13122: </tr>
13123: <tr>
1.335 nia 13124: <td>PKG_DB_TMPDIR</td>
1.336 nia 13125: <td>PKG_DEBUG_LEVEL</td>
1.269 leot 13126: </tr>
13127: <tr>
1.335 nia 13128: <td>PKG_DEFAULT_OPTIONS</td>
1.336 nia 13129: <td>PKG_DESTDIR_SUPPORT</td>
1.269 leot 13130: </tr>
13131: <tr>
1.335 nia 13132: <td>PKG_DEVELOPER</td>
1.336 nia 13133: <td>PKG_DISABLED_OPTIONS</td>
1.269 leot 13134: </tr>
13135: <tr>
1.335 nia 13136: <td>PKG_FATAL_ERRORS</td>
1.336 nia 13137: <td>PKG_FC</td>
1.269 leot 13138: </tr>
13139: <tr>
1.335 nia 13140: <td>PKG_FILELIST_CMD</td>
1.336 nia 13141: <td>PKG_GECOS</td>
1.269 leot 13142: </tr>
13143: <tr>
1.335 nia 13144: <td>PKG_GID</td>
1.336 nia 13145: <td>PKG_GROUPS</td>
1.269 leot 13146: </tr>
13147: <tr>
1.335 nia 13148: <td>PKG_GROUPS_VARS</td>
1.336 nia 13149: <td>PKG_HOME</td>
1.269 leot 13150: </tr>
13151: <tr>
1.335 nia 13152: <td>PKG_INIT_SCRIPTS</td>
1.336 nia 13153: <td>PKG_JAVA_HOME</td>
1.269 leot 13154: </tr>
13155: <tr>
1.335 nia 13156: <td>PKG_JVM</td>
1.336 nia 13157: <td>PKG_JVMS_ACCEPTED</td>
1.269 leot 13158: </tr>
13159: <tr>
1.335 nia 13160: <td>PKG_JVM_DEFAULT</td>
1.336 nia 13161: <td>PKG_LEGACY_OPTIONS</td>
1.269 leot 13162: </tr>
13163: <tr>
1.335 nia 13164: <td>PKG_LIBTOOL</td>
1.336 nia 13165: <td>PKG_OPTIONS</td>
1.269 leot 13166: </tr>
13167: <tr>
1.335 nia 13168: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.336 nia 13169: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.269 leot 13170: </tr>
13171: <tr>
1.335 nia 13172: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.336 nia 13173: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.269 leot 13174: </tr>
13175: <tr>
1.335 nia 13176: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.336 nia 13177: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.269 leot 13178: </tr>
13179: <tr>
1.335 nia 13180: <td>PKG_OPTIONS_VAR</td>
1.336 nia 13181: <td>PKG_PHP</td>
1.269 leot 13182: </tr>
13183: <tr>
1.335 nia 13184: <td>PKG_PHP_MAJOR_VERS</td>
1.336 nia 13185: <td>PKG_PHP_VERSION</td>
1.269 leot 13186: </tr>
13187: <tr>
1.335 nia 13188: <td>PKG_RCD_SCRIPTS</td>
1.336 nia 13189: <td>PKG_REFCOUNT_DBDIR</td>
1.269 leot 13190: </tr>
13191: <tr>
1.335 nia 13192: <td>PKG_REGISTER_SHELLS</td>
1.336 nia 13193: <td>PKG_RESUME_TRANSFERS</td>
1.269 leot 13194: </tr>
13195: <tr>
1.335 nia 13196: <td>PKG_SHELL</td>
1.336 nia 13197: <td>PKG_SUGGESTED_OPTIONS</td>
1.269 leot 13198: </tr>
13199: <tr>
1.335 nia 13200: <td>PKG_SUPPORTED_OPTIONS</td>
1.336 nia 13201: <td>PKG_SYSCONFBASE</td>
1.269 leot 13202: </tr>
13203: <tr>
1.335 nia 13204: <td>PKG_SYSCONFBASEDIR</td>
1.336 nia 13205: <td>PKG_SYSCONFDIR</td>
1.269 leot 13206: </tr>
13207: <tr>
1.335 nia 13208: <td>PKG_SYSCONFDIR_PERMS</td>
1.336 nia 13209: <td>PKG_SYSCONFSUBDIR</td>
1.269 leot 13210: </tr>
13211: <tr>
1.335 nia 13212: <td>PKG_SYSCONFVAR</td>
1.336 nia 13213: <td>PKG_TOOLS_BIN</td>
1.269 leot 13214: </tr>
13215: <tr>
1.335 nia 13216: <td>PKG_UID</td>
1.336 nia 13217: <td>PKG_UPDATE_FONTS_DB</td>
1.269 leot 13218: </tr>
13219: <tr>
1.335 nia 13220: <td>PKG_USERS</td>
1.336 nia 13221: <td>PKG_USERS_VARS</td>
1.269 leot 13222: </tr>
13223: <tr>
1.335 nia 13224: <td>PKG_VERBOSE</td>
1.336 nia 13225: <td>PLEASE</td>
1.269 leot 13226: </tr>
13227: <tr>
1.335 nia 13228: <td>PLIST</td>
1.336 nia 13229: <td>PLIST_AWK</td>
1.269 leot 13230: </tr>
13231: <tr>
1.335 nia 13232: <td>PLIST_AWK_ENV</td>
1.336 nia 13233: <td>PLIST_SRC</td>
1.269 leot 13234: </tr>
13235: <tr>
1.335 nia 13236: <td>PLIST_SUBST</td>
1.336 nia 13237: <td>PLIST_TYPE</td>
1.269 leot 13238: </tr>
13239: <tr>
1.335 nia 13240: <td>PLIST_VARS</td>
1.336 nia 13241: <td>POPTOP_USE_MPPE</td>
1.269 leot 13242: </tr>
13243: <tr>
1.335 nia 13244: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.336 nia 13245: <td>POST_FETCH_HOOK</td>
1.269 leot 13246: </tr>
13247: <tr>
1.335 nia 13248: <td>PREFER</td>
1.336 nia 13249: <td>PREFER_NATIVE</td>
1.269 leot 13250: </tr>
13251: <tr>
1.335 nia 13252: <td>PREFER_NATIVE_PTHREADS</td>
1.336 nia 13253: <td>PREFER_PKGSRC</td>
1.269 leot 13254: </tr>
13255: <tr>
1.335 nia 13256: <td>PREFIX</td>
1.336 nia 13257: <td>PREPEND_PATH</td>
1.269 leot 13258: </tr>
13259: <tr>
1.335 nia 13260: <td>PRE_ROOT_CMD</td>
1.336 nia 13261: <td>PRIVILEGED_STAGES</td>
1.269 leot 13262: </tr>
13263: <tr>
1.335 nia 13264: <td>PS</td>
1.336 nia 13265: <td>PTHREAD_AUTO_VARS</td>
1.269 leot 13266: </tr>
13267: <tr>
1.335 nia 13268: <td>PTHREAD_CFLAGS</td>
1.336 nia 13269: <td>PTHREAD_LDFLAGS</td>
1.269 leot 13270: </tr>
13271: <tr>
1.335 nia 13272: <td>PTHREAD_LIBS</td>
1.336 nia 13273: <td>PTHREAD_OPTS</td>
1.269 leot 13274: </tr>
13275: <tr>
1.335 nia 13276: <td>PTHREAD_TYPE</td>
1.336 nia 13277: <td>PVM_SSH</td>
1.269 leot 13278: </tr>
13279: <tr>
1.335 nia 13280: <td>PYPKGPREFIX</td>
1.336 nia 13281: <td>PYTHON_FOR_BUILD_ONLY</td>
1.269 leot 13282: </tr>
13283: <tr>
1.335 nia 13284: <td>PYTHON_SELF_CONFLICT</td>
1.336 nia 13285: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.269 leot 13286: </tr>
13287: <tr>
1.335 nia 13288: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.336 nia 13289: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.269 leot 13290: </tr>
13291: <tr>
1.335 nia 13292: <td>PYTHON_VERSION_DEFAULT</td>
1.336 nia 13293: <td>PYTHON_VERSION_REQD</td>
1.269 leot 13294: </tr>
13295: <tr>
1.335 nia 13296: <td>PYVERSSUFFIX</td>
1.336 nia 13297: <td>QMAILDIR</td>
1.269 leot 13298: </tr>
13299: <tr>
1.335 nia 13300: <td>QMAIL_ALIAS_USER</td>
1.336 nia 13301: <td>QMAIL_DAEMON_USER</td>
1.269 leot 13302: </tr>
13303: <tr>
1.335 nia 13304: <td>QMAIL_LOG_USER</td>
1.336 nia 13305: <td>QMAIL_NOFILES_GROUP</td>
1.269 leot 13306: </tr>
13307: <tr>
1.335 nia 13308: <td>QMAIL_PASSWD_USER</td>
1.336 nia 13309: <td>QMAIL_QMAIL_GROUP</td>
1.269 leot 13310: </tr>
13311: <tr>
1.335 nia 13312: <td>QMAIL_QUEUE_DIR</td>
1.336 nia 13313: <td>QMAIL_QUEUE_EXTRA</td>
1.269 leot 13314: </tr>
13315: <tr>
1.335 nia 13316: <td>QMAIL_QUEUE_USER</td>
1.336 nia 13317: <td>QMAIL_REMOTE_USER</td>
1.269 leot 13318: </tr>
13319: <tr>
1.335 nia 13320: <td>QMAIL_ROOT_USER</td>
1.336 nia 13321: <td>QMAIL_SEND_USER</td>
1.269 leot 13322: </tr>
13323: <tr>
1.335 nia 13324: <td>QORE_LATEST_MODULE_API</td>
1.336 nia 13325: <td>QORE_MODULE_API</td>
1.269 leot 13326: </tr>
13327: <tr>
1.335 nia 13328: <td>QORE_MODULE_DIR</td>
1.336 nia 13329: <td>QORE_USER_MODULE_DIR</td>
1.333 nia 13330: </tr>
13331: <tr>
1.335 nia 13332: <td>QORE_VERSION</td>
1.336 nia 13333: <td>QPOPPER_FAC</td>
1.333 nia 13334: </tr>
13335: <tr>
1.335 nia 13336: <td>QPOPPER_SPOOL_DIR</td>
1.336 nia 13337: <td>QPOPPER_USER</td>
1.333 nia 13338: </tr>
13339: <tr>
1.335 nia 13340: <td>RAKE_NAME</td>
1.336 nia 13341: <td>RASMOL_DEPTH</td>
1.269 leot 13342: </tr>
13343: <tr>
1.335 nia 13344: <td>RCD_SCRIPTS</td>
1.336 nia 13345: <td>RCD_SCRIPTS_DIR</td>
1.329 leot 13346: </tr>
13347: <tr>
1.335 nia 13348: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.336 nia 13349: <td>RCD_SCRIPTS_MODE</td>
1.332 rillig 13350: </tr>
13351: <tr>
1.335 nia 13352: <td>RCD_SCRIPTS_SHELL</td>
1.336 nia 13353: <td>RCD_SCRIPT_SRC</td>
1.320 wiz 13354: </tr>
13355: <tr>
1.336 nia 13356: <td>RDOC</td>
1.337 ! gutterid 13357: <td>READLINE_DEFAULT</td>
1.292 leot 13358: </tr>
13359: <tr>
1.336 nia 13360: <td>READLINE_TYPE</td>
1.337 ! gutterid 13361: <td>REAL_ROOT_GROUP</td>
1.329 leot 13362: </tr>
13363: <tr>
1.336 nia 13364: <td>REAL_ROOT_USER</td>
1.337 ! gutterid 13365: <td>RECURSIVE_MAKE</td>
1.327 wiz 13366: </tr>
13367: <tr>
1.336 nia 13368: <td>RELAY_CTRL_DIR</td>
1.337 ! gutterid 13369: <td>RELRO_SUPPORTED</td>
1.269 leot 13370: </tr>
13371: <tr>
1.336 nia 13372: <td>REPLACE_AWK</td>
1.337 ! gutterid 13373: <td>REPLACE_BASH</td>
1.320 wiz 13374: </tr>
13375: <tr>
1.336 nia 13376: <td>REPLACE_CSH</td>
1.337 ! gutterid 13377: <td>REPLACE_KSH</td>
1.311 leot 13378: </tr>
13379: <tr>
1.336 nia 13380: <td>REPLACE_LUA</td>
1.337 ! gutterid 13381: <td>REPLACE_NODEJS</td>
1.269 leot 13382: </tr>
13383: <tr>
1.336 nia 13384: <td>REPLACE_OCTAVE</td>
1.337 ! gutterid 13385: <td>REPLACE_PERL</td>
1.333 nia 13386: </tr>
13387: <tr>
1.336 nia 13388: <td>REPLACE_PERL6</td>
1.337 ! gutterid 13389: <td>REPLACE_PHP</td>
1.269 leot 13390: </tr>
13391: <tr>
1.336 nia 13392: <td>REPLACE_PYTHON</td>
1.337 ! gutterid 13393: <td>REPLACE_QORE</td>
1.331 gutterid 13394: </tr>
13395: <tr>
1.336 nia 13396: <td>REPLACE_R</td>
1.337 ! gutterid 13397: <td>REPLACE_RUBY</td>
1.269 leot 13398: </tr>
13399: <tr>
1.336 nia 13400: <td>REPLACE_RUBY_DIRS</td>
1.337 ! gutterid 13401: <td>REPLACE_RUBY_PAT</td>
1.333 nia 13402: </tr>
13403: <tr>
1.336 nia 13404: <td>REPLACE_SH</td>
1.337 ! gutterid 13405: <td>REPLACE_TEXLUA</td>
1.269 leot 13406: </tr>
13407: <tr>
1.336 nia 13408: <td>REPLACE_WISH</td>
1.337 ! gutterid 13409: <td>REQD_DIRS</td>
1.269 leot 13410: </tr>
13411: <tr>
1.336 nia 13412: <td>REQD_DIRS_PERMS</td>
1.337 ! gutterid 13413: <td>REQD_FILES</td>
1.269 leot 13414: </tr>
13415: <tr>
1.336 nia 13416: <td>REQD_FILES_MODE</td>
1.337 ! gutterid 13417: <td>REQD_FILES_PERMS</td>
1.269 leot 13418: </tr>
13419: <tr>
1.336 nia 13420: <td>RESOLV_AUTO_VARS</td>
1.337 ! gutterid 13421: <td>RESOLV_LDFLAGS</td>
1.281 leot 13422: </tr>
13423: <tr>
1.336 nia 13424: <td>RESOLV_LIBS</td>
1.335 nia 13425: <td>RM</td>
1.269 leot 13426: </tr>
13427: <tr>
1.336 nia 13428: <td>ROOT_CMD</td>
1.337 ! gutterid 13429: <td>ROOT_GROUP</td>
1.320 wiz 13430: </tr>
13431: <tr>
1.336 nia 13432: <td>ROOT_USER</td>
1.337 ! gutterid 13433: <td>RPCGEN</td>
1.332 rillig 13434: </tr>
13435: <tr>
1.336 nia 13436: <td>RPM</td>
1.337 ! gutterid 13437: <td>RPM2PKG_PLIST</td>
1.329 leot 13438: </tr>
13439: <tr>
1.336 nia 13440: <td>RPM2PKG_PREFIX</td>
1.337 ! gutterid 13441: <td>RPM2PKG_STAGE</td>
1.327 wiz 13442: </tr>
13443: <tr>
1.336 nia 13444: <td>RPM2PKG_STRIP</td>
1.337 ! gutterid 13445: <td>RPM2PKG_SUBPREFIX</td>
1.269 leot 13446: </tr>
13447: <tr>
1.336 nia 13448: <td>RPMFILES</td>
1.337 ! gutterid 13449: <td>RPMIGNOREPATH</td>
1.311 leot 13450: </tr>
13451: <tr>
1.336 nia 13452: <td>RPM_DB_PREFIX</td>
1.337 ! gutterid 13453: <td>RSSH_CVS_PATH</td>
1.269 leot 13454: </tr>
13455: <tr>
1.336 nia 13456: <td>RSSH_RDIST_PATH</td>
1.337 ! gutterid 13457: <td>RSSH_RSYNC_PATH</td>
1.269 leot 13458: </tr>
13459: <tr>
1.336 nia 13460: <td>RSSH_SCP_PATH</td>
1.337 ! gutterid 13461: <td>RSSH_SFTP_SERVER_PATH</td>
1.269 leot 13462: </tr>
13463: <tr>
1.336 nia 13464: <td>RUBY</td>
1.337 ! gutterid 13465: <td>RUBYGEM</td>
1.269 leot 13466: </tr>
13467: <tr>
1.336 nia 13468: <td>RUBYGEM_NAME</td>
1.337 ! gutterid 13469: <td>RUBYGEM_OPTIONS</td>
1.269 leot 13470: </tr>
13471: <tr>
1.336 nia 13472: <td>RUBYGEM_VERBOSE</td>
1.337 ! gutterid 13473: <td>RUBY_ABI_VERSION</td>
1.269 leot 13474: </tr>
13475: <tr>
1.336 nia 13476: <td>RUBY_ARCH</td>
1.337 ! gutterid 13477: <td>RUBY_ARCHINC</td>
1.269 leot 13478: </tr>
13479: <tr>
1.336 nia 13480: <td>RUBY_ARCHLIB</td>
1.337 ! gutterid 13481: <td>RUBY_BASE</td>
1.269 leot 13482: </tr>
13483: <tr>
1.336 nia 13484: <td>RUBY_BASERIDIR</td>
1.337 ! gutterid 13485: <td>RUBY_BUILD_DOCUMENT</td>
1.269 leot 13486: </tr>
13487: <tr>
1.336 nia 13488: <td>RUBY_DLEXT</td>
1.337 ! gutterid 13489: <td>RUBY_DOC</td>
1.269 leot 13490: </tr>
13491: <tr>
1.336 nia 13492: <td>RUBY_DYNAMIC_DIRS</td>
1.337 ! gutterid 13493: <td>RUBY_EG</td>
1.269 leot 13494: </tr>
13495: <tr>
1.336 nia 13496: <td>RUBY_ENCODING_ARG</td>
1.337 ! gutterid 13497: <td>RUBY_EXTCONF</td>
1.269 leot 13498: </tr>
13499: <tr>
1.336 nia 13500: <td>RUBY_EXTCONF_CHECK</td>
1.337 ! gutterid 13501: <td>RUBY_EXTCONF_DEBUG</td>
1.269 leot 13502: </tr>
13503: <tr>
1.336 nia 13504: <td>RUBY_EXTCONF_MAKEFILE</td>
1.337 ! gutterid 13505: <td>RUBY_GEM_ARCH</td>
1.269 leot 13506: </tr>
13507: <tr>
1.336 nia 13508: <td>RUBY_GEM_BASE</td>
1.337 ! gutterid 13509: <td>RUBY_INC</td>
1.269 leot 13510: </tr>
13511: <tr>
1.336 nia 13512: <td>RUBY_LIB</td>
1.337 ! gutterid 13513: <td>RUBY_LIB_BASE</td>
1.269 leot 13514: </tr>
13515: <tr>
1.336 nia 13516: <td>RUBY_NAME</td>
1.337 ! gutterid 13517: <td>RUBY_NOVERSION</td>
1.269 leot 13518: </tr>
13519: <tr>
1.336 nia 13520: <td>RUBY_PKGPREFIX</td>
1.337 ! gutterid 13521: <td>RUBY_RAILS</td>
1.269 leot 13522: </tr>
13523: <tr>
1.336 nia 13524: <td>RUBY_RAILS52_VERSION</td>
1.337 ! gutterid 13525: <td>RUBY_RAILS60_VERSION</td>
1.269 leot 13526: </tr>
13527: <tr>
1.336 nia 13528: <td>RUBY_RAILS61_VERSION</td>
1.337 ! gutterid 13529: <td>RUBY_RAILS70_VERSION</td>
1.269 leot 13530: </tr>
13531: <tr>
1.336 nia 13532: <td>RUBY_RAILS_ACCEPTED</td>
1.337 ! gutterid 13533: <td>RUBY_RAILS_DEFAULT</td>
1.269 leot 13534: </tr>
13535: <tr>
1.336 nia 13536: <td>RUBY_RAILS_REQD</td>
1.337 ! gutterid 13537: <td>RUBY_RAILS_STRICT_DEP</td>
1.269 leot 13538: </tr>
13539: <tr>
1.336 nia 13540: <td>RUBY_RIDIR</td>
1.337 ! gutterid 13541: <td>RUBY_SETUP</td>
1.269 leot 13542: </tr>
13543: <tr>
1.336 nia 13544: <td>RUBY_SHLIB</td>
1.337 ! gutterid 13545: <td>RUBY_SHLIBALIAS</td>
1.312 gdt 13546: </tr>
13547: <tr>
1.336 nia 13548: <td>RUBY_SHLIBVER</td>
1.337 ! gutterid 13549: <td>RUBY_SIMPLE_INSTALL</td>
1.289 leot 13550: </tr>
13551: <tr>
1.336 nia 13552: <td>RUBY_SITEARCHLIB</td>
1.337 ! gutterid 13553: <td>RUBY_SITELIB</td>
1.269 leot 13554: </tr>
13555: <tr>
1.336 nia 13556: <td>RUBY_SITELIB_BASE</td>
1.337 ! gutterid 13557: <td>RUBY_SITERIDIR</td>
1.269 leot 13558: </tr>
13559: <tr>
1.336 nia 13560: <td>RUBY_SLEXT</td>
1.337 ! gutterid 13561: <td>RUBY_SRCDIR</td>
1.269 leot 13562: </tr>
13563: <tr>
1.336 nia 13564: <td>RUBY_STATICLIB</td>
1.337 ! gutterid 13565: <td>RUBY_SUFFIX</td>
1.269 leot 13566: </tr>
13567: <tr>
1.336 nia 13568: <td>RUBY_SYSRIDIR</td>
1.337 ! gutterid 13569: <td>RUBY_USE_PTHREAD</td>
1.269 leot 13570: </tr>
13571: <tr>
1.336 nia 13572: <td>RUBY_VENDORARCHLIB</td>
1.337 ! gutterid 13573: <td>RUBY_VENDORLIB</td>
1.269 leot 13574: </tr>
13575: <tr>
1.336 nia 13576: <td>RUBY_VENDORLIB_BASE</td>
1.337 ! gutterid 13577: <td>RUBY_VER</td>
1.269 leot 13578: </tr>
13579: <tr>
1.336 nia 13580: <td>RUBY_VERSION</td>
1.337 ! gutterid 13581: <td>RUBY_VERSIONS_ACCEPTED</td>
1.269 leot 13582: </tr>
13583: <tr>
1.336 nia 13584: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.337 ! gutterid 13585: <td>RUBY_VERSION_DEFAULT</td>
1.269 leot 13586: </tr>
13587: <tr>
1.336 nia 13588: <td>RUBY_VERSION_REQD</td>
1.337 ! gutterid 13589: <td>RUBY_VER_DIR</td>
1.269 leot 13590: </tr>
13591: <tr>
1.336 nia 13592: <td>RUN</td>
1.337 ! gutterid 13593: <td>RUN_LDCONFIG</td>
1.269 leot 13594: </tr>
13595: <tr>
1.336 nia 13596: <td>RUST_TYPE</td>
1.337 ! gutterid 13597: <td>SCO</td>
1.269 leot 13598: </tr>
13599: <tr>
1.335 nia 13600: <td>SCREWS_GROUP</td>
1.333 nia 13601: <td>SCREWS_USER</td>
1.269 leot 13602: </tr>
13603: <tr>
1.337 ! gutterid 13604: <td>SCRIPTS_ENV</td>
1.333 nia 13605: <td>SCROLLKEEPER_DATADIR</td>
1.269 leot 13606: </tr>
13607: <tr>
1.337 ! gutterid 13608: <td>SCROLLKEEPER_REBUILDDB</td>
1.333 nia 13609: <td>SCROLLKEEPER_UPDATEDB</td>
1.269 leot 13610: </tr>
13611: <tr>
1.337 ! gutterid 13612: <td>SDIST_PAWD</td>
1.336 nia 13613: <td>SDL12_TYPE</td>
13614: </tr>
13615: <tr>
1.337 ! gutterid 13616: <td>SERIAL_DEVICES</td>
1.335 nia 13617: <td>SETGIDGAME</td>
1.269 leot 13618: </tr>
13619: <tr>
1.337 ! gutterid 13620: <td>SETGID_GAMES_PERMS</td>
1.335 nia 13621: <td>SETUID_ROOT_PERMS</td>
1.269 leot 13622: </tr>
13623: <tr>
1.337 ! gutterid 13624: <td>SH</td>
1.335 nia 13625: <td>SHLIB</td>
1.269 leot 13626: </tr>
13627: <tr>
1.335 nia 13628: <td>SIGN_PACKAGES</td>
1.336 nia 13629: <td>SILC_CLIENT_WITH_PERL</td>
1.269 leot 13630: </tr>
13631: <tr>
1.335 nia 13632: <td>SITE_SPECIFIC_PKGS</td>
1.336 nia 13633: <td>SKIP_DEPENDS</td>
1.292 leot 13634: </tr>
13635: <tr>
1.335 nia 13636: <td>SMF_INSTANCES</td>
1.336 nia 13637: <td>SMF_MANIFEST</td>
1.269 leot 13638: </tr>
13639: <tr>
1.335 nia 13640: <td>SMF_METHODS</td>
1.336 nia 13641: <td>SMF_METHOD_SHELL</td>
1.332 rillig 13642: </tr>
13643: <tr>
1.335 nia 13644: <td>SMF_METHOD_SRC</td>
1.336 nia 13645: <td>SMF_NAME</td>
1.269 leot 13646: </tr>
13647: <tr>
1.335 nia 13648: <td>SMF_PREFIX</td>
1.336 nia 13649: <td>SMF_SRCDIR</td>
1.274 rillig 13650: </tr>
13651: <tr>
1.335 nia 13652: <td>SNIPROXY_GROUP</td>
1.336 nia 13653: <td>SNIPROXY_USER</td>
1.269 leot 13654: </tr>
13655: <tr>
1.335 nia 13656: <td>SOURCE_BUFFSIZE</td>
1.336 nia 13657: <td>SPECIAL_PERMS</td>
1.269 leot 13658: </tr>
13659: <tr>
1.335 nia 13660: <td>SPECIFIC_PKGS</td>
1.336 nia 13661: <td>SSH_SUID</td>
1.269 leot 13662: </tr>
13663: <tr>
1.335 nia 13664: <td>SSP_SUPPORTED</td>
1.336 nia 13665: <td>SSYNC_PAWD</td>
1.269 leot 13666: </tr>
13667: <tr>
1.335 nia 13668: <td>STEP_MSG</td>
1.336 nia 13669: <td>STRIP</td>
1.269 leot 13670: </tr>
13671: <tr>
1.335 nia 13672: <td>STRIP_DBG</td>
1.336 nia 13673: <td>STRIP_DEBUG</td>
1.269 leot 13674: </tr>
13675: <tr>
1.335 nia 13676: <td>STRIP_DEBUG_SUPPORTED</td>
1.336 nia 13677: <td>STRIP_FILES_SKIP</td>
1.269 leot 13678: </tr>
13679: <tr>
1.335 nia 13680: <td>SU</td>
1.336 nia 13681: <td>SUBDIR</td>
1.269 leot 13682: </tr>
13683: <tr>
1.335 nia 13684: <td>SUBST</td>
1.336 nia 13685: <td>SUBST_CLASSES</td>
1.269 leot 13686: </tr>
13687: <tr>
1.335 nia 13688: <td>SUBST_FILES</td>
1.336 nia 13689: <td>SUBST_FILTER_CMD</td>
1.269 leot 13690: </tr>
13691: <tr>
1.335 nia 13692: <td>SUBST_MESSAGE</td>
1.336 nia 13693: <td>SUBST_NOOP_OK</td>
1.269 leot 13694: </tr>
13695: <tr>
1.335 nia 13696: <td>SUBST_SED</td>
1.336 nia 13697: <td>SUBST_SHOW_DIFF</td>
1.289 leot 13698: </tr>
13699: <tr>
1.335 nia 13700: <td>SUBST_SKIP_TEXT_CHECK</td>
1.336 nia 13701: <td>SUBST_STAGE</td>
1.269 leot 13702: </tr>
13703: <tr>
1.335 nia 13704: <td>SUBST_VARS</td>
1.336 nia 13705: <td>SUNWSPROBASE</td>
1.269 leot 13706: </tr>
13707: <tr>
1.335 nia 13708: <td>SUSE_PREFER</td>
1.336 nia 13709: <td>SU_CMD</td>
1.269 leot 13710: </tr>
13711: <tr>
1.337 ! gutterid 13712: <td>SYSCONFBASE</td>
! 13713: <td>TARGET_ARCH</td>
1.332 rillig 13714: </tr>
13715: <tr>
1.336 nia 13716: <td>TBL</td>
1.337 ! gutterid 13717: <td>TERMCAP_TYPE</td>
1.327 wiz 13718: </tr>
13719: <tr>
1.336 nia 13720: <td>TERMINFO_DEFAULT</td>
1.337 ! gutterid 13721: <td>TERMINFO_TYPE</td>
1.332 rillig 13722: </tr>
13723: <tr>
1.336 nia 13724: <td>TEST</td>
1.337 ! gutterid 13725: <td>TEST_DEPENDS</td>
1.320 wiz 13726: </tr>
13727: <tr>
1.336 nia 13728: <td>TEST_DIRS</td>
1.337 ! gutterid 13729: <td>TEST_ENV</td>
1.303 bacon 13730: </tr>
13731: <tr>
1.336 nia 13732: <td>TEST_ENV_SHELL</td>
1.337 ! gutterid 13733: <td>TEST_MAKE_CMD</td>
1.274 rillig 13734: </tr>
13735: <tr>
1.336 nia 13736: <td>TEST_MAKE_FLAGS</td>
1.337 ! gutterid 13737: <td>TEST_TARGET</td>
1.269 leot 13738: </tr>
13739: <tr>
1.336 nia 13740: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.337 ! gutterid 13741: <td>TEXLIVE_REV</td>
1.269 leot 13742: </tr>
13743: <tr>
1.336 nia 13744: <td>TEXLIVE_UNVERSIONED</td>
1.337 ! gutterid 13745: <td>TEXMFSITE</td>
1.269 leot 13746: </tr>
13747: <tr>
1.336 nia 13748: <td>TEX_FORMATS</td>
1.337 ! gutterid 13749: <td>TEX_HYPHEN_DAT</td>
1.269 leot 13750: </tr>
13751: <tr>
1.336 nia 13752: <td>TEX_HYPHEN_DEF</td>
1.337 ! gutterid 13753: <td>TEX_TEXMF_DIRS</td>
1.269 leot 13754: </tr>
13755: <tr>
1.336 nia 13756: <td>THTTPD_LOG_FACILITY</td>
1.337 ! gutterid 13757: <td>TINYDYN_USER</td>
1.269 leot 13758: </tr>
13759: <tr>
1.336 nia 13760: <td>TLSWRAPPER_CHROOT</td>
1.337 ! gutterid 13761: <td>TO</td>
1.269 leot 13762: </tr>
13763: <tr>
1.336 nia 13764: <td>TOOLS_ALIASES</td>
1.337 ! gutterid 13765: <td>TOOLS_ALWAYS_WRAP</td>
1.269 leot 13766: </tr>
13767: <tr>
1.336 nia 13768: <td>TOOLS_ARGS</td>
1.337 ! gutterid 13769: <td>TOOLS_BROKEN</td>
1.269 leot 13770: </tr>
13771: <tr>
1.336 nia 13772: <td>TOOLS_CMD</td>
1.337 ! gutterid 13773: <td>TOOLS_CMDLINE_SED</td>
1.269 leot 13774: </tr>
13775: <tr>
1.336 nia 13776: <td>TOOLS_CREATE</td>
1.337 ! gutterid 13777: <td>TOOLS_CROSS_DESTDIR</td>
1.269 leot 13778: </tr>
13779: <tr>
1.335 nia 13780: <td>TOOLS_DIR</td>
1.336 nia 13781: <td>TOOLS_FAIL</td>
1.269 leot 13782: </tr>
13783: <tr>
1.335 nia 13784: <td>TOOLS_GNU_MISSING</td>
1.336 nia 13785: <td>TOOLS_LDCONFIG</td>
1.269 leot 13786: </tr>
13787: <tr>
1.335 nia 13788: <td>TOOLS_NOOP</td>
1.336 nia 13789: <td>TOOLS_PATH</td>
1.269 leot 13790: </tr>
13791: <tr>
1.335 nia 13792: <td>TOOLS_SCRIPT</td>
1.337 ! gutterid 13793: <td>TOOLS_USE_CROSS_COMPILE</td>
1.269 leot 13794: </tr>
13795: <tr>
1.337 ! gutterid 13796: <td>TOOL_DEPENDS</td>
1.336 nia 13797: <td>TTF_FONTS_DIR</td>
1.269 leot 13798: </tr>
13799: <tr>
1.335 nia 13800: <td>TYPE</td>
1.336 nia 13801: <td>UAC_REQD_EXECS</td>
1.329 leot 13802: </tr>
13803: <tr>
1.335 nia 13804: <td>UCSPI_SSL_GROUP</td>
1.336 nia 13805: <td>UCSPI_SSL_USER</td>
1.327 wiz 13806: </tr>
13807: <tr>
1.335 nia 13808: <td>UNLIMIT_RESOURCES</td>
1.336 nia 13809: <td>UNPRIVILEGED</td>
1.269 leot 13810: </tr>
13811: <tr>
1.335 nia 13812: <td>UNPRIVILEGED_GROUP</td>
1.336 nia 13813: <td>UNPRIVILEGED_GROUPS</td>
1.269 leot 13814: </tr>
13815: <tr>
1.335 nia 13816: <td>UNPRIVILEGED_USER</td>
1.336 nia 13817: <td>UNWRAP_FILES</td>
1.269 leot 13818: </tr>
13819: <tr>
1.335 nia 13820: <td>UNWRAP_PATTERNS</td>
1.336 nia 13821: <td>UPDATE_GEMSPEC</td>
1.269 leot 13822: </tr>
13823: <tr>
1.335 nia 13824: <td>UPDATE_TARGET</td>
1.336 nia 13825: <td>URI</td>
1.269 leot 13826: </tr>
13827: <tr>
1.335 nia 13828: <td>USERGROUP_PHASE</td>
1.336 nia 13829: <td>USERPPP_GROUP</td>
1.269 leot 13830: </tr>
13831: <tr>
1.335 nia 13832: <td>USER_SPECIFIC_PKGS</td>
1.336 nia 13833: <td>USE_ABI_DEPENDS</td>
1.269 leot 13834: </tr>
13835: <tr>
1.335 nia 13836: <td>USE_APR</td>
1.336 nia 13837: <td>USE_BSD_MAKEFILE</td>
1.269 leot 13838: </tr>
13839: <tr>
1.335 nia 13840: <td>USE_BUILTIN</td>
1.336 nia 13841: <td>USE_CROSS_COMPILE</td>
1.269 leot 13842: </tr>
13843: <tr>
1.335 nia 13844: <td>USE_CURSES</td>
1.336 nia 13845: <td>USE_CWRAPPERS</td>
1.320 wiz 13846: </tr>
13847: <tr>
1.335 nia 13848: <td>USE_DB185</td>
1.336 nia 13849: <td>USE_FEATURES</td>
1.269 leot 13850: </tr>
13851: <tr>
1.335 nia 13852: <td>USE_GAMESGROUP</td>
1.336 nia 13853: <td>USE_GCC_RUNTIME</td>
1.269 leot 13854: </tr>
13855: <tr>
1.335 nia 13856: <td>USE_IMAKE</td>
1.336 nia 13857: <td>USE_JAVA</td>
1.269 leot 13858: </tr>
13859: <tr>
1.335 nia 13860: <td>USE_JAVA2</td>
1.336 nia 13861: <td>USE_LANGUAGES</td>
1.269 leot 13862: </tr>
13863: <tr>
1.335 nia 13864: <td>USE_LIBTOOL</td>
1.336 nia 13865: <td>USE_NATIVE_GCC</td>
1.269 leot 13866: </tr>
13867: <tr>
1.335 nia 13868: <td>USE_NETBSD_REPO</td>
1.336 nia 13869: <td>USE_PKGSRC_GCC</td>
1.269 leot 13870: </tr>
13871: <tr>
1.335 nia 13872: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.336 nia 13873: <td>USE_PKGTASKS</td>
1.269 leot 13874: </tr>
13875: <tr>
1.335 nia 13876: <td>USE_PKG_ADMIN_DIGEST</td>
1.336 nia 13877: <td>USE_RUBY_EXTCONF</td>
1.269 leot 13878: </tr>
13879: <tr>
1.335 nia 13880: <td>USE_RUBY_INSTALL</td>
1.336 nia 13881: <td>USE_RUBY_SETUP</td>
1.269 leot 13882: </tr>
13883: <tr>
1.335 nia 13884: <td>USE_RUBY_SETUP_PKG</td>
1.336 nia 13885: <td>USE_TOOLS</td>
1.269 leot 13886: </tr>
13887: <tr>
1.335 nia 13888: <td>UUCP_GROUP</td>
1.336 nia 13889: <td>UUCP_USER</td>
1.269 leot 13890: </tr>
13891: <tr>
1.335 nia 13892: <td>VARBASE</td>
1.336 nia 13893: <td>VARNAME</td>
1.269 leot 13894: </tr>
13895: <tr>
1.335 nia 13896: <td>VIM_EXTRA_OPTS</td>
1.336 nia 13897: <td>WARNING_MSG</td>
1.269 leot 13898: </tr>
13899: <tr>
1.335 nia 13900: <td>WCALC_CGIDIR</td>
1.336 nia 13901: <td>WCALC_CGIPATH</td>
1.269 leot 13902: </tr>
13903: <tr>
1.335 nia 13904: <td>WCALC_HTMLDIR</td>
1.336 nia 13905: <td>WCALC_HTMLPATH</td>
1.269 leot 13906: </tr>
13907: <tr>
1.335 nia 13908: <td>WDM_MANAGERS</td>
1.336 nia 13909: <td>WRAPPER_CC</td>
1.269 leot 13910: </tr>
13911: <tr>
1.335 nia 13912: <td>WRAPPER_REORDER_CMDS</td>
1.336 nia 13913: <td>WRKDIR</td>
1.269 leot 13914: </tr>
13915: <tr>
1.335 nia 13916: <td>WRKDIR_BASENAME</td>
1.336 nia 13917: <td>WRKDIR_LOCKTYPE</td>
1.269 leot 13918: </tr>
13919: <tr>
1.335 nia 13920: <td>WRKLOG</td>
1.336 nia 13921: <td>WRKOBJDIR</td>
1.269 leot 13922: </tr>
13923: <tr>
1.335 nia 13924: <td>WRKSRC</td>
1.336 nia 13925: <td>X10_PORT</td>
1.303 bacon 13926: </tr>
13927: <tr>
1.335 nia 13928: <td>X11</td>
1.336 nia 13929: <td>X11BASE</td>
1.269 leot 13930: </tr>
13931: <tr>
1.335 nia 13932: <td>X11_PKGSRCDIR</td>
1.336 nia 13933: <td>X11_TYPE</td>
1.269 leot 13934: </tr>
13935: <tr>
1.335 nia 13936: <td>X509_CERTIFICATE</td>
1.336 nia 13937: <td>X509_KEY</td>
1.269 leot 13938: </tr>
13939: <tr>
1.335 nia 13940: <td>XAW_TYPE</td>
1.336 nia 13941: <td>XLOCK_DEFAULT_MODE</td>
1.269 leot 13942: </tr>
13943: <tr>
1.335 nia 13944: <td>XMKMF</td>
1.336 nia 13945: <td>XMKMF_FLAGS</td>
1.269 leot 13946: </tr>
13947: <tr>
1.335 nia 13948: <td>XXX</td>
1.337 ! gutterid 13949: <td>YES</td>
1.269 leot 13950: </tr>
13951: <tr>
1.336 nia 13952: <td>ZSH_STATIC</td>
1.337 ! gutterid 13953: <td>__stdc__</td>
1.274 rillig 13954: </tr>
13955: <tr>
1.336 nia 13956: <td>_vargroups</td>
1.337 ! gutterid 13957: <td>accept</td>
1.332 rillig 13958: </tr>
13959: <tr>
1.336 nia 13960: <td>acquire-localbase-lock</td>
1.337 ! gutterid 13961: <td>acquire-lock</td>
1.269 leot 13962: </tr>
13963: <tr>
1.336 nia 13964: <td>add</td>
1.337 ! gutterid 13965: <td>administrator</td>
1.316 cirnatda 13966: </tr>
13967: <tr>
1.336 nia 13968: <td>alloca</td>
1.337 ! gutterid 13969: <td>alternatives</td>
1.289 leot 13970: </tr>
13971: <tr>
1.336 nia 13972: <td>aslr</td>
1.337 ! gutterid 13973: <td>asprintf</td>
1.269 leot 13974: </tr>
13975: <tr>
1.336 nia 13976: <td>atlas</td>
1.337 ! gutterid 13977: <td>autoconf</td>
1.269 leot 13978: </tr>
13979: <tr>
1.336 nia 13980: <td>automake</td>
1.337 ! gutterid 13981: <td>autoreconf</td>
1.289 leot 13982: </tr>
13983: <tr>
1.336 nia 13984: <td>awk</td>
1.337 ! gutterid 13985: <td>bash</td>
1.269 leot 13986: </tr>
13987: <tr>
1.336 nia 13988: <td>big-endian</td>
1.337 ! gutterid 13989: <td>bin-install</td>
1.269 leot 13990: </tr>
13991: <tr>
1.336 nia 13992: <td>bind</td>
1.337 ! gutterid 13993: <td>binpkg-list</td>
1.269 leot 13994: </tr>
13995: <tr>
1.336 nia 13996: <td>blas</td>
1.337 ! gutterid 13997: <td>bootstrap-depends</td>
1.271 brook 13998: </tr>
13999: <tr>
1.336 nia 14000: <td>broken</td>
1.337 ! gutterid 14001: <td>broken_on_platform</td>
1.269 leot 14002: </tr>
14003: <tr>
1.336 nia 14004: <td>bsd</td>
1.337 ! gutterid 14005: <td>bsd.prog.mk</td>
1.292 leot 14006: </tr>
14007: <tr>
1.336 nia 14008: <td>build</td>
1.337 ! gutterid 14009: <td>build-env</td>
1.274 rillig 14010: </tr>
14011: <tr>
1.336 nia 14012: <td>buildlink-directories</td>
1.337 ! gutterid 14013: <td>buildlink-oss-soundcard-h</td>
1.269 leot 14014: </tr>
14015: <tr>
1.336 nia 14016: <td>c</td>
1.337 ! gutterid 14017: <td>c++</td>
1.289 leot 14018: </tr>
14019: <tr>
1.336 nia 14020: <td>ccache</td>
1.337 ! gutterid 14021: <td>cce</td>
1.269 leot 14022: </tr>
14023: <tr>
1.336 nia 14024: <td>cdefs</td>
1.337 ! gutterid 14025: <td>ceil</td>
1.269 leot 14026: </tr>
14027: <tr>
1.336 nia 14028: <td>changes</td>
1.337 ! gutterid 14029: <td>changes-entry</td>
1.269 leot 14030: </tr>
14031: <tr>
1.336 nia 14032: <td>changes-entry-noupdate</td>
1.337 ! gutterid 14033: <td>check</td>
1.269 leot 14034: </tr>
14035: <tr>
1.336 nia 14036: <td>check-clean</td>
1.337 ! gutterid 14037: <td>check-files</td>
1.289 leot 14038: </tr>
14039: <tr>
1.336 nia 14040: <td>check-files-clean</td>
1.337 ! gutterid 14041: <td>check-vulnerable</td>
1.269 leot 14042: </tr>
14043: <tr>
1.336 nia 14044: <td>checksum</td>
1.337 ! gutterid 14045: <td>checksum-phase</td>
1.269 leot 14046: </tr>
14047: <tr>
1.336 nia 14048: <td>clean</td>
1.337 ! gutterid 14049: <td>clean-depends</td>
1.269 leot 14050: </tr>
14051: <tr>
1.336 nia 14052: <td>cleandir</td>
1.337 ! gutterid 14053: <td>commit</td>
1.269 leot 14054: </tr>
14055: <tr>
1.336 nia 14056: <td>commit-changes-entry</td>
1.337 ! gutterid 14057: <td>compact</td>
1.269 leot 14058: </tr>
14059: <tr>
1.336 nia 14060: <td>compiler</td>
1.337 ! gutterid 14061: <td>conf</td>
1.269 leot 14062: </tr>
14063: <tr>
1.336 nia 14064: <td>config.guess</td>
1.337 ! gutterid 14065: <td>config.sub</td>
1.269 leot 14066: </tr>
14067: <tr>
1.336 nia 14068: <td>configuration</td>
1.337 ! gutterid 14069: <td>configure</td>
1.269 leot 14070: </tr>
14071: <tr>
1.336 nia 14072: <td>configure-env</td>
1.337 ! gutterid 14073: <td>configure-help</td>
1.269 leot 14074: </tr>
14075: <tr>
1.336 nia 14076: <td>configure_args</td>
1.337 ! gutterid 14077: <td>connect</td>
1.269 leot 14078: </tr>
14079: <tr>
1.336 nia 14080: <td>cos</td>
1.337 ! gutterid 14081: <td>cputime</td>
1.269 leot 14082: </tr>
14083: <tr>
1.336 nia 14084: <td>create-usergroup</td>
1.337 ! gutterid 14085: <td>csh</td>
1.269 leot 14086: </tr>
14087: <tr>
1.336 nia 14088: <td>ctf</td>
14089: <td>debug</td>
1.289 leot 14090: </tr>
14091: <tr>
1.335 nia 14092: <td>declaration</td>
1.336 nia 14093: <td>declare</td>
1.329 leot 14094: </tr>
14095: <tr>
1.331 gutterid 14096: <td>defined</td>
1.336 nia 14097: <td>depend</td>
1.320 wiz 14098: </tr>
14099: <tr>
1.331 gutterid 14100: <td>dependencies</td>
1.336 nia 14101: <td>depends</td>
1.269 leot 14102: </tr>
14103: <tr>
1.331 gutterid 14104: <td>depends-checksum</td>
1.336 nia 14105: <td>depends-fetch</td>
1.311 leot 14106: </tr>
14107: <tr>
1.331 gutterid 14108: <td>deps</td>
1.336 nia 14109: <td>describe</td>
1.269 leot 14110: </tr>
14111: <tr>
1.331 gutterid 14112: <td>destdir</td>
1.336 nia 14113: <td>disable</td>
1.269 leot 14114: </tr>
14115: <tr>
1.331 gutterid 14116: <td>distclean</td>
1.336 nia 14117: <td>distinfo</td>
1.269 leot 14118: </tr>
14119: <tr>
1.331 gutterid 14120: <td>dl</td>
1.336 nia 14121: <td>dlopen</td>
1.269 leot 14122: </tr>
14123: <tr>
1.327 wiz 14124: <td>do-buildlink</td>
1.336 nia 14125: <td>do-clean</td>
1.269 leot 14126: </tr>
14127: <tr>
1.327 wiz 14128: <td>do-configure</td>
1.336 nia 14129: <td>do-configure-post-hook</td>
1.277 rillig 14130: </tr>
14131: <tr>
1.327 wiz 14132: <td>do-extract</td>
1.336 nia 14133: <td>do-fetch</td>
1.269 leot 14134: </tr>
14135: <tr>
1.332 rillig 14136: <td>do-install</td>
1.336 nia 14137: <td>emul</td>
1.332 rillig 14138: </tr>
14139: <tr>
14140: <td>emul-distinfo</td>
1.336 nia 14141: <td>emul-fetch</td>
1.269 leot 14142: </tr>
14143: <tr>
1.332 rillig 14144: <td>emulation</td>
1.336 nia 14145: <td>emulator</td>
1.289 leot 14146: </tr>
14147: <tr>
1.332 rillig 14148: <td>enable</td>
1.336 nia 14149: <td>endian</td>
1.269 leot 14150: </tr>
14151: <tr>
1.336 nia 14152: <td>enomem</td>
1.337 ! gutterid 14153: <td>ensurepip</td>
1.329 leot 14154: </tr>
14155: <tr>
1.327 wiz 14156: <td>err</td>
1.337 ! gutterid 14157: <td>errx</td>
1.269 leot 14158: </tr>
14159: <tr>
1.327 wiz 14160: <td>etc</td>
1.337 ! gutterid 14161: <td>exp</td>
1.320 wiz 14162: </tr>
14163: <tr>
1.327 wiz 14164: <td>extract-rpm</td>
1.337 ! gutterid 14165: <td>fabs</td>
1.311 leot 14166: </tr>
14167: <tr>
1.327 wiz 14168: <td>feature</td>
1.337 ! gutterid 14169: <td>features</td>
1.269 leot 14170: </tr>
14171: <tr>
1.327 wiz 14172: <td>fetch</td>
1.337 ! gutterid 14173: <td>fetch-list</td>
1.269 leot 14174: </tr>
14175: <tr>
1.327 wiz 14176: <td>follows</td>
1.337 ! gutterid 14177: <td>forbids</td>
1.289 leot 14178: </tr>
14179: <tr>
1.327 wiz 14180: <td>form</td>
1.337 ! gutterid 14181: <td>format</td>
1.269 leot 14182: </tr>
14183: <tr>
1.327 wiz 14184: <td>fortify</td>
1.335 nia 14185: <td>fortify_source</td>
1.332 rillig 14186: </tr>
14187: <tr>
1.335 nia 14188: <td>friend</td>
1.332 rillig 14189: <td>fts</td>
1.269 leot 14190: </tr>
14191: <tr>
1.335 nia 14192: <td>fts_close</td>
1.332 rillig 14193: <td>fts_open</td>
1.269 leot 14194: </tr>
14195: <tr>
1.335 nia 14196: <td>fts_read</td>
1.332 rillig 14197: <td>fts_set</td>
1.269 leot 14198: </tr>
14199: <tr>
1.335 nia 14200: <td>gcc</td>
1.332 rillig 14201: <td>gethostbyaddr</td>
1.269 leot 14202: </tr>
14203: <tr>
1.335 nia 14204: <td>gethostbyname</td>
1.332 rillig 14205: <td>gethostbyname2</td>
1.289 leot 14206: </tr>
14207: <tr>
1.335 nia 14208: <td>getopt_long</td>
1.332 rillig 14209: <td>getprogname</td>
1.269 leot 14210: </tr>
14211: <tr>
1.335 nia 14212: <td>getservbyname</td>
1.332 rillig 14213: <td>getservbyport</td>
1.269 leot 14214: </tr>
14215: <tr>
1.335 nia 14216: <td>getservent</td>
1.332 rillig 14217: <td>gettext</td>
1.289 leot 14218: </tr>
14219: <tr>
1.324 nia 14220: <td>github</td>
14221: <td>glob</td>
1.332 rillig 14222: </tr>
14223: <tr>
1.335 nia 14224: <td>gnu</td>
1.332 rillig 14225: <td>gnu_configure_strict</td>
1.269 leot 14226: </tr>
14227: <tr>
1.335 nia 14228: <td>go</td>
1.332 rillig 14229: <td>go-deps</td>
1.274 rillig 14230: </tr>
14231: <tr>
1.335 nia 14232: <td>golang</td>
1.332 rillig 14233: <td>guess-license</td>
1.269 leot 14234: </tr>
14235: <tr>
1.335 nia 14236: <td>hashbang</td>
1.332 rillig 14237: <td>heimdal</td>
1.269 leot 14238: </tr>
14239: <tr>
1.335 nia 14240: <td>help</td>
1.337 ! gutterid 14241: <td>imake</td>
1.329 leot 14242: </tr>
14243: <tr>
1.327 wiz 14244: <td>increment</td>
1.337 ! gutterid 14245: <td>indirect</td>
1.269 leot 14246: </tr>
14247: <tr>
1.335 nia 14248: <td>inet_aton</td>
1.327 wiz 14249: <td>interp</td>
1.320 wiz 14250: </tr>
14251: <tr>
1.335 nia 14252: <td>interpreter</td>
1.327 wiz 14253: <td>intl</td>
1.311 leot 14254: </tr>
14255: <tr>
1.335 nia 14256: <td>ip4</td>
1.327 wiz 14257: <td>ip6</td>
1.269 leot 14258: </tr>
14259: <tr>
1.335 nia 14260: <td>ipv4</td>
1.327 wiz 14261: <td>ipv6</td>
1.269 leot 14262: </tr>
14263: <tr>
1.335 nia 14264: <td>iso</td>
1.327 wiz 14265: <td>kerberos</td>
1.269 leot 14266: </tr>
14267: <tr>
1.335 nia 14268: <td>krb</td>
1.327 wiz 14269: <td>krb5</td>
1.269 leot 14270: </tr>
14271: <tr>
1.335 nia 14272: <td>ksh</td>
1.327 wiz 14273: <td>lapack</td>
1.303 bacon 14274: </tr>
14275: <tr>
1.335 nia 14276: <td>latex</td>
1.327 wiz 14277: <td>libintl_bindtextdomain</td>
1.303 bacon 14278: </tr>
14279: <tr>
1.335 nia 14280: <td>libintl_gettext</td>
1.327 wiz 14281: <td>libintl_textdomain</td>
1.269 leot 14282: </tr>
14283: <tr>
1.335 nia 14284: <td>libnbcompat</td>
1.327 wiz 14285: <td>libs</td>
1.292 leot 14286: </tr>
14287: <tr>
1.335 nia 14288: <td>libtool</td>
1.327 wiz 14289: <td>licence</td>
1.269 leot 14290: </tr>
14291: <tr>
1.335 nia 14292: <td>license</td>
1.327 wiz 14293: <td>lintl</td>
1.289 leot 14294: </tr>
14295: <tr>
1.335 nia 14296: <td>little-endian</td>
1.327 wiz 14297: <td>lock</td>
1.274 rillig 14298: </tr>
14299: <tr>
1.335 nia 14300: <td>locking</td>
1.333 nia 14301: <td>lua</td>
1.271 brook 14302: </tr>
14303: <tr>
1.335 nia 14304: <td>lvalue</td>
1.330 wiz 14305: <td>make</td>
1.269 leot 14306: </tr>
14307: <tr>
1.335 nia 14308: <td>makesum</td>
1.330 wiz 14309: <td>memory</td>
1.269 leot 14310: </tr>
14311: <tr>
1.330 wiz 14312: <td>meta</td>
1.337 ! gutterid 14313: <td>meta-package</td>
1.269 leot 14314: </tr>
14315: <tr>
1.330 wiz 14316: <td>meta_package</td>
1.337 ! gutterid 14317: <td>mit-krb5</td>
1.269 leot 14318: </tr>
14319: <tr>
1.330 wiz 14320: <td>mk.conf</td>
1.337 ! gutterid 14321: <td>mkl</td>
1.292 leot 14322: </tr>
14323: <tr>
1.330 wiz 14324: <td>mount</td>
1.337 ! gutterid 14325: <td>mprotect</td>
1.274 rillig 14326: </tr>
14327: <tr>
1.330 wiz 14328: <td>mremap</td>
1.337 ! gutterid 14329: <td>nb</td>
1.269 leot 14330: </tr>
14331: <tr>
1.330 wiz 14332: <td>nbcompat</td>
1.337 ! gutterid 14333: <td>netlib</td>
1.269 leot 14334: </tr>
14335: <tr>
1.333 nia 14336: <td>node</td>
1.337 ! gutterid 14337: <td>node.js</td>
1.333 nia 14338: </tr>
14339: <tr>
14340: <td>nodejs</td>
1.337 ! gutterid 14341: <td>obstack</td>
1.333 nia 14342: </tr>
14343: <tr>
1.332 rillig 14344: <td>obstack_ptr_grow</td>
1.337 ! gutterid 14345: <td>occurs</td>
1.320 wiz 14346: </tr>
14347: <tr>
1.332 rillig 14348: <td>only</td>
1.337 ! gutterid 14349: <td>openblas</td>
1.269 leot 14350: </tr>
14351: <tr>
1.332 rillig 14352: <td>options</td>
1.337 ! gutterid 14353: <td>options.mk</td>
1.269 leot 14354: </tr>
14355: <tr>
1.332 rillig 14356: <td>order</td>
1.337 ! gutterid 14357: <td>override</td>
1.269 leot 14358: </tr>
14359: <tr>
1.332 rillig 14360: <td>override-intltool</td>
1.337 ! gutterid 14361: <td>override-message-intltool</td>
1.271 brook 14362: </tr>
14363: <tr>
1.332 rillig 14364: <td>package</td>
1.337 ! gutterid 14365: <td>parallel</td>
1.269 leot 14366: </tr>
14367: <tr>
1.332 rillig 14368: <td>path</td>
1.337 ! gutterid 14369: <td>pax</td>
1.269 leot 14370: </tr>
14371: <tr>
1.332 rillig 14372: <td>paxctl</td>
1.337 ! gutterid 14373: <td>pbulk-index</td>
1.269 leot 14374: </tr>
14375: <tr>
1.332 rillig 14376: <td>pc</td>
1.337 ! gutterid 14377: <td>perl</td>
1.269 leot 14378: </tr>
14379: <tr>
1.332 rillig 14380: <td>perl5</td>
1.337 ! gutterid 14381: <td>perms</td>
1.269 leot 14382: </tr>
14383: <tr>
1.332 rillig 14384: <td>php</td>
1.337 ! gutterid 14385: <td>pkg-build-options</td>
1.269 leot 14386: </tr>
14387: <tr>
1.332 rillig 14388: <td>pkg-config</td>
1.337 ! gutterid 14389: <td>pkg_build_options</td>
1.269 leot 14390: </tr>
14391: <tr>
1.332 rillig 14392: <td>platform</td>
1.337 ! gutterid 14393: <td>plist</td>
1.269 leot 14394: </tr>
14395: <tr>
1.332 rillig 14396: <td>post-extract</td>
1.337 ! gutterid 14397: <td>post-fetch</td>
1.269 leot 14398: </tr>
14399: <tr>
1.332 rillig 14400: <td>post-wrapper</td>
1.337 ! gutterid 14401: <td>pre-build-checks-hook</td>
1.269 leot 14402: </tr>
14403: <tr>
1.332 rillig 14404: <td>pre-configure</td>
1.337 ! gutterid 14405: <td>pre-configure-checks-hook</td>
1.269 leot 14406: </tr>
14407: <tr>
1.332 rillig 14408: <td>pre-extract</td>
1.337 ! gutterid 14409: <td>pre-fetch</td>
1.289 leot 14410: </tr>
14411: <tr>
1.332 rillig 14412: <td>print-go-deps</td>
1.337 ! gutterid 14413: <td>print-plist</td>
1.269 leot 14414: </tr>
14415: <tr>
1.332 rillig 14416: <td>print-summary-data</td>
1.337 ! gutterid 14417: <td>privileged-install-hook</td>
1.269 leot 14418: </tr>
14419: <tr>
1.332 rillig 14420: <td>pypi</td>
1.337 ! gutterid 14421: <td>python</td>
1.269 leot 14422: </tr>
14423: <tr>
1.332 rillig 14424: <td>r</td>
1.337 ! gutterid 14425: <td>readme-all</td>
1.269 leot 14426: </tr>
14427: <tr>
1.337 ! gutterid 14428: <td>recursive</td>
1.332 rillig 14429: <td>recv</td>
1.269 leot 14430: </tr>
14431: <tr>
1.335 nia 14432: <td>recvfrom</td>
1.332 rillig 14433: <td>regcomp</td>
1.289 leot 14434: </tr>
14435: <tr>
1.335 nia 14436: <td>release-localbase-lock</td>
1.332 rillig 14437: <td>release-lock</td>
1.289 leot 14438: </tr>
14439: <tr>
1.335 nia 14440: <td>relro</td>
1.332 rillig 14441: <td>rename</td>
1.269 leot 14442: </tr>
14443: <tr>
1.335 nia 14444: <td>reorder</td>
1.332 rillig 14445: <td>replace</td>
1.269 leot 14446: </tr>
14447: <tr>
1.335 nia 14448: <td>replace_interpreter</td>
1.332 rillig 14449: <td>reproducible</td>
1.269 leot 14450: </tr>
14451: <tr>
1.335 nia 14452: <td>resolv</td>
1.332 rillig 14453: <td>root</td>
1.269 leot 14454: </tr>
14455: <tr>
1.335 nia 14456: <td>ruby</td>
1.332 rillig 14457: <td>send</td>
1.289 leot 14458: </tr>
14459: <tr>
1.335 nia 14460: <td>sendfile</td>
1.332 rillig 14461: <td>sendto</td>
1.269 leot 14462: </tr>
14463: <tr>
1.335 nia 14464: <td>setenv</td>
1.332 rillig 14465: <td>setgid</td>
1.269 leot 14466: </tr>
14467: <tr>
1.335 nia 14468: <td>setprogname</td>
1.332 rillig 14469: <td>setuid</td>
1.269 leot 14470: </tr>
14471: <tr>
1.335 nia 14472: <td>sh</td>
1.332 rillig 14473: <td>shebang</td>
1.269 leot 14474: </tr>
14475: <tr>
1.335 nia 14476: <td>show</td>
1.332 rillig 14477: <td>show-all</td>
1.296 rillig 14478: </tr>
14479: <tr>
1.335 nia 14480: <td>show-build-defs</td>
1.332 rillig 14481: <td>show-depends</td>
1.269 leot 14482: </tr>
14483: <tr>
1.337 ! gutterid 14484: <td>show-depends-all</td>
! 14485: <td>show-depends-dirs</td>
! 14486: </tr>
! 14487: <tr>
! 14488: <td>show-depends-pkgpaths</td>
1.335 nia 14489: <td>show-deps</td>
1.269 leot 14490: </tr>
14491: <tr>
1.337 ! gutterid 14492: <td>show-distfiles</td>
1.335 nia 14493: <td>show-downlevel</td>
1.269 leot 14494: </tr>
14495: <tr>
1.337 ! gutterid 14496: <td>show-subdir-var</td>
1.335 nia 14497: <td>show-tools</td>
1.269 leot 14498: </tr>
14499: <tr>
1.337 ! gutterid 14500: <td>show-var</td>
1.335 nia 14501: <td>show-vars</td>
1.269 leot 14502: </tr>
14503: <tr>
1.337 ! gutterid 14504: <td>snprintf</td>
1.335 nia 14505: <td>socket</td>
1.289 leot 14506: </tr>
14507: <tr>
1.337 ! gutterid 14508: <td>ssp</td>
1.335 nia 14509: <td>st_mode</td>
1.269 leot 14510: </tr>
14511: <tr>
1.337 ! gutterid 14512: <td>stage-install</td>
1.335 nia 14513: <td>strcasestr</td>
1.269 leot 14514: </tr>
14515: <tr>
1.337 ! gutterid 14516: <td>strict</td>
1.335 nia 14517: <td>strip</td>
1.277 rillig 14518: </tr>
14519: <tr>
1.337 ! gutterid 14520: <td>strndup</td>
1.335 nia 14521: <td>strnlen</td>
1.269 leot 14522: </tr>
14523: <tr>
1.337 ! gutterid 14524: <td>strsep</td>
1.335 nia 14525: <td>subst</td>
1.329 leot 14526: </tr>
14527: <tr>
1.337 ! gutterid 14528: <td>substitutions</td>
1.326 gutterid 14529: <td>sun</td>
1.327 wiz 14530: </tr>
14531: <tr>
1.335 nia 14532: <td>sunpro</td>
1.327 wiz 14533: <td>sunwspro</td>
1.311 leot 14534: </tr>
14535: <tr>
1.276 leot 14536: <td>symlink</td>
1.337 ! gutterid 14537: <td>test</td>
1.269 leot 14538: </tr>
14539: <tr>
1.289 leot 14540: <td>test-env</td>
1.337 ! gutterid 14541: <td>tex</td>
1.269 leot 14542: </tr>
14543: <tr>
1.289 leot 14544: <td>texlive</td>
1.337 ! gutterid 14545: <td>tmp</td>
1.269 leot 14546: </tr>
14547: <tr>
1.289 leot 14548: <td>tool</td>
1.337 ! gutterid 14549: <td>tools</td>
1.269 leot 14550: </tr>
14551: <tr>
1.289 leot 14552: <td>tools-libtool-m4-override</td>
1.337 ! gutterid 14553: <td>type</td>
1.269 leot 14554: </tr>
14555: <tr>
1.289 leot 14556: <td>ulimit</td>
1.337 ! gutterid 14557: <td>undefined</td>
1.269 leot 14558: </tr>
14559: <tr>
1.289 leot 14560: <td>undo-replace</td>
1.337 ! gutterid 14561: <td>unlimit</td>
1.269 leot 14562: </tr>
14563: <tr>
1.289 leot 14564: <td>unprivileged</td>
1.337 ! gutterid 14565: <td>unprivileged-install-hook</td>
1.269 leot 14566: </tr>
14567: <tr>
1.289 leot 14568: <td>unstripped</td>
1.337 ! gutterid 14569: <td>update</td>
1.269 leot 14570: </tr>
14571: <tr>
1.289 leot 14572: <td>upload</td>
1.337 ! gutterid 14573: <td>upload-distfiles</td>
1.269 leot 14574: </tr>
14575: <tr>
1.270 leot 14576: <td>use_tools</td>
1.337 ! gutterid 14577: <td>user</td>
1.269 leot 14578: </tr>
14579: <tr>
1.270 leot 14580: <td>utimes</td>
1.337 ! gutterid 14581: <td>vasprintf</td>
1.269 leot 14582: </tr>
14583: <tr>
1.270 leot 14584: <td>verbose</td>
1.337 ! gutterid 14585: <td>vsnprintf</td>
1.269 leot 14586: </tr>
14587: <tr>
1.270 leot 14588: <td>warn</td>
1.337 ! gutterid 14589: <td>warning</td>
1.269 leot 14590: </tr>
14591: <tr>
1.270 leot 14592: <td>warnings</td>
1.337 ! gutterid 14593: <td>warnx</td>
1.269 leot 14594: </tr>
14595: <tr>
1.289 leot 14596: <td>wattr_off</td>
1.337 ! gutterid 14597: <td>wattr_on</td>
1.269 leot 14598: </tr>
14599: <tr>
1.289 leot 14600: <td>work</td>
1.337 ! gutterid 14601: <td>wrapper</td>
1.269 leot 14602: </tr>
14603: <tr>
1.289 leot 14604: <td>wrkdir</td>
1.337 ! gutterid 14605: <td> </td>
1.269 leot 14606: </tr>
14607: </table>
1.267 rillig 14608: </div>
14609: <div class="appendix">
14610: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 14611: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 14612: <div class="toc">
14613: <p><b>Table of Contents</b></p>
1.210 leot 14614: <dl class="toc">
1.322 leot 14615: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
14616: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75 rillig 14617: </dl>
14618: </div>
1.79 rillig 14619: <p>This section contains information on editing the pkgsrc
14620: guide itself.</p>
1.148 asau 14621: <div class="sect1">
1.75 rillig 14622: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 14623: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.79 rillig 14624: <p>The pkgsrc guide's source code is stored in
14625: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
14626: are created from it:</p>
1.148 asau 14627: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 14628: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
14629: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289 leot 14630: <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>
14631: <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 14632: The PDF version of the pkgsrc guide.</p></li>
1.289 leot 14633: <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 14634: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 14635: </ul></div>
14636: </div>
1.148 asau 14637: <div class="sect1">
1.75 rillig 14638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 14639: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.79 rillig 14640: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 14641: <div class="procedure"><ol class="procedure" type="1">
1.304 bacon 14642: <li class="step"><p>Make sure you have checked out the htdocs repository
14643: into a sibling directory of your pkgsrc directory. You will need
14644: the ability to commit from both pkgsrc and htdocs.</p></li>
1.148 asau 14645: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 14646: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 14647: documentation) installed. These are automatically installed when
1.322 leot 14648: 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 14649: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 14650: right directory. All further steps will take place
14651: here.</p></li>
1.148 asau 14652: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 14653: <code class="filename">files/</code>.</p></li>
1.148 asau 14654: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 14655: guide for valid XML and to build the final output files. If you
14656: get any errors at this stage, you can just edit the files, as
14657: there are only symbolic links in the working directory, pointing
14658: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 14659: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 14660: commit)</strong></span></p></li>
1.148 asau 14661: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 14662: regenerate the output files with the proper RCS
14663: Ids.</p></li>
1.148 asau 14664: <li class="step">
1.110 hubertf 14665: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 14666: commit the files in both <code class="filename">pkgsrc/doc</code> and
14667: <code class="filename">htdocs</code>.</p>
1.148 asau 14668: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 14669: <h3 class="title">Note</h3>
14670: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 14671: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
14672: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 14673: directory.</p>
14674: </div>
14675: </li>
1.79 rillig 14676: </ol></div>
1.75 rillig 14677: </div>
14678: </div>
14679: </div></body>
1.1 grant 14680: </html>
CVSweb <webmaster@jp.NetBSD.org>