Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.229
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.25 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
9: </head>
1.41 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1 dsieger 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.10 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.10 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.213 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.41 asau 35: <div><div class="abstract">
1.1 dsieger 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.100 leot 48: <dl class="toc">
1.1 dsieger 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
1.154 rillig 63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1 dsieger 65: <dd><dl>
1.154 rillig 66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 67: <dd><dl>
1.154 rillig 68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 70: </dl></dd>
1.154 rillig 71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 72: <dd><dl>
1.154 rillig 73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 75: </dl></dd>
76: </dl></dd>
1.154 rillig 77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 78: <dd><dl>
1.154 rillig 79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 81: </dl></dd>
1.154 rillig 82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 83: <dd><dl>
1.154 rillig 84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 85: <dd><dl>
1.154 rillig 86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 88: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
89: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
90: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
91: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
92: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
93: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1 dsieger 94: </dl></dd>
1.154 rillig 95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 96: <dd><dl>
1.154 rillig 97: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
98: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
99: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 100: </dl></dd>
101: </dl></dd>
1.154 rillig 102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 103: <dd><dl>
1.154 rillig 104: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
105: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
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.1 dsieger 108: <dd><dl>
1.154 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.1 dsieger 112: </dl></dd>
1.154 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.1 dsieger 115: </dl></dd>
1.154 rillig 116: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 117: <dd><dl>
1.154 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.6 rillig 120: </dl></dd>
1.154 rillig 121: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 122: builds)</a></span></dt>
1.1 dsieger 123: <dd><dl>
1.154 rillig 124: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 125: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 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.178 rillig 128: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
129: <dd><dl>
1.179 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.181 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.178 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.154 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.23 wiz 161: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 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.221 nia 163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 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.1 dsieger 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.154 rillig 173: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 174: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 175: <dd><dl>
1.184 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.1 dsieger 179: <dd><dl>
1.184 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.1 dsieger 185: </dl></dd>
1.184 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.6 rillig 195: </dl></dd>
1.184 rillig 196: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 197: <dd><dl>
1.184 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.6 rillig 203: <dd><dl>
1.184 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.6 rillig 206: </dl></dd>
1.184 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.6 rillig 223: <dd><dl>
1.219 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.6 rillig 227: </dl></dd>
1.184 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.6 rillig 230: </dl></dd>
1.184 rillig 231: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 232: <dd><dl>
1.184 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.6 rillig 237: <dd><dl>
1.184 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.229 ! gutterid 242: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.6 rillig 243: </dl></dd>
244: </dl></dd>
1.184 rillig 245: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 246: <dd><dl>
1.184 rillig 247: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
248: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
249: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
250: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 251: </dl></dd>
1.184 rillig 252: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 253: <dd><dl>
1.184 rillig 254: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
255: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
256: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
257: </dl></dd>
258: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
259: <dd><dl>
260: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
261: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 262: <dd><dl>
1.184 rillig 263: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
264: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 265: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
266: and
267: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
268: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 269: </dl></dd>
1.184 rillig 270: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
271: <dd><dl>
272: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
273: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
274: </dl></dd>
275: </dl></dd>
276: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 277: <dd><dl>
1.184 rillig 278: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
279: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
280: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
281: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
282: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
283: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
284: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
285: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
286: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 287: </dl></dd>
1.184 rillig 288: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
289: <dd><dl>
290: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
291: <dd><dl>
292: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
293: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 294: </dl></dd>
1.184 rillig 295: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 296: <dd><dl>
1.184 rillig 297: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
298: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
299: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
300: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
301: </dl></dd>
302: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
303: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
304: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
305: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
306: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
307: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
308: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.154 rillig 309: </dl></dd>
310: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
311: <dd><dl>
312: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
313: <dd><dl>
314: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
315: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
316: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
317: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
318: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
319: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
320: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
321: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
322: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
323: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
324: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
325: </dl></dd>
326: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
327: <dd><dl>
328: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
329: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
330: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
331: </dl></dd>
332: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
333: <dd><dl>
334: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
336: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 337: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154 rillig 338: </dl></dd>
339: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
340: <dd><dl>
341: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
342: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 343: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 344: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
345: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
346: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
347: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 348: </dl></dd>
349: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
350: <dd><dl>
351: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
352: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 353: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
354: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
355: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 356: </dl></dd>
357: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
358: <dd><dl>
359: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
360: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
361: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
362: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
363: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 364: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154 rillig 365: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
366: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203 nia 367: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
368: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
369: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
370: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
371: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
372: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
373: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1 dsieger 374: emulation</a></span></dt>
1.203 nia 375: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
376: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1 dsieger 377: </dl></dd>
1.154 rillig 378: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 379: </dl></dd>
1.184 rillig 380: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
381: <dd><dl>
382: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
383: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
384: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
385: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
386: </dl></dd>
1.154 rillig 387: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 388: <dd><dl>
1.154 rillig 389: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
390: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
391: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
392: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
393: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
394: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
395: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
396: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
397: </dl></dd>
398: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 399: </dl></dd>
400: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
401: <dd><dl>
1.184 rillig 402: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 403: <dd><dl>
1.184 rillig 404: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
405: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
406: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 407: <dd><dl>
1.184 rillig 408: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
409: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 410: </dl></dd>
1.184 rillig 411: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
412: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 413: <dd><dl>
1.184 rillig 414: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
415: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 416: </dl></dd>
1.184 rillig 417: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 418: <dd><dl>
1.184 rillig 419: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
420: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 421: </dl></dd>
422: </dl></dd>
1.184 rillig 423: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 424: <dd><dl>
1.184 rillig 425: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
426: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 427: <dd><dl>
1.184 rillig 428: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
429: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 430: </dl></dd>
431: </dl></dd>
1.184 rillig 432: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
433: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 434: </dl></dd>
435: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
436: <dd><dl>
437: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
438: <dd><dl>
439: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
440: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
441: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 442: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 443: </dl></dd>
444: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
445: </dl></dd>
1.207 leot 446: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.1 dsieger 447: <dd><dl>
1.207 leot 448: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
449: <dd><dl>
450: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
451: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
452: </dl></dd>
453: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
454: <dd><dl>
455: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
456: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
457: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
458: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
459: </dl></dd>
460: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
461: <dd><dl>
462: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
463: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
464: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
465: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
466: </dl></dd>
467: </dl></dd>
468: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
469: <dd><dl>
470: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
471: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.1 dsieger 472: </dl></dd>
1.207 leot 473: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.1 dsieger 474: <dd><dl>
1.207 leot 475: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
476: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
477: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
478: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
479: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.148 leot 480: <code class="filename">stable</code>,
1.23 wiz 481: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 482: source packages</a></span></dt>
483: </dl></dd>
1.207 leot 484: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
485: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1 dsieger 486: <dd><dl>
1.207 leot 487: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
488: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 489: </dl></dd>
490: </dl>
491: </div>
492: <div class="list-of-tables">
493: <p><b>List of Tables</b></p>
494: <dl>
495: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
496: </dt>
1.184 rillig 497: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 498: </dt>
1.184 rillig 499: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 500: </dt>
501: </dl>
502: </div>
1.41 asau 503: <div class="chapter">
504: <div class="titlepage"><div><div><h1 class="title">
505: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 506: <div class="toc">
507: <p><b>Table of Contents</b></p>
1.100 leot 508: <dl class="toc">
1.1 dsieger 509: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
510: <dd><dl>
511: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
512: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
513: </dl></dd>
514: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
515: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
516: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
517: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
518: </dl>
519: </div>
1.41 asau 520: <div class="sect1">
1.1 dsieger 521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
522: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
523: <p>There is a lot of software freely available for Unix-based
524: systems, which is usually available in form of the source code. Before
525: such software can be used, it needs to be configured to the local
526: system, compiled and installed, and this is exactly what The NetBSD
527: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
528: to handle binary packages, so that not every user has to build the
529: packages for himself, which is a time-costly task.</p>
530: <p>pkgsrc currently contains several thousand packages,
531: including:</p>
1.41 asau 532: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 533: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.1 dsieger 534: web server</p></li>
1.207 leot 535: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1 dsieger 536: web browser</p></li>
1.207 leot 537: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1 dsieger 538: Desktop Environment</p></li>
1.207 leot 539: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.1 dsieger 540: Desktop Environment</p></li>
541: </ul></div>
1.108 rillig 542: <p>… just to name a few.</p>
1.1 dsieger 543: <p>pkgsrc has built-in support for handling varying dependencies,
544: such as pthreads and X11, and extended features such as IPv6 support on
545: a range of platforms.</p>
1.41 asau 546: <div class="sect2">
1.1 dsieger 547: <div class="titlepage"><div><div><h3 class="title">
548: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
549: <p>
550: pkgsrc provides the following key features:
551: </p>
1.41 asau 552: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 553: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 554: and installation of binary packages. The source and latest
555: patches are retrieved from a master or mirror download site, checksum
556: verified, then built on your system. Support for binary-only
557: distributions is available for both native platforms and NetBSD
558: emulated platforms.</p></li>
1.23 wiz 559: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 560: including binaries, libraries, man pages and other
561: documentation.</p></li>
1.104 sevan 562: <li class="listitem"><p>Tracking of package dependencies automatically, including when
563: performing updates, to ensure required packages are installed. The
564: configuration files of various packages are handled automatically during
565: updates, so local changes are preserved.</p></li>
1.23 wiz 566: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 567: consists of highly portable code. This allows the greatest speed of
1.25 spz 568: development when porting to a new platform. This portability also
1.1 dsieger 569: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
570: platforms</em></span>.</p></li>
1.23 wiz 571: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 572: international encryption requirements and build-time options for a
573: large number of packages are all set in a simple, central
574: configuration file.</p></li>
1.23 wiz 575: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 576: freely available under a BSD license, so you may extend and adapt
577: pkgsrc to your needs. Support for local packages and patches is
578: available right out of the box, so you can configure it specifically
579: for your environment.</p></li>
580: </ul></div>
581: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 582: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 583: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 584: — That means, if a package contains bugs, it's better to find
1.1 dsieger 585: them and to complain about them rather than to just install the package
586: and hope that it works. There are numerous checks in pkgsrc that try to
1.207 leot 587: find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.1 dsieger 588: of shell scripts), and post-installation checks (installed files,
589: references to shared libraries, script interpreters).</p></li>
1.23 wiz 590: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 591: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 592: pkgsrc has been ported to many operating systems. Care is taken that
593: packages behave the same on all platforms.</p></li>
594: </ul></div>
595: </div>
1.41 asau 596: <div class="sect2">
1.1 dsieger 597: <div class="titlepage"><div><div><h3 class="title">
598: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
599: <p>pkgsrc consists of both a source distribution and a binary
600: distribution for these operating systems. After retrieving the required
601: source or binaries, you can be up and running with pkgsrc in just
602: minutes!</p>
603: <p>pkgsrc was derived from FreeBSD's ports system, and
604: initially developed for NetBSD only. Since then, pkgsrc has
605: grown a lot, and now supports the following platforms:</p>
606: <div class="table">
607: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 608: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 609: <colgroup>
610: <col>
611: <col>
1.92 sevan 612: <col>
1.1 dsieger 613: </colgroup>
614: <thead><tr>
615: <th>Platform</th>
616: <th>Date Support Added</th>
1.92 sevan 617: <th>Notes</th>
1.1 dsieger 618: </tr></thead>
619: <tbody>
620: <tr>
1.174 leot 621: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 622: <td align="center">Aug 1997</td>
1.92 sevan 623: <td class="auto-generated"> </td>
1.1 dsieger 624: </tr>
625: <tr>
1.10 hubertf 626: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 627: <td align="center">Mar 1999</td>
1.151 sevan 628: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1 dsieger 629: </tr>
630: <tr>
1.174 leot 631: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 632: <td align="center">Jun 1999</td>
1.151 sevan 633: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1 dsieger 634: </tr>
635: <tr>
636: <td>
1.118 sevan 637: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 638: </td>
639: <td align="center">Oct 2001</td>
1.191 bacon 640: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.1 dsieger 641: </tr>
642: <tr>
1.174 leot 643: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 644: <td align="center">Nov 2002</td>
1.151 sevan 645: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1 dsieger 646: </tr>
647: <tr>
1.174 leot 648: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 649: <td align="center">Nov 2002</td>
1.151 sevan 650: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1 dsieger 651: </tr>
652: <tr>
1.174 leot 653: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 654: <td align="center">Dec 2002</td>
1.92 sevan 655: <td>
1.151 sevan 656: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.92 sevan 657: </td>
1.1 dsieger 658: </tr>
659: <tr>
660: <td>BSD/OS</td>
661: <td align="center">Dec 2003</td>
1.92 sevan 662: <td class="auto-generated"> </td>
1.1 dsieger 663: </tr>
664: <tr>
1.174 leot 665: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 666: <td align="center">Dec 2003</td>
1.151 sevan 667: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1 dsieger 668: </tr>
669: <tr>
670: <td>
1.174 leot 671: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 672: (Microsoft Windows Services for Unix)
673: </td>
674: <td align="center">Mar 2004</td>
1.151 sevan 675: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1 dsieger 676: </tr>
677: <tr>
1.174 leot 678: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 679: <td align="center">Oct 2004</td>
1.92 sevan 680: <td class="auto-generated"> </td>
1.1 dsieger 681: </tr>
682: <tr>
1.10 hubertf 683: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 684: <td align="center">Nov 2004</td>
1.151 sevan 685: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1 dsieger 686: </tr>
687: <tr>
1.174 leot 688: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 689: <td align="center">Apr 2007</td>
1.151 sevan 690: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1 dsieger 691: </tr>
1.23 wiz 692: <tr>
1.174 leot 693: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.23 wiz 694: <td align="center">Sep 2010</td>
1.151 sevan 695: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23 wiz 696: </tr>
1.45 obache 697: <tr>
1.174 leot 698: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 699: <td align="center">Jan 2011</td>
1.92 sevan 700: <td class="auto-generated"> </td>
1.45 obache 701: </tr>
702: <tr>
1.174 leot 703: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.45 obache 704: <td align="center">Nov 2011</td>
1.151 sevan 705: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45 obache 706: </tr>
707: <tr>
1.174 leot 708: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.45 obache 709: <td align="center">Mar 2013</td>
1.151 sevan 710: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45 obache 711: </tr>
1.58 ryoon 712: <tr>
1.174 leot 713: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.58 ryoon 714: <td align="center">Jul 2013</td>
1.151 sevan 715: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.58 ryoon 716: </tr>
1.104 sevan 717: <tr>
1.174 leot 718: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.104 sevan 719: <td align="center">Jun 2014</td>
1.229 ! gutterid 720: <td>Removed from pkgsrc Sep 2022</td>
1.104 sevan 721: </tr>
1.1 dsieger 722: </tbody>
723: </table></div>
724: </div>
725: <br class="table-break">
726: </div>
727: </div>
1.41 asau 728: <div class="sect1">
1.1 dsieger 729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
730: <a name="overview"></a>1.2. Overview</h2></div></div></div>
731: <p>This document is divided into three parts. The first,
1.10 hubertf 732: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 733: describes how one can use one of the packages in the Package
734: Collection, either by installing a precompiled binary package,
735: or by building one's own copy using the NetBSD package system.
1.10 hubertf 736: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1 dsieger 737: package so it can be easily built by other NetBSD users without
738: knowing about the package's building details. The third part,
1.10 hubertf 739: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 740: is intended for those who want to understand how pkgsrc is
741: implemented.</p>
742: <p>This document is available in various formats:
1.10 hubertf 743: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1 dsieger 744: </div>
1.41 asau 745: <div class="sect1">
1.1 dsieger 746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
747: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 748: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
749: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 750: terminology used within this document.</p>
1.41 asau 751: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 752: <dt><span class="term">Package</span></dt>
753: <dd><p>A set of files and building instructions
754: that describe what's necessary
755: to build a certain piece of software using
756: pkgsrc. Packages are traditionally stored under
1.123 wiz 757: <code class="filename">/usr/pkgsrc</code>,
758: but may be stored in any location,
759: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1 dsieger 760: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 761: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 762: is part of the NetBSD operating system and can be bootstrapped
763: to run on non-NetBSD operating systems as well. It handles
764: building (compiling), installing, and removing of
765: packages.</p></dd>
766: <dt><span class="term">Distfile</span></dt>
767: <dd><p>This term describes the file or files that are
768: provided by the author of the piece of software to
769: distribute his work. All the changes necessary to build on
770: NetBSD are reflected in the corresponding package. Usually
771: the distfile is in the form of a compressed tar-archive,
772: but other types are possible, too. Distfiles are usually
773: stored below
774: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
775: <dt><span class="term">Port</span></dt>
776: <dd><p>This is the term used by FreeBSD and OpenBSD people
777: for what we call a package.
1.23 wiz 778: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 779: architecture.</p></dd>
780: <dt><span class="term">Precompiled/binary package</span></dt>
781: <dd>
782: <p>A set of binaries built with pkgsrc from a distfile
783: and stuffed together in a single <code class="filename">.tgz</code>
784: file so it can be installed on machines of the same
785: machine architecture without the need to
786: recompile. Packages are usually generated in
787: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 788: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 789: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 790: especially in the context of precompiled packages.</p>
791: </dd>
792: <dt><span class="term">Program</span></dt>
793: <dd><p>The piece of software to be installed which will be
794: constructed from all the files in the distfile by the
795: actions defined in the corresponding package.</p></dd>
796: </dl></div>
1.41 asau 797: <div class="sect2">
1.1 dsieger 798: <div class="titlepage"><div><div><h3 class="title">
799: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 800: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 801: <dt><span class="term">pkgsrc users</span></dt>
802: <dd>
803: <p>The
804: pkgsrc users are people who use the packages provided by pkgsrc.
805: Typically they are system administrators. The people using the
1.23 wiz 806: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
807: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 808: <p>There are two kinds of pkgsrc users: Some only want to
809: install pre-built binary packages. Others build the pkgsrc
810: packages from source, either for installing them directly or for
1.10 hubertf 811: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.1 dsieger 812: documentation.</p>
813: </dd>
814: <dt><span class="term">package maintainers</span></dt>
815: <dd><p>A
1.10 hubertf 816: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.1 dsieger 817: <dt><span class="term">infrastructure developers</span></dt>
818: <dd><p>These people are involved in all those files
819: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 820: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.1 dsieger 821: too.</p></dd>
822: </dl></div>
823: </div>
824: </div>
1.41 asau 825: <div class="sect1">
1.1 dsieger 826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
827: <a name="typography"></a>1.4. Typography</h2></div></div></div>
828: <p>When giving examples for commands, shell prompts are used to
829: show if the command should/can be issued as root, or if
1.23 wiz 830: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 831: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
832: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.229 ! gutterid 833: Bourne shell and derivatives.</p>
1.1 dsieger 834: </div>
835: </div>
1.41 asau 836: <div class="part">
1.1 dsieger 837: <div class="titlepage"><div><div><h1 class="title">
838: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
839: <div class="toc">
840: <p><b>Table of Contents</b></p>
1.100 leot 841: <dl class="toc">
1.154 rillig 842: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
843: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1 dsieger 844: <dd><dl>
1.154 rillig 845: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 846: <dd><dl>
1.154 rillig 847: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
848: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 849: </dl></dd>
1.154 rillig 850: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 851: <dd><dl>
1.154 rillig 852: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
853: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 854: </dl></dd>
855: </dl></dd>
1.154 rillig 856: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 857: <dd><dl>
1.154 rillig 858: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
859: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 860: </dl></dd>
1.154 rillig 861: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 862: <dd><dl>
1.154 rillig 863: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 864: <dd><dl>
1.154 rillig 865: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
866: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 867: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
868: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
869: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
870: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
871: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
872: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1 dsieger 873: </dl></dd>
1.154 rillig 874: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 875: <dd><dl>
1.154 rillig 876: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
877: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
878: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 879: </dl></dd>
880: </dl></dd>
1.154 rillig 881: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 882: <dd><dl>
1.154 rillig 883: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
884: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
885: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
886: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 887: <dd><dl>
1.154 rillig 888: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
889: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
890: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 891: </dl></dd>
1.154 rillig 892: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
893: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 894: </dl></dd>
1.154 rillig 895: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 896: <dd><dl>
1.154 rillig 897: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
898: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 899: </dl></dd>
1.154 rillig 900: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 901: builds)</a></span></dt>
1.1 dsieger 902: <dd><dl>
1.154 rillig 903: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 904: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 905: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
906: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 907: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
908: <dd><dl>
1.179 rillig 909: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
910: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.181 rillig 911: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
912: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
913: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
914: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
915: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
916: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
917: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
918: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 919: </dl></dd>
920: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
921: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 922: </dl></dd>
923: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
924: <dd><dl>
925: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
926: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
927: </dl></dd>
928: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
929: <dd><dl>
930: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
931: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
932: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
933: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
934: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
935: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
936: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
937: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
938: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
939: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 940: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 941: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.221 nia 942: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 943: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
944: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
945: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
946: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
947: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 948: </dl></dd>
949: </dl>
950: </div>
1.41 asau 951: <div class="chapter">
1.1 dsieger 952: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 953: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
954: <p>
955: To get help when using pkgsrc, the definitive source is this
956: document, the pkgsrc guide. If you don't find anything here,
957: there are alternatives:
958: </p>
959: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
960: <li class="listitem">
961: <p>
962: The built-in pkgsrc help, which is available after bootstrapping
963: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
964: help for any topic, such as a variable name like
965: <code class="varname">BUILD_DEFS</code>, a make target like
966: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
967: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.207 leot 968: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.154 rillig 969: </li>
970: <li class="listitem"><p>
1.163 rillig 971: To see the value of a single variable, run <span class="command"><strong>bmake
972: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
973: </p></li>
974: <li class="listitem"><p>
975: To see the values of the most common variables, run
976: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
977: topic. To see the variables for a single topic, run
978: <span class="command"><strong>bmake
979: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
980: <span class="command"><strong>bmake show-all-fetch</strong></span>.
981: </p></li>
982: <li class="listitem"><p>
1.154 rillig 983: The pkgsrc-users mailing list, to which
984: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
985: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
986: questions</a>.</p></li>
987: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
988: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
989: or by using a specialized chat program such as
990: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
991: Pick any user name and join the channel #pkgsrc.</p></li>
992: </ul></div>
993: </div>
994: <div class="chapter">
995: <div class="titlepage"><div><div><h2 class="title">
996: <a name="getting"></a>Chapter 3. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
1.1 dsieger 997: <div class="toc">
998: <p><b>Table of Contents</b></p>
1.100 leot 999: <dl class="toc">
1.154 rillig 1000: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 1001: <dd><dl>
1.154 rillig 1002: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
1003: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 1004: </dl></dd>
1.154 rillig 1005: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 1006: <dd><dl>
1.154 rillig 1007: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
1008: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 1009: </dl></dd>
1010: </dl>
1011: </div>
1012: <p>Before you download and extract the files, you need to decide
1013: where you want to extract them. When using pkgsrc as root user, pkgsrc
1014: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
1015: free to install the sources and binary packages wherever you want in
1016: your filesystem, provided that the pathname does not contain white-space
1017: or other characters that are interpreted specially by the shell and some
1018: other programs. A safe bet is to use only letters, digits, underscores
1019: and dashes.</p>
1.41 asau 1020: <div class="sect1">
1.1 dsieger 1021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1022: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 1023: <p>Before you download any pkgsrc files, you should decide
1024: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1025: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1026: quarterly basis from the current branch and only gets modified
1027: for security updates. The names of the stable branches are built
1028: from the year and the quarter, for example
1.214 leot 1029: <code class="literal">2021Q4</code>.</p>
1.1 dsieger 1030: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 1031: want to download pkgsrc. You can get it as a tar file or via CVS.
1032: Both ways are described here.</p>
1.51 asau 1033: <p>Note that tar archive contains CVS working copy.
1034: Thus you can switch to using CVS at any later time.</p>
1.41 asau 1035: <div class="sect2">
1.1 dsieger 1036: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1037: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 1038: <p>The primary download location for all pkgsrc files is
1.151 sevan 1039: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 1040: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1041: (it points to the same location).
1042: There are a number of subdirectories for different purposes,
1.207 leot 1043: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix D. Directory layout of the pkgsrc FTP server">Appendix D, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.51 asau 1044: <p>The tar archive for the current branch is in the directory
1.151 sevan 1045: <code class="filename">current</code> and is called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.118 sevan 1046: It is autogenerated weekly.</p>
1.51 asau 1047: <p>To save download time we provide bzip2- and
1048: xz-compressed archives which are published at
1.151 sevan 1049: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
1.51 asau 1050: and
1.151 sevan 1051: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
1.51 asau 1052: respectively.
1053: </p>
1054: <p>You can fetch the same files using FTP.</p>
1.214 leot 1055: <p>The tar file for the stable branch 2021Q4 is in the
1056: directory <code class="filename">pkgsrc-2021Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136 leot 1057: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 1058: <pre class="screen">
1.214 leot 1059: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q4/pkgsrc.tar.gz</code></strong></pre>
1.78 snj 1060: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1061: or your web browser.</p>
1.12 weinem 1062: <p>Then, extract it with:</p>
1.78 snj 1063: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1064: <p>This will create the directory <code class="filename">pkgsrc/</code>
1065: in <code class="filename">/usr/</code> and all the package source will be
1066: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1067: <p>To download pkgsrc-current, run:</p>
1068: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1 dsieger 1069: </div>
1.41 asau 1070: <div class="sect2">
1.1 dsieger 1071: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1072: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1073: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.214 leot 1074: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2021Q4 -P pkgsrc</code></strong>
1.23 wiz 1075: </pre>
1076: <p>This will create the directory <code class="filename">pkgsrc/</code>
1077: in your <code class="filename">/usr/</code> directory and all the package source
1078: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1079: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1080: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1081: </pre>
1.174 leot 1082: <p>Refer to the <a class="ulink" href="https://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23 wiz 1083: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39 wiz 1084: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23 wiz 1085: </pre>
1086: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1087: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1088: or better globally in <code class="filename">/etc/profile</code>:</p>
1089: <pre class="programlisting">
1090: # set CVS remote shell command
1091: CVS_RSH=ssh
1092: export CVS_RSH
1093: </pre>
1094: <p>By default, CVS doesn't do things like most people would expect it to do.
1095: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1096: in your home directory and saving the following lines to it.
1097: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1098: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1099: <pre class="programlisting">
1100: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1101: cvs -q
1.2 rillig 1102: checkout -P
1.4 rillig 1103: update -dP
1104: diff -upN
1.2 rillig 1105: rdiff -u
1.23 wiz 1106: release -d
1.2 rillig 1107: </pre>
1.1 dsieger 1108: </div>
1109: </div>
1.41 asau 1110: <div class="sect1">
1.1 dsieger 1111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1112: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1113: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1114: (which also works if you have first installed it via a tar
1115: file). It saves bandwidth and hard disk activity, compared to
1116: downloading the tar file again.</p>
1.41 asau 1117: <div class="sect2">
1.1 dsieger 1118: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1119: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1120: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1121: <h3 class="title">Warning</h3>
1122: <p>When updating from a tar file, you first need to
1123: completely remove the old pkgsrc directory. Otherwise those
1124: files that have been removed from pkgsrc in the mean time will
1125: not be removed on your local disk, resulting in inconsistencies.
1126: When removing the old files, any changes that you have done to
1127: the pkgsrc files will be lost after updating. Therefore updating
1128: via CVS is strongly recommended.</p>
1129: </div>
1130: <p>Note that by default the distfiles and the binary packages
1131: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1132: before updating. You can also configure pkgsrc to store distfiles
1133: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1134: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154 rillig 1135: variables. See <a class="xref" href="#configuring" title="Chapter 6. Configuring pkgsrc">Chapter 6, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1 dsieger 1136: <p>To update pkgsrc from a tar file, download the tar file as
1137: explained above. Then, make sure that you have not made any
1138: changes to the files in the pkgsrc directory. Remove the pkgsrc
1139: directory and extract the new tar file. Done.</p>
1140: </div>
1.41 asau 1141: <div class="sect2">
1.1 dsieger 1142: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1143: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1144: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1145: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1146: </pre>
1147: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
1148: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1149: </pre>
1.41 asau 1150: <div class="sect3">
1.1 dsieger 1151: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1152: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1153: <p>When updating pkgsrc, the CVS program keeps track of the
1154: branch you selected. But if you, for whatever reason, want to
1155: switch from the stable branch to the current one, you can do it
1.23 wiz 1156: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1157: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1158: back to the stable branch, add the
1.214 leot 1159: <span class="quote">“<span class="quote">-rpkgsrc-2021Q4</span>”</span> option.</p>
1.1 dsieger 1160: </div>
1.41 asau 1161: <div class="sect3">
1.1 dsieger 1162: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1163: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1164: <p>When you update pkgsrc, the CVS program will only touch
1165: those files that are registered in the CVS repository. That
1166: means that any packages that you created on your own will stay
1167: unmodified. If you change files that are managed by CVS, later
1168: updates will try to merge your changes with those that have been
1169: done by others. See the CVS manual, chapter
1.23 wiz 1170: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1171: </div>
1172: </div>
1173: </div>
1174: </div>
1.41 asau 1175: <div class="chapter">
1.1 dsieger 1176: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1177: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1178: <div class="toc">
1179: <p><b>Table of Contents</b></p>
1.100 leot 1180: <dl class="toc">
1.154 rillig 1181: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1182: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1183: </dl>
1184: </div>
1.41 asau 1185: <div class="sect1">
1.1 dsieger 1186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1187: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1188: <p>See <a class="xref" href="#using-pkg" title="5.1. Using binary packages">Section 5.1, “Using binary packages”</a>.</p>
1.1 dsieger 1189: </div>
1.41 asau 1190: <div class="sect1">
1.1 dsieger 1191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1192: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1193: <p>pkgsrc can be bootstrapped for use in two different modes:
1194: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1195: to privileged one all programs are installed under one particular user
1.43 asau 1196: and cannot utilise privileged operations (packages don't create
1197: special users and all special file permissions like setuid are ignored).
1198: </p>
1.1 dsieger 1199: <p>Installing the bootstrap kit from source should be as simple as:</p>
1200: <pre class="screen">
1.60 asau 1201: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1202: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1203: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1204: </pre>
1.43 asau 1205: <p>To bootstrap in unprivileged mode pass <span class="quote">“<span class="quote">--unprivileged</span>”</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
1206: <p>By default, in privileged mode pkgsrc uses
1207: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1208: where programs will be installed in,
1.118 sevan 1209: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1210: directory where pkgsrc will do its internal bookkeeping,
1211: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1212: where packages install their persistent data.
1213: In unprivileged mode pkgsrc uses
1214: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1215: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1216: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1217: </p>
1218: <p>You can change default layout using command-line arguments.
1219: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1220: </p>
1.41 asau 1221: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1222: <h3 class="title">Note</h3>
1.10 hubertf 1223: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1224: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1225: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1226: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1227: </div>
1.43 asau 1228: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1229: <h3 class="title">Note</h3>
1230: <p>It is possible to bootstrap multiple instances of pkgsrc
1231: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1232: corresponding to the installation you're working with to build
1233: and install packages.
1234: </p>
1235: </div>
1.1 dsieger 1236: </div>
1237: </div>
1.41 asau 1238: <div class="chapter">
1.1 dsieger 1239: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1240: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1241: <div class="toc">
1242: <p><b>Table of Contents</b></p>
1.100 leot 1243: <dl class="toc">
1.154 rillig 1244: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1245: <dd><dl>
1.154 rillig 1246: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1247: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 1248: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1249: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1250: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1251: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1252: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
1253: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.154 rillig 1254: </dl></dd>
1255: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1256: <dd><dl>
1257: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1258: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1259: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 1260: </dl></dd>
1261: </dl>
1262: </div>
1263: <p>Basically, there are two ways of using pkgsrc. The first
1264: is to only install the package tools and to use binary packages
1.23 wiz 1265: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1266: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1267: of pkgsrc, too. Then you are able to build your own packages,
1268: and you can still use binary packages from someone else.</p>
1.41 asau 1269: <div class="sect1">
1.1 dsieger 1270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1271: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.202 nia 1272: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.151 sevan 1273: site and mirrors, there are collections of binary packages,
1.9 rillig 1274: ready to be installed. These binary packages have been built using the
1275: default settings for the directories, that is:</p>
1.41 asau 1276: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1277: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1278: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1279: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.9 rillig 1280: </ul></div>
1281: <p>If you cannot use these directories for whatever reasons (maybe
1282: because you're not root), you cannot use these binary packages, but
1.154 rillig 1283: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="4.2. Bootstrapping pkgsrc">Section 4.2, “Bootstrapping pkgsrc”</a>.</p>
1.41 asau 1284: <div class="sect2">
1.1 dsieger 1285: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1286: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1287: <p>To install binary packages, you first need to know from where
1288: to get them. The first place where you should look is on the main
1.202 nia 1289: pkgsrc CDN in the directory <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5 weinem 1290: <p>This directory contains binary packages for multiple
1.226 gutterid 1291: platforms. First, select your operating system. Then, select your
1292: hardware architecture, and in the third step, the OS version and
1293: the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1294: <p>In this directory, you may find a file called
1.9 rillig 1295: <code class="filename">bootstrap.tar.gz</code> which contains the package
1296: management tools. If the file is missing, it is likely that your
1297: operating system already provides those tools. Download the file and
1298: extract it in the <code class="filename">/</code> directory. It will create
1299: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1300: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1301: </div>
1.41 asau 1302: <div class="sect2">
1.1 dsieger 1303: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1304: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1305: <p>In the directory from the last section, there is a
1.85 wiz 1306: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1307: binary packages that are available for the platform, excluding those
1.202 nia 1308: that may not be distributed via HTTP or FTP.</p>
1.9 rillig 1309: <p>To install packages directly from an FTP or HTTP server, run
1310: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1311: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1312: <pre class="screen">
1.202 nia 1313: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1314: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.169 rillig 1315: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="$PKG_PATH/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.9 rillig 1316: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.202 nia 1317: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.9 rillig 1318: </pre>
1319: <p>Instead of URLs, you can also use local paths, for example if
1320: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1321: repository. If you want to install packages from multiple sources,
1322: you can separate them by a semicolon in
1323: <code class="varname">PKG_PATH</code>.</p>
1324: <p>After these preparations, installing a package is very
1325: easy:</p>
1326: <pre class="screen">
1.202 nia 1327: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1328: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1329: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1330: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1331: </pre>
1332: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1333: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1334: <p>Any prerequisite packages needed to run the
1.1 dsieger 1335: package in question will be installed, too, assuming they are
1.202 nia 1336: present in the repository.</p>
1.1 dsieger 1337: <p>After you've installed packages, be sure to have
1338: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1339: <code class="varname">PATH</code> so you can actually start the just
1340: installed program.</p>
1341: </div>
1.41 asau 1342: <div class="sect2">
1.1 dsieger 1343: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1344: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1345: <p>To update binary packages, it is recommended that you use
1346: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1347: package repository to your locally installed packages and safely
1348: replace any older packages.</p>
1349: <p>Note that pkgsrc is released as quarterly branches.
1350: If you are updating to a newer quarterly branch of pkgsrc, you may
1351: need to adjust the repository in
1352: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1353: </div>
1354: <div class="sect2">
1355: <div class="titlepage"><div><div><h3 class="title">
1356: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1357: <p>To deinstall a package, it does not matter whether it was
1.202 nia 1358: installed from source code or from a binary package. Neither the
1359: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1360: command need to know.</p>
1361: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.1 dsieger 1362: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.202 nia 1363: name can be given with or without version number.</p>
1.1 dsieger 1364: </div>
1.41 asau 1365: <div class="sect2">
1.1 dsieger 1366: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1367: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1368: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.202 nia 1369: installed packages or binary package files.
1370: As with other management tools, it works with packages installed
1371: from source or binaries.</p>
1.1 dsieger 1372: </div>
1.41 asau 1373: <div class="sect2">
1.1 dsieger 1374: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1375: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1376: <p>
1.164 leot 1377: The pkgsrc Security Team and Packages Groups maintain a list of
1.202 nia 1378: known vulnerabilities to packages which are (or have been)
1.1 dsieger 1379: included in pkgsrc. The list is available from the NetBSD
1.202 nia 1380: CDN at <a class="ulink" href="https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
1381: </p>
1382: <p>
1383: Please note that not every "vulnerability" with a CVE assignment is
1384: exploitable in every configuration.
1385: Some bugs are marked as active simply because an fix was not
1386: marked as such.
1387: Operating system specific hardening and mitigation features may also
1388: reduce the impact of bugs.
1.1 dsieger 1389: </p>
1390: <p>
1.22 jakllsch 1391: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1392: this list can be downloaded
1393: automatically, and a security audit of all packages installed on a system
1394: can take place.
1395: </p>
1396: <p>
1.22 jakllsch 1397: There are two components to auditing. The first
1398: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1399: is for downloading
1.1 dsieger 1400: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1401: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1402: installed packages are vulnerable. If a package is vulnerable, you
1403: will see output similar to the following:
1404: </p>
1405: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1406: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.1 dsieger 1407: <p>
1.22 jakllsch 1408: You may wish to have the
1.202 nia 1409: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1410: file downloaded daily so that
1411: it remains current. This may be done by adding an appropriate entry
1.207 leot 1412: to the root users <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1413: </p>
1414: <pre class="screen">
1.121 sevan 1415: # Download vulnerabilities file
1.118 sevan 1416: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1417: # Audit the installed packages and email results to root
1418: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1419: root >/dev/null 2>&1
1.22 jakllsch 1420: </pre>
1421: <p>
1.118 sevan 1422: will update the vulnerability list every day at 3AM, followed by an audit
1423: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1424:
1.118 sevan 1425: On NetBSD this may be accomplished instead by adding the following
1426: line to <code class="filename">/etc/daily.conf</code>:
1427: </p>
1428: <pre class="screen">
1429: fetch_pkg_vulnerabilities=YES
1430: </pre>
1431: <p>
1432: to fetch the vulnerability list from the daily security script. The system
1433: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1434: desired (not required), by adding the following line to
1.118 sevan 1435: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1436: </p>
1437: <pre class="screen">
1.118 sevan 1438: check_pkg_vulnerabilities=YES
1.22 jakllsch 1439: </pre>
1440: <p>
1.207 leot 1441: see <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.1 dsieger 1442: </p>
1443: </div>
1.41 asau 1444: <div class="sect2">
1.1 dsieger 1445: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1446: <a name="pkg_versions"></a>5.1.7. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.1 dsieger 1447: <p>
1.207 leot 1448: Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23 wiz 1449: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.202 nia 1450: argument to check if any packages are stale, e.g.
1.1 dsieger 1451: </p>
1452: <pre class="screen">
1453: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1454: ...
1455: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1456: </pre>
1457: </div>
1.41 asau 1458: <div class="sect2">
1.1 dsieger 1459: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1460: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.10 hubertf 1461: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1462: administrative functions on the package system.</p>
1463: </div>
1464: </div>
1.41 asau 1465: <div class="sect1">
1.1 dsieger 1466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1467: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1 dsieger 1468: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1469: directory now contains a set of packages, organized into
1470: categories. You can browse the online index of packages, or run
1.10 hubertf 1471: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1472: directory to build local <code class="filename">README.html</code> files for
1.207 leot 1473: all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/index.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.1 dsieger 1474: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1475: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1476: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1477: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1478: different <code class="varname">LOCALBASE</code> definitions on the same
1479: system (inside a chroot is an exception). </p>
1480: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1481: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.1 dsieger 1482: instructions how to create your own packages.</p>
1.41 asau 1483: <div class="sect2">
1.1 dsieger 1484: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1485: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1 dsieger 1486: <p>To build packages from source, you need a working C
1487: compiler. On NetBSD, you need to install the
1.23 wiz 1488: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1489: sets. If you want to build X11-related packages, the
1.23 wiz 1490: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1491: sets are required, too.</p>
1492: </div>
1.41 asau 1493: <div class="sect2">
1.1 dsieger 1494: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1495: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1 dsieger 1496: <p>The first step for building a package is downloading the
1497: distfiles (i.e. the unmodified source). If they have not yet been
1498: downloaded, pkgsrc will fetch them automatically.</p>
1499: <p>If you have all files that you need in the
1500: <code class="filename">distfiles</code> directory,
1501: you don't need to connect. If the distfiles are on CD-ROM, you can
1502: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1503: </p>
1504: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1505: <p>
1.10 hubertf 1506: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1507: <p>By default a list of distribution sites will be randomly
1508: intermixed to prevent huge load on servers which holding popular
1509: packages (for example, SourceForge.net mirrors). Thus, every
1510: time when you need to fetch yet another distfile all the mirrors
1511: will be tried in new (random) order. You can turn this feature
1512: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1513: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1514: <p>You can overwrite some of the major distribution sites to
1515: fit to sites that are close to your own. By setting one or two
1516: variables you can modify the order in which the master sites are
1517: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1518: delimited list of domain suffixes.
1519: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1520: contains a whitespace delimited list of regular expressions. It
1521: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1522: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1523: some examples. This may save some of your bandwidth and
1524: time.</p>
1525: <p>You can change these settings either in your shell's environment, or,
1526: if you want to keep the settings, by editing the
1.10 hubertf 1527: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1528: and adding the definitions there.</p>
1529: <p>
1530: If a package depends on many other packages (such as
1.207 leot 1531: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.1 dsieger 1532: alternate between periods of
1533: downloading source, and compiling. To ensure you have all the source
1534: downloaded initially you can run the command:
1535: </p>
1536: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1537: <p>
1538: which will output and run a set of shell commands to fetch the
1539: necessary files into the <code class="filename">distfiles</code> directory. You can
1540: also choose to download the files manually.
1541: </p>
1542: </div>
1.41 asau 1543: <div class="sect2">
1.1 dsieger 1544: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1545: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1 dsieger 1546: <p>
1547: Once the software has downloaded, any patches will be applied, then it
1548: will be compiled for you. This may take some time depending on your
1549: computer, and how many other packages the software depends on and their
1550: compile time.
1551: </p>
1.41 asau 1552: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1553: <h3 class="title">Note</h3>
1554: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1555: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1556: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1557: </div>
1558: <p>For example, type</p>
1559: <pre class="screen">
1560: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1561: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1562: </pre>
1563: <p>at the shell prompt to build the various components of the
1564: package.</p>
1565: <p>The next stage is to actually install the newly compiled
1566: program onto your system. Do this by entering:
1567:
1568: </p>
1569: <pre class="screen">
1570: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1571: </pre>
1572: <p>
1573:
1574: while you are still in the directory for whatever package you
1575: are installing.</p>
1576: <p>Installing the package on your system may require you to
1577: be root. However, pkgsrc has a
1578: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1579: to only become root for the actual installation step.</p>
1580: <p>That's it, the software should now be installed and setup for use.
1581: You can now enter:
1582:
1583: </p>
1584: <pre class="screen">
1585: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1586: </pre>
1587: <p>
1588:
1589: to remove the compiled files in the work directory, as you shouldn't need
1590: them any more. If other packages were also added to your system
1591: (dependencies) to allow your program to compile, you can tidy these up
1592: also with the command:</p>
1593: <pre class="screen">
1594: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1595: </pre>
1596: <p>Taking the figlet utility as an example, we can install it on our
1.207 leot 1597: system by building as shown in <a class="xref" href="#logs" title="Appendix C. Build logs">Appendix C, <i>Build logs</i></a>.</p>
1.1 dsieger 1598: <p>The program is installed under the default root of the
1599: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1600: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1601: variable in your environment, and it will use that value as the
1602: root of your packages tree. So, to use
1603: <code class="filename">/usr/local</code>, set
1604: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1605: Please note that you should use a directory which is dedicated to
1606: packages and not shared with other programs (i.e., do not try and
1607: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1608: to add any of your own files or directories (such as
1609: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1610: <code class="filename">pkgsrc/</code>) below the
1611: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1612: conflicts between programs and other files installed by the
1613: package system and whatever else may have been installed
1614: there.</p>
1.10 hubertf 1615: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1616: alter some configuration options at build time. Have a look at
1617: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1618: of what will be set there by default. Environment variables such
1619: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1620: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1621: set them each time you want to use pkgsrc.</p>
1.23 wiz 1622: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1623: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1624: or being installed. This may be for debugging purposes, or out of
1625: simple curiosity. A number of utility values have been added to
1626: help with this.</p>
1.23 wiz 1627: <div class="orderedlist"><ol class="orderedlist" type="1">
1628: <li class="listitem">
1.207 leot 1629: <p>If you invoke the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 1630: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1631: information will be displayed. For example,</p>
1632: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1633: <p>will show all the commands that are invoked, up to and
1.23 wiz 1634: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1635: </li>
1.23 wiz 1636: <li class="listitem">
1.207 leot 1637: <p>If you want to know the value of a certain <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1638: definition, then the <code class="varname">VARNAME</code> definition
1639: should be used, in conjunction with the show-var
1.207 leot 1640: target. e.g. to show the expansion of the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1641: variable <code class="varname">LOCALBASE</code>:</p>
1642: <pre class="screen">
1643: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1644: /usr/pkg
1645: <code class="prompt">%</code>
1646: </pre>
1647: </li>
1648: </ol></div>
1649: <p>If you want to install a binary package that you've either
1650: created yourself (see next section), that you put into
1651: pkgsrc/packages manually or that is located on a remote FTP
1652: server, you can use the "bin-install" target. This target will
1.207 leot 1653: install a binary package - if available - via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 1654: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1655: sites searched is kept in the variable
1656: <code class="varname">BINPKG_SITES</code>, which defaults to
1.207 leot 1657: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 1658: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1659: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1660: details.</p>
1661: <p>A final word of warning: If you set up a system that has a
1662: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1663: set that before any packages are installed, as you cannot use
1664: several directories for the same purpose. Doing so will result in
1665: pkgsrc not being able to properly detect your installed packages,
1666: and fail miserably. Note also that precompiled binary packages are
1667: usually built with the default <code class="varname">LOCALBASE</code> of
1668: <code class="filename">/usr/pkg</code>, and that you should
1669: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1670: <code class="varname">LOCALBASE</code>.</p>
1671: </div>
1672: </div>
1673: </div>
1.41 asau 1674: <div class="chapter">
1.1 dsieger 1675: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1676: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1 dsieger 1677: <div class="toc">
1678: <p><b>Table of Contents</b></p>
1.100 leot 1679: <dl class="toc">
1.154 rillig 1680: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1681: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1682: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
1683: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1684: <dd><dl>
1685: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
1686: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1687: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 1688: </dl></dd>
1.154 rillig 1689: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
1690: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 1691: </dl>
1692: </div>
1.4 rillig 1693: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1694: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1695: that file depends on the installation. On NetBSD, when you use
1.207 leot 1696: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 1697: <code class="filename">/etc/</code>. In all other cases the default location is
1698: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1699: bootstrap program to install the binary packages.</p>
1700: <p>The format of the configuration file is that of the usual
1701: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1702: is done by setting variables in this file. Note that you can define all
1703: kinds of variables, and no special error checking (for example for
1.112 rillig 1704: spelling mistakes) takes place.</p>
1.41 asau 1705: <div class="sect1">
1.1 dsieger 1706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1707: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112 rillig 1708: <p>The following variables apply to all
1.1 dsieger 1709: pkgsrc packages. A complete list of the variables that can be
1710: configured by the user is available in
1711: <code class="filename">mk/defaults/mk.conf</code>, together with some
1712: comments that describe each variable's intent.</p>
1.41 asau 1713: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1714: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1715: packages will be installed. The default is
1716: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1717: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1718: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1719: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1720: installed. The default is
1721: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1722: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1723: X11 is installed on the system. The default is
1.84 wiz 1724: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1725: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1726: downloaded copies of the original source distributions used
1727: for building pkgsrc packages. The default is
1728: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1729: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1730: database about installed packages is stored. The default is
1.118 sevan 1731: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1732: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1733: If set, override the packages'
1734: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1735: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1736: Backup location(s) for distribution files and patch files
1737: if not found locally or in
1738: <code class="filename">${MASTER_SITES}</code> or
1739: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1740: The defaults is
1741: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1742: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1743: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1744: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1745: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1746: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1747: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1748: List of acceptable licenses. License names are case-sensitive.
1749: Whenever you try to build a package whose license is not in this
1750: list, you will get an error message. If the license condition is
1751: simple enough, the error message will include specific
1752: instructions on how to change this variable.</p></li>
1.1 dsieger 1753: </ul></div>
1754: </div>
1.41 asau 1755: <div class="sect1">
1.1 dsieger 1756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1757: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1758: <p>
1.1 dsieger 1759: </p>
1.41 asau 1760: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1761: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1762: directory for the binary packages. The default is
1763: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1764: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1765: The top level directory where, if defined, the separate
1766: working directories will get created, and symbolically
1767: linked to from <code class="filename">${WRKDIR}</code> (see below).
1768: This is useful for building packages on several
1769: architectures, then <code class="filename">${PKGSRCDIR}</code>
1770: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1771: is local to every architecture. (It should be noted that
1772: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1773: — it is an internal definition which refers to the
1.1 dsieger 1774: root of the pkgsrc tree. It is possible to have many
1775: pkgsrc tree instances.)</p></li>
1.23 wiz 1776: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1777: Directory for local patches that aren't part of pkgsrc.
1.184 rillig 1778: See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> for more
1.1 dsieger 1779: information.</p></li>
1.23 wiz 1780: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1781: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1782: BSD-style Makefile. If this is not set,
1783: <code class="varname">MAKECONF</code> is set to
1784: <code class="filename">/dev/null</code> to avoid picking up
1785: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1786: </ul></div>
1787: </div>
1.41 asau 1788: <div class="sect1">
1.1 dsieger 1789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1790: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.198 leot 1791: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
1.143 maya 1792: By default, binary packages of built packages are
1.150 leot 1793: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143 maya 1794: this variable to "no" prevents this.</p></li></ul></div>
1.107 jnemeth 1795: <p>Packages have to support installation into a
1.4 rillig 1796: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1797: to be built, before the actual filesystem is touched. DESTDIR
1798: support exists in two variations:</p>
1.41 asau 1799: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1800: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1801: installation and packaging is still run as root.</p></li>
1802: <li class="listitem"><p>Full DESTDIR support can run the complete
1803: build, installation and packaging as normal user. Root
1804: privileges are only needed to add packages.</p></li>
1805: </ul></div>
1.4 rillig 1806: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1807: clean</code></strong> needs to be run as root.</p>
1.17 imil 1808: <p>Considering the <code class="filename">foo/bar</code> package,
1809: DESTDIR full support can be tested using the following commands
1810:
1811: </p>
1812: <pre class="programlisting">
1813: <code class="prompt">$</code> id
1814: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1815: <code class="prompt">$</code> mkdir $HOME/packages
1816: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1817: </pre>
1818: <p>
1819:
1820: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1821: should be needed
1822:
1823: </p>
1824: <pre class="programlisting">
1.66 asau 1825: <code class="prompt">$</code> make stage-install
1.17 imil 1826: </pre>
1827: <p>
1828:
1829: Create a package without root privileges
1830:
1831: </p>
1832: <pre class="programlisting">
1.66 asau 1833: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1834: </pre>
1835: <p>
1836:
1837: For the following command, you must be able to gain root
1.207 leot 1838: privileges using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 1839:
1840: </p>
1841: <pre class="programlisting">
1.66 asau 1842: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1843: </pre>
1844: <p>
1845:
1846: Then, as a simple user
1847:
1848: </p>
1849: <pre class="programlisting">
1850: <code class="prompt">$</code> make clean
1851: </pre>
1852: <p>
1853:
1854: </p>
1.4 rillig 1855: </div>
1.41 asau 1856: <div class="sect1">
1.4 rillig 1857: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1858: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1859: <div class="sect2">
1.1 dsieger 1860: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1861: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1862: <p>By default, pkgsrc will use GCC to build packages. This may be
1863: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1864: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1865: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1866: <dd>
1867: <p>This is a list of values specifying the chain of
1868: compilers to invoke when building packages. Valid values
1869: are:</p>
1.41 asau 1870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1871: <li class="listitem"><p><code class="varname">ccc</code>:
1872: Compaq C Compilers (Tru64)</p></li>
1873: <li class="listitem"><p><code class="varname">ccache</code>:
1874: compiler cache (chainable)</p></li>
1875: <li class="listitem"><p><code class="varname">clang</code>:
1876: Clang C and Objective-C compiler</p></li>
1.23 wiz 1877: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1878: distributed C/C++ (chainable)</p></li>
1.66 asau 1879: <li class="listitem"><p><code class="varname">f2c</code>:
1880: Fortran 77 to C compiler (chainable)</p></li>
1881: <li class="listitem"><p><code class="varname">icc</code>:
1882: Intel C++ Compiler (Linux)</p></li>
1883: <li class="listitem"><p><code class="varname">ido</code>:
1884: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1885: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1886: GNU C/C++ Compiler</p></li>
1.66 asau 1887: <li class="listitem"><p><code class="varname">hp</code>:
1888: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1889: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1890: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1891: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1892: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1893: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1894: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1895: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1896: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1897: </ul></div>
1898: <p>The default is
1.23 wiz 1899: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1900: <code class="varname">ccache</code> and/or
1901: <code class="varname">distcc</code> with an appropriate
1902: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1903: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1904: variable should always be terminated with a value for
1905: a real compiler. Note that only one real compiler
1.23 wiz 1906: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1907: is not allowed).</p>
1908: </dd>
1909: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1910: <dd><p>This specifies the minimum version of GCC to use
1911: when building packages. If the system GCC doesn't
1912: satisfy this requirement, then pkgsrc will build and
1913: install one of the GCC packages to use instead.</p></dd>
1.153 leot 1914: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114 maya 1915: <dd><p>Specifies which version of python to use when several
1916: options are available.</p></dd>
1917: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.176 gutterid 1918: <dd><p>Specifies the Fortran compiler to use.
1919: The default is <code class="varname">gfortran</code>.</p></dd>
1.114 maya 1920: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1921: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1922: <code class="varname">gfortran</code> is used, this option specifies which
1923: version to use.</p></dd>
1.1 dsieger 1924: </dl></div>
1925: </div>
1.41 asau 1926: <div class="sect2">
1.1 dsieger 1927: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1928: <a name="conf.cflags"></a>6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 1929: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1930: please make sure to use the <code class="literal">+=</code> operator
1931: instead of the <code class="literal">=</code> operator:</p>
1932: <pre class="programlisting">
1933: CFLAGS+= -your -flags
1934: </pre>
1935: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1936: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1937: need to add their own flags. You may want to take a look
1.207 leot 1938: at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23 wiz 1939: package if you're interested in optimization specifically
1940: for the current CPU. </p>
1.1 dsieger 1941: </div>
1.41 asau 1942: <div class="sect2">
1.1 dsieger 1943: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1944: <a name="conf.ldflags"></a>6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 1945: <p>If you want to pass flags to the linker, both in the configure
1946: step and the build step, you can do this in two ways. Either set
1947: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1948: between the two is that <code class="varname">LIBS</code> will be appended to
1949: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1950: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1951: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1952: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1953: <code class="varname">CFLAGS</code>, if you do not wish to override these
1954: settings, use the <code class="literal">+=</code> operator:</p>
1955: <pre class="programlisting">
1956: LDFLAGS+= -your -linkerflags
1957: </pre>
1958: </div>
1959: </div>
1.41 asau 1960: <div class="sect1">
1.1 dsieger 1961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1962: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1963: <p>
1.1 dsieger 1964: </p>
1.41 asau 1965: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1966: <li class="listitem">
1.1 dsieger 1967: <p><code class="varname">PKG_DEVELOPER</code>:
1968: Run some sanity checks that package developers want:
1969: </p>
1.41 asau 1970: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1971: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 1972: fuzz</p></li>
1.23 wiz 1973: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 1974: binaries will find their shared libs.</p></li>
1975: </ul></div>
1976: <p>
1977: </p>
1978: </li>
1.23 wiz 1979: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 1980: of debugging output which is displayed whilst making and
1981: installing the package. The default value for this is 0,
1982: which will not display the commands as they are executed
1983: (normal, default, quiet operation); the value 1 will display
1984: all shell commands before their invocation, and the value 2
1985: will display both the shell commands before their invocation,
1.112 rillig 1986: as well as their actual execution progress with <span class="command"><strong>set
1987: -x</strong></span>.</p></li>
1.1 dsieger 1988: </ul></div>
1989: <p>
1990: </p>
1991: </div>
1.41 asau 1992: <div class="sect1">
1.1 dsieger 1993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1994: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1995: <p>Some packages have build time options, usually to select
1996: between different dependencies, enable optional support for big
1997: dependencies or enable experimental features.</p>
1998: <p>To see which options, if any, a package supports, and which
1.10 hubertf 1999: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2000: show-options</strong></span>, for example:</p>
2001: <pre class="programlisting">
2002: The following options are supported by this package:
2003: ssl Enable SSL support.
2004: Exactly one of the following gecko options is required:
2005: firefox Use firefox as gecko rendering engine.
2006: mozilla Use mozilla as gecko rendering engine.
2007: At most one of the following database options may be selected:
2008: mysql Enable support for MySQL database.
2009: pgsql Enable support for PostgreSQL database.
2010:
2011: These options are enabled by default: firefox
2012: These options are currently enabled: mozilla ssl
2013: </pre>
2014: <p>The following variables can be defined in
1.10 hubertf 2015: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2016: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2017: which can be used to select or disable options for all packages
2018: that support them, and
2019: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2020: which can be used to select or disable options specifically for
2021: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 2022: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2023: are disabled. A few examples:</p>
2024: <pre class="screen">
1.10 hubertf 2025: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1 dsieger 2026: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2027: PKG_OPTIONS.kdebase= debug -sasl
2028: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2029: <p>It is important to note that options that were specifically
1.18 snj 2030: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2031: you do not wish to include the option. If you are unsure you can view
2032: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2033: <p>The following settings are consulted in the order given, and
2034: the last setting that selects or disables an option is
2035: used:</p>
1.23 wiz 2036: <div class="orderedlist"><ol class="orderedlist" type="1">
2037: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2038: maintainer</p></li>
1.23 wiz 2039: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2040: variables (see below)</p></li>
1.23 wiz 2041: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2042: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2043: </ol></div>
2044: <p>For groups of mutually exclusive options, the last option
2045: selected is used, all others are automatically disabled. If an
2046: option of the group is explicitly disabled, the previously
2047: selected option, if any, is used. It is an error if no option
2048: from a required group of options is selected, and building the
2049: package will fail.</p>
2050: <p>Before the options framework was introduced, build options
2051: were selected by setting a variable (often named
2052: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2053: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2054: transition to the options framework for the user, these legacy
2055: variables are converted to the appropriate options setting
2056: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2057: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2058: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2059: directly. Support for the legacy variables will be removed
2060: eventually.</p>
2061: </div>
2062: </div>
1.41 asau 2063: <div class="chapter">
1.1 dsieger 2064: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2065: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1 dsieger 2066: <div class="toc">
2067: <p><b>Table of Contents</b></p>
1.100 leot 2068: <dl class="toc">
1.154 rillig 2069: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2070: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.1 dsieger 2071: </dl>
2072: </div>
1.41 asau 2073: <div class="sect1">
1.1 dsieger 2074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2075: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1 dsieger 2076: <p>Once you have built and installed a package, you can create
2077: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.207 leot 2078: 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.1 dsieger 2079: the same package on a group of hosts and wasting CPU time. It also
2080: provides a simple means for others to install your package, should
2081: you distribute it.</p>
2082: <p>To create a binary package, change into the appropriate
1.10 hubertf 2083: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2084: package</strong></span>:</p>
2085: <pre class="screen">
1.112 rillig 2086: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2087: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2088: </pre>
1.1 dsieger 2089: <p>This will build and install your package (if not already done),
2090: and then build a binary package from what was installed. You can
1.10 hubertf 2091: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2092: it. Binary packages are created by default in
2093: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.207 leot 2094: gzipped tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a
2095: 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.154 rillig 2096: <p>See <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a> for information on how to submit
1.1 dsieger 2097: such a binary package.</p>
2098: </div>
1.41 asau 2099: <div class="sect1">
1.1 dsieger 2100: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2101: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.184 rillig 2102: <p>See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a>.</p>
1.6 rillig 2103: </div>
2104: </div>
1.41 asau 2105: <div class="chapter">
1.6 rillig 2106: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2107: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 2108: builds)</h2></div></div></div>
2109: <div class="toc">
2110: <p><b>Table of Contents</b></p>
1.100 leot 2111: <dl class="toc">
1.154 rillig 2112: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 2113: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 2114: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2115: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 2116: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2117: <dd><dl>
1.179 rillig 2118: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2119: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.181 rillig 2120: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
2121: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
2122: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
2123: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
2124: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
2125: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
2126: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
2127: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 2128: </dl></dd>
2129: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2130: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2131: </dl>
2132: </div>
1.175 gutterid 2133: <p>For a number of reasons, you may want to build binary packages
2134: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.71 wiz 2135: For instance, when you have multiple machines that should run the same software,
2136: it is wasted time if they all build their packages themselves from source.
2137: Or you may want to build a list of packages you want and check them before
1.175 gutterid 2138: deploying onto production systems.
1.71 wiz 2139: There is a way of getting a set of binary packages:
1.175 gutterid 2140: the bulk build system, or pbulk ("p" stands for "parallel").
1.112 rillig 2141: This chapter describes how to set it up.</p>
1.41 asau 2142: <div class="sect1">
1.6 rillig 2143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2144: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71 wiz 2145: <p>First of all, you have to decide whether you build all packages
2146: or a limited set of them. Full bulk builds usually consume a lot more resources,
2147: both space and time, than builds for some practical sets of packages.
1.175 gutterid 2148: A number of particularly heavy packages exist that are not actually
2149: interesting to a wide audience. (The approximate resource consumption for a
2150: 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>.)
2151: For limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2152: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2153: </p>
2154: <p>During bulk builds various packages are installed and deinstalled
2155: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2156: so make sure that you don't need any package during the builds.
1.112 rillig 2157: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2158: or something even more restrictive, depending on what the operating system provides,
2159: or dedicate the whole physical machine.
2160: As a useful side effect this makes sure that bulk builds cannot
2161: break anything in your system. There have been numerous cases where
1.6 rillig 2162: certain packages tried to install files outside the
2163: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2164: <code class="filename">/etc</code>.
2165: </p>
1.6 rillig 2166: </div>
1.41 asau 2167: <div class="sect1">
1.6 rillig 2168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 rillig 2169: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
2170: <p>Running a bulk build works roughly as follows:</p>
1.41 asau 2171: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2172: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2173: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2174: </ul></div>
1.41 asau 2175: <div class="sect2">
1.15 rillig 2176: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2177: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112 rillig 2178: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2179: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2180: Configure network access to fetch distribution files.
1.112 rillig 2181: Create a user with name "pbulk".</p>
1.68 asau 2182: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2183: <pre class="screen">
1.151 sevan 2184: <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>
2185: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
1.72 wiz 2186: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.68 asau 2187: </pre>
2188: <p>Or any other way that fits (e.g., curl, wget).</p>
2189: <p>Deploy and configure pbulk tools, e.g.:</p>
2190: <pre class="screen">
1.118 sevan 2191: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.68 asau 2192: <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>
2193: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2194: </pre>
2195: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2196: <h3 class="title">Note</h3>
2197: <p><code class="filename">mk.conf.frag</code> is a fragment of
2198: <code class="filename">mk.conf</code> that contains settings you want to
2199: apply to packages you build. For instance,</p>
2200: <pre class="programlisting">
1.112 rillig 2201: PKG_DEVELOPER= yes # perform more checks
2202: X11_TYPE= modular # use pkgsrc X11
2203: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2204: # when building all packages)
1.68 asau 2205: </pre>
2206: </div>
2207: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2208: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2209: <pre class="programlisting">
2210: www/firefox
2211: mail/thunderbird
2212: misc/libreoffice4
2213: </pre>
1.69 asau 2214: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2215: and make final amendments, if wanted.</p>
1.68 asau 2216: <p>Start it:</p>
2217: <pre class="screen">
2218: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2219: </pre>
2220: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2221: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2222: </p>
2223: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2224: <h3 class="title">Note</h3>
2225: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2226: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2227: The script is kept small enough for better understanding.</p>
2228: </div>
2229: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2230: <h3 class="title">Note</h3>
2231: <p>The <code class="filename">pbulk.sh</code> script supports running
1.205 wiz 2232: unprivileged bulk build and helps configuring distributed bulk builds.
2233: Distributed bulk builds support either building in worker chroots
2234: (each node is a path to a different chroot)
2235: that replicate the target system, including the pbulk prefix,
2236: or remote machines (each node is
2237: an IP address that must be accessible over SSH without a password).</p>
1.68 asau 2238: </div>
1.6 rillig 2239: </div>
2240: </div>
1.41 asau 2241: <div class="sect1">
1.6 rillig 2242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2243: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71 wiz 2244: <p>A complete bulk build requires lots of disk space. Some of the
2245: disk space can be read-only, some other must be writable. Some can be on
2246: remote filesystems (such as NFS) and some should be local. Some can be
2247: temporary filesystems, others must survive a sudden reboot.</p>
2248: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.205 wiz 2249: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2250: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.71 wiz 2251: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2252: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2253: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2254: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2255: </ul></div>
2256: </div>
2257: <div class="sect1">
2258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.178 rillig 2259: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2260: <p>To ensure that pkgsrc packages work in different configurations, it
2261: makes sense to run non-default bulk builds from time to time. This
2262: section lists some ideas for bulk builds that intentionally let packages
2263: fail if they don't follow the pkgsrc style.</p>
2264: <div class="sect2">
2265: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2266: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.178 rillig 2267: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2268: <pre class="programlisting">
2269: GNU_CONFIGURE_STRICT= yes
2270: </pre>
2271: <p>When a package fails this additional check, the most common cause
2272: is that the configure option was valid for an older version of the
2273: package but does not apply anymore. In that case, just remove it.</p>
2274: </div>
2275: <div class="sect2">
2276: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2277: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.178 rillig 2278: <p>The job of a compiler is not restricted to producing executable
1.179 rillig 2279: code, most compilers also detect typical programming mistakes. The pkgsrc
2280: compiler wrappers make it easy to force compiler options when the package
2281: is built. This can be used to find typical bugs across all packages that
2282: are in pkgsrc. By reporting these bugs upstream, the packages will be
2283: more reliable with the next updates.</p>
2284: <p>Add some of the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.178 rillig 2285: <pre class="programlisting">
2286: CFLAGS+= -Werror=char-subscripts
1.179 rillig 2287: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 2288: </pre>
1.179 rillig 2289: <p>When a package fails to build using these stricter compiler
2290: options, document the circumstances in which the compiler produced the
2291: error message. This includes:</p>
1.178 rillig 2292: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2293: <li class="listitem"><p>The platform
2294: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2295: <li class="listitem"><p>The source file</p></li>
2296: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2297: part of the diagnostic.</p></li>
1.179 rillig 2298: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.178 rillig 2299: </ul></div>
2300: <p>If a package produces these error messages, but the package is
1.179 rillig 2301: 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
2302: in the next builds:</p>
1.178 rillig 2303: <pre class="programlisting">
1.179 rillig 2304: .if ${PKGPATH} == category/package
1.178 rillig 2305: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2306: # error message
2307: # code
1.179 rillig 2308: # Reason why the code does not need to be fixed.
1.178 rillig 2309: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 2310: .endif
1.178 rillig 2311: </pre>
2312: <p>If the error messages from the compiler are valid and the code
1.179 rillig 2313: needs to be fixed, prepare a local patch (see
2314: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2315: authors of the package, providing them with the information you collected
2316: above.</p>
2317: <p>Patches that are not essential for the package to work should only
2318: be reported upstream but not committed to pkgsrc, to make future updates
2319: easier.</p>
1.178 rillig 2320: </div>
2321: <div class="sect2">
2322: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2323: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
2324: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2325: these apply to all phases of the package build process. Especially in the
2326: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2327: decisions. The GNU configure scripts feed many small test programs to the
2328: C compiler to see whether certain headers are available, functions are
2329: defined in a library and programs can be run. In many cases these
2330: programs would not survive a strict compiler run with <code class="literal">-Wall
2331: -Wextra -Werror</code>.</p>
2332: <p>The pkgsrc infrastructure is flexible enough to support compiler
2333: options being added between the <code class="literal">configure</code> and
2334: <code class="literal">build</code> phases. It's a little more complicated than the
2335: other examples in this section but still easy enough.</p>
2336: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2337: desired compiler options. The compiler wrapper's original task is to hide
2338: unwanted directories of include files and to normalize compiler options.
2339: It does this by wrapping the compiler command and rewriting the command
2340: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2341: package directory and examine the
2342: <code class="filename">work/.cwrappers/config</code> directory. It contains
2343: individual configurations for the C compiler and the related tools. The
2344: plan is to find a hook between the configure and build phases, and to
2345: modify these configuration files at that point.</p>
2346: <p>To find this hook, have a look at
2347: <code class="filename">mk/build/build.mk</code>, which contains among others the
2348: <code class="literal">pre-build-checks-hook</code>. The word
2349: <code class="literal">checks</code> doesn't quite fit, but the
2350: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2351: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2352: <pre class="programlisting">
2353: # Just a few example options.
2354: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2355:
2356: .if ${BUILD_ONLY_CFLAGS:U:M*}
2357: pre-build-checks-hook: add-build-only-cflags
2358:
2359: add-build-only-cflags: .PHONY
2360: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2361: ${TEST} ! -f ${.TARGET} || exit 0; \
2362: for flag in ${BUILD_ONLY_CFLAGS}; do \
2363: ${ECHO} "append=$$flag" >> cc; \
2364: done; \
2365: > ${.TARGET}
2366: .endif
2367: </pre>
2368: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2369: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2370: not with spaces.)</p>
2371: <p>The condition in the <code class="literal">.if</code> statement contains the
2372: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2373: should be undefined, possibly because it is only defined for a subset of
2374: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2375: at least one compiler option, to prevent a syntax error in the shell
2376: parser.</p>
2377: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2378: that the additional compiler options are only appended once, even if
2379: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2380: creates a marker file.</p>
2381: <p>To verify that this setup works, run <span class="command"><strong>bmake
2382: configure</strong></span> in a package directory. Up to now, everything works
2383: as usual. Examine the directory
2384: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2385: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2386: the file <code class="filename">cc</code>. Examine the tail of the
2387: <code class="filename">work/.work.log</code> file to see that the normal compiler
2388: options are used.</p>
2389: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2390: options to the file <code class="filename">cc</code> and will create the marker
2391: file in the same directory. After that, the build starts as usual, but
2392: with the added compiler options. Examine the tail of the file
2393: <code class="filename">work/.work.log</code> to see that the lines starting with
2394: <code class="literal">[*]</code> don't contain the compiler options, but the
2395: corresponding lines starting with <code class="literal"><.></code> do end
2396: with these options.</p>
2397: <p>Building packages using this setup variant and fixing the resulting
2398: 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>
2399: </div>
2400: <div class="sect2">
2401: <div class="titlepage"><div><div><h3 class="title">
2402: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.178 rillig 2403: <p>Some directories like <code class="varname">PREFIX</code>,
2404: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2405: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2406: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2407: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2408: <pre class="programlisting">
2409: PREFIX= /a-random-uuid
2410: PKG_SYSCONFDIR= /a-random-uuid
2411: VARBASE= /a-random-uuid
2412: PKGMANDIR= a-random-uuid
2413: PKG_INFODIR= a-random-uuid
2414: </pre>
2415: </div>
2416: <div class="sect2">
2417: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2418: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.178 rillig 2419: <p>When building a package, warnings are typically ignored since they
2420: just flow by and do not cause the build to fail immediately. To find
2421: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2422: <pre class="programlisting">
2423: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2424: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2425: </pre>
2426: <p>(There are many more classes of warnings in pkgsrc, and most of
2427: them can be redefined with a simple definition like above.</p>
1.179 rillig 2428: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.178 rillig 2429: the package Makefile, research whether the package actually needs Perl.
2430: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2431: Makefile, and if it doesn't, add
2432: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2433: </div>
2434: <div class="sect2">
2435: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2436: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.178 rillig 2437: <p>Using pkglint as part of the regular build process is mostly a
2438: waste of time. If you want to fix some of the warnings, just run pkglint
2439: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2440: 10), which is much faster than a complete bulk build.</p>
2441: </div>
2442: <div class="sect2">
2443: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2444: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.178 rillig 2445: <p>To ensure that the binary packages don't contain references to the
2446: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2447: that variable includes the item <code class="literal">extra</code>, it is
2448: possible to define additional patterns that must not appear in any
2449: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2450: <pre class="programlisting">
2451: CHECK_WRKREF= extra
2452: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2453: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2454: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2455: </pre>
2456: <p>The above patterns will probably generate many false positives,
2457: therefore the results need to be taken with a grain of salt.</p>
2458: </div>
2459: <div class="sect2">
2460: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2461: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.178 rillig 2462: <p>To run the test suites that come with each package, add this line
2463: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2464: <pre class="programlisting">
2465: PKGSRC_RUN_TEST= yes
2466: </pre>
2467: <p>Be prepared that even the most basic packages fail this test. When
2468: doing a bulk build with this, it will often abort in the early phase
2469: where the packages are scanned for their dependencies since there are
2470: cyclic dependencies. There is still a lot to do in this area.</p>
2471: </div>
2472: <div class="sect2">
2473: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2474: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.178 rillig 2475: <p>To catch typos in the shell snippets from the Makefile fragments,
2476: add the <code class="literal">-u</code> flag to most of the commands by adding this
2477: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2478: <pre class="programlisting">
2479: RUN= @set -eu;
2480: </pre>
1.181 rillig 2481: <p>After that, ensure that none of the bulk build log files (even
2482: those for successfully built packages) contains the string
2483: <code class="literal">parameter not set</code> or whatever error message the
2484: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.178 rillig 2485: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2486: definition.</p>
2487: </div>
2488: <div class="sect2">
2489: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2490: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.178 rillig 2491: <p>The build logs of a package are often quite long. This allows error
2492: messages or other interesting details to hide between the noise. To make
2493: the actual error message stand out more, add these lines to
2494: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2495: <pre class="programlisting">
2496: GNU_CONFIGURE_QUIET= yes
2497: MAKE_FLAGS+= -s
2498: </pre>
2499: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2500: Make. On exotic platforms with their own make, it may be a little
2501: different.</p>
2502: </div>
2503: </div>
2504: <div class="sect1">
2505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2506: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2507: <p>After your pkgsrc bulk-build has completed, you may wish to
2508: create a CD-ROM set of the resulting binary packages to assist
2509: in installing packages on other machines. The
1.207 leot 2510: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/index.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.1 dsieger 2511: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2512: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2513: way that keeps all the dependencies for a given package on the same
2514: CD as that package.</p>
1.41 asau 2515: <div class="sect2">
1.1 dsieger 2516: <div class="titlepage"><div><div><h3 class="title">
1.178 rillig 2517: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2518: <p>Complete documentation for cdpack is found in the cdpack(1)
2519: man page. The following short example assumes that the binary
2520: packages are left in
2521: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2522: sufficient disk space exists in <code class="filename">/u2</code> to
2523: hold the ISO 9660 images.</p>
2524: <pre class="screen">
2525: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2526: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2527: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2528: </pre>
2529: <p>If you wish to include a common set of files
2530: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2531: etc.) on each CD in the collection, then you need to create a
1.175 gutterid 2532: directory which contains these files, e.g.:</p>
1.1 dsieger 2533: <pre class="screen">
2534: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2535: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2536: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2537: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2538: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2539: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2540: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2541: </pre>
2542: <p>Now create the images:</p>
2543: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2544: <p>Each image will contain <code class="filename">README</code>,
2545: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2546: in their root directories.</p>
2547: </div>
2548: </div>
2549: </div>
1.41 asau 2550: <div class="chapter">
1.1 dsieger 2551: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2552: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2553: <div class="toc">
2554: <p><b>Table of Contents</b></p>
1.100 leot 2555: <dl class="toc">
1.154 rillig 2556: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2557: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1 dsieger 2558: </dl>
2559: </div>
2560: <p>The files that are installed by pkgsrc are organized in a way that
2561: is similar to what you find in the <code class="filename">/usr</code> directory
2562: of the base system. But some details are different. This is because
2563: pkgsrc initially came from FreeBSD and had adopted its file system
2564: hierarchy. Later it was largely influenced by NetBSD. But no matter
2565: which operating system you are using pkgsrc with, you can expect the
2566: same layout for pkgsrc.</p>
2567: <p>There are mainly four root directories for pkgsrc, which are all
2568: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2569: When pkgsrc has been installed as root, the default locations
2570: are:</p>
2571: <pre class="programlisting">
2572: LOCALBASE= /usr/pkg
2573: PKG_SYSCONFBASE= /usr/pkg/etc
2574: VARBASE= /var
1.119 sevan 2575: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2576: </pre>
2577: <p>In unprivileged mode (when pkgsrc has been installed as any other
2578: user), the default locations are:</p>
2579: <pre class="programlisting">
2580: LOCALBASE= ${HOME}/pkg
2581: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2582: VARBASE= ${HOME}/pkg/var
1.119 sevan 2583: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2584: </pre>
2585: <p>What these four directories are for, and what they look like is
2586: explained below.</p>
1.41 asau 2587: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2588: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2589: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2590: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2591: the well-known subdirectories like <code class="filename">bin</code>,
2592: <code class="filename">include</code>, <code class="filename">lib</code>,
2593: <code class="filename">share</code> and
2594: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2595: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2596: <code class="filename">/var</code> in the base system. Some programs (especially
2597: games, network daemons) need write access to it during normal
2598: operation.</p></li>
1.23 wiz 2599: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2600: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2601: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 2602: itself.</p></li>
2603: </ul></div>
1.41 asau 2604: <div class="sect1">
1.1 dsieger 2605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2606: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2607: </h2></div></div></div>
2608: <p>The following directories exist in a typical pkgsrc installation
2609: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2610: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2611: <dt><span class="term"><code class="filename">bin</code></span></dt>
2612: <dd><p>Contains executable programs that are intended to be
2613: directly used by the end user.</p></dd>
2614: <dt><span class="term"><code class="filename">emul</code></span></dt>
2615: <dd><p>Contains files for the emulation layers of various other
2616: operating systems, especially for
2617: NetBSD.</p></dd>
2618: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2619: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2620: <dd><p>Contains
2621: the configuration files.</p></dd>
2622: <dt><span class="term"><code class="filename">include</code></span></dt>
2623: <dd><p>Contains headers for the C and C++ programming
2624: languages.</p></dd>
2625: <dt><span class="term"><code class="filename">info</code></span></dt>
2626: <dd><p>Contains GNU info files of various
2627: packages.</p></dd>
2628: <dt><span class="term"><code class="filename">lib</code></span></dt>
2629: <dd><p>Contains shared and static
2630: libraries.</p></dd>
2631: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2632: <dd><p>Contains data files that don't change after
2633: installation. Other data files belong into
2634: <code class="filename">${VARBASE}</code>.</p></dd>
2635: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2636: <dd><p>Contains programs that are not intended to be used by
2637: end users, such as helper programs or network
2638: daemons.</p></dd>
2639: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2640: <dd><p>Contains programs that are intended to be executed as
2641: CGI scripts by a web server.</p></dd>
2642: <dt><span class="term"><code class="filename">man</code> (the usual value of
2643: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2644: <dd><p>Contains brief
2645: documentation in form of manual pages.</p></dd>
2646: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2647: <dd><p>Contains programs that are intended to be used only by
2648: the super-user.</p></dd>
2649: <dt><span class="term"><code class="filename">share</code></span></dt>
2650: <dd><p>Contains platform-independent data files that don't
2651: change after installation.</p></dd>
2652: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2653: <dd><p>Contains documentation files provided by the
2654: packages.</p></dd>
2655: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2656: <dd><p>Contains example files provided by the packages. Among
2657: others, the original configuration files are saved here and copied to
2658: <code class="filename">${PKG_SYSCONFDIR}</code> during
2659: installation.</p></dd>
2660: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2661: <dd><p>Contains the original files for rc.d
2662: scripts.</p></dd>
2663: <dt><span class="term"><code class="filename">var</code> (the usual location of
2664: <code class="filename">${VARBASE}</code>)</span></dt>
2665: <dd><p>Contains files
2666: that may be modified after
2667: installation.</p></dd>
2668: </dl></div>
2669: </div>
1.41 asau 2670: <div class="sect1">
1.1 dsieger 2671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2672: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2673: </h2></div></div></div>
1.41 asau 2674: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2675: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2676: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2677: <dd><p>Contains
2678: information about the currently installed
2679: packages.</p></dd>
2680: <dt><span class="term"><code class="filename">games</code></span></dt>
2681: <dd><p>Contains highscore
2682: files.</p></dd>
2683: <dt><span class="term"><code class="filename">log</code></span></dt>
2684: <dd><p>Contains log files.</p></dd>
2685: <dt><span class="term"><code class="filename">run</code></span></dt>
2686: <dd><p>Contains informational files about daemons that are
2687: currently running.</p></dd>
2688: </dl></div>
2689: </div>
2690: </div>
1.41 asau 2691: <div class="chapter">
1.1 dsieger 2692: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2693: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2694: <div class="toc">
2695: <p><b>Table of Contents</b></p>
1.100 leot 2696: <dl class="toc">
1.154 rillig 2697: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2698: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2699: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2700: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2701: <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>
2702: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2703: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2704: <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>
2705: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2706: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 2707: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 2708: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.221 nia 2709: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 2710: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2711: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2712: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2713: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2714: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 2715: </dl>
2716: </div>
2717: <p>This section contains hints, tips & tricks on special things in
2718: pkgsrc that we didn't find a better place for in the previous chapters, and
2719: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2720: <div class="sect1">
1.1 dsieger 2721: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2722: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2723: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2724: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2725: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 2726: This is a general purpose list for most issues regarding
2727: pkgsrc, regardless of platform, e.g. soliciting user help
2728: for pkgsrc configuration, unexpected build failures, using
2729: particular packages, upgrading pkgsrc installations,
2730: questions regarding the pkgsrc release branches, etc. General announcements or
2731: proposals for changes that impact the pkgsrc user community,
2732: e.g. major infrastructure changes, new features, package
2733: removals, etc., may also be posted.</p></li>
1.174 leot 2734: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 2735: A list where the results of pkgsrc bulk builds are sent and
2736: discussed.</p></li>
1.174 leot 2737: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 2738: This list is for those who are interested in getting a
2739: commit message for every change committed to pkgsrc. It is
2740: also available in digest form, meaning one daily message
2741: containing all commit messages for changes to the package
2742: source tree in that 24 hour period.</p></li>
2743: </ul></div>
2744: <p>To subscribe, do:</p>
2745: <pre class="programlisting">
2746: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2747: </pre>
2748: <p>Archives for all these mailing lists are available from
1.174 leot 2749: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2750: </div>
1.41 asau 2751: <div class="sect1">
1.1 dsieger 2752: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2753: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2754: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2755: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2756: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2757: they might be useful, and not to duplicate the documentation that comes
2758: with each package.</p>
2759: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.207 leot 2760: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/index.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1 dsieger 2761: Symlinks for use by buildlink.</p></li></ul></div>
2762: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2763: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2764: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/index.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.121 sevan 2765: Calculates various kinds of checksums (including SHA3).</p></li>
1.207 leot 2766: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/index.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.1 dsieger 2767: Compatibility library for pkgsrc tools.</p></li>
1.207 leot 2768: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/index.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.1 dsieger 2769: non-BSD systems due to lack of native mtree.</p></li>
1.207 leot 2770: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.1 dsieger 2771: Up-to-date replacement for
2772: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2773: systems where pkg_install is not present.</p></li>
2774: </ul></div>
2775: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2777: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1 dsieger 2778: Create a binary package from an
1.10 hubertf 2779: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2780: save the old package.</p></li>
1.207 leot 2781: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/index.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.1 dsieger 2782: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2783: from multiple locations. It currently supports the following
2784: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.207 leot 2785: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.16 jnemeth 2786: the best compiler flags to optimise code for your current
1.23 wiz 2787: CPU and compiler. </p></li>
1.1 dsieger 2788: </ul></div>
2789: <p>Utilities for keeping track of installed packages, being up to date,
2790: etc:</p>
1.41 asau 2791: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2792: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/index.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.65 wiz 2793: update tool similar to apt(1). Download, install, and upgrade
2794: binary packages easily.</p></li>
1.207 leot 2795: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.1 dsieger 2796: packages whose installed versions do not match the latest pkgsrc
2797: entries.</p></li>
1.207 leot 2798: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.1 dsieger 2799: dependency graphs of packages, to aid in choosing a strategy for
2800: updating.</p></li>
1.207 leot 2801: <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
2802: 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>
2803: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12 weinem 2804: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.207 leot 2805: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1 dsieger 2806: does various checks on the complete pkgsrc system.</p></li>
1.207 leot 2807: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/index.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.1 dsieger 2808: packages you have installed.</p></li>
2809: </ul></div>
2810: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2811: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2812: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.1 dsieger 2813: making and maintaining patches for a package (includes pkgdiff,
2814: pkgvi, mkpatches, etc.).</p></li>
1.207 leot 2815: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/index.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.1 dsieger 2816: converting to pkgsrc.</p></li>
2817: </ul></div>
2818: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2819: utilities)</p>
1.41 asau 2820: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2821: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/index.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.1 dsieger 2822: packages in a chrooted area.</p></li>
1.207 leot 2823: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/index.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.1 dsieger 2824: kernel version for chrooted cross builds.</p></li>
2825: </ul></div>
2826: </div>
1.41 asau 2827: <div class="sect1">
1.1 dsieger 2828: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2829: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2830: <p>To install packages from source as a non-root user, download
1.154 rillig 2831: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 3. Where to get pkgsrc and how to keep it up-to-date">Chapter 3, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
1.108 rillig 2832: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2833: --unprivileged</strong></span>.</p>
2834: <p>This will install the binary part of pkgsrc to
2835: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2836: into <code class="filename">~/pkg/etc</code>.</p>
2837: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2838: </div>
1.41 asau 2839: <div class="sect1">
1.1 dsieger 2840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2841: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2842: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2843: enable this feature by adding the option
2844: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2845: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2846: distfile is found, pkgsrc will try to resume it.</p>
2847: <p>You can also
1.61 wiz 2848: use a different program than the platform default program by changing the
1.16 jnemeth 2849: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2850: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2851: by using the value manual. A value of custom disables the system defaults
2852: and dependency tracking for the fetch program. In that case you have to
2853: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2854: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2855: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2856: <p>For example, if you want to use
1.16 jnemeth 2857: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2858: like:</p>
2859: <pre class="programlisting">
1.112 rillig 2860: FETCH_USING= wget
1.1 dsieger 2861: </pre>
2862: </div>
1.41 asau 2863: <div class="sect1">
1.1 dsieger 2864: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2865: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4 rillig 2866: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2867: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2868: you will have to add the following line into
1.10 hubertf 2869: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2870: <pre class="programlisting">
1.4 rillig 2871: X11_TYPE=modular
1.1 dsieger 2872: </pre>
2873: </div>
1.41 asau 2874: <div class="sect1">
1.1 dsieger 2875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2876: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2877: <p>If you are sitting behind a firewall which does not allow direct
2878: connections to Internet hosts (i.e. non-NAT), you may specify the
2879: relevant proxy hosts. This is done using an environment variable in the
2880: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2881: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2882: port 80 as the proxy port number. So the proxy environment variables
2883: are:</p>
2884: <pre class="programlisting">
2885: ftp_proxy=ftp://orpheus.amdahl.com:80/
2886: http_proxy=http://orpheus.amdahl.com:80/
2887: </pre>
2888: </div>
1.41 asau 2889: <div class="sect1">
1.1 dsieger 2890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2891: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2892: <p>Some fetch tools are not prepared to support HTTPS by default
2893: (for example, the one in NetBSD 6.0), or the one installed by the
2894: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2895: dependency graph).</p>
2896: <p>Usually you won't notice, because distribution files are
2897: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2898: be often enough if you are following pkgsrc-current. In that case, set
2899: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2900: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2901: with HTTPS support by default. Of course, these tools need to be
2902: installed before you can use them this way.</p>
2903: </div>
2904: <div class="sect1">
2905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2906: <a name="passive-ftp"></a>10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1 dsieger 2907: <p>This depends on which utility is used to retrieve distfiles. From
2908: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2909: the first available command from the following list:</p>
1.41 asau 2910: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2911: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2912: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2913: </ul></div>
2914: <p>On a default NetBSD installation, this will be
2915: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2916: connections first, and falls back to active connections if the server
2917: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2918: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2919: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2920: <p>Having that option present will prevent
2921: <code class="filename">/usr/bin/ftp</code> from falling back to active
2922: transfers.</p>
2923: </div>
1.41 asau 2924: <div class="sect1">
1.1 dsieger 2925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2926: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2927: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2928: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2929: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.1 dsieger 2930: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2931: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2932: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2933: resulting list to your machine at work/school and use it there. If you
1.207 leot 2934: 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.1 dsieger 2935: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2936: URL:</p>
2937: <p>At home:</p>
2938: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2939: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2940: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2941: <p>At work:</p>
2942: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2943: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2944: home.</p>
2945: <p>If you have a machine running NetBSD, and you want to get
2946: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2947: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2948: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2949: directly by running:</p>
2950: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2951: <p>If you even decide to ignore
2952: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2953: by running:</p>
2954: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2955: </div>
1.41 asau 2956: <div class="sect1">
1.1 dsieger 2957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2958: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 2959: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.207 leot 2960: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.1 dsieger 2961: package, you get the error from make that it doesn't know how to make
2962: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2963: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2964: the NetBSD base distribution on your machine. It is recommended to do
2965: that to format man pages.</p>
1.207 leot 2966: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.1 dsieger 2967: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2968: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2969: </div>
1.41 asau 2970: <div class="sect1">
1.1 dsieger 2971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2972: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 2973: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2974: when you installed your NetBSD machine. Please get and install it, by
2975: extracting it in <code class="filename">/</code>:</p>
2976: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2977: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2978: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2979: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2980: -r</strong></span>).</p>
2981: </div>
1.41 asau 2982: <div class="sect1">
1.1 dsieger 2983: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.221 nia 2984: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.1 dsieger 2985: <p>When installing packages as non-root user and using the just-in-time
1.207 leot 2986: <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.1 dsieger 2987: password for each required package installed. To avoid this, the sudo
2988: package can be used, which does password caching over a limited time. To
1.221 nia 2989: use it, install <span class="command"><strong>sudo</strong></span> or
2990: <span class="command"><strong>priv</strong></span> (either as binary package, from
2991: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/priv/index.html" target="_top"><code class="filename">security/priv</code></a>, or
1.207 leot 2992: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/index.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.10 hubertf 2993: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2994: <span class="emphasis"><em>after</em></span> the definition of the
2995: <code class="varname">LOCALBASE</code> variable:</p>
2996: <pre class="programlisting">
2997: .if exists(${LOCALBASE}/bin/sudo)
2998: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2999: .endif
3000: </pre>
3001: </div>
1.41 asau 3002: <div class="sect1">
1.1 dsieger 3003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3004: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3005: <p>As the system administrator, you can choose where configuration files
3006: are installed. The default settings make all these files go into
3007: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3008: be suboptimal depending on your expectations (e.g., a read-only,
3009: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3010: configuration of the provided packages).</p>
3011: <p>In order to change the defaults, you can modify the
3012: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3013: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3014: directory; some common examples include <code class="filename">/etc</code> or
3015: <code class="filename">/etc/pkg</code>.</p>
3016: <p>Furthermore, you can change this value on a per-package basis by
3017: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3018: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3019: package you would like to modify, that is, the contents of
3020: <code class="varname">PKGBASE</code>.</p>
3021: <p>Note that after changing these settings, you must rebuild and
3022: reinstall any affected packages.</p>
3023: </div>
1.41 asau 3024: <div class="sect1">
1.1 dsieger 3025: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3026: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3027: <p>Please be aware that there can often be bugs in third-party software,
3028: and some of these bugs can leave a machine vulnerable to exploitation by
3029: attackers. In an effort to lessen the exposure, the NetBSD packages team
3030: maintains a database of known-exploits to packages which have at one time
3031: been included in pkgsrc. The database can be downloaded automatically, and
3032: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3033: do this, refer to the following two tools (installed as part of the
1.207 leot 3034: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.23 wiz 3035: <div class="orderedlist"><ol class="orderedlist" type="1">
3036: <li class="listitem">
1.20 snj 3037: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3038: download a list of the security vulnerabilities information. This list
1.25 spz 3039: is kept up to date by the pkgsrc security team, and is distributed
3040: from the NetBSD ftp server:</p>
1.177 leot 3041: <p><a class="ulink" href="https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a></p>
1.1 dsieger 3042: </li>
1.23 wiz 3043: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3044: current machine, checking each known vulnerability. If a
1.1 dsieger 3045: vulnerable package is installed, it will be shown by output to stdout,
3046: including a description of the type of vulnerability, and a URL
3047: containing more information.</p></li>
3048: </ol></div>
1.121 sevan 3049: <p>Use of these tools is strongly recommended!
1.202 nia 3050: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, “Checking for security vulnerabilities in installed packages”</a> for instructions on how to automate checking and
1.121 sevan 3051: reporting.</p>
3052: <p>If this database is installed, pkgsrc builds will use it to
3053: perform a security check before building any package.</p>
1.1 dsieger 3054: </div>
1.41 asau 3055: <div class="sect1">
1.1 dsieger 3056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3057: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1 dsieger 3058: <p>When you add your own preferences to the
3059: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3060: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3061: environment variables to the <code class="filename">./configure</code>
1.207 leot 3062: 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.1 dsieger 3063: <code class="varname">CFLAGS</code> from the environment variable by
3064: overriding them in the <code class="filename">Makefile</code>s of their
3065: package.</p>
3066: <p>Currently there is no solution to this problem. If you
3067: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3068: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3069: directory and then inspect any <code class="filename">Makefile</code> and
3070: <code class="filename">Makefile.in</code> for whether they define
3071: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3072: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3073: programmers write so bad code that it only works for the
3074: specific combination of <code class="varname">CFLAGS</code> they have
3075: chosen.</p>
1.172 rillig 3076: <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>
3077: <pre class="programlisting">
3078: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3079: CFLAGS+= -Dpkgsrc___CFLAGS
3080: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3081: </pre>
3082: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3083: to see whether the above flags are passed to the actual build
3084: commands in general.</p>
3085: <p>To find out whether the flags are passed to individual compiler
3086: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3087: most cases, the flags from the original command lines (the lines starting
3088: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3089: (the lines starting with <code class="literal"><.></code>). If the flag is
3090: missing from the actual compiler command, it must have been removed by
1.184 rillig 3091: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.1 dsieger 3092: </div>
1.41 asau 3093: <div class="sect1">
1.1 dsieger 3094: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3095: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3096: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3097: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3098: case that occurs often is that people only update pkgsrc in
3099: parts, because of performance reasons. Since pkgsrc is one large
3100: system, not a collection of many small systems, there are
3101: sometimes changes that only work when the whole pkgsrc tree is
3102: updated.</p></li>
1.41 asau 3103: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3104: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3105: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3106: files.</p></li>
1.41 asau 3107: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3108: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3109: verify this.</p></li>
1.108 rillig 3110: <li class="step"><p>If you are a package developer who wants to invest
1.154 rillig 3111: some work, have a look at <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.41 asau 3112: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3113: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3114: </ol></div>
3115: </div>
1.41 asau 3116: <div class="sect1">
1.1 dsieger 3117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3118: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3119: <p>You have modified a file from pkgsrc, and someone else has
3120: modified that same file afterwards in the CVS repository. Both changes
3121: are in the same region of the file, so when you updated pkgsrc, the
3122: <code class="literal">cvs</code> command marked the conflicting changes in the
3123: file. Because of these markers, the file is no longer a valid
3124: <code class="filename">Makefile</code>.</p>
3125: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3126: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3127: -dP</strong></span> in that directory to download the current version.</p>
3128: </div>
3129: </div>
3130: </div>
1.41 asau 3131: <div class="part">
1.1 dsieger 3132: <div class="titlepage"><div><div><h1 class="title">
3133: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3134: <div class="partintro">
1.1 dsieger 3135: <div></div>
3136: <p>This part of the book deals with creating and
1.23 wiz 3137: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3138: guide on creating a new package. The remaining chapters are more
3139: like a reference manual for pkgsrc.</p>
3140: <div class="toc">
3141: <p><b>Table of Contents</b></p>
1.100 leot 3142: <dl class="toc">
1.154 rillig 3143: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 3144: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 3145: <dd><dl>
1.184 rillig 3146: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3147: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3148: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 3149: <dd><dl>
1.184 rillig 3150: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3151: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3152: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3153: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3154: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 3155: </dl></dd>
1.184 rillig 3156: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3157: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3158: <dd><dl>
3159: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3160: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3161: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3162: </dl></dd>
3163: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3164: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3165: </dl></dd>
1.184 rillig 3166: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 3167: <dd><dl>
1.184 rillig 3168: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3169: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3170: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3171: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3172: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 3173: <dd><dl>
1.184 rillig 3174: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3175: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 3176: </dl></dd>
1.184 rillig 3177: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3178: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3179: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3180: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3181: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3182: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3183: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3184: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3185: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3186: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3187: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3188: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3189: </dl></dd>
3190: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3191: <dd><dl>
3192: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 3193: <dd><dl>
1.219 nia 3194: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
3195: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
3196: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.6 rillig 3197: </dl></dd>
1.184 rillig 3198: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3199: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6 rillig 3200: </dl></dd>
1.184 rillig 3201: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3202: <dd><dl>
1.184 rillig 3203: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3204: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3205: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3206: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 3207: <dd><dl>
1.184 rillig 3208: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3209: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3210: <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>
3211: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 ! gutterid 3212: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.6 rillig 3213: </dl></dd>
3214: </dl></dd>
1.184 rillig 3215: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 3216: <dd><dl>
1.184 rillig 3217: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3218: <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>
3219: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3220: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3221: </dl></dd>
1.184 rillig 3222: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 3223: <dd><dl>
1.184 rillig 3224: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3225: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3226: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3227: </dl></dd>
3228: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3229: <dd><dl>
3230: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3231: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3232: <dd><dl>
1.184 rillig 3233: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3234: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 3235: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3236: and
3237: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3238: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3239: </dl></dd>
1.184 rillig 3240: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3241: <dd><dl>
3242: <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>
3243: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3244: </dl></dd>
3245: </dl></dd>
3246: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 3247: <dd><dl>
1.184 rillig 3248: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3249: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3250: <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>
3251: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3252: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3253: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3254: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3255: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3256: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 3257: </dl></dd>
1.184 rillig 3258: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3259: <dd><dl>
3260: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3261: <dd><dl>
3262: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3263: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 3264: </dl></dd>
1.184 rillig 3265: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 3266: <dd><dl>
1.184 rillig 3267: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3268: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
3269: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
3270: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
3271: </dl></dd>
3272: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3273: <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>
3274: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3275: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3276: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3277: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3278: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.154 rillig 3279: </dl></dd>
3280: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3281: <dd><dl>
3282: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3283: <dd><dl>
3284: <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>
3285: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3286: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3287: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3288: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3289: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3290: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3291: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3292: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3293: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3294: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3295: </dl></dd>
3296: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3297: <dd><dl>
3298: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3299: <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>
3300: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3301: </dl></dd>
3302: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3303: <dd><dl>
3304: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3305: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3306: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 3307: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154 rillig 3308: </dl></dd>
3309: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3310: <dd><dl>
3311: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3312: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 3313: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 3314: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
3315: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
3316: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
3317: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 3318: </dl></dd>
3319: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3320: <dd><dl>
3321: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3322: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 3323: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3324: <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>
3325: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 3326: </dl></dd>
3327: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3328: <dd><dl>
3329: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3330: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3331: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3332: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3333: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 3334: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154 rillig 3335: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
3336: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203 nia 3337: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
3338: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
3339: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
3340: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
3341: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
3342: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
3343: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1 dsieger 3344: emulation</a></span></dt>
1.203 nia 3345: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
3346: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1 dsieger 3347: </dl></dd>
1.154 rillig 3348: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3349: </dl></dd>
1.184 rillig 3350: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3351: <dd><dl>
3352: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3353: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3354: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3355: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3356: </dl></dd>
1.154 rillig 3357: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3358: <dd><dl>
1.154 rillig 3359: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3360: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3361: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3362: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3363: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3364: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3365: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3366: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3367: </dl></dd>
3368: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 3369: </dl>
3370: </div>
3371: </div>
1.41 asau 3372: <div class="chapter">
1.1 dsieger 3373: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3374: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3375: <p>
3376: To get help when developing pkgsrc, the definitive source is this
3377: document, the pkgsrc guide. If you don't find anything here,
3378: there are alternatives:
3379: </p>
3380: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3381: <li class="listitem">
3382: <p>
3383: The built-in pkgsrc help, which is available after bootstrapping
3384: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3385: help for any topic, such as a variable name like
3386: <code class="varname">BUILD_DEFS</code>, a make target like
3387: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3388: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.207 leot 3389: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.154 rillig 3390: </li>
3391: <li class="listitem"><p>
1.163 rillig 3392: To see the value of a single variable, run <span class="command"><strong>bmake
3393: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3394: </p></li>
3395: <li class="listitem"><p>
3396: To see the values of the most common variables, run
3397: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3398: topic. To see the variables for a single topic, run
3399: <span class="command"><strong>bmake
3400: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3401: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3402: </p></li>
3403: <li class="listitem"><p>
1.154 rillig 3404: The tech-pkg mailing list, to which
3405: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3406: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3407: questions</a>.</p></li>
3408: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3409: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3410: or by using a specialized chat program such as
3411: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3412: Pick any user name and join the channel #pkgsrc.</p></li>
3413: </ul></div>
3414: </div>
3415: <div class="chapter">
3416: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 3417: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3418: <div class="toc">
3419: <p><b>Table of Contents</b></p>
1.100 leot 3420: <dl class="toc">
1.184 rillig 3421: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3422: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3423: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3424: <dd><dl>
3425: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3426: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3427: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3428: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3429: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3430: </dl></dd>
3431: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3432: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3433: <dd><dl>
3434: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3435: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3436: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3437: </dl></dd>
1.184 rillig 3438: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3439: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3440: </dl>
3441: </div>
1.184 rillig 3442: <p>Whenever you're preparing a package, there are a number of
3443: files involved which are described in the following
3444: sections.</p>
3445: <div class="sect1">
3446: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3447: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3448: </h2></div></div></div>
3449: <p>Building, installation and creation of a binary package are all
3450: controlled by the package's <code class="filename">Makefile</code>.
3451: The <code class="filename">Makefile</code> describes various things about
3452: a package, for example from where to get it, how to configure,
3453: build, and install it.</p>
3454: <p>A package <code class="filename">Makefile</code> contains several
3455: sections that describe the package.</p>
3456: <p>In the first section there are the following variables, which
3457: should appear exactly in the order given here. The order and
3458: grouping of the variables is mostly historical and has no further
3459: meaning.</p>
3460: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3461: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3462: distribution file to be downloaded from the package's
3463: website.</p></li>
3464: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3465: package, as used by pkgsrc. You need to provide it if
3466: <code class="varname">DISTNAME</code> (which is the default) is not a good
3467: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3468: provided (no distribution file is required). Usually it is the pkgsrc
3469: directory name together with the version number. It must match the
3470: regular expression
3471: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3472: starts with a letter or digit, and contains only letters, digits,
1.204 nia 3473: dashes, underscores, dots and plus signs.
3474: New packages should have entirely lower-case names, with the exception
3475: of some that must follow pre-existing conventions
3476: (e.g. R packages begin with <code class="varname">R-</code>).
3477: You can use the <code class="code">:tl</code> variable modifier to lower-case
3478: the package name.</p></li>
1.184 rillig 3479: <li class="listitem">
3480: <p><code class="varname">CATEGORIES</code> is a list of categories
3481: which the package fits in. You can choose any of the top-level
3482: directories of pkgsrc for it.</p>
3483: <p>Currently the following values are available for
3484: <code class="varname">CATEGORIES</code>. If more than
3485: one is used, they need to be separated by spaces:</p>
1.1 dsieger 3486: <pre class="programlisting">
1.184 rillig 3487: archivers cross geography meta-pkgs security
3488: audio databases graphics misc shells
3489: benchmarks devel ham multimedia sysutils
3490: biology editors inputmethod net textproc
3491: cad emulators lang news time
3492: chat finance mail parallel wm
3493: comms fonts math pkgtools www
3494: converters games mbone print x11
1.1 dsieger 3495: </pre>
3496: </li>
1.184 rillig 3497: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3498: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3499: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3500: and <code class="varname">DISTFILES</code> are discussed in detail in
3501: <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>
3502: </ul></div>
3503: <p>The second section contains information about separately
3504: downloaded patches, if any.
3505: </p>
3506: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3507: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3508: Name(s) of additional files that contain distribution patches.
3509: There is no default. pkgsrc will look for them at
3510: <code class="varname">PATCH_SITES</code>.
3511: They will automatically be uncompressed before patching if
3512: the names end with <code class="filename">.gz</code> or
3513: <code class="filename">.Z</code>.</p></li>
3514: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3515: Primary location(s) for distribution patch files (see
3516: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3517: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.207 leot 3518: 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.184 rillig 3519: help find the correct files to patch. It defaults to
3520: <span class="command"><strong>-p0</strong></span>.</p></li>
3521: </ul></div>
3522: <p>The third section contains the following variables.
3523: </p>
3524: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3525: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
3526: address of the person who feels responsible for this package,
3527: and who is most likely to look at problems or questions regarding
1.207 leot 3528: 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.184 rillig 3529: Other developers may contact the <code class="varname">MAINTAINER</code>
3530: before making changes to the package, but are not required to
3531: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3532: to yourself. If you really can't maintain the package for future
3533: updates, set it to
3534: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
3535: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
3536: of <code class="varname">MAINTAINER</code> when you do not want other
3537: developers to update or change the package without contacting
3538: you first. A package Makefile should contain one of
3539: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3540: not both. </p></li>
3541: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3542: find more information about the package.</p></li>
3543: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3544: description of the package (should not include the package
3545: name).</p></li>
3546: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3547: 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>
3548: </ul></div>
3549: <p>Other variables that affect the build:
3550: </p>
3551: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3552: <p><code class="varname">WRKSRC</code>: The directory where the
3553: interesting distribution files of the package are found. The
3554: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3555: works for most packages.</p>
3556: <p>If a package doesn't create a subdirectory for itself
3557: (most GNU software does, for instance), but extracts itself in
3558: the current directory, you should set
3559: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3560: <p>If a package doesn't create a subdirectory with the
3561: name of <code class="varname">DISTNAME</code> but some different name,
3562: set <code class="varname">WRKSRC</code> to point to the proper name in
3563: <code class="filename">${WRKDIR}</code>, for example
3564: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.207 leot 3565: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/index.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/index.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.184 rillig 3566: <p>The name of the working directory created by pkgsrc is
3567: taken from the <code class="varname">WRKDIR_BASENAME</code>
3568: variable. By default, its value is
3569: <code class="filename">work</code>. If you want to use the same
3570: pkgsrc tree for building different kinds of binary packages,
3571: you can change the variable according to your needs. Two
3572: other variables handle common cases of setting
3573: <code class="varname">WRKDIR_BASENAME</code> individually. If
3574: <code class="varname">OBJHOSTNAME</code> is defined in
3575: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3576: the host's name is attached to the directory name. If
3577: <code class="varname">OBJMACHINE</code> is defined, the platform name
3578: is attached, which might look like
3579: <code class="filename">work.i386</code> or
3580: <code class="filename">work.sparc</code>.</p>
3581: </li></ul></div>
3582: <p>Please pay attention to the following gotchas:</p>
3583: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3584: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3585: installed in compressed form by the package. For packages using
3586: BSD-style makefiles which honor MANZ, there is
3587: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3588: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3589: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3590: below).</p></li>
3591: <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>
3592: </ul></div>
3593: </div>
1.41 asau 3594: <div class="sect1">
1.1 dsieger 3595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 3596: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3597: </h2></div></div></div>
3598: <p>The <code class="filename">distinfo</code> file contains the message
3599: digest, or checksum, of each distfile needed for the package. This
3600: ensures that the distfiles retrieved from the Internet have not been
3601: corrupted during transfer or altered by a malign force to introduce
3602: a security hole. To provide maximum security, all distfiles are
3603: protected using three different message digest algorithms (SHA1,
3604: RMD160, SHA512), as well as the file size.</p>
3605: <p>The <code class="filename">distinfo</code> file also contains the
3606: checksums for all the patches found in the
3607: <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
3608: are only applied intentionally and that they don't accidentally change,
3609: e.g. when merging different changes together. They also make sure that
3610: new patches are actually added to CVS and old ones are removed.
3611: Too see whether the patches and the <code class="filename">distinfo</code> file
3612: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3613: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3614: <span class="command"><strong>make distinfo</strong></span> command.</p>
3615: <p>Some packages have different sets of distfiles depending on
1.207 leot 3616: the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk8/index.html" target="_top"><code class="filename">lang/openjdk8</code></a>. These are kept in the same
1.184 rillig 3617: <code class="filename">distinfo</code> file and care should be taken when
3618: upgrading such a package to ensure distfile information is not
3619: lost.</p>
3620: </div>
3621: <div class="sect1">
3622: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3623: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3624: </h2></div></div></div>
3625: <p>Some packages don't work out-of-the box on the various
3626: platforms that are supported by pkgsrc. These packages need
3627: to be patched to make them work. The patch files can be
3628: found in the <code class="filename">patches/</code> directory.</p>
3629: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3630: applied to the files in <code class="varname">WRKSRC</code> directory after
3631: extracting them, in alphabetic order.</p>
1.41 asau 3632: <div class="sect2">
1.1 dsieger 3633: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3634: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3635: <p>The <code class="filename">patch-*</code> files should be in
3636: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3637: problems. (To force patches to apply with fuzz you can set
3638: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3639: should contain only changes for a single file, and no file should be
3640: patched by more than one patch file. This helps to keep future
3641: modifications simple.</p>
3642: <p>Each patch file is structured as follows: In the first line,
3643: there is the RCS Id of the patch itself. The second line should be
3644: empty for aesthetic reasons. After that, there should be a comment for
3645: each change that the patch does. There are a number of standard
3646: cases:</p>
3647: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3648: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3649: mention the vulnerability ID (CAN, CVE).</p></li>
3650: <li class="listitem"><p>Patches that change source code should mention the
3651: platform and other environment (for example, the compiler) that the
3652: patch is needed for.</p></li>
3653: </ul></div>
3654: <p>The patch should be commented so that any
3655: developer who knows the code of the application can make some use of
3656: the patch. Special care should be taken for the upstream developers,
3657: since we generally want that they accept our patches, so we have less
3658: work in the future.</p>
1.1 dsieger 3659: </div>
1.41 asau 3660: <div class="sect2">
1.1 dsieger 3661: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3662: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3663: <p>One important thing to mention is to pay attention that no RCS
3664: IDs get stored in the patch files, as these will cause problems when
3665: later checked into the NetBSD CVS tree. Use the
1.207 leot 3666: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.184 rillig 3667: problems.</p>
3668: <p>For even more automation, we recommend using
3669: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.222 gutterid 3670: whole set of patches. You just have to back up files before you
3671: edit them to <code class="filename">filename.orig</code>, e.g., with
1.184 rillig 3672: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3673: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3674: you upgrade a package this way, you can easily compare the new
3675: set of patches with the previously existing one with
3676: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3677: are replaced by new files, so carefully check if you want to take all
3678: the changes.</p>
3679: <p>When you have finished a package, remember to generate
3680: the checksums for the patch files by using the <span class="command"><strong>make
3681: 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>
3682: <p>When adding a patch that corrects a problem in the
3683: distfile (rather than e.g. enforcing pkgsrc's view of where
3684: man pages should go), send the patch as a bug report to the
3685: maintainer. This benefits non-pkgsrc users of the package,
3686: and usually makes it possible to remove the patch in future
3687: version.</p>
3688: <p>The file names of the patch files are usually of the form
3689: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3690: Many packages still use the previous convention
3691: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3692: but new patches should be of the form containing the filename.
1.207 leot 3693: <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.184 rillig 3694: automatically.</p>
1.222 gutterid 3695: <p>When updating pre-existing patch files, if a file uses the old
3696: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
3697: convention, it's best not to change it to the new form, as that will
3698: just cause churn that makes it harder to track changes to patching
3699: over time. Similarly, if a patch now applies at different line offsets,
3700: but still applies cleanly as-is, there's no need to update it, as that
3701: also unnecessarily complicates the patch history.</p>
1.17 imil 3702: </div>
1.160 brook 3703: <div class="sect2">
3704: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3705: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3706: <p>If you want to share patches between multiple packages
3707: in pkgsrc, e.g. because they use the same distfiles, set
3708: <code class="varname">PATCHDIR</code> to the path where the patch files
3709: can be found, e.g.:</p>
3710: <pre class="programlisting">
3711: PATCHDIR= ../../editors/xemacs/patches
3712: </pre>
3713: <p>Patch files that are distributed by the author or other
3714: maintainers can be listed in
3715: <code class="varname">PATCHFILES</code>.</p>
3716: <p>If it is desired to store any patches that should not be
3717: committed into pkgsrc, they can be kept outside the pkgsrc
3718: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3719: directory tree there is expected to have the same
3720: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3721: patches are expected to be stored inside these dirs (also
3722: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3723: example, if you want to keep a private patch for
3724: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3725: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3726: files in the named directory are expected to be patch files,
3727: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3728: applied</em></span>.</p>
1.160 brook 3729: </div>
3730: <div class="sect2">
3731: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3732: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3733: <p>When fixing a portability issue in the code do not use
3734: preprocessor magic to check for the current operating system nor
3735: platform. Doing so hurts portability to other platforms because
3736: the OS-specific details are not abstracted appropriately.</p>
3737: <p>The general rule to follow is: instead of checking for the
3738: operating system the application is being built on, check for the
3739: specific <span class="emphasis"><em>features</em></span> you need. For example,
3740: instead of assuming that kqueue is available under NetBSD and
3741: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3742: kqueue support, add a check that detects kqueue itself —
3743: yes, this generally involves patching the
3744: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3745: that prevents some OSes from adopting interfaces from other OSes
3746: (e.g. Linux implementing kqueue), something that the above checks
3747: cannot take into account.</p>
3748: <p>Of course, checking for features generally involves more
3749: work on the developer's side, but the resulting changes are
3750: cleaner and there are chances they will work on many other
3751: platforms. Not to mention that there are higher chances of being
3752: later integrated into the mainstream sources. Remember:
3753: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3754: <p>Some typical examples:</p>
3755: <div class="table">
3756: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3757: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3758: <colgroup>
3759: <col>
3760: <col>
3761: <col>
3762: </colgroup>
3763: <thead><tr>
3764: <th>Where</th>
3765: <th>Incorrect</th>
3766: <th>Correct</th>
3767: </tr></thead>
3768: <tbody>
3769: <tr>
3770: <td>configure script</td>
3771: <td>
1.160 brook 3772: <pre class="programlisting">
1.184 rillig 3773: case ${target_os} in
3774: netbsd*) have_kvm=yes ;;
3775: *) have_kvm=no ;;
3776: esac
1.160 brook 3777: </pre>
1.184 rillig 3778: </td>
3779: <td>
1.160 brook 3780: <pre class="programlisting">
1.184 rillig 3781: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.160 brook 3782: </pre>
1.184 rillig 3783: </td>
3784: </tr>
3785: <tr>
3786: <td>C source file</td>
3787: <td>
1.1 dsieger 3788: <pre class="programlisting">
1.184 rillig 3789: #if defined(__NetBSD__)
3790: # include <sys/event.h>
3791: #endif
1.1 dsieger 3792: </pre>
1.184 rillig 3793: </td>
3794: <td>
1.1 dsieger 3795: <pre class="programlisting">
1.184 rillig 3796: #if defined(HAVE_SYS_EVENT_H)
3797: # include <sys/event.h>
3798: #endif
1.1 dsieger 3799: </pre>
1.184 rillig 3800: </td>
3801: </tr>
3802: <tr>
3803: <td>C source file</td>
3804: <td>
1.1 dsieger 3805: <pre class="programlisting">
1.184 rillig 3806: int
3807: monitor_file(...)
3808: {
3809: #if defined(__NetBSD__)
3810: int fd = kqueue();
3811: ...
3812: #else
3813: ...
3814: #endif
3815: }
1.1 dsieger 3816: </pre>
1.184 rillig 3817: </td>
3818: <td>
1.1 dsieger 3819: <pre class="programlisting">
1.184 rillig 3820: int
3821: monitor_file(...)
3822: {
3823: #if defined(HAVE_KQUEUE)
3824: int fd = kqueue();
3825: ...
3826: #else
3827: ...
3828: #endif
3829: }
1.1 dsieger 3830: </pre>
1.184 rillig 3831: </td>
3832: </tr>
3833: </tbody>
3834: </table></div>
3835: </div>
3836: <br class="table-break">
3837: </div>
3838: <div class="sect2">
3839: <div class="titlepage"><div><div><h3 class="title">
3840: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3841: <p>Always, always, <span class="strong"><strong>always</strong></span>
3842: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3843: improvements you do to a package to the mainstream developers.
3844: This is the only way to get their attention on portability issues
3845: and to ensure that future versions can be built out-of-the box on
3846: NetBSD. Furthermore, any user that gets newer distfiles will get
3847: the fixes straight from the packaged code.</p>
3848: <p>This generally involves cleaning up the patches
3849: (because sometimes the patches that are
3850: added to pkgsrc are quick hacks), filing bug reports in the
3851: appropriate trackers for the projects and working with the
3852: mainstream authors to accept your changes. It is
3853: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3854: the packages in pkgsrc are kept simple and thus further changes
3855: can be done without much hassle.</p>
3856: <p>When you have done this, please add a URL to the upstream
3857: bug report to the patch comment.</p>
3858: <p>Support the idea of free software!</p>
3859: </div>
1.1 dsieger 3860: </div>
1.184 rillig 3861: <div class="sect1">
3862: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3863: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3864: <div class="variablelist"><dl class="variablelist">
3865: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3866: <dd><p>A multi-line description of the piece of software. This should include
3867: any credits where they are due. Please bear in mind that others do not
3868: share your sense of humour (or spelling idiosyncrasies), and that others
3869: will read everything that you write here.</p></dd>
3870: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3871: <dd><p>This file governs the files that are installed on your
3872: system: all the binaries, manual pages, etc. There are other
3873: directives which may be entered in this file, to control the
3874: creation and deletion of directories, and the location of
3875: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3876: information.</p></dd>
3877: </dl></div>
3878: </div>
3879: <div class="sect1">
3880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3881: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3882: <div class="sect2">
3883: <div class="titlepage"><div><div><h3 class="title">
3884: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3885: <div class="variablelist"><dl class="variablelist">
3886: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3887: <dd>
1.207 leot 3888: <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.184 rillig 3889: First time after package extraction and before files are
3890: moved in place, the second time after the files to install
3891: are moved in place. This can be used to do any custom
3892: procedures not possible with @exec commands in
1.207 leot 3893: <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
3894: <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.184 rillig 3895: Please note that you can modify variables in it easily by using
3896: <code class="varname">FILES_SUBST</code> in the package's
3897: <code class="filename">Makefile</code>:</p>
1.1 dsieger 3898: <pre class="programlisting">
1.184 rillig 3899: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3900: </pre>
1.184 rillig 3901: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3902: <code class="filename">INSTALL</code>. By default, substitution is
3903: performed for <code class="varname">PREFIX</code>,
3904: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3905: <code class="varname">VARBASE</code>, and a few others, type
3906: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3907: complete list.</p>
3908: </dd>
3909: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3910: <dd><p>This script is executed before and after any files are removed. It is
3911: this script's responsibility to clean up any additional messy details
3912: around the package's installation, since all pkg_delete knows is how to
3913: delete the files created in the original distribution.
1.207 leot 3914: 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>
3915: 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.184 rillig 3916: The same methods to replace variables can be used as for
3917: the <code class="filename">INSTALL</code> file.</p></dd>
3918: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3919: <dd>
3920: <p>This file is displayed after installation of the package.
1.198 leot 3921: While this was used often in the past, it has two
3922: problems: the display will be missed if many packages are
3923: intalled at once, and the person installing the package
3924: and the one using or configuring it may be different. It
3925: should therefore be used only in exceptional circumstances
3926: where lasting negative consequences would result from
3927: someone not reading it.</p>
3928: <p>MESSAGE should not be used for:</p>
3929: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3930: <li class="listitem"><p>exhortations to read the documentation</p></li>
3931: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
3932: <li class="listitem"><p>anything that should be explained in the
3933: installation/configuration documentation that should
3934: come with the package</p></li>
3935: </ul></div>
3936: <p>If the documentation provided by upstream needs
3937: enhancing, create e.g. files/README.pkgsrc and install it
3938: in the package's documentation directory.
3939: </p>
3940: <p>Note that MESSAGE is shown for all operating
3941: systems and all init systems. If a MESSAGE is necessary,
3942: it should be narrowed to only those operating systems and
3943: init systems to which it applies.</p>
3944: <p>Note that you can modify variables in it easily by using
1.184 rillig 3945: <code class="varname">MESSAGE_SUBST</code> in the package's
3946: <code class="filename">Makefile</code>:</p>
1.1 dsieger 3947: <pre class="programlisting">
1.184 rillig 3948: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3949: </pre>
1.184 rillig 3950: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
3951: <code class="filename">MESSAGE</code>. By default, substitution is
3952: performed for <code class="varname">PKGNAME</code>,
3953: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
3954: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3955: <code class="varname">PKG_SYSCONFDIR</code>,
3956: <code class="varname">ROOT_GROUP</code>, and
3957: <code class="varname">ROOT_USER</code>.</p>
3958: <p>You can display a different or additional files by
3959: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3960: default is <code class="filename">MESSAGE</code>, if the file
3961: exists.</p>
3962: </dd>
3963: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
3964: <dd>
3965: <p>This file is used by the alternatives framework.
3966: It creates, configures, and destroys generic wrappers used to
3967: run programs with similar interfaces.
3968: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3969: for more information.</p>
3970: <p>Each line of the file contains two filenames, first
3971: the wrapper and then the alternative provided by the package.
3972: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3973: </dd>
3974: </dl></div>
3975: </div>
3976: <div class="sect2">
3977: <div class="titlepage"><div><div><h3 class="title">
3978: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
3979: <div class="variablelist"><dl class="variablelist">
3980: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3981: <dd><p>This file contains arbitrary things that could
3982: also go into a <code class="filename">Makefile</code>, but its purpose is
3983: to be used by more than one package. This file should only be
3984: used when the packages that will use the file are known in
3985: advance. For other purposes it is often better to write a
3986: <code class="filename">*.mk</code> file and give it a good name that
3987: describes what it does.</p></dd>
3988: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3989: <dd><p>This file contains the dependency information
3990: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
3991: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3992: <dd><p>This file contains workarounds for compiler bugs
3993: and similar things. It is included automatically by the pkgsrc
3994: infrastructure, so you don't need an extra
3995: <code class="literal">.include</code> line for
3996: it.</p></dd>
3997: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3998: <dd><p>This file contains the code for the
3999: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
4000: selected by the user. If a package has only one or two options,
4001: it is equally acceptable to put the code directly into the
4002: <code class="filename">Makefile</code>.</p></dd>
4003: </dl></div>
4004: </div>
4005: <div class="sect2">
4006: <div class="titlepage"><div><div><h3 class="title">
4007: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
4008: <div class="variablelist"><dl class="variablelist">
4009: <dt><span class="term"><code class="filename">README*</code></span></dt>
4010: <dd><p>These files do not take place in the creation of
4011: a package and thus are purely informative to the package
4012: developer.</p></dd>
4013: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4014: <dd><p>This file contains things that need to be done
4015: to make the package even
4016: better.</p></dd>
4017: </dl></div>
4018: </div>
4019: </div>
4020: <div class="sect1">
4021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4022: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
4023: </h2></div></div></div>
4024: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4025: unpacked into the directory denoted by
4026: <code class="varname">WRKDIR</code>. It can be removed by running
4027: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4028: directory is also used to keep various timestamp files.
4029: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4030: The default is <code class="filename">${.CURDIR}/work</code>
4031: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4032: if <code class="varname">OBJMACHINE</code> is set.</p>
1.1 dsieger 4033: </div>
1.184 rillig 4034: <div class="sect1">
4035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4036: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
4037: </h2></div></div></div>
4038: <p>If you have any files that you wish to be placed in the package
4039: prior to configuration or building, you can place these files here
4040: and use a <span class="command"><strong>${CP}</strong></span> command in the
4041: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4042: <p>If you want to share files in this way with other
4043: packages, set the <code class="varname">FILESDIR</code> variable to point
4044: to the other package's <code class="filename">files</code> directory,
4045: e.g.:</p>
1.1 dsieger 4046: <pre class="programlisting">
1.184 rillig 4047: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 4048: </pre>
4049: </div>
4050: </div>
1.41 asau 4051: <div class="chapter">
1.1 dsieger 4052: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 4053: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.1 dsieger 4054: <div class="toc">
4055: <p><b>Table of Contents</b></p>
1.100 leot 4056: <dl class="toc">
1.184 rillig 4057: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4058: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4059: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4060: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4061: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4062: <dd><dl>
4063: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4064: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4065: </dl></dd>
4066: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4067: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4068: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4069: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4070: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4071: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4072: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4073: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4074: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4075: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4076: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4077: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.1 dsieger 4078: </dl>
4079: </div>
1.41 asau 4080: <div class="sect1">
1.1 dsieger 4081: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4082: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4083: <p>This chapter gives a detailed description on how a package is
4084: built. Building a package is separated into different
4085: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4086: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4087: described in the following sections. Each phase is split into
4088: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4089: containing phase, prefixed by one of <code class="varname">pre-</code>,
4090: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4091: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4092: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4093: <p>Never override the regular targets (like
4094: <code class="varname">fetch</code>), if you have to, override the
4095: <code class="varname">do-*</code> ones instead.</p>
4096: <p>The basic steps for building a program are always the same. First
4097: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4098: the local system and then extracted. After any pkgsrc-specific patches
4099: to compile properly are applied, the software can be configured, then
4100: built (usually by compiling), and finally the generated binaries, etc.
4101: can be put into place on the system.</p>
4102: <p>To get more details about what is happening at each step,
4103: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4104: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4105: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4106: </div>
4107: <div class="sect1">
4108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4109: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4110: <p>Before outlining the process performed by the NetBSD package system in
4111: the next section, here's a brief discussion on where programs are
4112: installed, and which variables influence this.</p>
4113: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4114: where all files of the final program shall be installed. It is
4115: usually set to <code class="varname">LOCALBASE</code>
4116: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4117: for pkgs in the <code class="filename">cross</code> category. The value of
4118: <code class="varname">PREFIX</code> needs to be put
4119: into the various places in the program's source where paths to
4120: 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>
4121: <p>When choosing which of these variables to use,
4122: follow the following rules:</p>
1.41 asau 4123: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 4124: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4125: where the current pkg will be installed. When referring to a
4126: pkg's own installation path, use
4127: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
1.223 nia 4128: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.184 rillig 4129: are installed. If you need to construct a -I or -L argument
4130: to the compiler to find includes and libraries installed by
1.223 nia 4131: another pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.184 rillig 4132: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4133: installed all packages in <code class="filename">/usr/local</code>. As
4134: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4135: administrator, this variable is a misnomer.</p></li>
4136: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4137: distribution (from xsrc, etc.) is installed. When looking for
4138: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4139: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4140: <li class="listitem"><p>X11-based packages using imake must set
4141: <code class="varname">USE_IMAKE</code> to be installed correctly under
4142: <code class="varname">LOCALBASE</code>.</p></li>
4143: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.207 leot 4144: 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.184 rillig 4145: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4146: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4147: </ul></div>
4148: </div>
4149: <div class="sect1">
4150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4151: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4152: <p>When building a package, various directories are used to store
4153: source files, temporary files, pkgsrc-internal files, and so on. These
4154: directories are explained here.</p>
4155: <p>Some of the directory variables contain relative pathnames. There
4156: are two common base directories for these relative directories:
4157: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4158: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4159: inside the package itself.</p>
4160: <div class="variablelist"><dl class="variablelist">
4161: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4162: <dd><p>This is an absolute pathname that points to the pkgsrc
4163: root directory. Generally, you don't need
4164: it.</p></dd>
4165: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4166: <dd><p>This is an absolute pathname that points to the
4167: current package.</p></dd>
4168: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.228 gutterid 4169: <dd>
4170: <p>This is a pathname relative to
4171: <code class="varname">PKGSRCDIR</code> that points to the current package.
4172: It is defined after including <code class="filename">bsd.prefs.mk</code>
4173: and can be used in makefile fragments that are used by several
4174: packages to distinguish between these packages. Other variables
4175: that would serve the same purpose are <code class="varname">PKGBASE</code>
4176: and <code class="varname">PKGNAME</code>, but these are only defined after
4177: including <code class="filename">bsd.pkg.mk</code>, which is too
4178: late.</p>
4179: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
4180: <code class="varname">PKGPATH</code> to tweak variables like
4181: <code class="varname">MAKE_JOBS</code> and
4182: <code class="varname">CFLAGS</code>.</p>
4183: </dd>
1.184 rillig 4184: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4185: <dd><p>This is an absolute pathname pointing to the directory
4186: where all work takes place. The distfiles are extracted to this
4187: directory. It also contains temporary directories and log files used by
4188: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4189: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4190: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4191: <dd><p>This is an absolute pathname pointing to the directory
4192: where the distfiles are extracted. It is usually a direct subdirectory
4193: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4194: that isn't hidden. This variable may be changed by a package
4195: <code class="filename">Makefile</code>.</p></dd>
4196: </dl></div>
4197: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4198: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4199: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4200: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4201: If users would like to have their pkgsrc trees behave in a
4202: read-only manner, then the value of
4203: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4204: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 4205: </div>
1.41 asau 4206: <div class="sect1">
1.1 dsieger 4207: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4208: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4209: <p>You can run a particular phase by typing <span class="command"><strong>make
1.228 gutterid 4210: <em class="replaceable"><code>phase</code></em></strong></span>, where
4211: <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
4212: automatically run all phases that are required for this phase. The
4213: default phase is <code class="varname">build</code>, that is, when you run
4214: <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.184 rillig 4215: the package will be built, but not installed.</p>
1.1 dsieger 4216: </div>
1.41 asau 4217: <div class="sect1">
1.1 dsieger 4218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4219: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4220: <p>The first step in building a package is to fetch the
4221: distribution files (distfiles) from the sites that are providing
4222: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4223: phase.</p>
1.41 asau 4224: <div class="sect2">
1.1 dsieger 4225: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 4226: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4227: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4228: defines all URLs from where the distfile, whose name is
4229: derived from the <code class="varname">DISTNAME</code> variable, is
4230: fetched. The more complicated cases are described
4231: below.</p>
4232: <p>The variable <code class="varname">DISTFILES</code> specifies
4233: the list of distfiles that have to be fetched. Its value
4234: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4235: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4236: so that most packages don't need to define it at all.
4237: <code class="varname">EXTRACT_SUFX</code> is
4238: <code class="literal">.tar.gz</code> by default, but can be changed
4239: freely. Note that if your package requires additional
4240: distfiles to the default one, you cannot just append the
4241: additional filenames using the <code class="literal">+=</code>
4242: operator, but you have write for example:</p>
4243: <pre class="programlisting">
4244: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4245: </pre>
4246: <p>Each distfile is fetched from a list of sites, usually
4247: <code class="varname">MASTER_SITES</code>. If the package has multiple
4248: <code class="varname">DISTFILES</code> or multiple
4249: <code class="varname">PATCHFILES</code> from different sites, you can
4250: set
4251: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4252: to the list of URLs where the file
4253: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4254: (including the suffix) can be found.</p>
4255: <pre class="programlisting">
4256: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4257: DISTFILES+= foo-file.tar.gz
4258: SITES.foo-file.tar.gz= \
4259: https://www.somewhere.com/somehow/ \
4260: https://www.somewhereelse.com/mirror/somehow/
4261: </pre>
4262: <p>When actually fetching the distfiles, each item from
4263: <code class="varname">MASTER_SITES</code> or
4264: <code class="varname">SITES.*</code> gets the name of each distfile
4265: appended to it, without an intermediate slash. Therefore,
4266: all site values have to end with a slash or other separator
4267: character. This allows for example to set
4268: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4269: that gets the name of the distfile as a parameter. In this
4270: case, the definition would look like:</p>
4271: <pre class="programlisting">
4272: MASTER_SITES= https://www.example.com/download.cgi?file=
4273: </pre>
4274: <p> The exception to this rule are URLs starting with a dash.
4275: In that case the URL is taken as is, fetched and the result
4276: stored under the name of the distfile. You can use this style
4277: for the case when the download URL style does not match the
4278: above common case. For example, if permanent download URL is a
4279: redirector to the real download URL, or the download file name
4280: is offered by an HTTP Content-Disposition header. In the
4281: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4282: created instead of the default
4283: <code class="filename">v1.0.0.tar.gz</code>.</p>
4284: <pre class="programlisting">
4285: DISTNAME= foo-1.0.0
4286: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4287: </pre>
4288: <p>There are some predefined values for
4289: <code class="varname">MASTER_SITES</code>, which can be used in
4290: packages. The names of the variables should speak for
4291: themselves.</p>
4292: <table border="0" summary="Simple list" class="simplelist">
4293: <tr>
4294: <td>MASTER_SITE_APACHE</td>
4295: <td>MASTER_SITE_BACKUP</td>
4296: </tr>
4297: <tr>
4298: <td>MASTER_SITE_CRATESIO</td>
4299: <td>MASTER_SITE_CYGWIN</td>
4300: </tr>
4301: <tr>
4302: <td>MASTER_SITE_DEBIAN</td>
4303: <td>MASTER_SITE_FREEBSD</td>
4304: </tr>
4305: <tr>
4306: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4307: <td>MASTER_SITE_GENTOO</td>
4308: </tr>
4309: <tr>
4310: <td>MASTER_SITE_GITHUB</td>
1.225 gutterid 4311: <td>MASTER_SITE_GITLAB</td>
4312: </tr>
4313: <tr>
1.184 rillig 4314: <td>MASTER_SITE_GNOME</td>
1.225 gutterid 4315: <td>MASTER_SITE_GNU</td>
1.184 rillig 4316: </tr>
4317: <tr>
4318: <td>MASTER_SITE_GNUSTEP</td>
1.225 gutterid 4319: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.184 rillig 4320: </tr>
4321: <tr>
4322: <td>MASTER_SITE_IFARCHIVE</td>
1.225 gutterid 4323: <td>MASTER_SITE_KDE</td>
1.184 rillig 4324: </tr>
4325: <tr>
4326: <td>MASTER_SITE_MOZILLA</td>
1.225 gutterid 4327: <td>MASTER_SITE_MOZILLA_ALL</td>
1.184 rillig 4328: </tr>
4329: <tr>
4330: <td>MASTER_SITE_MYSQL</td>
1.225 gutterid 4331: <td>MASTER_SITE_NETLIB</td>
1.184 rillig 4332: </tr>
4333: <tr>
4334: <td>MASTER_SITE_OPENBSD</td>
1.225 gutterid 4335: <td>MASTER_SITE_OPENOFFICE</td>
1.184 rillig 4336: </tr>
4337: <tr>
4338: <td>MASTER_SITE_OSDN</td>
1.225 gutterid 4339: <td>MASTER_SITE_PERL_CPAN</td>
1.184 rillig 4340: </tr>
4341: <tr>
4342: <td>MASTER_SITE_PGSQL</td>
1.225 gutterid 4343: <td>MASTER_SITE_PYPI</td>
1.184 rillig 4344: </tr>
4345: <tr>
4346: <td>MASTER_SITE_RUBYGEMS</td>
1.225 gutterid 4347: <td>MASTER_SITE_R_CRAN</td>
1.184 rillig 4348: </tr>
4349: <tr>
4350: <td>MASTER_SITE_SOURCEFORGE</td>
1.225 gutterid 4351: <td>MASTER_SITE_SUNSITE</td>
1.184 rillig 4352: </tr>
1.1 dsieger 4353: <tr>
1.184 rillig 4354: <td>MASTER_SITE_SUSE</td>
1.225 gutterid 4355: <td>MASTER_SITE_TEX_CTAN</td>
1.1 dsieger 4356: </tr>
4357: <tr>
1.184 rillig 4358: <td>MASTER_SITE_XCONTRIB</td>
1.225 gutterid 4359: <td>MASTER_SITE_XEMACS</td>
1.1 dsieger 4360: </tr>
4361: <tr>
1.184 rillig 4362: <td>MASTER_SITE_XORG</td>
1.225 gutterid 4363: <td> </td>
1.184 rillig 4364: </tr>
4365: </table>
4366: <p>Some explanations for the less self-explaining ones:
4367: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
4368: 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
4369: 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>
4370: <p>If you choose one of these predefined sites, you may
4371: want to specify a subdirectory of that site. Since these
4372: macros may expand to more than one actual site, you
4373: <span class="emphasis"><em>must</em></span> use the following construct to
4374: specify a subdirectory:</p>
1.1 dsieger 4375: <pre class="programlisting">
1.184 rillig 4376: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4377: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 4378: </pre>
1.184 rillig 4379: <p>Note the trailing slash after the subdirectory
4380: name.</p>
4381: </div>
4382: <div class="sect2">
4383: <div class="titlepage"><div><div><h3 class="title">
4384: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4385: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4386: all the distfiles exist in a local directory
4387: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4388: user). If the files do not exist, they are fetched using
4389: commands of the form</p>
1.1 dsieger 4390: <pre class="programlisting">
1.184 rillig 4391: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4392: </pre>
4393: <p>where <code class="literal">${site}</code> varies through
4394: several possibilities in turn: first,
4395: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4396: sites specified in either <code class="varname">SITES.file</code> if
4397: defined, else <code class="varname">MASTER_SITES</code> or
4398: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4399: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4400: all except the first and the last can be optionally sorted
4401: by the user, via setting either
4402: <code class="varname">MASTER_SORT_RANDOM</code>, and
4403: <code class="varname">MASTER_SORT_AWK</code> or
4404: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4405: <p> The specific command and arguments used depend on the
4406: <code class="varname">FETCH_USING</code> parameter. The example above is
4407: for <code class="literal">FETCH_USING=custom</code>.</p>
4408: <p>The distfiles mirror run by the NetBSD Foundation uses the
4409: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4410: distfiles, if they are freely distributable. Packages setting
4411: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4412: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4413: mirrored.</p>
1.1 dsieger 4414: </div>
4415: </div>
1.184 rillig 4416: <div class="sect1">
4417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4418: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4419: <p>After the distfile(s) are fetched, their checksum is
4420: generated and compared with the checksums stored in the
4421: distinfo file. If the checksums don't match, the build is
4422: aborted. This is to ensure the same distfile is used for
4423: building, and that the distfile wasn't changed, e.g. by some
4424: malign force, deliberately changed distfiles on the master
4425: distribution site or network lossage.</p>
1.1 dsieger 4426: </div>
1.41 asau 4427: <div class="sect1">
1.1 dsieger 4428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4429: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4430: <p>When the distfiles are present on the local system, they
4431: need to be extracted, as they usually come in the form of some
4432: compressed archive format.</p>
4433: <p>By default, all <code class="varname">DISTFILES</code> are
4434: extracted. If you only need some of them, you can set the
4435: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4436: files.</p>
4437: <p>Extracting the files is usually done by a little
4438: program, <code class="filename">mk/extract/extract</code>, which
4439: already knows how to extract various archive formats, so most
4440: likely you will not need to change anything here. But if you
4441: need, the following variables may help you:</p>
1.41 asau 4442: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4443: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4444: <dd><p>Use these variables to override the default
4445: options for an extract command, which are defined in
4446: <code class="filename">mk/extract/extract</code>.</p></dd>
4447: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4448: <dd><p>This variable can be set to
4449: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4450: (which is the default value), <code class="literal">pax</code>, or an
4451: absolute pathname pointing to the command with which tar
4452: archives should be extracted. It is preferred to choose bsdtar over gtar
4453: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 4454: </dl></div>
1.184 rillig 4455: <p>If the <code class="filename">extract</code> program doesn't
4456: serve your needs, you can also override the
4457: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4458: command used for extracting the files. This command is
4459: executed in the <code class="filename">${WRKSRC}</code>
4460: directory. During execution of this command, the shell
4461: variable <code class="varname">extract_file</code> holds the absolute
4462: pathname of the file that is going to be extracted.</p>
4463: <p>And if that still does not suffice, you can override the
4464: <code class="varname">do-extract</code> target in the package
4465: Makefile.</p>
1.1 dsieger 4466: </div>
1.41 asau 4467: <div class="sect1">
1.1 dsieger 4468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4469: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4470: <p>After extraction, all the patches named by the
4471: <code class="varname">PATCHFILES</code>, those present in the patches
4472: subdirectory of the package as well as in
4473: $LOCALPATCHES/$PKGPATH (e.g.
4474: <code class="filename">/usr/local/patches/graphics/png</code>) are
4475: applied. Patchfiles ending in <code class="filename">.Z</code> or
4476: <code class="filename">.gz</code> are uncompressed before they are
4477: applied, files ending in <code class="filename">.orig</code> or
4478: <code class="filename">.rej</code> are ignored. Any special options to
1.207 leot 4479: <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.184 rillig 4480: <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.207 leot 4481: <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.184 rillig 4482: fail if the expected text from the patch context is not found in the
4483: patched file. If that happens, fix the patch file by comparing it
4484: with the actual text in the file to be patched.</p>
1.1 dsieger 4485: </div>
1.41 asau 4486: <div class="sect1">
1.1 dsieger 4487: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4488: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4489: <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>.
4490: </p>
1.1 dsieger 4491: </div>
1.41 asau 4492: <div class="sect1">
1.1 dsieger 4493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4494: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4495: <p>This phase creates wrapper programs for the compilers and
4496: linkers. The following variables can be used to tweak the
4497: wrappers.</p>
4498: <div class="variablelist"><dl class="variablelist">
4499: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4500: <dd><p>The command used to print progress
4501: messages. Does nothing by default. Set to
4502: <code class="literal">${ECHO}</code> to see the progress
4503: messages.</p></dd>
4504: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4505: <dd><p>This variable can be set to
4506: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4507: depending on whether you want additional information in the
4508: wrapper log file.</p></dd>
4509: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4510: <dd><p>This variable can be set to
4511: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4512: on whether the wrapper should use its cache, which will
4513: improve the speed. The default value is
4514: <code class="literal">yes</code>, but is forced to
4515: <code class="literal">no</code> if the platform does not support
4516: it.</p></dd>
4517: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4518: <dd><p>A list of reordering commands. A reordering
4519: command has the form
4520: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4521: It ensures that that
4522: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4523: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4524: </p></dd>
4525: </dl></div>
4526: </div>
4527: <div class="sect1">
4528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4529: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4530: <p>Most pieces of software need information on the header
4531: files, system calls, and library routines which are available
4532: on the platform they run on. The process of determining this
4533: information is known as configuration, and is usually
4534: automated. In most cases, a script is supplied with the
4535: distfiles, and its invocation results in generation of header
4536: files, Makefiles, etc.</p>
4537: <p>If the package contains a configure script, this can be
4538: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4539: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4540: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.187 rillig 4541: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4542: <p>In the <code class="literal">do-configure</code> stage, a rough
4543: equivalent of the following command is run. See
4544: <code class="filename">mk/configure/configure.mk</code>, target
4545: <code class="literal">do-configure-script</code> for the exact
4546: definition.</p>
4547: <pre class="programlisting">
4548: .for dir in ${CONFIGURE_DIRS}
4549: cd ${WRKSRC} && cd ${dir} \
4550: && env ${CONFIGURE_ENV} \
4551: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 4552: .endfor
1.1 dsieger 4553: </pre>
1.184 rillig 4554: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4555: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4556: <code class="varname">WRKSRC</code>. In each of these directories, the
4557: configure script is run with the environment
4558: <code class="varname">CONFIGURE_ENV</code> and arguments
4559: <code class="varname">CONFIGURE_ARGS</code>. The variables
4560: <code class="varname">CONFIGURE_ENV</code>,
4561: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4562: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4563: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4564: package.</p>
4565: <p>If the program uses the Perl way of configuration (mainly Perl
4566: modules, but not only), i.e. a file called
4567: <code class="filename">Makefile.PL</code>, it should include
4568: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4569: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4570: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4571: <p>If the program uses an <code class="filename">Imakefile</code>
4572: for configuration, the appropriate steps can be invoked by
4573: setting <code class="varname">USE_IMAKE</code> to
4574: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4575: You can add variables to xmkmf's environment by adding them to the
4576: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4577: <p>If the program uses <code class="filename">cmake</code>
4578: for configuration, the appropriate steps can be invoked by
4579: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
4580: You can add variables to cmake's environment by adding them to the
4581: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
4582: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
4583: The top directory argument is given by the
4584: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
4585: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
4586: <p>If there is no configure step at all, set
4587: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4588: </div>
1.41 asau 4589: <div class="sect1">
1.1 dsieger 4590: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4591: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.187 rillig 4592: <p>For building a package, a rough equivalent of the following
4593: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4594: <code class="literal">do-build</code> for the exact definition.</p>
1.1 dsieger 4595: <pre class="programlisting">
1.187 rillig 4596: .for dir in ${BUILD_DIRS}
4597: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 4598: && env ${MAKE_ENV} \
1.187 rillig 4599: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 4600: -f ${MAKE_FILE} \
4601: ${BUILD_TARGET}
4602: .endfor
1.1 dsieger 4603: </pre>
1.184 rillig 4604: <p><code class="varname">BUILD_DIRS</code> (default:
4605: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4606: <code class="varname">WRKSRC</code>. In each of these directories,
4607: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4608: <code class="varname">MAKE_ENV</code> and arguments
4609: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4610: <code class="varname">MAKE_ENV</code>,
4611: <code class="varname">BUILD_MAKE_FLAGS</code>,
4612: <code class="varname">MAKE_FILE</code> and
4613: <code class="varname">BUILD_TARGET</code> may all be changed by the
4614: package.</p>
4615: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4616: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4617: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4618: default value of <code class="varname">MAKE_FILE</code> is
4619: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4620: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4621: <p>If there is no build step at all, set
4622: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4623: </div>
1.41 asau 4624: <div class="sect1">
1.1 dsieger 4625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4626: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4627: <p>[TODO]</p>
1.1 dsieger 4628: </div>
1.41 asau 4629: <div class="sect1">
1.1 dsieger 4630: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4631: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4632: <p>Once the build stage has completed, the final step is to
4633: install the software in public directories, so users can
4634: access the programs and files.</p>
1.187 rillig 4635: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4636: of the following code is executed; see
4637: <code class="filename">mk/install/install.mk</code>, target
4638: <code class="literal">do-install</code> for the exact definition. Additionally,
4639: before and after this code, several consistency checks are run
4640: against the files-to-be-installed, see
4641: <code class="filename">mk/check/*.mk</code> for details.</p>
4642: <pre class="programlisting">
4643: .for dir in ${INSTALL_DIRS}
4644: cd ${WRKSRC} && cd ${dir} \
4645: && env ${INSTALL_ENV} ${MAKE_ENV} \
4646: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4647: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 4648: .endfor
1.1 dsieger 4649: </pre>
1.184 rillig 4650: <p>The variable's meanings are analogous to the ones in the
4651: <span class="emphasis"><em>build</em></span> phase.
4652: <code class="varname">INSTALL_DIRS</code> defaults to
4653: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4654: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4655: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4656: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4657: defined.</p>
4658: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4659: variables are useful. They are all variations of the
1.207 leot 4660: <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.184 rillig 4661: permissions preset. <code class="varname">INSTALL</code> is the plain
4662: install command. The specialized variants, together with their
4663: intended use, are:</p>
4664: <div class="variablelist"><dl class="variablelist">
4665: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4666: <dd><p>directories that contain
4667: binaries</p></dd>
4668: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4669: <dd><p>directories that contain
4670: scripts</p></dd>
4671: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4672: <dd><p>directories that contain shared and static
4673: libraries</p></dd>
4674: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4675: <dd><p>directories that contain data
4676: files</p></dd>
4677: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4678: <dd><p>directories that contain man
4679: pages</p></dd>
4680: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4681: <dd><p>directories that contain data files for games
4682: </p></dd>
4683: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4684: <dd><p>binaries that can be stripped from debugging
4685: symbols</p></dd>
4686: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4687: <dd><p>binaries that cannot be
4688: stripped</p></dd>
4689: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4690: <dd><p>game
4691: binaries</p></dd>
4692: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4693: <dd><p>shared and static
4694: libraries</p></dd>
4695: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4696: <dd><p>data files</p></dd>
4697: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4698: <dd><p>data files for
4699: games</p></dd>
4700: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4701: <dd><p>man pages</p></dd>
4702: </dl></div>
4703: <p>Some other variables are:</p>
4704: <div class="variablelist"><dl class="variablelist">
4705: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.207 leot 4706: <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.184 rillig 4707: when installing binaries. Any debugging sections and symbols present in
4708: binaries will be preserved.
4709: </p></dd>
4710: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4711: <dd><p>A list of directories relative to
4712: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4713: beginning of the <span class="emphasis"><em>install</em></span> phase.
4714: The package is supposed to create all needed directories itself
4715: before installing files to it and list all other directories here.
4716: </p></dd>
4717: </dl></div>
4718: <p>In the rare cases that a package shouldn't install anything,
4719: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4720: mostly relevant for packages in the <code class="filename">regress</code>
4721: category.</p>
1.1 dsieger 4722: </div>
1.41 asau 4723: <div class="sect1">
1.1 dsieger 4724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4725: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4726: <p>Once the install stage has completed, a binary package of
4727: the installed files can be built. These binary packages can be
4728: used for quick installation without previous compilation, e.g. by
4729: the <span class="command"><strong>make bin-install</strong></span> or by using
4730: <span class="command"><strong>pkg_add</strong></span>.</p>
4731: <p>By default, the binary packages are created in
4732: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4733: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4734: one for each category in the <code class="varname">CATEGORIES</code>
4735: variable. <code class="varname">PACKAGES</code> defaults to
4736: <code class="filename">pkgsrc/packages</code>.</p>
1.1 dsieger 4737: </div>
1.41 asau 4738: <div class="sect1">
1.1 dsieger 4739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4740: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4741: <p>Once you're finished with a package, you can clean the work
4742: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4743: to clean the work directories of all dependencies too, use
4744: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 4745: </div>
1.41 asau 4746: <div class="sect1">
1.1 dsieger 4747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4748: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.41 asau 4749: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4750: <dt><span class="term">pre/post-*</span></dt>
4751: <dd>
4752: <p>For any of the main targets described in the previous
4753: section (configure, build, install, etc.), two auxiliary
4754: targets exist with
4755: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4756: prefix for the main target's name. These targets are
4757: invoked before and after the main target is called,
4758: allowing extra configuration or installation steps be
4759: performed from a package's Makefile, for example, which
4760: a program's configure script or install target
4761: omitted.</p>
4762: <p>About 5% of the pkgsrc packages define their custom
4763: post-extract target, another 5% define pre-configure, and 10%
4764: define post-install. The other pre/post-* targets are defined
4765: even less often.</p>
4766: </dd>
4767: <dt><span class="term">do-*</span></dt>
1.1 dsieger 4768: <dd>
1.184 rillig 4769: <p>Should one of the main targets do the wrong thing,
4770: and should there be no variable to fix this, you can
4771: redefine it with the do-* target. (Note that redefining
4772: the target itself instead of the do-* target is a bad
4773: idea, as the pre-* and post-* targets won't be called
4774: anymore, etc.)</p>
4775: <p>About 15% of the pkgsrc packages override the default
4776: do-install, the other do-* targets are overridden even less
4777: often.</p>
1.1 dsieger 4778: </dd>
1.184 rillig 4779: <dt><span class="term">reinstall</span></dt>
1.1 dsieger 4780: <dd>
1.184 rillig 4781: <p>If you did a <span class="command"><strong>make install</strong></span> and
4782: you noticed some file was not installed properly, you
4783: can repeat the installation with this target, which will
4784: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4785: <p>This is the default value of
4786: <code class="varname">DEPENDS_TARGET</code> except in the case of
4787: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4788: package</strong></span>, where the defaults are
4789: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4790: respectively.</p>
1.1 dsieger 4791: </dd>
1.184 rillig 4792: <dt><span class="term">deinstall</span></dt>
4793: <dd>
1.207 leot 4794: <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.184 rillig 4795: current directory, effectively de-installing the
4796: package. The following variables can be used to tune the
4797: behaviour:</p>
4798: <div class="variablelist"><dl class="variablelist">
4799: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.207 leot 4800: <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.184 rillig 4801: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4802: <dd><p>Remove all packages that require (depend on)
4803: the given package. This can be used to remove any
4804: packages that may have been pulled in by a given
4805: package, e.g. if <span class="command"><strong>make deinstall
4806: DEINSTALLDEPENDS=1</strong></span> is done in
4807: <code class="filename">pkgsrc/x11/kde</code>, this is
4808: likely to remove whole KDE. Works by adding
1.207 leot 4809: <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.184 rillig 4810: command line.</p></dd>
4811: </dl></div>
4812: </dd>
4813: <dt><span class="term">bin-install</span></dt>
4814: <dd><p>Install a binary package from local disk and via FTP
4815: from a list of sites (see the
4816: <code class="varname">BINPKG_SITES</code> variable), and do a
4817: <span class="command"><strong>make package</strong></span> if no binary package is
4818: available anywhere. The arguments given to
4819: <span class="command"><strong>pkg_add</strong></span> can be set via
4820: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4821: operation, etc.</p></dd>
4822: <dt><span class="term">install-clean</span></dt>
4823: <dd><p>This target removes the state files for the "install" and later
4824: phases so that the "install" target may be re-invoked. This can be
4825: used after editing the PLIST to install the package without
4826: rebuilding it.</p></dd>
4827: <dt><span class="term">build-clean</span></dt>
4828: <dd><p>This target removes the state files for the "build" and later
4829: phases so that the "build" target may be re-invoked.</p></dd>
4830: <dt><span class="term">update</span></dt>
4831: <dd>
4832: <p>This target causes the current package to be
4833: updated to the latest version. The package and all
4834: depending packages first get de-installed, then current
4835: versions of the corresponding packages get compiled and
4836: installed. This is similar to manually noting which
4837: packages are currently installed, then performing a
4838: series of <span class="command"><strong>make deinstall</strong></span> and
4839: <span class="command"><strong>make install</strong></span> (or whatever
4840: <code class="varname">UPDATE_TARGET</code> is set to) for these
4841: packages.</p>
4842: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4843: resume package updating in case a previous <span class="command"><strong>make
4844: update</strong></span> was interrupted for some reason.
4845: However, in this case, make sure you don't call
4846: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4847: list of dependent packages in <code class="varname">WRKDIR</code>.
4848: Otherwise, you lose the ability to automatically update
4849: the current package along with the dependent packages
4850: you have installed.</p>
4851: <p>Resuming an interrupted <span class="command"><strong>make
4852: update</strong></span> will only work as long as the package
4853: tree remains unchanged. If the source code for one of
4854: the packages to be updated has been changed, resuming
4855: <span class="command"><strong>make update</strong></span> will most certainly
4856: fail!</p>
4857: <p>The following variables can be used either on the
4858: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4859: alter the behaviour of <span class="command"><strong>make
4860: update</strong></span>:</p>
4861: <div class="variablelist"><dl class="variablelist">
4862: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4863: <dd><p>Install target to recursively use for the
4864: updated package and the dependent packages.
4865: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4866: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4867: <span class="command"><strong>make update</strong></span>. Other good
4868: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4869: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4870: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4871: endless loop!</p></dd>
4872: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4873: <dd><p>Don't clean up after updating. Useful if
4874: you want to leave the work sources of the updated
4875: packages around for inspection or other purposes.
4876: Be sure you eventually clean up the source tree
4877: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4878: or you may run into troubles with old source code
4879: still lying around on your next
4880: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4881: update</strong></span>.</p></dd>
4882: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4883: <dd><p>Deinstall each package before installing
4884: (making <code class="varname">DEPENDS_TARGET</code>). This
4885: may be necessary if the
4886: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4887: called after interrupting a running <span class="command"><strong>make
4888: update</strong></span>.</p></dd>
4889: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4890: <dd><p>Allows you to disable recursion and hardcode
4891: the target for packages. The default is
4892: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4893: facilitating a recursive update of prerequisite
4894: packages. Only set
4895: <code class="varname">DEPENDS_TARGET</code> if you want to
4896: disable recursive updates. Use
4897: <code class="varname">UPDATE_TARGET</code> instead to just
4898: set a specific target for each package to be
4899: installed during <span class="command"><strong>make update</strong></span>
4900: (see above).</p></dd>
4901: </dl></div>
4902: </dd>
4903: <dt><span class="term">clean-update</span></dt>
4904: <dd>
4905: <p>Clean the source tree for all packages that would
4906: get updated if <span class="command"><strong>make update</strong></span> was called
4907: from the current directory. This target should not be
4908: used if the current package (or any of its depending
4909: packages) have already been de-installed (e.g., after
4910: calling <span class="command"><strong>make update</strong></span>) or you may lose
4911: some packages you intended to update. As a rule of
4912: thumb: only use this target <span class="emphasis"><em>before</em></span>
4913: the first time you run <span class="command"><strong>make update</strong></span>
4914: and only if you have a dirty package tree (e.g., if you
4915: used <code class="varname">NOCLEAN</code>).</p>
4916: <p>If you are unsure about whether your tree is
4917: clean, you can either perform a <span class="command"><strong>make
4918: clean</strong></span> at the top of the tree, or use the
4919: following sequence of commands from the directory of the
4920: package you want to update (<span class="emphasis"><em>before</em></span>
4921: running <span class="command"><strong>make update</strong></span> for the first
4922: time, otherwise you lose all the packages you wanted to
4923: update!):</p>
4924: <pre class="screen">
4925: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
4926: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
4927: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
4928: </pre>
4929: <p>The following variables can be used either on the
4930: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
4931: <span class="command"><strong>make clean-update</strong></span>:</p>
4932: <div class="variablelist"><dl class="variablelist">
4933: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
4934: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
4935: reconstruct the list of directories to update for
4936: this package. Only use this if <span class="command"><strong>make
4937: update</strong></span> successfully installed all
4938: packages you wanted to update. Normally, this is
4939: done automatically on <span class="command"><strong>make
4940: update</strong></span>, but may have been suppressed by
4941: the <code class="varname">NOCLEAN</code> variable (see
4942: above).</p></dd>
4943: </dl></div>
4944: </dd>
4945: <dt><span class="term">replace</span></dt>
4946: <dd>
4947: <p>Update the installation of the current package. This
4948: differs from update in that it does not replace dependent
1.207 leot 4949: packages. You will need to install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.184 rillig 4950: target to work.</p>
4951: <p><span class="emphasis"><em>Be careful when using this
4952: target!</em></span> There are no guarantees that dependent
4953: packages will still work, in particular they will most
4954: certainly break if you <span class="command"><strong>make replace</strong></span> a
4955: library package whose shared library major version changed
4956: between your installed version and the new one. For this
4957: reason, this target is not officially supported and only
4958: recommended for advanced users.</p>
4959: </dd>
4960: <dt><span class="term">info</span></dt>
1.207 leot 4961: <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.184 rillig 4962: package. You can use this to check which version of a
4963: package is installed.</p></dd>
4964: <dt><span class="term">index</span></dt>
4965: <dd>
4966: <p>This is a top-level command, i.e. it should be used in
4967: the <code class="filename">pkgsrc</code> directory. It creates a
4968: database of all packages in the local pkgsrc tree, including
4969: dependencies, comment, maintainer, and some other useful
4970: information. Individual entries are created by running
4971: <span class="command"><strong>make describe</strong></span> in the packages'
4972: directories. This index file is saved as
4973: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
4974: verbose format by running <span class="command"><strong>make
4975: print-index</strong></span>. You can search in it with
4976: <span class="command"><strong>make search
4977: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
4978: extract a list of all packages that depend on a particular
4979: one by running <span class="command"><strong>make show-deps
4980: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
4981: <p>Running this command takes a very long time, some
4982: hours even on fast machines!</p>
4983: </dd>
4984: <dt><span class="term">readme</span></dt>
4985: <dd>
4986: <p>This target generates a
1.199 nia 4987: <code class="filename">index.html</code> file, which can be
1.207 leot 4988: viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/index.html" target="_top"><code class="filename">www/links</code></a>. The generated files
1.184 rillig 4989: contain references to any packages which are in the
4990: <code class="varname">PACKAGES</code> directory on the local
4991: host. The generated files can be made to refer to URLs
4992: based on <code class="varname">FTP_PKG_URL_HOST</code> and
4993: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.199 nia 4994: wanted to generate <code class="filename">index.html</code>
1.184 rillig 4995: files which pointed to binary packages on the local
4996: machine, in the directory
4997: <code class="filename">/usr/packages</code>, set
4998: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
4999: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
5000: <code class="varname">${PACKAGES}</code> directory and its
5001: subdirectories will be searched for all the binary
5002: packages.</p>
5003: <p>The target can be run at the toplevel or in category
5004: directories, in which case it descends recursively.</p>
5005: </dd>
5006: <dt><span class="term">readme-all</span></dt>
5007: <dd><p>This is a top-level command, run it in
5008: <code class="filename">pkgsrc</code>. Use this target to create a
5009: file <code class="filename">README-all.html</code> which contains a
5010: list of all packages currently available in the NetBSD
5011: Packages Collection, together with the category they belong
5012: to and a short description. This file is compiled from the
1.199 nia 5013: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.184 rillig 5014: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
5015: readme</strong></span>.</p></dd>
5016: <dt><span class="term">cdrom-readme</span></dt>
5017: <dd><p>This is very much the same as the
5018: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
5019: used when generating a pkgsrc tree to be written to a
5020: CD-ROM. This target also produces
1.199 nia 5021: <code class="filename">index.html</code> files, and can be made
1.184 rillig 5022: to refer to URLs based on
5023: <code class="varname">CDROM_PKG_URL_HOST</code> and
5024: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
5025: <dt><span class="term">show-distfiles</span></dt>
5026: <dd><p>This target shows which distfiles and patchfiles
5027: are needed to build the package
5028: (<code class="varname">ALLFILES</code>, which contains all
5029: <code class="varname">DISTFILES</code> and
5030: <code class="varname">PATCHFILES</code>, but not
5031: <code class="filename">patches/*</code>).</p></dd>
5032: <dt><span class="term">show-downlevel</span></dt>
5033: <dd><p>This target shows nothing if the package is not
5034: installed. If a version of this package is installed,
5035: but is not the version provided in this version of
5036: pkgsrc, then a warning message is displayed. This target
5037: can be used to show which of your installed packages are
5038: downlevel, and so the old versions can be deleted, and
5039: the current ones added.</p></dd>
5040: <dt><span class="term">show-pkgsrc-dir</span></dt>
5041: <dd><p>This target shows the directory in the pkgsrc
5042: hierarchy from which the package can be built and
5043: installed. This may not be the same directory as the one
5044: from which the package was installed. This target is
5045: intended to be used by people who may wish to upgrade
5046: many packages on a single host, and can be invoked from
5047: the top-level pkgsrc Makefile by using the
5048: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
5049: <dt><span class="term">show-installed-depends</span></dt>
5050: <dd><p>This target shows which installed packages match
5051: the current package's <code class="varname">DEPENDS</code>. Useful
5052: if out of date dependencies are causing build
5053: problems.</p></dd>
5054: <dt><span class="term">print-build-depends-list</span></dt>
5055: <dd><p>This target shows the list of packages that the current package
5056: depends on for building.</p></dd>
5057: <dt><span class="term">print-run-depends-list</span></dt>
5058: <dd><p>This target shows the list of packages that the current package
5059: depends on for running.</p></dd>
5060: <dt><span class="term">check-shlibs</span></dt>
5061: <dd><p>After a package is installed, check all its
5062: binaries and (on ELF platforms) shared libraries to see
5063: if they find the shared libs they need. Run by default
5064: 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>
5065: <dt><span class="term">print-PLIST</span></dt>
5066: <dd>
5067: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5068: upgraded pkg, this prints out an attempt to generate a
5069: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5070: -newer work/.extract_done</strong></span>. An attempt is made
5071: to care for shared libs etc., but it is
5072: <span class="emphasis"><em>strongly</em></span> recommended to review the
5073: result before putting it into
5074: <code class="filename">PLIST</code>. On upgrades, it's useful to
5075: diff the output of this command against an already
5076: existing <code class="filename">PLIST</code> file.</p>
1.207 leot 5077: <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.184 rillig 5078: other methods that don't update file access times, be
5079: sure to add these files manually to your
5080: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5081: -newer</span>”</span> command used by this target won't catch
5082: them!</p>
5083: <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
5084: information on this target.</p>
5085: </dd>
5086: </dl></div>
5087: </div>
5088: </div>
5089: <div class="chapter">
5090: <div class="titlepage"><div><div><h2 class="title">
5091: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5092: <div class="toc">
5093: <p><b>Table of Contents</b></p>
5094: <dl class="toc">
5095: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5096: <dd><dl>
1.219 nia 5097: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
5098: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
5099: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.184 rillig 5100: </dl></dd>
5101: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5102: <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>
5103: </dl>
5104: </div>
5105: <p>When you find a package that is not yet in pkgsrc, you
5106: most likely have a URL from where you can download the source
5107: code. Starting with this URL, creating a package involves only a
5108: few steps.</p>
5109: <div class="procedure"><ol class="procedure" type="1">
5110: <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
5111: enable the basic quality checks.</p></li>
5112: <li class="step">
1.207 leot 5113: <p>Install the package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkg_developer/index.html" target="_top"><code class="filename">meta-pkgs/pkg_developer</code></a>, which among others will
1.184 rillig 5114: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5115: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5116: <span class="command"><strong>mkpatches</strong></span>:</p>
5117: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5118: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5119: </li>
5120: <li class="step">
5121: <p>Choose one of the top-level directories as the category in
5122: which you want to place your package. You can also create a directory of
1.219 nia 5123: your own (maybe called <code class="filename">local</code>). Change into that
5124: category directory:</p>
5125: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em></code></strong></pre>
1.184 rillig 5126: </li>
5127: <li class="step">
1.219 nia 5128: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
5129: argument the URL of the distribution file (in most cases a
5130: <code class="filename">.tar.gz</code> file). This will download the distribution
5131: file and create the necessary files of the package, based on what's in
5132: the distribution file:</p>
1.184 rillig 5133: <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>
5134: </li>
5135: <li class="step">
5136: <p>Examine the extracted files to determine the dependencies of
5137: your package. Ideally, this is mentioned in some
5138: <code class="filename">README</code> file, but things may differ. For each of
5139: these dependencies, look where it exists in pkgsrc, and if there is a
5140: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5141: line to your package <code class="filename">Makefile</code> which includes that
5142: file just before the last line. If the
5143: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5144: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5145: that the package's include files and libraries are provided.</p>
1.219 nia 5146: <p>If you just need binaries from a dependent package, add a
1.184 rillig 5147: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5148: version of the dependency and where it can be found in pkgsrc. This line
5149: should be placed in the third paragraph. If the dependency is only
5150: needed for building the package, but not when using it, use
5151: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5152: instead of <code class="varname">DEPENDS</code>.
5153: The difference between <code class="varname">TOOL_DEPENDS</code> and
5154: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5155: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.219 nia 5156: packages, i.e. packages for the platform where the package is built;
1.184 rillig 5157: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.219 nia 5158: packages, i.e. packages for the platform for which the package
5159: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
5160: specifies a dependency used only for testing the resulting package
5161: built, using the upstream project's included test suite, on the native
5162: platform.
1.184 rillig 5163: Your package may then look like this:</p>
5164: <pre class="programlisting">
5165: [...]
5166:
5167: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5168: DEPENDS+= screen-[0-9]*:../../misc/screen
5169: DEPENDS+= screen>=4.0:../../misc/screen
5170:
5171: [...]
5172:
5173: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5174: .include "../../devel/glib2/buildlink3.mk"
5175: .include "../../mk/bsd.pkg.mk"
5176: </pre>
5177: </li>
5178: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5179: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5180: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5181: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5182: additional explanations.</p></li>
5183: <li class="step"><p>In many cases the package is not yet ready to build. You can
5184: 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
5185: over there, you can hopefully continue here.</p></li>
5186: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5187: directory from the extracted files. Besides these files, a lot of cache
1.219 nia 5188: files and other system information have been saved in the working
5189: directory, which may have become outdated after you edited the
1.184 rillig 5190: <code class="filename">Makefile</code>.</p></li>
5191: <li class="step">
5192: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5193: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p>
1.219 nia 5194: <p>If the extracted files from the package need to be fixed, run
5195: multiple rounds of these commands:</p>
5196: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.184 rillig 5197: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5198: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.219 nia 5199: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
5200: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.184 rillig 5201: </li>
5202: <li class="step"><p>When the package builds fine, the next step is to install
5203: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5204: everything works.</p></li>
5205: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5206: contains a list of the files that are installed by the package, is
5207: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5208: >PLIST</strong></span> to generate a probably correct list. Check
5209: the file using your preferred text editor to see if the list of
5210: files looks plausible.</p></li>
5211: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5212: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5213: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5214: had been registered in the database of installed files, but with an
5215: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5216: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5217: registered with the list of files from
5218: <code class="filename">PLIST</code>.</p></li>
5219: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5220: from above again in a single step, making sure that the PLIST is correct
5221: and the whole package is created as intended.</p></li>
1.219 nia 5222: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
5223: left to do.</p></li>
1.184 rillig 5224: <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>
5225: </ol></div>
5226: <div class="sect1">
5227: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5228: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5229: <div class="sect2">
5230: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5231: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.184 rillig 5232: <p>Python modules and programs packages are easily created using a
5233: set of predefined variables.</p>
5234: <p>
5235: If some Python versions are not supported by the software, set the
5236: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5237: that are not supported, e.g.
5238: </p>
5239: <pre class="programlisting">
5240: PYTHON_VERSIONS_INCOMPATIBLE= 27
5241: </pre>
5242: <p>
5243: If the packaged software is a Python module, include one of
1.215 wiz 5244: <code class="filename">../../lang/python/egg.mk</code> or
1.184 rillig 5245: <code class="filename">../../lang/python/extension.mk</code>.</p>
1.215 wiz 5246: <p>Most Python packages use setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
1.184 rillig 5247: If the packaged software is using setuptools, you only need
5248: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
1.215 wiz 5249: </p>
1.184 rillig 5250: <p>Either way, the package directory should be called
5251: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5252: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5253: </p>
5254: <pre class="programlisting">
5255: DISTNAME= foopymodule-1.2.10
5256: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5257: </pre>
1.226 gutterid 5258: <p>
5259: For software in PyPi, the name should match what PyPi specifies for
5260: "pip install software".
5261: </p>
1.184 rillig 5262: <p>If it is an application, include
5263: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5264: In order to correctly set the path to the Python interpreter, use the
5265: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5266: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5267: For example:
5268: </p>
5269: <pre class="programlisting">
5270: REPLACE_PYTHON= *.py
5271: </pre>
5272: <p>Some Python modules have separate distributions for Python-2.x
5273: and Python-3.x support. In pkgsrc this is handled by the
5274: <code class="filename">versioned_dependencies.mk</code> file. Set
5275: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
5276: packages that should be depended upon and include
5277: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
5278: then the pkgsrc infrastructure will depend on the appropriate package
5279: version. For example:
5280: </p>
5281: <pre class="programlisting">
5282: PYTHON_VERSIONED_DEPENDENCIES=dialog
5283: </pre>
5284: <p>
5285: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
5286: of supported packages.</p>
5287: </div>
5288: <div class="sect2">
5289: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5290: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.184 rillig 5291: <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>
5292: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.207 leot 5293: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/index.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
1.184 rillig 5294: Individual packages (and optionally their dependencies) may be created
5295: and updated. R packages generally follow the same form, and most of
5296: the relevant information needed is contained in a
5297: <code class="filename">DESCRIPTION</code> file as part of each R package on
5298: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5299: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5300: creates or updates a package in the canonical form. The resulting
5301: package should be reviewed for correctness.</p>
5302: </div>
5303: <div class="sect2">
5304: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5305: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.184 rillig 5306: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.207 leot 5307: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/index.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
1.184 rillig 5308: <p>If the TeXlive package name is not known, it may be useful to
5309: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5310: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5311: 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
5312: archive</a>.</p>
5313: <p>If the TeXlive package name is known, download the files from
5314: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5315: archive</a>. For package <code class="filename">foo</code>, you will need
5316: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5317: also have associated documentation packages, so download
5318: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5319: should be placed in the appropriate category directory, which is often
5320: but not always <code class="filename">print</code>. Then run the following
5321: command in the category directory.</p>
5322: <pre class="programlisting">
5323: texlive2pkg foo.tar.xz foo.doc.tar.xz
5324: </pre>
5325: <p>This will create two packages, <code class="filename">tex-foo</code> and
5326: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5327: are correct.</p>
5328: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5329: currently does not include version information in package filenames
5330: and changes their contents periodically when updates occur.
5331: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5332: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5333: main one and the corresponding documentation, upload the distfiles
5334: with the following command in each package directory.</p>
5335: <pre class="programlisting">
5336: make upload-distfiles
5337: </pre>
5338: </div>
5339: </div>
5340: <div class="sect1">
5341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5342: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5343: <div class="sect2">
5344: <div class="titlepage"><div><div><h3 class="title">
5345: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5346: <div class="sect3">
5347: <div class="titlepage"><div><div><h4 class="title">
5348: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5349: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5350: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5351: pkgsrc. As the description says it has to do with the web, the obvious
5352: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5353: <pre class="programlisting">
5354: <code class="prompt">$</code> mkdir www/nvu
5355: <code class="prompt">$</code> cd www/nvu
5356: </pre>
5357: <p>The web site says that the sources are available as a tar file, so
5358: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5359: <pre class="programlisting">
5360: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5361: </pre>
5362: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5363: below the <code class="varname">DISTNAME</code> line, as the package name should
5364: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5365: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5366: <code class="varname">COMMENT</code> fields. Then the package
5367: <code class="filename">Makefile</code> looked like that:</p>
5368: <pre class="programlisting">
5369: # $NetBSD $
5370: #
5371:
5372: DISTNAME= nvu-1.0-sources
5373: PKGNAME= nvu-1.0
5374: CATEGORIES= www
5375: MASTER_SITES= http://cvs.nvu.com/download/
5376: EXTRACT_SUFX= .tar.bz2
5377:
5378: MAINTAINER= rillig@NetBSD.org
5379: HOMEPAGE= http://cvs.nvu.com/
5380: COMMENT= Web Authoring System
5381:
5382: # url2pkg-marker (please do not remove this line.)
5383: .include "../../mk/bsd.pkg.mk"
5384: </pre>
5385: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5386: this is a workaround to prevent CVS expanding to the filename of the
5387: guide.</p>
5388: <p>Then, I quit the editor and watched pkgsrc downloading a large
5389: source archive:</p>
5390: <pre class="programlisting">
5391: url2pkg> Running "make makesum" ...
5392: => Required installed package digest>=20010302: digest-20060826 found
5393: => Fetching nvu-1.0-sources.tar.bz2
5394: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5395: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5396: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5397: url2pkg> Running "make extract" ...
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: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5402: ===> Installing dependencies for nvu-1.0
5403: ===> Overriding tools for nvu-1.0
5404: ===> Extracting for nvu-1.0
5405: url2pkg> Adjusting the Makefile.
5406:
5407: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5408:
5409: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5410: </pre>
5411: </div>
5412: <div class="sect3">
5413: <div class="titlepage"><div><div><h4 class="title">
5414: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5415: <p>Now that the package has been extracted, let's see what's inside
5416: it. The package has a <code class="filename">README.txt</code>, but that only
5417: says something about mozilla, so it's probably useless for seeing what
5418: dependencies this package has. But since there is a GNU configure script
5419: in the package, let's hope that it will complain about everything it
5420: needs.</p>
5421: <pre class="programlisting">
5422: <code class="prompt">$</code> bmake
5423: => Required installed package digest>=20010302: digest-20060826 found
5424: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5425: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5426: ===> Patching for nvu-1.0
5427: ===> Creating toolchain wrappers for nvu-1.0
5428: ===> Configuring for nvu-1.0
5429: [...]
5430: configure: error: Perl 5.004 or higher is required.
5431: [...]
5432: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5433: [...]
5434: </pre>
5435: <p>That worked quite well. So I opened the package Makefile in my
5436: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5437: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5438: package have changed now, and since a perl wrapper is automatically
5439: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5440: from scratch.</p>
5441: <pre class="programlisting">
5442: <code class="prompt">$</code> bmake clean
5443: ===> Cleaning for nvu-1.0
5444: <code class="prompt">$</code> bmake
5445: [...]
5446: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5447: GNU Make. You will not be able to build Mozilla without GNU Make.
5448: [...]
5449: </pre>
5450: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5451: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5452: <pre class="programlisting">
5453: [...]
5454: checking for GTK - version >= 1.2.0... no
5455: *** Could not run GTK test program, checking why...
5456: [...]
5457: </pre>
5458: <p>Now to the other dependencies. The first question is: Where is the
5459: GTK package hidden in pkgsrc?</p>
5460: <pre class="programlisting">
5461: <code class="prompt">$</code> echo ../../*/gtk*
5462: [many packages ...]
5463: <code class="prompt">$</code> echo ../../*/gtk
5464: ../../x11/gtk
5465: <code class="prompt">$</code> echo ../../*/gtk2
5466: ../../x11/gtk2
5467: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5468: ../../x11/gtk2/buildlink3.mk
5469: </pre>
5470: <p>The first try was definitely too broad. The second one had exactly
5471: one result, which is very good. But there is one pitfall with GNOME
5472: packages. Before GNOME 2 had been released, there were already many
5473: GNOME 1 packages in pkgsrc. To be able to continue to use these
5474: packages, the GNOME 2 packages were imported as separate packages, and
5475: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5476: whether this was the case here, and indeed it was.</p>
5477: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5478: file, adding the dependency is very easy. I just inserted an
5479: <code class="literal">.include</code> line before the last line of the package
5480: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5481: <pre class="programlisting">
5482: [...]
5483: .include "../../x11/gtk2/buildlink3.mk"
5484: .include "../../mk/bsd.pkg.mk
5485: </pre>
5486: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5487: was:</p>
1.1 dsieger 5488: <pre class="programlisting">
1.184 rillig 5489: [...]
5490: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5491: checking for GTK - version >= 1.2.0... no
5492: *** Could not run GTK test program, checking why...
5493: *** The test program failed to compile or link. See the file config.log for the
5494: *** exact error that occured. This usually means GTK was incorrectly installed
5495: *** or that you have moved GTK since it was installed. In the latter case, you
5496: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5497: configure: error: Test for GTK failed.
5498: [...]
1.111 sevan 5499: </pre>
1.184 rillig 5500: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5501: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5502: told me that this package really wanted to have the GNOME 1 version of
5503: GTK. If the package had looked for GTK2, it would have looked for
5504: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5505: So I changed the <code class="literal">x11/gtk2</code> to
5506: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5507: and tried again.</p>
1.18 snj 5508: <pre class="programlisting">
1.184 rillig 5509: [...]
5510: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5511: In file included from xpidl.c:42:
5512: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5513: In file included from xpidl.c:42:
5514: xpidl.h:132: error: parse error before "IDL_ns"
5515: [...]
1.111 sevan 5516: </pre>
1.184 rillig 5517: <p>The package still does not find all of its dependencies. Now the
5518: question is: Which package provides the
5519: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.18 snj 5520: <pre class="programlisting">
1.184 rillig 5521: <code class="prompt">$</code> echo ../../*/*idl*
5522: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5523: <code class="prompt">$</code> echo ../../*/*IDL*
5524: ../../net/libIDL
1.111 sevan 5525: </pre>
1.184 rillig 5526: <p>Let's take the one from the second try. So I included the
5527: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5528: again. But the error didn't change. After digging through some of the
5529: code, I concluded that the build process of the package was broken and
5530: couldn't have ever worked, but since the Mozilla source tree is quite
5531: large, I didn't want to fix it. So I added the following to the package
5532: <code class="filename">Makefile</code> and tried again:</p>
1.86 wiz 5533: <pre class="programlisting">
1.184 rillig 5534: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5535: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.111 sevan 5536: </pre>
1.184 rillig 5537: <p>The latter line is needed because the package expects the library
5538: <code class="filename">libIDL.so</code>, but only
5539: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5540: wrapper to rewrite that on the fly.</p>
5541: <p>The next problem was related to a recent change of the FreeType
1.207 leot 5542: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/index.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.184 rillig 5543: which patch files were relevant for this issue and copied them to the
5544: <code class="filename">patches</code> directory. Then I retried, fixed the
5545: patches so that they applied cleanly and retried again. This time,
5546: everything worked.</p>
1.86 wiz 5547: </div>
1.184 rillig 5548: <div class="sect3">
5549: <div class="titlepage"><div><div><h4 class="title">
5550: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 5551: <pre class="programlisting">
1.184 rillig 5552: <code class="prompt">$</code> bmake CHECK_FILES=no install
5553: [...]
5554: <code class="prompt">$</code> bmake print-PLIST >PLIST
5555: <code class="prompt">$</code> bmake deinstall
5556: <code class="prompt">$</code> bmake install
1.111 sevan 5557: </pre>
1.184 rillig 5558: </div>
5559: </div>
1.1 dsieger 5560: </div>
5561: </div>
1.41 asau 5562: <div class="chapter">
1.1 dsieger 5563: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 5564: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 5565: <div class="toc">
5566: <p><b>Table of Contents</b></p>
1.100 leot 5567: <dl class="toc">
1.184 rillig 5568: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5569: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5570: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5571: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5572: <dd><dl>
5573: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5574: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5575: <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>
5576: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 ! gutterid 5577: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.1 dsieger 5578: </dl></dd>
5579: </dl>
5580: </div>
1.184 rillig 5581: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5582: each of which forms a well-defined part of the pkgsrc system. Using
1.207 leot 5583: 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.184 rillig 5584: like pkgsrc requires some discipline to keep the code correct and
5585: understandable.</p>
5586: <p>The basic ingredients for <code class="filename">Makefile</code>
5587: programming are variables and shell
5588: commands. Among these shell commands may even be more complex ones
1.207 leot 5589: 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.184 rillig 5590: as intended it is necessary to quote all variables correctly when they
5591: are used.</p>
5592: <p>This chapter describes some patterns that appear quite often in
5593: <code class="filename">Makefile</code>s, including the pitfalls that come along
5594: with them.</p>
1.41 asau 5595: <div class="sect1">
1.1 dsieger 5596: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5597: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5598: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5599: <p>When you are creating a file as a
5600: target of a rule, always write the data to a temporary file first
5601: and finally rename that file. Otherwise there might occur an error
5602: in the middle of generating the file, and when the user runs
1.207 leot 5603: <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.184 rillig 5604: regenerated properly. Example:</p>
1.1 dsieger 5605: <pre class="programlisting">
1.184 rillig 5606: wrong:
5607: @echo "line 1" > ${.TARGET}
5608: @echo "line 2" >> ${.TARGET}
5609: @false
5610:
5611: correct:
5612: @echo "line 1" > ${.TARGET}.tmp
5613: @echo "line 2" >> ${.TARGET}.tmp
5614: @false
5615: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 5616: </pre>
1.184 rillig 5617: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5618: <code class="filename">wrong</code> will exist, although there was an error
5619: message in the first run. On the other hand, running <span class="command"><strong>make
5620: correct</strong></span> gives an error message twice, as expected.</p>
1.207 leot 5621: <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.184 rillig 5622: <code class="literal">${.TARGET}</code> in case of error, but this only
5623: happens when it is interrupted, for example by pressing
5624: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.207 leot 5625: 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.184 rillig 5626: </li></ul></div>
5627: </div>
5628: <div class="sect1">
5629: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5630: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5631: <p><code class="filename">Makefile</code> variables contain strings that
5632: can be processed using the five operators <code class="code">=</code>,
5633: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.207 leot 5634: <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.184 rillig 5635: page.</p>
5636: <p>When a variable's value is parsed from a
5637: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5638: the backslash character <code class="code">\</code> are handled specially. If a
5639: backslash is the last character in a line, that backslash is removed
5640: from the line and the line continues with the next line of the file.</p>
5641: <p>The <code class="code">#</code> character starts a comment that reaches
5642: until the end of the line. To get an actual <code class="code">#</code> character,
5643: such as in a URL, write <code class="code">\#</code> instead.</p>
5644: <p>The evaluation of variables either happens immediately or lazy.
5645: It happens immediately when the variable occurs on the right-hand
5646: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5647: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5648: In the other cases, it is evaluated lazily.</p>
5649: <p>Some of the modifiers split the string into words and then
5650: operate on the words, others operate on the string as a whole. When a
5651: string is split into words, double quotes and single quotes are
1.207 leot 5652: 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.184 rillig 5653: <div class="sect2">
5654: <div class="titlepage"><div><div><h3 class="title">
5655: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5656: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5657: <li class="listitem"><p>All variable names starting with an underscore
5658: are reserved for use by the pkgsrc infrastructure. They shall
5659: not be used by packages.</p></li>
5660: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5661: lowercase variable names for the iteration
5662: variables.</p></li>
5663: <li class="listitem"><p>All list variables should have a plural name,
5664: such as <code class="varname">PKG_OPTIONS</code> or
5665: <code class="varname">DISTFILES</code>.</p></li>
5666: </ul></div>
5667: </div>
5668: </div>
5669: <div class="sect1">
5670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5671: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5672: <div class="sect2">
5673: <div class="titlepage"><div><div><h3 class="title">
5674: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5675: <p>When adding a string that possibly contains whitespace or quotes to
5676: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5677: modifier.</p>
5678: <p>When adding another list to a list (example 2), it must not be
5679: quoted, since its elements are already quoted.</p>
1.1 dsieger 5680: <pre class="programlisting">
1.184 rillig 5681: STRING= foo * bar `date`
5682: LIST= # empty
5683: ANOTHER_LIST= a=b c=d
5684:
5685: LIST+= ${STRING:Q} # 1
5686: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 5687: </pre>
1.184 rillig 5688: </div>
5689: <div class="sect2">
5690: <div class="titlepage"><div><div><h3 class="title">
5691: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5692: <p>Echoing a string containing special characters needs special
5693: work.</p>
1.1 dsieger 5694: <pre class="programlisting">
1.184 rillig 5695: STRING= foo bar < > * `date` $$HOME ' "
5696: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5697:
5698: all:
5699: echo ${STRING} # 1
5700: echo ${STRING:Q} # 2
5701: printf '%s\n' ${STRING:Q}'' # 3
5702: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 5703: </pre>
1.184 rillig 5704: <p>Example 1 leads to a syntax error in the shell, as the characters
5705: are just copied.</p>
5706: <p>Example 2 quotes the string so that the shell interprets it
5707: correctly. But the echo command may additionally interpret strings with a
5708: leading dash or those containing backslashes.</p>
1.207 leot 5709: <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.184 rillig 5710: interprets the format string, but not the next argument. The trailing
5711: single quotes handle the case when the string is empty. In that case, the
5712: :Q modifier would result in an empty string too, which would then be
1.207 leot 5713: 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.184 rillig 5714: but other programs may care.</p>
5715: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5716: need to be quoted because the quoting has already been done
5717: when adding elements to the list.</p>
1.1 dsieger 5718: </div>
1.41 asau 5719: <div class="sect2">
1.1 dsieger 5720: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 5721: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5722: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5723: GNU-style configure script (especially those that call other configure
5724: scripts), it must not have leading or trailing whitespace, since
5725: otherwise the configure script gets confused. To trim leading and
5726: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5727: following example:</p>
1.1 dsieger 5728: <pre class="programlisting">
1.184 rillig 5729: CPPFLAGS= # empty
5730: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5731: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 5732:
1.184 rillig 5733: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 5734:
1.184 rillig 5735: all:
5736: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5737: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5738: </pre>
5739: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5740: trailing whitespace because the <code class="code">+=</code> operator always adds a
5741: space.</p>
5742: </div>
5743: <div class="sect2">
5744: <div class="titlepage"><div><div><h3 class="title">
5745: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5746: <p>When a possibly empty variable is used in a shell program, it may
5747: lead to a syntax error.</p>
5748: <pre class="programlisting">
5749: EGFILES= # empty
1.1 dsieger 5750:
1.184 rillig 5751: install-examples: # produces a syntax error in the shell
5752: for egfile in ${EGFILES}; do \
5753: echo "Installing $$egfile"; \
5754: done
5755: </pre>
5756: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.207 leot 5757: <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.184 rillig 5758: To fix this syntax error, use one of the snippets below.</p>
5759: <pre class="programlisting">
1.229 ! gutterid 5760: EGFILES= # empty
1.1 dsieger 5761:
1.184 rillig 5762: install-examples:
5763: for egfile in ${EGFILES} ""; do \
5764: [ -n "$$egfile" ] || continue; \
5765: echo "Installing $$egfile"; \
5766: done
5767: </pre>
5768: <p>In this case, an empty string is appended to the iteration list (to
5769: prevent the syntax error) and filtered out later.</p>
5770: <pre class="programlisting">
5771: EGFILES= # empty
1.1 dsieger 5772:
1.184 rillig 5773: install-examples:
5774: .for egfile in ${EGFILES}
5775: echo "Installing ${egfile}"
5776: .endfor
1.1 dsieger 5777: </pre>
1.184 rillig 5778: <p>If one of the filenames contains special characters, it should be
5779: enclosed in single or double quotes.</p>
5780: <p>To have a shell command test whether a make variable is empty, use
5781: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5782: </div>
1.229 ! gutterid 5783: <div class="sect2">
! 5784: <div class="titlepage"><div><div><h3 class="title">
! 5785: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
! 5786: <p>When a variable can have the values <code class="literal">yes</code> or
! 5787: <code class="literal">no</code>, use the following pattern to test the variable:</p>
! 5788: <pre class="programlisting">
! 5789: .if ${VAR:U:tl} == "yes"
! 5790: # do something
! 5791: .endif
! 5792: </pre>
! 5793: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
! 5794: can be undefined. If the variable is guaranteed to be defined, the
! 5795: <code class="literal">:U</code> can be omitted.</p>
! 5796: <p>The <code class="literal">:tl</code> modifier converts the variable value to
! 5797: lowercase, allowing for the values <code class="literal">yes</code>,
! 5798: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
! 5799: </div>
1.184 rillig 5800: </div>
5801: </div>
5802: <div class="chapter">
5803: <div class="titlepage"><div><div><h2 class="title">
5804: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5805: <div class="toc">
5806: <p><b>Table of Contents</b></p>
5807: <dl class="toc">
5808: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5809: <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>
5810: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5811: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5812: </dl>
1.1 dsieger 5813: </div>
1.184 rillig 5814: <p>Many packages have the ability to be built to support different
5815: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5816: in pkgsrc that provides generic handling of those options that
5817: determine different ways in which the packages can be built. It's
5818: possible for the user to specify exactly which sets of options will be
5819: built into a package or to allow a set of global default options
5820: apply.</p>
5821: <p>There are two broad classes of behaviors that one might want to
5822: control via options. One is whether some particular feature is
5823: enabled in a program that will be built anyway, often by including or
5824: not including a dependency on some other package. The other is
5825: whether or not an additional program will be built as part of the
5826: package. Generally, it is better to make a split package for such
5827: additional programs instead of using options, because it enables
5828: binary packages to be built which can then be added separately. For
5829: example, the foo package might have minimal dependencies (those
5830: packages without which foo doesn't make sense), and then the foo-gfoo
5831: package might include the GTK frontend program gfoo. This is better
5832: than including a gtk option to foo that adds gfoo, because either that
5833: option is default, in which case binary users can't get foo without
5834: gfoo, or not default, in which case they can't get gfoo. With split
5835: packages, they can install foo without having GTK, and later decide to
5836: install gfoo (pulling in GTK at that time). This is an advantage to
5837: source users too, avoiding the need for rebuilds.</p>
5838: <p>Plugins with widely varying dependencies should usually be split
5839: instead of options.</p>
5840: <p>It is often more work to maintain split packages, especially if
5841: the upstream package does not support this. The decision of split
5842: vs. option should be made based on the likelihood that users will want
5843: or object to the various pieces, the size of the dependencies that are
5844: included, and the amount of work.</p>
5845: <p>A further consideration is licensing. Non-free parts, or parts
5846: that depend on non-free dependencies (especially plugins) should
5847: almost always be split if feasible.</p>
5848: <div class="sect1">
5849: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5850: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5851: <p>Global default options are listed in
5852: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5853: that should be built into every package if that option is supported.
5854: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5855: </div>
1.41 asau 5856: <div class="sect1">
1.1 dsieger 5857: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5858: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5859: </h2></div></div></div>
5860: <p>The following example shows how
5861: <code class="filename">bsd.options.mk</code> should be used
5862: by the hypothetical ``wibble'' package, either in the package
5863: <code class="filename">Makefile</code>, or in a file,
5864: e.g. <code class="filename">options.mk</code>, that is included by the
5865: main package <code class="filename">Makefile</code>.</p>
1.1 dsieger 5866: <pre class="programlisting">
1.184 rillig 5867: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5868: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5869: PKG_OPTIONS_OPTIONAL_GROUPS= database
5870: PKG_OPTIONS_GROUP.database= mysql pgsql
5871: PKG_SUGGESTED_OPTIONS= wibble-foo
5872: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5873: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5874:
5875: .include "../../mk/bsd.prefs.mk"
5876:
5877: # this package was previously named wibble2
5878: .if defined(PKG_OPTIONS.wibble2)
5879: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5880: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5881: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5882: .endif
5883:
5884: .include "../../mk/bsd.options.mk"
5885:
5886: # Package-specific option-handling
1.1 dsieger 5887:
1.184 rillig 5888: ###
5889: ### FOO support
5890: ###
5891: .if !empty(PKG_OPTIONS:Mwibble-foo)
5892: CONFIGURE_ARGS+= --enable-foo
5893: .endif
1.1 dsieger 5894:
1.184 rillig 5895: ###
5896: ### LDAP support
5897: ###
5898: .if !empty(PKG_OPTIONS:Mldap)
5899: . include "../../databases/openldap-client/buildlink3.mk"
5900: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5901: .endif
1.1 dsieger 5902:
1.184 rillig 5903: ###
5904: ### database support
5905: ###
5906: .if !empty(PKG_OPTIONS:Mmysql)
5907: . include "../../mk/mysql.buildlink3.mk"
5908: .endif
5909: .if !empty(PKG_OPTIONS:Mpgsql)
5910: . include "../../mk/pgsql.buildlink3.mk"
5911: .endif
5912: </pre>
5913: <p>The first section contains the information about which build
5914: options are supported by the package, and any default options settings
5915: if needed.</p>
5916: <div class="orderedlist"><ol class="orderedlist" type="1">
5917: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.207 leot 5918: <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.184 rillig 5919: options. It should be set to
5920: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5921: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5922: at the point where the options are processed.</p></li>
5923: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
5924: build options supported by the package.</p></li>
5925: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
5926: list of names of groups of mutually exclusive options. The options in
5927: each group are listed in
5928: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5929: The most specific setting of any option from the group takes
5930: precedence over all other options in the group. Options from the
5931: groups will be automatically added to
5932: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
5933: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
5934: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5935: packages will fail if no option from the group is
5936: selected.</p></li>
5937: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
5938: of names of sets of options. At least one option from each set must
5939: be selected. The options in each set are listed in
5940: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5941: Options from the sets will be automatically added to
5942: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5943: fail if no option from the set is selected.</p></li>
5944: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
5945: build options which are enabled by default.</p></li>
5946: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
5947: of
5948: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
5949: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
5950: their option counterparts. Pairs should be added with
5951: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
5952: warning will be issued if the user uses a legacy
5953: variable.</p></li>
5954: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
5955: of
5956: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
5957: pairs that map options that have been renamed to their new
5958: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
5959: the listing of global legacy options. A warning will be issued if
5960: the user uses a legacy option.</p></li>
5961: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
5962: options implied by deprecated variables used. This can be used for
5963: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5964: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5965: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
5966: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
5967: a list of warnings about deprecated variables or options used, and
5968: what to use instead.</p></li>
5969: </ol></div>
5970: <p>A package should never modify
5971: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5972: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5973: To suggest a default set of options, use
5974: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5975: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5976: including <code class="filename">bsd.options.mk</code>. If none of
5977: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5978: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5979: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5980: happen with platform-specific options if none of them is supported on
5981: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5982: empty list and the package is otherwise treated as not using the
5983: options framework.</p>
5984: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5985: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5986: build options, properly filtered to remove unsupported and duplicate
5987: options.</p>
5988: <p>The remaining sections contain the logic that is specific to
5989: each option. The correct way to check for an option is to check
5990: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5991: <pre class="programlisting">
5992: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.1 dsieger 5993: </pre>
5994: </div>
1.184 rillig 5995: <div class="sect1">
5996: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5997: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
5998: <p>Options that enable similar features in different packages (like
5999: optional support for a library) should use a common name in all
6000: packages that support it (like the name of the library). If another
6001: package already has an option with the same meaning, use the same
6002: name.</p>
6003: <p>Options that enable features specific to one package, where it's
6004: unlikely that another (unrelated) package has the same (or a similar)
6005: optional feature, should use a name prefixed with
6006: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6007: <p>If a group of related packages share an optional feature
6008: specific to that group, prefix it with the name of the
6009: <span class="quote">“<span class="quote">main</span>”</span> package
6010: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6011: <p>For new options, add a line to
6012: <code class="filename">mk/defaults/options.description</code>. Lines have two
6013: fields, separated by tab. The first field is the option name, the
6014: second its description. The description should be a whole sentence
6015: (starting with an uppercase letter and ending with a period) that
6016: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6017: support.</span>”</span> The file is sorted by option names.</p>
6018: </div>
6019: <div class="sect1">
6020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6021: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
6022: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6023: different dependencies based on the options with which the package was
6024: built. For querying these options, the file
6025: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6026: typical example looks like this:</p>
1.1 dsieger 6027: <pre class="programlisting">
1.184 rillig 6028: pkgbase := libpurple
6029: .include "../../mk/pkg-build-options.mk"
6030:
6031: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6032: ...
6033: .endif
1.117 sevan 6034: </pre>
1.184 rillig 6035: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6036: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6037: options of the libpurple package, which can then be queried like
6038: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6039: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6040: details.</p>
1.1 dsieger 6041: </div>
6042: </div>
1.41 asau 6043: <div class="chapter">
1.1 dsieger 6044: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 6045: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6046: <div class="toc">
6047: <p><b>Table of Contents</b></p>
1.100 leot 6048: <dl class="toc">
1.184 rillig 6049: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
6050: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
6051: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6052: </dl>
6053: </div>
1.184 rillig 6054: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6055: by pkgsrc and also for individual packages to define what commands
6056: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6057: or for later run-time of an installed packaged (such as
6058: <code class="varname">DEPENDS</code>).
6059: If the native system provides an adequate tool, then in many cases, a pkgsrc
6060: package will not be used.</p>
6061: <p>When building a package, the replacement tools are
6062: made available in a directory (as symlinks or wrapper scripts)
6063: that is early in the executable search path. Just like the buildlink
6064: system, this helps with consistent builds.</p>
6065: <p>A tool may be needed to help build a specific package. For example,
6066: perl, GNU make (gmake) or yacc may be needed.</p>
6067: <p>Also a tool may be needed, for example, because the native system's supplied
6068: tool may be inefficient for building a package with pkgsrc.
6069: For example, a package may need GNU awk, bison (instead of
6070: yacc) or a better sed.</p>
6071: <p>The tools used by a package can be listed by running
6072: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6073: <div class="sect1">
1.1 dsieger 6074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6075: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6076: <p>The default set of tools used by pkgsrc is defined in
6077: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6078: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6079: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6080: These can be seen by running:
6081: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6082: <p>If a package needs a specific program to build
6083: then the <code class="varname">USE_TOOLS</code> variable can be used
6084: to define the tools needed.</p>
1.1 dsieger 6085: </div>
1.184 rillig 6086: <div class="sect1">
6087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6088: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6089: <p>In the following examples, the :run means that it is needed at
6090: run-time (and becomes a DEPENDS).
6091: The default is a build dependency which can be set with
6092: :build. (So in this example, it is the same as gmake:build
6093: and pkg-config:build.)</p>
1.1 dsieger 6094: <pre class="programlisting">
1.184 rillig 6095: USE_TOOLS+= gmake perl:run pkg-config
1.1 dsieger 6096: </pre>
1.184 rillig 6097: <p>When using the tools framework, a
6098: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6099: which contains the full path to the appropriate tool. For example,
6100: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6101: on Linux systems.</p>
6102: <p>If you always need a pkgsrc version of the
6103: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6104: </p>
1.1 dsieger 6105: </div>
1.184 rillig 6106: <div class="sect1">
6107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6108: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6109: <p>When improving or porting pkgsrc to a new platform, have a look
6110: at (or create) the corresponding platform specific make file fragment under
6111: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6112: the name of the common tools. For example:</p>
1.1 dsieger 6113: <pre class="programlisting">
1.184 rillig 6114: .if exists(/usr/bin/bzcat)
6115: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6116: .elif exists(/usr/bin/bzip2)
6117: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6118: .endif
6119:
6120: TOOLS_PLATFORM.true?= true # shell builtin
1.1 dsieger 6121: </pre>
6122: </div>
6123: </div>
1.184 rillig 6124: <div class="chapter">
6125: <div class="titlepage"><div><div><h2 class="title">
6126: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6127: <div class="toc">
6128: <p><b>Table of Contents</b></p>
6129: <dl class="toc">
6130: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6131: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6132: <dd><dl>
6133: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6134: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6135: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6136: and
6137: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6138: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6139: </dl></dd>
6140: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
6141: <dd><dl>
6142: <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>
6143: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
6144: </dl></dd>
6145: </dl>
1.1 dsieger 6146: </div>
1.184 rillig 6147: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6148: are seen by a package's configure and build processes. This is implemented
6149: in a two step process:</p>
6150: <div class="orderedlist"><ol class="orderedlist" type="1">
6151: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6152: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6153: of <code class="varname">WRKDIR</code>.</p></li>
6154: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6155: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6156: <code class="option">-L${LOCALBASE}/lib</code> into references to
6157: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6158: native compiler on some operating systems look like GCC, so that
6159: packages that expect GCC won't require modifications to build with
6160: those native compilers.</p></li>
6161: </ol></div>
6162: <p>This normalizes the environment in which a package is built so that the
6163: package may be built consistently despite what other software may be
6164: installed. Please note that the normal system header and library paths,
6165: e.g. <code class="filename">/usr/include</code>,
6166: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6167: designed to insulate the package build from non-system-supplied
6168: software.</p>
1.41 asau 6169: <div class="sect1">
1.1 dsieger 6170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6171: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6172: <p>The process of converting packages to use the buildlink3
6173: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6174: The things to keep in mind are:</p>
1.23 wiz 6175: <div class="orderedlist"><ol class="orderedlist" type="1">
1.184 rillig 6176: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6177: instead of the actual toolchain. Some packages are tricky,
6178: and the only way to know for sure is the check
6179: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6180: wrappers are being invoked.</p></li>
6181: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6182: the package Makefile, e.g. Java VMs, standalone shells,
6183: etc., because the code to symlink files into
6184: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6185: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6186: </p></li>
6187: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6188: <code class="filename">buildlink3.mk</code> files that you list in a
6189: package's Makefile are added as dependencies for that package.
6190: </p></li>
6191: </ol></div>
6192: <p>If a dependency on a particular package is required for its libraries and
6193: headers, then we replace:</p>
6194: <pre class="programlisting">
6195: DEPENDS+= foo>=1.1.0:../../category/foo
6196: </pre>
6197: <p>with</p>
6198: <pre class="programlisting">
6199: .include "../../category/foo/buildlink3.mk"
6200: </pre>
6201: <p>The buildlink3.mk files usually define the required dependencies.
6202: If you need a newer version of the dependency when using buildlink3.mk
6203: files, then you can define it in your Makefile; for example:</p>
1.1 dsieger 6204: <pre class="programlisting">
1.184 rillig 6205: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6206: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 6207: </pre>
1.184 rillig 6208: <p>There are several <code class="filename">buildlink3.mk</code>
6209: files in <code class="filename">pkgsrc/mk</code>
6210: that handle special package issues:</p>
6211: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6212: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6213: the native or a pkgsrc Berkeley DB implementation based on
6214: the values of <code class="varname">BDB_ACCEPTED</code> and
6215: <code class="varname">BDB_DEFAULT</code>.</p></li>
6216: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6217: comes with neither Curses nor NCurses, this will take care
1.207 leot 6218: to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/index.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.184 rillig 6219: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6220: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6221: adding a dependency on Heimdal or MIT-krb5 for packages that
6222: require a Kerberos 5 implementation.</p></li>
6223: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6224: system-provided Motif installation or adds a dependency on
1.207 leot 6225: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/index.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/index.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.184 rillig 6226: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6227: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6228: to choose which Motif version will be used.</p></li>
6229: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6230: system-provided GNU readline or editline (libedit) installation,
1.207 leot 6231: 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>,
6232: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/index.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.184 rillig 6233: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6234: If your package really needs GNU readline library, its Makefile
6235: should include <code class="filename">devel/readline/buildlink3.mk</code>
6236: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6237: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6238: variables that may be used by packages that use the
6239: Open Sound System (OSS) API.</p></li>
6240: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6241: any of the Postgres versions in the variable
6242: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6243: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6244: the file for more information.</p></li>
6245: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6246: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.207 leot 6247: a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/index.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.184 rillig 6248: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6249: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6250: library.</p></li>
6251: </ul></div>
6252: <p>The comments in those <code class="filename">buildlink3.mk</code>
6253: files provide a more complete
6254: description of how to use them properly.</p>
1.1 dsieger 6255: </div>
1.41 asau 6256: <div class="sect1">
1.1 dsieger 6257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6258: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6259: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6260: included by Makefiles to indicate the need to compile and link
6261: against header files and libraries provided by the package. A
6262: <code class="filename">buildlink3.mk</code> file should always provide
6263: enough information to add the correct type of dependency
6264: relationship and include any other
6265: <code class="filename">buildlink3.mk</code> files that it needs to find
6266: headers and libraries that it needs in turn.</p>
6267: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.207 leot 6268: file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/index.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.184 rillig 6269: package is highly recommended. For most packages, the following
6270: command will generate a good starting point for
6271: <code class="filename">buildlink3.mk</code> files:</p>
6272: <pre class="screen">
6273: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6274: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6275: </pre>
1.41 asau 6276: <div class="sect2">
1.1 dsieger 6277: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6278: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6279: <p>The following real-life example
6280: <code class="filename">buildlink3.mk</code> is taken
6281: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.1 dsieger 6282: <pre class="programlisting">
1.184 rillig 6283: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
6284:
6285: BUILDLINK_TREE+= tiff
6286:
6287: .if !defined(TIFF_BUILDLINK3_MK)
6288: TIFF_BUILDLINK3_MK:=
6289:
6290: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6291: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6292: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6293:
6294: .include "../../devel/zlib/buildlink3.mk"
6295: .include "../../graphics/jpeg/buildlink3.mk"
6296: .endif # TIFF_BUILDLINK3_MK
6297:
6298: BUILDLINK_TREE+= -tiff
1.1 dsieger 6299: </pre>
1.184 rillig 6300: <p>The header and footer manipulate
6301: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6302: <code class="filename">buildlink3.mk</code> files and is used to track
6303: the dependency tree.</p>
6304: <p>The main section is protected from multiple inclusion
6305: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6306: added. Several important variables are set in the section:</p>
6307: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6308: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6309: is the dependency version recorded in the installed
1.184 rillig 6310: package; this should always be set using
6311: <span class="command"><strong>+=</strong></span> to ensure that
6312: we're appending to any pre-existing list of values. This
1.185 wiz 6313: variable should be set to the last version of the
1.184 rillig 6314: package that had an backwards-incompatible API change.
6315: </p></li>
6316: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6317: is the location of the <em class="replaceable"><code>pkg</code></em>
6318: pkgsrc directory.</p></li>
6319: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6320: (not shown above) controls whether we use
6321: <code class="varname">BUILD_DEPENDS</code> or
6322: <code class="varname">DEPENDS</code> to add the dependency on
6323: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6324: selected by setting
6325: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6326: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
6327: used.</p></li>
6328: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6329: and
6330: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6331: (not shown above) are lists of subdirectories of
6332: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6333: to add to the header and library search paths. These
6334: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6335: respectively.</p></li>
6336: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6337: (not shown above) is the list of preprocessor flags to add
6338: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6339: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6340: should be avoided and instead be handled using
6341: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6342: above.</p></li>
6343: </ul></div>
6344: <p>The following variables are all optionally defined within
6345: this second section (protected against multiple inclusion) and
6346: control which package files are symlinked into
6347: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6348: transformed during the symlinking:</p>
6349: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6350: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6351: (not shown above) is a shell glob pattern relative to
6352: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6353: to be symlinked into
6354: <code class="filename">${BUILDLINK_DIR}</code>,
6355: e.g. <code class="filename">include/*.h</code>.</p></li>
6356: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6357: (not shown above) is a shell pipeline that
6358: outputs to stdout a list of files relative to
6359: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6360: The resulting files are to be symlinked
6361: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6362: this takes the <code class="filename">+CONTENTS</code> of a
6363: <em class="replaceable"><code>pkg</code></em> and filters it through
6364: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6365: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6366: (not shown above) is a filter command that filters
6367: <code class="filename">+CONTENTS</code> input into a list of files
6368: relative to
6369: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6370: on stdout. By default,
6371: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6372: outputs the contents of the <code class="filename">include</code>
6373: and <code class="filename">lib</code> directories in the package
6374: <code class="filename">+CONTENTS</code>.</p></li>
6375: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6376: (not shown above) is a list of sed arguments used to
6377: transform the name of the source filename into a
6378: destination filename, e.g. <span class="command"><strong>-e
6379: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6380: </ul></div>
6381: <p>This section can additionally include any
6382: <code class="filename">buildlink3.mk</code> needed for
6383: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6384: Including these <code class="filename">buildlink3.mk</code> files
6385: means that the headers and libraries for these
6386: dependencies are also symlinked into
6387: <code class="filename">${BUILDLINK_DIR}</code>
6388: whenever the <em class="replaceable"><code>pkg</code></em>
6389: <code class="filename">buildlink3.mk</code>
6390: file is included. Dependencies are only added for directly
6391: include <code class="filename">buildlink3.mk</code> files.</p>
6392: <p>When providing a <code class="filename">buildlink3.mk</code> and
6393: including other <code class="filename">buildlink3.mk</code> files in it,
6394: please only add necessary ones, i.e., those whose libraries or
6395: header files are automatically exposed when the package is
6396: use.</p>
6397: <p>In particular, if only an executable
6398: (<code class="filename">bin/foo</code>) is linked against a library, that
6399: library does not need to be propagated in the
6400: <code class="filename">buildlink3.mk</code> file.</p>
6401: <p>The following steps should help you decide if a
6402: <code class="filename">buildlink3.mk</code> file needs to be included:
6403: </p>
6404: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6405: <li class="listitem"><p>Look at the installed header files: What
6406: headers do they include? The packages providing these files
6407: must be buildlinked.</p></li>
6408: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6409: libraries and look against what other libraries they link.
6410: Some of the packages providing these probably need to be
6411: buildlinked; however, it's not automatic, since e.g. GTK on
6412: some systems pulls in the X libraries, so they will show up in
6413: the <code class="filename">ldd</code> output, while on others (like OS
6414: X) it won't. <code class="filename">ldd</code> output can thus only be
6415: used as a hint.</p></li>
6416: </ul></div>
6417: <p>
6418: </p>
6419: </div>
1.41 asau 6420: <div class="sect2">
1.1 dsieger 6421: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6422: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6423: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6424: and
6425: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6426: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.185 wiz 6427: <p>Both variables set lower bounds for a version of this package.
6428: The two variables differ in that one describes source
1.184 rillig 6429: compatibility (API) and the other binary compatibility (ABI).
6430: The difference is that a change in the API breaks compilation of
6431: programs while changes in the ABI stop compiled programs from
6432: running.</p>
1.185 wiz 6433: <p>The
6434: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6435: variable in a <code class="filename">buildlink3.mk</code> should be
6436: changed very rarely. (One possible scenario: If all packages
6437: using this package need a higher version than defined in the
6438: <code class="filename">buildlink3.mk</code>,
1.184 rillig 6439: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6440: could be updated to that higher version.)</p>
6441: <p>On the other hand, changes to
1.184 rillig 6442: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6443: are more common. The variable will need to be updated every
6444: time the major version of one of its shared libraries is changed,
6445: or any other change where a binary built against the previous
6446: version of the package will not run against the new version any
6447: longer.</p>
6448: <p>In such a case, the package's
1.184 rillig 6449: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6450: must be increased to require the new package version. Then the
6451: <code class="varname">PKGREVISION</code> of all packages
6452: <em class="replaceable"><code>foo</code></em> that depend on this package need
6453: to be increased, and if they have
6454: <code class="filename">buildlink3.mk</code> files,
6455: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6456: in their <code class="filename">buildlink3.mk</code> files must be
6457: increased to the new version as well. This is required so that a
6458: package will pull in the versions of the packages that use the
6459: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6460: uniquely identify the packages built against the new ABI. The
1.207 leot 6461: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/revbump/index.html" target="_top"><code class="filename">pkgtools/revbump</code></a> package can
1.185 wiz 6462: help with these updates.</p>
6463: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6464: about dependencies on other packages, including the
6465: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.184 rillig 6466: <p>Please take careful consideration before adjusting
6467: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6468: or
6469: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6470: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6471: cause unneeded package deletions and rebuilds. In many cases,
6472: new versions of packages work just fine with older
6473: dependencies.</p>
1.211 gutterid 6474: <p>Also, it is not needed to set
1.184 rillig 6475: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6476: when it is identical to
1.211 gutterid 6477: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
6478: <p>Note there is also the distinction that users are able to disable
6479: enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
6480: variable, but there is no equivalent option for API dependencies.</p>
1.1 dsieger 6481: </div>
6482: </div>
1.41 asau 6483: <div class="sect1">
1.1 dsieger 6484: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6485: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6486: <p>Some packages in pkgsrc install headers and libraries that
6487: coincide with headers and libraries present in the base system.
6488: Aside from a <code class="filename">buildlink3.mk</code> file, these
6489: packages should also include a <code class="filename">builtin.mk</code>
6490: file that includes the necessary checks to decide whether using
6491: the built-in software or the pkgsrc software is
6492: appropriate.</p>
6493: <p>The only requirements of a builtin.mk file for
6494: <em class="replaceable"><code>pkg</code></em> are:</p>
6495: <div class="orderedlist"><ol class="orderedlist" type="1">
6496: <li class="listitem"><p>It should set
6497: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6498: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6499: after it is included.</p></li>
6500: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6501: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6502: which is already set before the
6503: <code class="filename">builtin.mk</code> file is included.</p></li>
6504: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6505: is <span class="emphasis"><em>very</em></span> important and takes careful
6506: attention to <code class="filename">Makefile</code> coding.</p></li>
6507: </ol></div>
6508: <div class="sect2">
6509: <div class="titlepage"><div><div><h3 class="title">
6510: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6511: <p>The following is the recommended template for builtin.mk
6512: files:</p>
1.1 dsieger 6513: <pre class="programlisting">
1.184 rillig 6514: .if !defined(IS_BUILTIN.foo)
6515: #
6516: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6517: # genuinely exists in the system or not.
6518: #
6519: IS_BUILTIN.foo?= no
1.1 dsieger 6520:
1.184 rillig 6521: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6522: # version can be determined.
6523: #
6524: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6525: BUILTIN_PKG.foo?= foo-1.0
6526: . endif
6527: .endif # IS_BUILTIN.foo
1.1 dsieger 6528:
1.184 rillig 6529: .if !defined(USE_BUILTIN.foo)
6530: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6531: . if defined(BUILTIN_PKG.foo)
6532: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6533: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6534: USE_BUILTIN.foo!= \
6535: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6536: && ${ECHO} "yes" || ${ECHO} "no"
6537: . endif
6538: . endfor
6539: . endif
6540: .endif # USE_BUILTIN.foo
1.1 dsieger 6541:
1.184 rillig 6542: CHECK_BUILTIN.foo?= no
6543: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6544: #
6545: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6546: # "yes" or "no".
6547: #
6548: .endif # CHECK_BUILTIN.foo
1.1 dsieger 6549: </pre>
1.184 rillig 6550: <p>The first section sets
6551: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6552: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6553: in the base system. This should not be a base system software
6554: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6555: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6556: included as part of the base system. This variable is only
6557: used internally within the <code class="filename">builtin.mk</code>
6558: file.</p>
6559: <p>The second section sets
6560: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6561: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6562: system if it exists (if
6563: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6564: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6565: within the <code class="filename">builtin.mk</code> file.</p>
6566: <p>The third section sets
6567: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6568: and is <span class="emphasis"><em>required</em></span> in all
6569: <code class="filename">builtin.mk</code> files. The code in this
6570: section must make the determination whether the built-in
6571: software is adequate to satisfy the dependencies listed in
6572: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6573: This is typically done by comparing
6574: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6575: against each of the dependencies in
6576: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6577: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6578: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6579: end of the <code class="filename">builtin.mk</code> file. Note that
6580: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6581: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6582: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6583: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6584: that the built-in version of the software is similar enough to
6585: be used as a replacement.</p>
6586: <p>The last section is guarded by
6587: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6588: and includes code that uses the value of
6589: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6590: set in the previous section. This typically includes, e.g.,
6591: adding additional dependency restrictions and listing additional
6592: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6593: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6594: </div>
6595: <div class="sect2">
6596: <div class="titlepage"><div><div><h3 class="title">
6597: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
6598: <p>When building packages, it's possible to choose whether to set
6599: a global preference for using either the built-in (native)
6600: version or the pkgsrc version of software to satisfy a
6601: dependency. This is controlled by setting
6602: <code class="varname">PREFER_PKGSRC</code> and
6603: <code class="varname">PREFER_NATIVE</code>. These variables take values
6604: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
6605: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
6606: use the pkgsrc versions of software, while
6607: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
6608: built-in versions. Preferences are determined by the most
6609: specific instance of the package in either
6610: <code class="varname">PREFER_PKGSRC</code> or
6611: <code class="varname">PREFER_NATIVE</code>. If a package is specified
6612: in neither or in both variables, then
6613: <code class="varname">PREFER_PKGSRC</code> has precedence over
6614: <code class="varname">PREFER_NATIVE</code>. For example, to require
6615: using pkgsrc versions of software for all but the most basic
6616: bits on a NetBSD system, you can set:</p>
1.1 dsieger 6617: <pre class="programlisting">
1.184 rillig 6618: PREFER_PKGSRC= yes
6619: PREFER_NATIVE= getopt skey tcp_wrappers
6620: </pre>
6621: <p>A package <span class="emphasis"><em>must</em></span> have a
6622: <code class="filename">builtin.mk</code>
6623: file to be listed in <code class="varname">PREFER_NATIVE</code>,
6624: otherwise it is simply ignored in that list.</p>
1.191 bacon 6625: <p><code class="varname">PREFER_PKGSRC</code> and
6626: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
6627: to ensure that the bootstrap process does not use inapropriate
6628: native tools as dependencies for core packages.
6629:
6630: </p>
6631: <pre class="screen">
6632: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
6633: </pre>
6634: <p>
6635:
1.184 rillig 6636: Switching between settings globally at a later date can introduce
6637: complications with dependency resolution. This is caused by packages
1.191 bacon 6638: built with the opposite preference being installed alongside each
6639: other. Hence, any changes to these variables after bootstrap will
6640: necessitate rebuilding all packages depending on one whose preference
6641: has been changed. This is not trivial and should be avoided.</p>
6642: <p>When using pkgsrc on Linux systems, there is high risk of
6643: "leakage", where programs installed by pkgsrc may inadvertently use a
6644: command or library not installed by pkgsrc, e.g. those installed by
6645: yum or apt. Such foreign dependencies may be installed, removed, or
6646: upgraded to a version incompatible with the pkgsrc package at any
6647: time, causing pkgsrc packages to subsequently malfunction. Pkgsrc
6648: cannot prevent this, as it has no control over other package managers.
6649: Another potential problem is that under Redhat Enterprise and related
6650: Linux systems, yum packages are only patched and never upgraded, so
6651: eventually they may become too outdated for use by pkgsrc. Even
6652: intentionally using foreign dependencies, not considered leakage, can
6653: lead to these problems, so it is generally discouraged. In order to
6654: minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
6655: This ensures that pkgsrc is aware of any changes to dependency packages
6656: and can rebuild or upgrade the entire dependency tree as needed. This
6657: default can be overridden by setting --prefer-pkgsrc to "no" or a list of
6658: packages, or by setting --prefer-native to "yes".</p>
1.1 dsieger 6659: </div>
1.7 rillig 6660: </div>
1.1 dsieger 6661: </div>
1.41 asau 6662: <div class="chapter">
1.1 dsieger 6663: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 6664: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.1 dsieger 6665: <div class="toc">
6666: <p><b>Table of Contents</b></p>
1.100 leot 6667: <dl class="toc">
1.184 rillig 6668: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6669: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6670: <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>
6671: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6672: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6673: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6674: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6675: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6676: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 6677: </dl>
6678: </div>
1.184 rillig 6679: <p>The <code class="filename">PLIST</code> file contains a package's
6680: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6681: the package (relative to the <code class="filename">${PREFIX}</code>
6682: directory it's been installed in) plus some additional statements
1.207 leot 6683: - 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.184 rillig 6684: This chapter addresses some issues that need attention when
6685: dealing with the <code class="filename">PLIST</code> file (or files, see
6686: below!).</p>
1.41 asau 6687: <div class="sect1">
1.1 dsieger 6688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6689: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6690: <p>Be sure to add a RCS ID line as the first thing in any
6691: <code class="filename">PLIST</code> file you write:</p>
6692: <pre class="programlisting">
6693: @comment $NetBSD $
6694: </pre>
6695: <p>An artificial space has been added between NetBSD and $, this is a
6696: workaround here to prevent CVS expanding to the filename of the guide. When
6697: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6698: </div>
1.41 asau 6699: <div class="sect1">
1.1 dsieger 6700: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6701: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6702: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6703: to output a PLIST that matches any new files since the package
6704: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6705: more information on this target.</p>
1.1 dsieger 6706: </div>
1.41 asau 6707: <div class="sect1">
1.1 dsieger 6708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6709: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6710: </h2></div></div></div>
6711: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6712: of AWK patterns and actions that are used to filter the output of
6713: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6714: scripting you like to it, but be careful with quoting.</p>
6715: <p>For example, to get all files inside the
6716: <code class="filename">libdata/foo</code> directory removed from the
6717: resulting PLIST:</p>
1.1 dsieger 6718: <pre class="programlisting">
1.184 rillig 6719: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 6720: </pre>
1.185 wiz 6721: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6722: evaluated after the file list and directory list are sorted.
6723: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6724: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6725: list and directory list are sorted.</p>
1.184 rillig 6726: </div>
6727: <div class="sect1">
6728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6729: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6730: <p>A number of variables are substituted automatically in
6731: PLISTs when a package is installed on a system. This includes the
6732: following variables:</p>
6733: <div class="variablelist"><dl class="variablelist">
6734: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6735: <dd>
6736: <p>Some packages like emacs and perl embed information
6737: about which architecture they were built on into the
6738: pathnames where they install their files. To handle this
6739: case, PLIST will be preprocessed before actually used, and
6740: the symbol
6741: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6742: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6743: same is done if the string
6744: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6745: PLIST somewhere - use this on packages that have GNU
6746: autoconf-created configure scripts.</p>
6747: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6748: <h3 class="title">Legacy note</h3>
6749: <p>There used to be a symbol
6750: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6751: was replaced by the output of <span class="command"><strong>uname
6752: -m</strong></span>, but that's no longer supported and has
6753: been removed.</p>
6754: </div>
6755: </dd>
6756: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6757: <dd>
6758: <p>Some packages want to embed the OS name and version
6759: into some paths. To do this, use these variables in the
6760: <code class="filename">PLIST</code>:
6761: </p>
6762: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6763: <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>
6764: <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>
6765: <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>
6766: </ul></div>
6767: </dd>
6768: </dl></div>
6769: <p>For a list of values which are replaced by
6770: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6771: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6772: <code class="varname">PLIST_SUBST</code> should help.</p>
6773: <p>If you want to change other variables not listed above, you
6774: can add variables and their expansions to this variable in the
6775: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="12.5. Optional files">Section 12.5, “Optional files”</a>):</p>
1.1 dsieger 6776: <pre class="programlisting">
1.184 rillig 6777: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 6778: </pre>
1.184 rillig 6779: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6780: in the <code class="filename">PLIST</code> with
6781: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6782: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6783: the common case of conditionally including some
6784: <code class="filename">PLIST</code> entries. It can be done by adding
6785: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6786: setting the corresponding <code class="varname">PLIST.foo</code> variable
6787: to <code class="literal">yes</code> if the entry should be included.
6788: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6789: in the <code class="filename">PLIST</code> with either
6790: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6791: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6792: For example, in <code class="filename">Makefile</code>:</p>
1.66 asau 6793: <pre class="programlisting">
1.184 rillig 6794: PLIST_VARS+= foo
6795: .if <em class="replaceable"><code>condition</code></em>
6796: PLIST.foo= yes
6797: .else
1.66 asau 6798: </pre>
1.184 rillig 6799: <p>And then in <code class="filename">PLIST</code>:</p>
1.1 dsieger 6800: <pre class="programlisting">
1.184 rillig 6801: @comment $NetBSD $
6802: bin/bar
6803: man/man1/bar.1
6804: ${PLIST.foo}bin/foo
6805: ${PLIST.foo}man/man1/foo.1
6806: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 6807: </pre>
1.184 rillig 6808: <p>An artificial space has been added between NetBSD and $, this is a
6809: workaround here to prevent CVS expanding to the filename of the guide. When
1.195 gutterid 6810: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6811: </div>
1.184 rillig 6812: <div class="sect1">
6813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6814: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6815: <p>Man pages should be installed in compressed form if
6816: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6817: and uncompressed otherwise. To handle this in the
6818: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6819: appended/removed automatically for man pages according to
6820: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6821: or not, see above for details. This modification of the
6822: <code class="filename">PLIST</code> file is done on a copy of it, not
6823: <code class="filename">PLIST</code> itself.</p>
1.1 dsieger 6824: </div>
1.41 asau 6825: <div class="sect1">
1.1 dsieger 6826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6827: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6828: </h2></div></div></div>
6829: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6830: in generating the binary package, set the variable
6831: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.207 leot 6832: 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.184 rillig 6833: important. The default for <code class="varname">PLIST_SRC</code> is
6834: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.1 dsieger 6835: </div>
1.41 asau 6836: <div class="sect1">
1.1 dsieger 6837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6838: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6839: <p>Some packages decide to install a different set of files based on
6840: the operating system being used. These differences can be
6841: automatically handled by using the following files:</p>
6842: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6843: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6844: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6845: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6846: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6847: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6848: </ul></div>
1.1 dsieger 6849: </div>
1.41 asau 6850: <div class="sect1">
1.1 dsieger 6851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6852: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6853: <p>Some packages decide to generate hard-to-guess file names
6854: during installation that are hard to wire down.</p>
6855: <p>In such cases, you can set the
6856: <code class="varname">GENERATE_PLIST</code> variable to shell code
6857: terminated (with a semicolon) that will output PLIST entries which
6858: will be appended to the PLIST</p>
6859: <p>You can find one example in editors/xemacs:</p>
6860: <pre class="programlisting">
6861: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6862: </pre>
6863: <p>which will append something like
6864: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6865: <code class="filename">PLIST</code>.
6866: </p>
1.1 dsieger 6867: </div>
1.41 asau 6868: <div class="sect1">
1.1 dsieger 6869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6870: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6871: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6872: multiple (and unrelated) packages install files. These
6873: directories were problematic because you had to add special
6874: tricks in the PLIST to conditionally remove them, or have some
6875: centralized package handle them.</p>
6876: <p>In pkgsrc, it is now easy: Each package should create
6877: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6878: will remove any directories left empty after uninstalling a
6879: package.</p>
6880: <p>If a package needs an empty directory to work, create
6881: the directory during installation as usual, and also add an
6882: entry to the PLIST:
6883:
6884: </p>
6885: <pre class="programlisting">
6886: @pkgdir path/to/empty/directory
6887: </pre>
6888: <p>
6889:
6890: or take a look at <code class="varname">MAKE_DIRS</code> and
6891: <code class="varname">OWN_DIRS</code>.
1.1 dsieger 6892: </p>
6893: </div>
1.184 rillig 6894: </div>
6895: <div class="chapter">
6896: <div class="titlepage"><div><div><h2 class="title">
6897: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6898: <div class="toc">
6899: <p><b>Table of Contents</b></p>
6900: <dl class="toc">
6901: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6902: <dd><dl>
6903: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6904: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6905: </dl></dd>
6906: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6907: <dd><dl>
6908: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6909: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
6910: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
6911: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
6912: </dl></dd>
6913: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6914: <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>
6915: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6916: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6917: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6918: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6919: <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>
6920: </dl>
6921: </div>
6922: <p>This chapter describes the framework known as
6923: <code class="literal">pkginstall</code>, whose key features are:</p>
6924: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6925: <li class="listitem"><p>Generic installation and manipulation of directories and files
6926: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6927: <li class="listitem"><p>Automatic handling of configuration files during installation,
6928: provided that packages are correctly designed.</p></li>
6929: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6930: <li class="listitem"><p>Registration of system users and groups.</p></li>
6931: <li class="listitem"><p>Registration of system shells.</p></li>
6932: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6933: </ul></div>
6934: <p>The following sections inspect each of the above points in detail.</p>
6935: <p>You may be thinking that many of the things described here could be
6936: easily done with simple code in the package's post-installation target
6937: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6938: as the code in them is only executed when building from source. Machines
6939: using binary packages could not benefit from it at all (as the code itself
6940: could be unavailable). Therefore, the only way to achieve any of the items
6941: described above is by means of the installation scripts, which are
6942: automatically generated by pkginstall.</p>
1.41 asau 6943: <div class="sect1">
1.1 dsieger 6944: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6945: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6946: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6947: of files and directories that belong to a package. The names used in it
6948: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6949: which means that it cannot register files outside this directory (absolute
6950: path names are not allowed). Despite this restriction, some packages need
6951: to install files outside this location; e.g., under
6952: <code class="filename">${VARBASE}</code> or
6953: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6954: is to create such files during installation time by using
6955: installation scripts.</p>
6956: <p>The generic installation scripts are shell scripts that can
6957: contain arbitrary code. The list of scripts to execute is taken from
6958: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6959: <code class="filename">INSTALL</code>. A similar variable exists for package
6960: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6961: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6962: commands, so they have the potential to create and manage files
6963: anywhere in the file system.</p>
6964: <p>Using these general installation files is not recommended, but
6965: may be needed in some special cases. One reason for avoiding them is
6966: that the user has to trust the packager that there is no unwanted or
6967: simply erroneous code included in the installation script. Also,
6968: previously there were many similar scripts for the same functionality,
6969: and fixing a common error involved finding and changing all of
6970: them.</p>
6971: <p>The pkginstall framework offers another, standardized way. It
6972: provides generic scripts to abstract the manipulation of such files
6973: and directories based on variables set in the package's
6974: <code class="filename">Makefile</code>. The rest of this section describes
6975: these variables.</p>
6976: <div class="sect2">
6977: <div class="titlepage"><div><div><h3 class="title">
6978: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
6979: <p>The following variables can be set to request the creation of
6980: directories anywhere in the file system:</p>
6981: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6982: <li class="listitem">
6983: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
6984: contain a list of directories that should be created and should attempt
6985: to be destroyed by the installation scripts. The difference between
6986: the two is that the latter prompts the administrator to remove any
6987: directories that may be left after deinstallation (because they were
6988: not empty), while the former does not. Example:</p>
6989: <pre class="programlisting">
6990: MAKE_DIRS+= ${VARBASE}/foo/private
6991: </pre>
6992: </li>
6993: <li class="listitem">
6994: <p><code class="varname">MAKE_DIRS_PERMS</code> and
6995: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
6996: which directories should be created and should attempt to be destroyed
6997: by the installation scripts. Each tuple holds the following values,
6998: separated by spaces: the directory name, its owner, its group and its
6999: numerical mode. For example:</p>
7000: <pre class="programlisting">
7001: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
7002: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
7003: </pre>
7004: <p>The difference between the two is exactly the same as their
7005: non-<code class="varname">PERMS</code> counterparts.</p>
7006: </li>
7007: </ul></div>
1.1 dsieger 7008: </div>
1.184 rillig 7009: <div class="sect2">
7010: <div class="titlepage"><div><div><h3 class="title">
7011: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
7012: <p>Creating non-empty files outside the installation prefix is tricky
7013: because the <code class="filename">PLIST</code> forces all files to be inside it.
7014: To overcome this problem, the only solution is to extract the file in the
7015: known place (i.e., inside the installation prefix) and copy it to the
7016: appropriate location during installation (done by the installation scripts
7017: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
7018: file</em></span> in the following paragraphs, which describe the variables
7019: that can be used to automatically and consistently handle files outside the
7020: installation prefix:</p>
7021: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7022: <li class="listitem">
7023: <p><code class="varname">CONF_FILES</code> and
7024: <code class="varname">REQD_FILES</code> are pairs of master and target files.
7025: During installation time, the master file is copied to the target one
7026: if and only if the latter does not exist. Upon deinstallation, the
7027: target file is removed provided that it was not modified by the
7028: installation.</p>
7029: <p>The difference between the two is that the latter prompts the
7030: administrator to remove any files that may be left after
7031: deinstallation (because they were not empty), while the former does
7032: not.</p>
7033: </li>
7034: <li class="listitem">
7035: <p><code class="varname">CONF_FILES_PERMS</code> and
7036: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
7037: files as well as their target locations. For each of them, it also
7038: specifies their owner, their group and their numeric permissions, in
7039: this order. For example:</p>
1.1 dsieger 7040: <pre class="programlisting">
1.184 rillig 7041: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
7042: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 7043: </pre>
1.184 rillig 7044: <p>The difference between the two is exactly the same as their
7045: non-<code class="varname">PERMS</code> counterparts.</p>
7046: </li>
7047: </ul></div>
7048: </div>
1.1 dsieger 7049: </div>
1.41 asau 7050: <div class="sect1">
1.1 dsieger 7051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7052: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
7053: <p>Configuration files are special in the sense that they are installed
7054: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
7055: need special treatment during installation (most of which is automated by
7056: pkginstall). The main concept you must bear in mind is that files marked
7057: as configuration files are automatically copied to the right place (somewhere
7058: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
7059: and only if</em></span> they didn't exist before. Similarly, they will not
7060: be removed if they have local modifications. This ensures that
7061: administrators never lose any custom changes they may have made.</p>
7062: <div class="sect2">
7063: <div class="titlepage"><div><div><h3 class="title">
7064: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7065: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7066: specifies where configuration files shall be installed. Its contents are
7067: set based upon the following variables:</p>
7068: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7069: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7070: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
7071: be overridden by the user to point to his preferred location (e.g.,
7072: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7073: Packages must not use it directly.</p></li>
7074: <li class="listitem">
7075: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7076: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7077: for the package being built shall be installed. The definition of this
7078: variable only makes sense in the package's
7079: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7080: <p>As an example, consider the Apache package,
1.207 leot 7081: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.184 rillig 7082: configuration files under the
7083: <code class="filename">httpd/</code> subdirectory of
7084: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7085: Makefile.</p>
7086: </li>
7087: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7088: variable that holds this package's configuration directory (if
7089: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7090: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7091: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7092: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7093: directory where the configuration files for the package identified by
7094: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7095: </ul></div>
7096: <p>Based on the above variables, pkginstall determines the value of
7097: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
7098: variable that can be used within a package to refer to its configuration
7099: directory. The algorithm used to set its value is basically the
7100: following:</p>
7101: <div class="orderedlist"><ol class="orderedlist" type="1">
7102: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7103: its value is used.</p></li>
7104: <li class="listitem"><p>If the previous variable is not defined but
7105: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7106: <code class="filename">Makefile</code>, the resulting value is
7107: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7108: <li class="listitem"><p>Otherwise, it is set to
7109: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7110: </ol></div>
7111: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
7112: 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
7113: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
7114: be created with OWN_DIRS or MAKE_DIRS.</p>
7115: </div>
7116: <div class="sect2">
7117: <div class="titlepage"><div><div><h3 class="title">
7118: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7119: <p>Given that pkgsrc (and users!) expect configuration files to be in a
7120: known place, you need to teach each package where it shall install its
7121: files. In some cases you will have to patch the package Makefiles to
7122: achieve it. If you are lucky, though, it may be as easy as passing an
7123: extra flag to the configuration script; this is the case of GNU Autoconf-
7124: generated files:</p>
1.1 dsieger 7125: <pre class="programlisting">
1.184 rillig 7126: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 7127: </pre>
1.184 rillig 7128: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
7129: for</em></span> its configuration files, not where they will be originally
7130: installed (although the difference is never explicit,
7131: unfortunately).</p>
1.1 dsieger 7132: </div>
1.184 rillig 7133: <div class="sect2">
7134: <div class="titlepage"><div><div><h3 class="title">
7135: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
7136: <p>As said before, pkginstall automatically handles configuration files.
7137: This means that <span class="strong"><strong>the packages themselves must not
7138: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7139: directly</strong></span>. Bad news is that many software installation scripts
7140: will, out of the box, mess with the contents of that directory. So what is
7141: the correct procedure to fix this issue?</p>
7142: <p>You must teach the package (usually by manually patching it) to
7143: install any configuration files under the examples hierarchy,
7144: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7145: <code class="filename">PLIST</code> registers them and the administrator always
7146: has the original copies available.</p>
7147: <p>Once the required configuration files are in place (i.e., under the
7148: examples hierarchy), the pkginstall framework can use them as master copies
7149: during the package installation to update what is in
7150: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7151: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
7152: 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
7153: about their syntax and their purpose. Here is an example, taken from the
1.207 leot 7154: <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.1 dsieger 7155: <pre class="programlisting">
1.184 rillig 7156: EGDIR= ${PREFIX}/share/doc/mutt/samples
7157: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 dsieger 7158: </pre>
1.184 rillig 7159: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
7160: package and has no meaning outside it.</p>
1.1 dsieger 7161: </div>
1.184 rillig 7162: <div class="sect2">
7163: <div class="titlepage"><div><div><h3 class="title">
7164: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
7165: <p>The automatic copying of config files can be toggled by setting the
7166: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7167: installation.</p>
1.1 dsieger 7168: </div>
7169: </div>
1.41 asau 7170: <div class="sect1">
1.1 dsieger 7171: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7172: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7173: <p>System startup scripts are special files because they must be
7174: installed in a place known by the underlying OS, usually outside the
7175: 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
7176: can be used. However, pkginstall provides a special mechanism to handle
7177: these files.</p>
7178: <p>In order to provide system startup scripts, the package has
7179: to:</p>
7180: <div class="orderedlist"><ol class="orderedlist" type="1">
7181: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7182: the <code class="literal">.sh</code> suffix appended. Considering the
1.223 nia 7183: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups-base/index.html" target="_top"><code class="filename">print/cups-base</code></a> package as an example, it
7184: has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.184 rillig 7185: <li class="listitem">
7186: <p>Tell pkginstall to handle it, appending the name of the script,
7187: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7188: Continuing the previous example:</p>
7189: <pre class="programlisting">
7190: RCD_SCRIPTS+= cupsd
7191: </pre>
7192: </li>
7193: </ol></div>
7194: <p>Once this is done, pkginstall will do the following steps for each
7195: script in an automated fashion:</p>
7196: <div class="orderedlist"><ol class="orderedlist" type="1">
7197: <li class="listitem"><p>Process the file found in the files directory applying all the
7198: substitutions described in the <code class="filename">FILES_SUBST</code>
7199: variable.</p></li>
7200: <li class="listitem"><p>Copy the script from the files directory to the examples
7201: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
7202: that this master file must be explicitly registered in the
7203: <code class="filename">PLIST</code>.</p></li>
7204: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7205: from the examples hierarchy into the system-wide startup scripts
7206: directory.</p></li>
7207: </ol></div>
7208: <div class="sect2">
7209: <div class="titlepage"><div><div><h3 class="title">
7210: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7211: <p>The automatic copying of config files can be toggled by setting the
7212: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7213: installation. Note that the scripts will be always copied inside the
7214: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7215: matter what the value of this variable is.</p>
1.1 dsieger 7216: </div>
7217: </div>
1.184 rillig 7218: <div class="sect1">
7219: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7220: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7221: <p>If a package needs to create special users and/or groups during
7222: installation, it can do so by using the pkginstall framework.</p>
7223: <p>Users can be created by adding entries to the
7224: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7225: syntax:</p>
7226: <pre class="programlisting">
7227: user:group
7228: </pre>
7229: <p>Further specification of user details may be done by setting
7230: per-user variables.
7231: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7232: numeric UID for the user.
7233: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7234: user's description or comment.
7235: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7236: user's home directory, and defaults to
7237: <code class="filename">/nonexistent</code> if not specified.
7238: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7239: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7240: not specified.</p>
7241: <p>Similarly, groups can be created by adding entries to the
7242: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7243: <pre class="programlisting">
7244: group
7245: </pre>
7246: <p>The numeric GID of the group may be set by defining
7247: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7248: <p>If a package needs to create the users and groups at an earlier
7249: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7250: <code class="literal">configure</code>,<code class="literal">build</code>, or
7251: <code class="literal">pre-install</code> to indicate the phase before which the
7252: users and groups are created. In this case, the numeric UIDs and GIDs
7253: of the created users and groups are automatically hardcoded into the
7254: final installation scripts.</p>
1.1 dsieger 7255: </div>
1.41 asau 7256: <div class="sect1">
1.1 dsieger 7257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7258: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7259: <p>Packages that install system shells should register them in the shell
7260: database, <code class="filename">/etc/shells</code>, to make things easier to the
7261: administrator. This must be done from the installation scripts to keep
7262: binary packages working on any system. pkginstall provides an easy way to
7263: accomplish this task.</p>
7264: <p>When a package provides a shell interpreter, it has to set the
7265: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7266: add some hooks to the installation scripts to handle it. Consider the
1.207 leot 7267: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/index.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.184 rillig 7268: <pre class="programlisting">
7269: PKG_SHELL= ${PREFIX}/bin/zsh
7270: </pre>
7271: <div class="sect2">
7272: <div class="titlepage"><div><div><h3 class="title">
7273: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7274: <p>The automatic registration of shell interpreters can be disabled by
7275: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7276: environment variable to <code class="literal">NO</code>.</p>
7277: </div>
1.1 dsieger 7278: </div>
1.41 asau 7279: <div class="sect1">
1.1 dsieger 7280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7281: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7282: <p>Packages that install X11 fonts should update the database files
7283: that index the fonts within each fonts directory. This can easily be
7284: accomplished within the pkginstall framework.</p>
7285: <p>When a package installs X11 fonts, it must list the directories in
7286: which fonts are installed in the
7287: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7288: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7289: <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
7290: installation scripts to run the appropriate commands to update the fonts
7291: database files within each of those directories. For convenience, if the
7292: directory path is relative, it is taken to be relative to the package's
1.207 leot 7293: installation prefix. Consider the following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/index.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.1 dsieger 7294: <pre class="programlisting">
1.184 rillig 7295: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 7296: </pre>
1.184 rillig 7297: <div class="sect2">
7298: <div class="titlepage"><div><div><h3 class="title">
7299: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7300: <p>The automatic update of fonts databases can be disabled by
7301: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7302: environment variable to <code class="literal">NO</code>.</p>
1.1 dsieger 7303: </div>
7304: </div>
7305: </div>
1.41 asau 7306: <div class="chapter">
1.1 dsieger 7307: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 7308: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 7309: <div class="toc">
7310: <p><b>Table of Contents</b></p>
1.100 leot 7311: <dl class="toc">
1.154 rillig 7312: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 7313: <dd><dl>
1.154 rillig 7314: <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>
7315: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7316: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7317: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7318: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7319: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7320: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7321: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7322: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7323: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7324: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7325: </dl></dd>
7326: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7327: <dd><dl>
7328: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7329: <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>
7330: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7331: </dl></dd>
7332: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7333: <dd><dl>
7334: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7335: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7336: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 7337: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154 rillig 7338: </dl></dd>
7339: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7340: <dd><dl>
7341: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7342: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 7343: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 7344: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
7345: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
7346: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
7347: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 7348: </dl></dd>
7349: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7350: <dd><dl>
7351: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7352: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 7353: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7354: <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>
7355: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 7356: </dl></dd>
7357: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7358: <dd><dl>
7359: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7360: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7361: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7362: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7363: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 7364: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154 rillig 7365: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
7366: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203 nia 7367: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
7368: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
7369: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
7370: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
7371: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
7372: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
7373: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1 dsieger 7374: emulation</a></span></dt>
1.203 nia 7375: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
7376: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1 dsieger 7377: </dl></dd>
1.154 rillig 7378: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7379: </dl>
7380: </div>
1.41 asau 7381: <div class="sect1">
1.1 dsieger 7382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7383: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 7384: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 7385: different platforms. As a result, it is important to ensure,
7386: where possible, that packages in pkgsrc are portable. This
7387: chapter mentions some particular details you should pay
7388: attention to while working on pkgsrc.</p>
1.41 asau 7389: <div class="sect2">
1.1 dsieger 7390: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7391: <a name="pulling-vars-from-etc-mk.conf"></a>21.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 7392: </h3></div></div></div>
7393: <p>The pkgsrc user can configure pkgsrc by overriding several
7394: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7395: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7396: want to use those variables in the preprocessor directives of
1.207 leot 7397: <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.1 dsieger 7398: <code class="literal">.for</code>), you need to include the file
7399: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7400: loads the user preferences.</p>
7401: <p>But note that some variables may not be completely defined
7402: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7403: included, as they may contain references to variables that are
1.108 rillig 7404: not yet defined. In shell commands (the lines in
7405: <code class="filename">Makefile</code> that are indented with a tab) this
7406: is no problem, since variables are only expanded when they are
7407: used. But in the preprocessor directives mentioned above and in
7408: dependency lines (of the form <code class="literal">target:
1.1 dsieger 7409: dependencies</code>) the variables are expanded at load
7410: time.</p>
1.41 asau 7411: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7412: <h3 class="title">Note</h3>
1.108 rillig 7413: <p>To check whether a variable can be used at load time,
7414: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 7415: </div>
7416: </div>
1.41 asau 7417: <div class="sect2">
1.1 dsieger 7418: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7419: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 7420: <p>Occasionally, packages require interaction from the user,
7421: and this can be in a number of ways:</p>
1.41 asau 7422: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7423: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7424: interaction such as entering username/password or accepting a
7425: license on a web page.</p></li>
1.23 wiz 7426: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7427: passwords.</p></li>
1.23 wiz 7428: <li class="listitem"><p>help to configure the package before it is built</p></li>
7429: <li class="listitem"><p>help during the build process</p></li>
7430: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7431: </ul></div>
1.108 rillig 7432: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7433: variable to define which stages need interaction. This should be
7434: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 7435: <pre class="programlisting">
7436: INTERACTIVE_STAGE= configure install
1.111 sevan 7437: </pre>
1.1 dsieger 7438: <p>The user can then decide to skip this package by setting the
1.108 rillig 7439: <code class="varname">BATCH</code> variable. Packages that require interaction
7440: are also excluded from bulk builds.</p>
1.1 dsieger 7441: </div>
1.41 asau 7442: <div class="sect2">
1.1 dsieger 7443: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7444: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 7445: <p>Authors of software can choose the licence under which software
7446: can be copied. The Free Software Foundation has declared some
7447: licenses "Free", and the Open Source Initiative has a definition of
7448: "Open Source".</p>
7449: <p>By default, pkgsrc allows packages with Free or Open Source
7450: licenses to be built. To allow packages with other licenses to be
7451: built as well, the pkgsrc user needs to add these licenses to the
7452: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7453: that this variable only affects which packages may be
7454: <span class="emphasis"><em>built</em></span>, while the license terms often also
7455: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 7456: <p>One might want to only install packages with a BSD license,
1.108 rillig 7457: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 7458: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 7459: user can override the default by setting the
7460: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 7461: of "+=". The licenses accepted by default are defined in the
7462: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7463: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7464: <p>The license tag mechanism is intended to address
7465: copyright-related issues surrounding building, installing and
7466: using a package, and not to address redistribution issues (see
7467: <code class="varname">RESTRICTED</code> and
1.111 sevan 7468: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7469: Packages with redistribution restrictions should set these
7470: tags.</p>
1.1 dsieger 7471: <p>Denoting that a package may be copied according to a
7472: particular license is done by placing the license in
7473: <code class="filename">pkgsrc/licenses</code> and setting the
7474: <code class="varname">LICENSE</code> variable to a string identifying the
1.207 leot 7475: license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/index.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.1 dsieger 7476: <pre class="programlisting">
7477: LICENSE= xv-license
1.111 sevan 7478: </pre>
1.1 dsieger 7479: <p>When trying to build, the user will get a notice that the
7480: package is covered by a license which has not been placed in the
7481: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7482: <pre class="programlisting">
7483: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7484: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7485: ===> To view the license, enter "/usr/bin/make show-license".
7486: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7487: ===> ACCEPTABLE_LICENSES+=xv-license
7488: *** Error code 1
1.111 sevan 7489: </pre>
1.10 hubertf 7490: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7491: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7492: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7493: convey to pkgsrc that it should not in the future fail because of
7494: that license:</p>
7495: <pre class="programlisting">
7496: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7497: </pre>
7498: <p>The use of <code class="varname">LICENSE=shareware</code>,
7499: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7500: is deprecated because it does not crisply refer to a particular
7501: license text. Another problem with such usage is that it does not
7502: enable a user to tell pkgsrc to proceed for a single package
7503: without also telling pkgsrc to proceed for all packages with that
7504: tag.</p>
7505: <div class="sect3">
7506: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7507: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7508: <p>When adding a package with a new license, the following steps
7509: are required:</p>
7510: <div class="orderedlist"><ol class="orderedlist" type="1">
7511: <li class="listitem">
1.169 rillig 7512: <p>Check whether the license qualifies as Free or Open Source by
7513: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7514: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111 sevan 7515: Open Source Initiative</a>. If this is the case, the filename in
7516: <code class="filename">pkgsrc/licenses/</code> does not need the
7517: <code class="filename">-license</code> suffix, and the license name should be
7518: added to:</p>
1.48 rodent 7519: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7520: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7521: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7522: <li class="listitem"><p>default_acceptable_licenses in
7523: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48 rodent 7524: </ul></div>
7525: </li>
1.169 rillig 7526: <li class="listitem"><p>The license text should be added to
7527: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7528: licenses can be seen in this directory.</p></li>
1.48 rodent 7529: </ol></div>
1.111 sevan 7530: </div>
7531: <div class="sect3">
7532: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7533: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7534: <p>When the license changes (in a way other than formatting),
1.111 sevan 7535: make sure that the new license has a different name (e.g.,
1.1 dsieger 7536: append the version number if it exists, or the date). Just
7537: because a user told pkgsrc to build programs under a previous
7538: version of a license does not mean that pkgsrc should build
7539: programs under the new licenses. The higher-level point is that
7540: pkgsrc does not evaluate licenses for reasonableness; the only
7541: test is a mechanistic test of whether a particular text has been
1.111 sevan 7542: approved by either of two bodies (FSF or OSI).</p>
7543: </div>
1.1 dsieger 7544: </div>
1.41 asau 7545: <div class="sect2">
1.1 dsieger 7546: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7547: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7548: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7549: By declaring the restrictions, package tools can
1.1 dsieger 7550: automatically refrain from e.g. placing binary packages on FTP
7551: sites.</p>
1.111 sevan 7552: <p>There are four possible restrictions, which are
1.1 dsieger 7553: the cross product of sources (distfiles) and binaries not being
7554: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7555: language in any license, and because non-Free licenses tend to be
7556: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7557: CD-ROM.
7558:
7559: "FTP" means making the source or binary file available over the
7560: Internet at no charge.
7561:
7562: "CD-ROM" means making the source or binary available on some kind of
7563: media, together with other source and binary packages, which is sold
7564: for a distribution charge.
1.1 dsieger 7565: </p>
7566: <p>In order to encode these restrictions, the package system
7567: defines five make variables that can be set to note these
7568: restrictions:</p>
1.41 asau 7569: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7570: <li class="listitem">
1.1 dsieger 7571: <p><code class="varname">RESTRICTED</code></p>
7572: <p>This variable should be set whenever a restriction
7573: exists (regardless of its kind). Set this variable to a
7574: string containing the reason for the restriction. It should
7575: be understood that those wanting to understand the restriction
7576: will have to read the license, and perhaps seek advice of
7577: counsel.</p>
7578: </li>
1.23 wiz 7579: <li class="listitem">
1.1 dsieger 7580: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7581: <p>Binaries may not be placed on CD-ROM containing other
7582: binary packages, for which a distribution charge may be made.
7583: In this case, set this variable to
7584: <code class="varname">${RESTRICTED}</code>.</p>
7585: </li>
1.23 wiz 7586: <li class="listitem">
1.1 dsieger 7587: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7588: <p>Binaries may not made available on the Internet without
7589: charge. In this case, set this variable to
7590: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7591: binary packages will not be included on ftp.NetBSD.org.</p>
7592: </li>
1.23 wiz 7593: <li class="listitem">
1.1 dsieger 7594: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7595: <p>Distfiles may not be placed on CD-ROM, together with
7596: other distfiles, for which a fee may be charged. In this
7597: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7598: </p>
7599: </li>
1.23 wiz 7600: <li class="listitem">
1.1 dsieger 7601: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7602: <p>Distfiles may not made available via FTP at no charge.
7603: In this case, set this variable to
7604: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7605: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7606: </li>
7607: </ul></div>
1.111 sevan 7608: <p>Please note that packages will be removed from pkgsrc when the
7609: distfiles are not distributable and cannot be obtained for a period
7610: of one full quarter branch. Packages with manual/interactive fetch
7611: must have a maintainer and it is his/her responsibility to ensure
7612: this.</p>
1.1 dsieger 7613: </div>
1.41 asau 7614: <div class="sect2">
1.1 dsieger 7615: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7616: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.175 gutterid 7617: <p>Your package may depend on some other package being present,
7618: and there are various ways of expressing this dependency.
7619: pkgsrc supports the <code class="varname">DEPENDS</code>,
7620: <code class="varname">BUILD_DEPENDS</code>,
7621: <code class="varname">TOOL_DEPENDS</code>, and
7622: <code class="varname">TEST_DEPENDS</code> definitions, the
1.1 dsieger 7623: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7624: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7625: to handle dependencies, and which uses the variables named above.
1.184 rillig 7626: See <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a> for more information.</p>
1.175 gutterid 7627: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7628: definition registers that pre-requisite in the binary package so it
7629: will be pulled in when the binary package is later installed, whilst
7630: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7631: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7632: dependency that is only needed for building or testing the resulting
1.184 rillig 7633: package. See also <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> for more information.</p>
1.1 dsieger 7634: <p>This means that if you only need a package present whilst
1.175 gutterid 7635: you are building or testing, it should be noted as a
7636: <code class="varname">TOOL_DEPENDS</code>,
7637: <code class="varname">BUILD_DEPENDS</code>, or
7638: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.156 leot 7639: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7640: packages, i.e. packages for the architecture where the package
7641: is built;
7642: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.175 gutterid 7643: packages, i.e., packages for the architecture for which the package
1.156 leot 7644: is built.</p>
1.175 gutterid 7645: <p>The format for a <code class="varname">DEPENDS</code>,
7646: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7647: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.1 dsieger 7648: <pre class="programlisting">
7649: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7650: </pre>
1.23 wiz 7651: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7652: may include any of the wildcard version numbers recognized by
1.207 leot 7653: <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.23 wiz 7654: <div class="orderedlist"><ol class="orderedlist" type="1">
7655: <li class="listitem">
1.1 dsieger 7656: <p>If your package needs another package's binaries or
1.54 wiz 7657: libraries to build and run, and if that package has a
1.1 dsieger 7658: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7659: <pre class="programlisting">
7660: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7661: </pre>
1.1 dsieger 7662: </li>
1.23 wiz 7663: <li class="listitem">
1.54 wiz 7664: <p>If your package needs another package's binaries or
7665: libraries only for building, and if that package has a
7666: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7667: <pre class="programlisting">
7668: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7669: </pre>
1.54 wiz 7670: <p>but set
7671: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7672: to make it a build dependency only. This case is rather
7673: rare.</p>
7674: </li>
7675: <li class="listitem">
1.25 spz 7676: <p>If your package needs binaries from another package to build,
1.156 leot 7677: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7678: <pre class="programlisting">
1.156 leot 7679: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7680: </pre>
1.1 dsieger 7681: </li>
1.156 leot 7682: <li class="listitem"><p>If your package needs static libraries to link against, header
7683: files to include, etc. from another package to build,
7684: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7685: <li class="listitem"><p>If your package needs a library with which to link and
7686: there is no <code class="filename">buildlink3.mk</code> file
7687: available, create one. Using
7688: <code class="varname">DEPENDS</code> won't be sufficient because the
7689: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7690: <li class="listitem">
1.25 spz 7691: <p>If your package needs some executable to be able to run
7692: correctly and if there's no
7693: <code class="filename">buildlink3.mk</code> file, this is specified
7694: using the <code class="varname">DEPENDS</code> variable. The
1.207 leot 7695: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/index.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.129 wiz 7696: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7697: when it runs, and that is specified:</p>
1.1 dsieger 7698: <pre class="programlisting">
1.129 wiz 7699: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7700: </pre>
1.25 spz 7701: </li>
1.175 gutterid 7702: <li class="listitem"><p>If your package includes a test suite that has extra
7703: dependencies only required for this purpose (frequently this
7704: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7705: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.25 spz 7706: <li class="listitem">
7707: <p>You can use wildcards in package dependencies. Note that
7708: such wildcard dependencies are retained when creating binary
7709: packages. The dependency is checked when installing the binary
7710: package and any package which matches the pattern will be
7711: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7712: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7713: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7714: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7715: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7716: <p>Wildcards can also be used to specify that a package
7717: will only build against a certain minimum version of a
7718: pre-requisite:</p>
7719: <pre class="programlisting">
1.25 spz 7720: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7721: </pre>
1.25 spz 7722: <p>This means that the package will build using version 6.0
7723: of ImageMagick or newer. Such a dependency may be warranted
7724: if, for example, the command line options of an executable
7725: have changed.</p>
7726: <p>If you need to depend on minimum versions of libraries,
1.183 wiz 7727: set
7728: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7729: to the appropriate pattern before including its
7730: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7731: <pre class="programlisting">
7732: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7733: .include "../../graphics/jpeg/buildlink3.mk"
7734: </pre>
1.1 dsieger 7735: <p>For security fixes, please update the package
1.154 rillig 7736: vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, “Handling packages with security problems”</a> for more
1.1 dsieger 7737: information.</p>
7738: </li>
7739: </ol></div>
7740: <p>If your package needs files from another package to build,
7741: add the relevant distribution files to
7742: <code class="varname">DISTFILES</code>, so they will be extracted
1.207 leot 7743: automatically. See the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/index.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.1 dsieger 7744: (It relies on the jpeg sources being present in source form
7745: during the build.)</p>
7746: </div>
1.41 asau 7747: <div class="sect2">
1.1 dsieger 7748: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7749: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.226 gutterid 7750: <p>Your package may conflict with other packages users might
7751: already have installed on their system, e.g., if your package
1.1 dsieger 7752: installs the same set of files as another package in the pkgsrc
1.227 wiz 7753: tree.</p>
1.207 leot 7754: <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>
7755: and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/index.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.142 leot 7756: install the same shared library, thus you set in
7757: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7758: <pre class="programlisting">
7759: CONFLICTS= Xaw-Xpm-[0-9]*
7760: </pre>
7761: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7762: <pre class="programlisting">
7763: CONFLICTS= libXaw3d-[0-9]*
7764: </pre>
1.207 leot 7765: <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.142 leot 7766: that conflict with existing packages and abort. However, in many
7767: situations this is too late in the process. Binary package managers
7768: will not know about the conflict until they attempt to install the
7769: package after already downloading it and all its dependencies.
7770: Users may also waste time building a package and its dependencies
7771: only to find out at the end that it conflicts with another package
7772: they have installed.</p>
7773: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7774: should be added in all cases where it is known that packages conflict
7775: with each other. These <code class="varname">CONFLICTS</code> entries are
1.207 leot 7776: 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.142 leot 7777: managers to inform users that packages cannot be installed onto
7778: the target system.</p>
1.1 dsieger 7779: </div>
1.41 asau 7780: <div class="sect2">
1.1 dsieger 7781: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7782: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7783: <p>There are several reasons why a package might be
7784: instructed to not build under certain circumstances. If the
7785: package builds and runs on most platforms, the exceptions
1.83 dholland 7786: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7787: the package builds and runs on a small handful of platforms,
7788: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7789: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7790: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7791: (OS-version-platform) that can use glob-style
7792: wildcards.</p>
7793: <p>If a package is not appropriate for some platforms (as
1.114 maya 7794: opposed to merely broken), a different set of variables should be
1.83 dholland 7795: used as this affects failure reporting and statistics.
7796: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7797: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7798: the package is appropriate for only a small handful of platforms
7799: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7800: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7801: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7802: (OS-version-platform) that can use glob-style
7803: wildcards.</p>
7804: <p>Some packages are tightly bound to a specific version of an
1.207 leot 7805: operating system, e.g. LKMs or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/index.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
1.1 dsieger 7806: backwards compatible with other versions of the OS, and should be
7807: uploaded to a version specific directory on the FTP server. Mark
7808: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7809: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7810: the package system internals, but may be used in the
7811: future.</p>
7812: <p>If the package should be skipped (for example, because it
7813: provides functionality already provided by the system), set
7814: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7815: the package should fail because some preconditions are not met,
7816: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7817: message.</p>
7818: </div>
1.41 asau 7819: <div class="sect2">
1.1 dsieger 7820: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7821: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7822: <p>To ensure that a package may not be deleted, once it has been
7823: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7824: be set in the package Makefile. This will be carried into any
7825: binary package that is made from this pkgsrc entry. A
1.23 wiz 7826: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.207 leot 7827: 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.23 wiz 7828: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7829: </div>
1.41 asau 7830: <div class="sect2">
1.1 dsieger 7831: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7832: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7833: <p>When a vulnerability is found, this should be noted in
1.205 wiz 7834: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>.
7835: Entries in that file consist of three parts:</p>
7836: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7837: <li class="listitem"><p>package version pattern</p></li>
7838: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
7839: <li class="listitem"><p>URL providing additional information about the issue</p></li>
7840: </ul></div>
7841: <p>For the package version pattern please always use `<' to
7842: mark an upper bound (not `<='!). This will avoid possible
7843: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
7844: related to security fixes. Lower bounds can be added too, using
7845: '>' or '>='. For example,
1.206 wiz 7846: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.205 wiz 7847: versions 1.0 (included) to 1.2 (excluded) of
7848: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
7849: issue.</p>
7850: <p>Entries should always be added at the bottom of the file.</p>
7851: <p>When fixing packages, please modify the upper bound of the
7852: corresponding entry. To continue the previous example, if a fix
7853: was backported to version 1.1nb2, change the previous pattern to
1.206 wiz 7854: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.205 wiz 7855: <p>To locally test a package version pattern against a
7856: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
7857: pmatch</strong></span> command.</p>
7858: <p>The URL should be as permanent as possible and provide as
7859: much information about the issue as possible. CVE entries are
7860: preferred.</p>
7861: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.31 wiz 7862: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7863: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7864: <code class="varname">PKGREVISION</code> should be increased (this is of
7865: course not necessary if the problem is fixed by using a newer
7866: release of the software), and the pattern in the
7867: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7868: <p>Also, if the fix should be applied to the stable pkgsrc
7869: branch, be sure to submit a pullup request!</p>
7870: <p>Binary packages already on ftp.NetBSD.org will be handled
7871: semi-automatically by a weekly cron job.</p>
1.205 wiz 7872: <p>In case a security issue is disputed, please contact
7873: pkgsrc-security@NetBSD.org.</p>
1.1 dsieger 7874: </div>
1.41 asau 7875: <div class="sect2">
1.1 dsieger 7876: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7877: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1 dsieger 7878: <p>When making fixes to an existing package it can be useful
7879: to change the version number in <code class="varname">PKGNAME</code>. To
7880: avoid conflicting with future versions by the original author, a
1.23 wiz 7881: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.1 dsieger 7882: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7883: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7884: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7885: <pre class="programlisting">
7886: DISTNAME= foo-17.42
7887: PKGREVISION= 9
1.111 sevan 7888: </pre>
1.1 dsieger 7889: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7890: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7891: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7892: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7893: <code class="varname">PKGNAME_NOREV</code>.</p>
7894: <p>When a new release of the package is released, the
7895: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7896: minor release of the above package, things should be like:</p>
7897: <pre class="programlisting">
7898: DISTNAME= foo-17.43
1.111 sevan 7899: </pre>
1.1 dsieger 7900: <p><code class="varname">PKGREVISION</code> should be incremented for any
7901: non-trivial change in the resulting binary package. Without a
7902: <code class="varname">PKGREVISION</code> bump, someone with the previous
7903: version installed has no way of knowing that their package is out
7904: of date. Thus, changes without increasing
7905: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7906: trivial that no reasonable person would want to upgrade", and this
7907: is the rough test for when increasing
7908: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7909: changes that do not merit increasing
7910: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7911: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7912: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169 rillig 7913: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7914: comments in Makefile.</p></li>
7915: <li class="listitem"><p>Changing build variables if the resulting binary
7916: package is the same.</p></li>
7917: <li class="listitem"><p>Changing
7918: <code class="filename">DESCR</code>.</p></li>
7919: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7920: default options don't change.</p></li>
1.1 dsieger 7921: </ul></div>
7922: <p>Examples of changes that do merit an increase to
7923: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7924: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7925: <li class="listitem"><p>Security fixes</p></li>
7926: <li class="listitem"><p>Changes or additions to a patch
7927: file</p></li>
7928: <li class="listitem"><p>Changes to the
7929: <code class="filename">PLIST</code></p></li>
7930: <li class="listitem"><p>A dependency is changed or
7931: renamed.</p></li>
1.1 dsieger 7932: </ul></div>
7933: <p>PKGREVISION must also be incremented when dependencies have ABI
7934: changes.</p>
7935: </div>
1.41 asau 7936: <div class="sect2">
1.1 dsieger 7937: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7938: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.180 rillig 7939: <p>When you want to replace the same text in multiple files, or
7940: multiple times in the same file, it is cumbersome to maintain a patch
7941: file for this. This is where the SUBST framework steps in. It provides an
7942: easy-to-use interface for replacing text in files. It just needs the
7943: following information:</p>
7944: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7945: <li class="listitem"><p>In which phase of the package build cycle should the
7946: replacement happen?</p></li>
7947: <li class="listitem"><p>In which files should the replacement
1.172 rillig 7948: happen?</p></li>
1.180 rillig 7949: <li class="listitem"><p>Which text should be replaced with
7950: what?</p></li>
1.172 rillig 7951: </ul></div>
7952: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.180 rillig 7953: variables. A minimal example is:</p>
7954: <pre class="programlisting">
7955: SUBST_CLASSES+= paths
7956: SUBST_STAGE.paths= pre-configure
7957: SUBST_FILES.paths= src/*.c
7958: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
7959: </pre>
7960: <p>Translated into English, it means: In the pre-configure stage (that
7961: is, after applying the patches from the patches/ directory and before
7962: running the configure script and the portability check), replace the text
7963: <code class="literal">/usr/local</code> with the content of the variable
7964: <code class="varname">PREFIX</code>.</p>
7965: <p>Each SUBST block starts by appending an identifier to
7966: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
7967: identifier can be chosen freely by the package. If there should ever be
7968: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
7969: early, so don't worry about name collisions.</p>
7970: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
7971: SUBST block are parameterized using this identifier. In the remainder of
7972: this section, these parameterized variables are written as
7973: <code class="varname">SUBST_STAGE.*</code>.</p>
7974: <pre class="programlisting">
7975: SUBST_CLASSES+= paths
7976: SUBST_STAGE.paths= pre-configure
7977: SUBST_MESSAGE.paths= Fixing absolute paths.
7978: SUBST_FILES.paths= src/*.c
7979: SUBST_FILES.paths+= scripts/*.sh
7980: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
7981: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
7982: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
7983: </pre>
7984: <p>To get a complete picture about the SUBST substitutions, run
7985: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
7986: expected, run pkglint on the package, which detects several typical
7987: mistakes surrounding the SUBST blocks. For any questions that might
7988: remain after this, have a look at
7989: <code class="filename">mk/subst.mk</code>.</p>
7990: <div class="sect3">
7991: <div class="titlepage"><div><div><h4 class="title">
7992: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
7993: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
7994: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
7995: <code class="literal">pre-configure</code> is used most often, by far. The most
7996: popular stages are, in chronological order:</p>
7997: <div class="variablelist"><dl class="variablelist">
7998: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
7999: <dd>
8000: <p>The substitutions are applied immediately after the
8001: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
8002: package will leave no traces of the original files.</p>
8003: <p>When the substitution applies to files for which there is also a
8004: patch in the <code class="filename">patches/</code> directory, this means that the
8005: patches will be computed based on the result of the substitution. When
8006: these patches are sent to the upstream maintainer later, to be fixed in
8007: the upstream package, these patches may no longer match what the upstream
8008: author is used to. Because of this, <code class="literal">pre-configure</code> is
8009: often a better choice.</p>
8010: </dd>
8011: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
8012: <dd>
8013: <p>The substitutions are applied after the patches from the
8014: <code class="filename">patches/</code> directory. This makes it possible to run
8015: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.207 leot 8016: can be edited using the tools pkgvi and mkpatches from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package.</p>
1.180 rillig 8017: <p>When updating the patches, it is helpful to explicitly separate the
8018: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
8019: configure</strong></span>, and to only edit the patches between these commands.
8020: Otherwise the substitutions from the SUBST block will end up in the patch
8021: file. When this happens in really obvious ways, pkglint will complain
8022: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
8023: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
8024: can only detect these really obvious
8025: cases.</p>
8026: </dd>
8027: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
8028: <dd><p>This stage should only be used if the package defines a
8029: <code class="literal">pre-configure</code> action itself, and the substitution must
8030: happen after that. Typical examples are packages that use the
8031: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
8032: script from
8033: <code class="filename">configure.ac</code>.</p></dd>
8034: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
8035: <dd><p>This stage is used to fix up any mistakes by the
8036: configure stage.</p></dd>
8037: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
8038: <dd><p>This stage should only be used for substitutions that are
8039: clearly related to building the package, not for fixing the
8040: configuration. Substitutions for pathnames (such as replacing
8041: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
8042: user names (such as replacing <code class="literal">@MY_USER@</code> with the
8043: actual username) belong in pre-configure or post-configure
8044: instead.</p></dd>
8045: <dt><span class="term"><code class="literal">post-build</code></span></dt>
8046: <dd>
8047: <p>Just as with pre-build, this stage should only be used
8048: for substitutions that are clearly related to building the package, not
8049: for fixing the configuration. Substitutions for pathnames (such as
8050: replacing <code class="filename">/usr/local</code> with
8051: <code class="literal">${PREFIX}</code>) or user names (such as replacing
8052: <code class="literal">@MY_USER@</code> with the actual username) belong in
8053: pre-configure or post-configure instead.</p>
8054: <p>A typical use is to update pkg-config files to include the rpath
8055: compiler options.</p>
8056: </dd>
8057: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8058: <dd><p>In general, the install phase should be as simple as
8059: possible. As with the pre-build and post-build stages, it should not be
8060: used to fix pathnames or user names, these belong in pre-configure
8061: instead. There are only few legitimate use cases for applying
8062: substitutions in this stage.</p></dd>
8063: </dl></div>
8064: </div>
8065: <div class="sect3">
8066: <div class="titlepage"><div><div><h4 class="title">
1.181 rillig 8067: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.180 rillig 8068: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8069: filename patterns. These patterns are relative to
8070: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8071: A typical example is:</p>
8072: <pre class="programlisting">
8073: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8074: </pre>
8075: <p>The above patterns, especially the last, are quite broad. The SUBST
8076: implementation checks that each filename pattern that is mentioned here
8077: has an effect. For example, if none of the
8078: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8079: and substituted, that filename pattern is redundant and should be left
1.181 rillig 8080: out. By default, the SUBST framework will complain with an error message.
8081: If the text to be substituted occurs in some of the files from a single
8082: pattern, but not in all of them, that is totally ok, and the SUBST
1.180 rillig 8083: framework will only print an INFO message for those files.</p>
8084: <p>If there is a good reason for having redundant filename patterns,
1.181 rillig 8085: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.180 rillig 8086: <p>Another popular way of choosing the files for the substitutions is
8087: via a shell command, like this:</p>
8088: <pre class="programlisting">
1.181 rillig 8089: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 8090: SUBST_FILES.path= ${C_FILES_CMD:sh}
8091: </pre>
8092: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8093: freely chosen and independent of the SUBST framework.</p>
8094: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8095: lists each file individually. Thereby chances are higher that there are
8096: filename patterns in which no substitution happens. Since the SUBST
8097: framework cannot know whether the filename patterns in
8098: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8099: Makefile (where any redundant filename pattern would be suspicious) or
8100: been generated by a shell command (in which redundant filename patterns
8101: are more likely and to be expected), it will complain about these
8102: redundant filename patterns. Therefore, SUBST blocks that use a shell
8103: command to generate the list of filename patterns often need to set
8104: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8105: </div>
8106: <div class="sect3">
8107: <div class="titlepage"><div><div><h4 class="title">
8108: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8109: <p>In most cases, the substitutions are given using one or more
1.207 leot 8110: <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.180 rillig 8111: <pre class="programlisting">
8112: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8113: </pre>
8114: <p>Each of the sed commands needs to be preceded by the
8115: <code class="literal">-e</code> option and should be specified on a line of its
8116: own, to avoid hiding short sed commands at the end of a line.</p>
8117: <p>Since the sed commands often contain shell metacharacters as the
8118: separator (the <code class="literal">|</code> in the above example), it is common
8119: to enclose them in single quotes.</p>
8120: <p>A common substitution is to replace placeholders of the form
8121: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8122: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8123: <pre class="programlisting">
8124: SUBST_VARS.path= PREFIX
8125: </pre>
8126: <p>This type of substitutions is typically done by the GNU configure
1.181 rillig 8127: scripts during the do-configure stage, but in some cases these need to be
8128: overridden. The same pattern is also used when a package defines patches
8129: that replace previously hard-coded paths like
8130: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8131: placeholder first, which then gets substituted by the actual
8132: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8133: cases, it works equally well to just use the SUBST framework to directly
8134: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8135: thereby omitting the intermediate patch file.</p>
1.180 rillig 8136: <p>If the above is not flexible enough, it is possible to not use sed
8137: at all for the substitution but to specify an entirely different command,
8138: like this:</p>
1.1 dsieger 8139: <pre class="programlisting">
1.180 rillig 8140: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8141: </pre>
8142: <p>This is used for the few remaining packages in which the
8143: distributed files use Windows-style line endings that need to be
8144: converted to UNIX-style line endings.</p>
8145: </div>
8146: <div class="sect3">
8147: <div class="titlepage"><div><div><h4 class="title">
8148: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8149: <p>When a SUBST block is applied during a package build, a message is
8150: logged. The default message is fine for most purposes but can be
8151: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8152: message.</p>
8153: </div>
1.1 dsieger 8154: </div>
8155: </div>
1.41 asau 8156: <div class="sect1">
1.1 dsieger 8157: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8158: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 8159: <div class="sect2">
1.1 dsieger 8160: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8161: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1 dsieger 8162: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8163: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8164: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8165: with the name of each file to download as an argument, expecting
8166: it to output the URL of the directory from which to download
1.207 leot 8167: it. <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/index.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.1 dsieger 8168: example of this usage.</p>
8169: <p>If the download can't be automated, because the user must
8170: submit personal information to apply for a password, or must pay
8171: for the source, or whatever, you can set
8172: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8173: displayed to the user before aborting the build. Example:</p>
8174: <pre class="programlisting">
8175: FETCH_MESSAGE= "Please download the files"
8176: FETCH_MESSAGE+= " "${DISTFILES:Q}
8177: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 8178: </pre>
1.1 dsieger 8179: </div>
1.41 asau 8180: <div class="sect2">
1.1 dsieger 8181: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8182: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1 dsieger 8183: <p>Sometimes authors of a software package make some
8184: modifications after the software was released, and they put up a
8185: new distfile without changing the package's version number. If a
8186: package is already in pkgsrc at that time, the checksum will
8187: no longer match. The contents of the new distfile should be
8188: compared against the old one before changing anything, to make
8189: sure the distfile was really updated on purpose, and that
8190: no trojan horse or so crept in.
8191: Please mention that the distfiles were compared and what was found
1.53 rodent 8192: in your commit message.</p>
1.109 wiz 8193: <p>Then, the correct way to work around this is to set
8194: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8195: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8196: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8197: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 8198: <code class="varname">PATCHFILES</code> for this package will be put in that
1.154 rillig 8199: subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="21.1.10. How to handle incrementing versions when fixing an existing package">Section 21.1.10, “How to handle incrementing versions when fixing an existing package”</a> for more details.) In case this
1.1 dsieger 8200: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 8201: including the <code class="filename">nbX</code> suffix) or a date stamp can
8202: be appended, like
8203: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169 rillig 8204: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8205: name does not contain a version and the distfile is apt to change. In
8206: cases where the likelihood of this is very small,
8207: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8208: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8209: distfile name changes, even if a package is being moved or
8210: renamed.</p>
1.53 rodent 8211: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8212: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8213: path in the filenames.
1.53 rodent 8214: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8215: Furthermore, a mail to the package's authors seems appropriate
8216: telling them that changing distfiles after releases without
8217: changing the file names is not good practice.</p>
8218: </div>
1.88 tnn 8219: <div class="sect2">
8220: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8221: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169 rillig 8222: <p>Helper methods exist for packages hosted on github.com which
8223: will often have distfile names that clash with other packages, for
8224: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8225: from below:</p>
1.88 tnn 8226: <div class="sect3">
8227: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8228: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169 rillig 8229: <p>If your distfile URL looks similar to
1.189 bacon 8230: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.169 rillig 8231: then you are packaging a tagged release.</p>
1.88 tnn 8232: <pre class="programlisting">
1.189 bacon 8233: DISTNAME= example-1.0
1.90 tnn 8234: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8235: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8236: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 8237: EXTRACT_SUFX= .zip
8238: </pre>
8239: </div>
8240: <div class="sect3">
8241: <div class="titlepage"><div><div><h4 class="title">
1.189 bacon 8242: <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>
8243: <p>If your distfile looks similar to
8244: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8245: release, then set the package version to 0.0.0.N, where N is the number
8246: of commits to the repository, and set GITHUB_TAG to the commit hash.
8247: This will (almost) ensure that the first tagged release will have a
8248: version greater than this one so that package upgrades will function
8249: properly.</p>
8250: <pre class="programlisting">
8251: DISTNAME= example-0.0.0.347
8252: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8253: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8254: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8255: </pre>
8256: </div>
8257: <div class="sect3">
8258: <div class="titlepage"><div><div><h4 class="title">
8259: <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>
8260: <p>If your distfile looks similar to
8261: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8262: then include the last release version and the commit count since that
8263: release in the package version and set GITHUB_TAG to the commit hash.
8264: The latest release and commit count are shown in the output of
8265: "git describe --tags":
8266: </p>
8267: <pre class="screen">
8268: # git clone https://github.com/username/example
8269: # cd example
8270: # git describe --tags
8271: 1.2.3-5-g988881a
8272: </pre>
1.88 tnn 8273: <pre class="programlisting">
1.189 bacon 8274: DISTNAME= example-1.2.3.5
8275: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8276: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8277: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 8278: </pre>
1.88 tnn 8279: </div>
8280: <div class="sect3">
8281: <div class="titlepage"><div><div><h4 class="title">
1.189 bacon 8282: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.169 rillig 8283: <p>If your distfile URL looks similar to
1.189 bacon 8284: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.169 rillig 8285: then you are packaging a release.</p>
1.88 tnn 8286: <pre class="programlisting">
8287: DISTNAME= offensive-1.6
1.90 tnn 8288: PKGNAME= ${DISTNAME:S/offensive/proper/}
8289: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8290: GITHUB_PROJECT= example
1.90 tnn 8291: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8292: EXTRACT_SUFX= .zip
1.111 sevan 8293: </pre>
1.88 tnn 8294: </div>
8295: </div>
1.1 dsieger 8296: </div>
1.41 asau 8297: <div class="sect1">
1.1 dsieger 8298: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8299: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8300: <div class="sect2">
1.1 dsieger 8301: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8302: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8303: <p>pkgsrc supports many different machines, with different
8304: object formats like a.out and ELF, and varying abilities to do
8305: shared library and dynamic loading at all. To accompany this,
8306: varying commands and options have to be passed to the
8307: compiler, linker, etc. to get the Right Thing, which can be
8308: pretty annoying especially if you don't have all the machines
8309: at your hand to test things. The
1.207 leot 8310: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/index.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.23 wiz 8311: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8312: both static and dynamic libraries from a set of source files,
8313: thus being platform-independent.</p>
8314: <p>Here's how to use libtool in a package in seven simple
8315: steps:</p>
1.23 wiz 8316: <div class="orderedlist"><ol class="orderedlist" type="1">
8317: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8318: Makefile.</p></li>
1.23 wiz 8319: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8320: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8321: add it to the definition of <code class="varname">CC</code>, if only
8322: libraries are being built in a given Makefile. This one command
8323: will build both PIC and non-PIC library objects, so you need not
8324: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8325: <li class="listitem">
1.1 dsieger 8326: <p>For the linking of the library, remove any
1.23 wiz 8327: <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
8328: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8329: <pre class="programlisting">
8330: ${LIBTOOL} --mode=link \
8331: ${CC} -o ${.TARGET:.a=.la} \
8332: ${OBJS:.o=.lo} \
8333: -rpath ${PREFIX}/lib \
8334: -version-info major:minor
1.111 sevan 8335: </pre>
1.1 dsieger 8336: <p>Note that the library is changed to have a
8337: <code class="filename">.la</code> extension, and the objects are
8338: changed to have a <code class="filename">.lo</code>
8339: extension. Change <code class="varname">OBJS</code> as
8340: necessary. This automatically creates all of the
8341: <code class="filename">.a</code>,
8342: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8343: necessary) in the build directory. Be sure to include
1.23 wiz 8344: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8345: minor are zero, as libtool will otherwise strip off the
8346: shared library version.</p>
8347: <p>From the libtool manual:</p>
8348: <pre class="programlisting">
8349: So, libtool library versions are described by three integers:
8350:
8351: CURRENT
8352: The most recent interface number that this library implements.
8353:
8354: REVISION
8355: The implementation number of the CURRENT interface.
8356:
8357: AGE
8358: The difference between the newest and oldest interfaces that
8359: this library implements. In other words, the library implements
8360: all the interface numbers in the range from number `CURRENT -
8361: AGE' to `CURRENT'.
8362:
8363: If two libraries have identical CURRENT and AGE numbers, then the
8364: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 8365: </pre>
1.23 wiz 8366: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8367: different results for a.out and ELF (excluding symlinks)
8368: in only one case. An ELF library of the form
1.23 wiz 8369: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8370: will have a symlink of
1.23 wiz 8371: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8372: on an a.out platform. This is handled
8373: automatically.</p>
1.23 wiz 8374: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8375: directory of the library being built.</p>
8376: <p>In the <code class="filename">PLIST</code>, include only the
8377: <code class="filename">.la</code> file, the other files will be
8378: added automatically.</p>
8379: </li>
1.23 wiz 8380: <li class="listitem">
1.1 dsieger 8381: <p>When linking shared object (<code class="filename">.so</code>)
1.207 leot 8382: 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.23 wiz 8383: shared libraries, use <span class="quote">“<span class="quote">-module
8384: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8385: tacked on.</p>
8386: <p>The <code class="filename">PLIST</code> file gets the
8387: <code class="filename">foo.so</code> entry.</p>
8388: </li>
1.23 wiz 8389: <li class="listitem">
1.1 dsieger 8390: <p>When linking programs that depend on these libraries
8391: <span class="emphasis"><em>before</em></span> they are installed, preface
1.207 leot 8392: 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.23 wiz 8393: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8394: libraries (static or shared), but please be aware that
8395: libtool will not allow you to specify a relative path in
1.23 wiz 8396: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8397: expects you to change that argument to be the
8398: <code class="filename">.la</code> file. e.g.</p>
8399: <pre class="programlisting">
8400: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 8401: </pre>
1.1 dsieger 8402: <p>should be changed to:</p>
8403: <pre class="programlisting">
8404: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 8405: </pre>
1.1 dsieger 8406: <p>and it will do the right thing with the libraries.</p>
8407: </li>
1.23 wiz 8408: <li class="listitem">
1.207 leot 8409: <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>
8410: 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.23 wiz 8411: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8412: <code class="filename">.la</code>. e.g.</p>
8413: <pre class="programlisting">
1.22 jakllsch 8414: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 8415: </pre>
1.1 dsieger 8416: <p>This will install the static <code class="filename">.a</code>,
8417: shared library, any needed symlinks, and run
1.207 leot 8418: <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.1 dsieger 8419: </li>
1.23 wiz 8420: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8421: the <code class="filename">.la</code>
8422: file (this is a change from previous behaviour).</p></li>
8423: </ol></div>
8424: </div>
1.41 asau 8425: <div class="sect2">
1.1 dsieger 8426: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8427: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8428: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8429: package Makefile. This will override the package's own libtool
8430: in most cases. For older libtool using packages, libtool is
8431: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8432: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8433: configure; find work*/ -name libtool</strong></span>.</p>
8434: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8435: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8436: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8437: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8438: package's libtool script(s), set it as appropriate.</p>
8439: <p>If you do not need <code class="filename">*.a</code> static
8440: libraries built and installed, then use
8441: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8442: <p>If your package makes use of the platform-independent library
8443: for loading dynamic shared objects, that comes with libtool
8444: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8445: <p>Some packages use libtool incorrectly so that the package
8446: may not work or build in some circumstances. Some of the more
8447: common errors are:</p>
1.41 asau 8448: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8449: <li class="listitem">
1.1 dsieger 8450: <p>The inclusion of a shared object (-module) as a dependent library in an
8451: executable or library. This in itself isn't a problem if one of two things
8452: has been done:</p>
1.23 wiz 8453: <div class="orderedlist"><ol class="orderedlist" type="1">
8454: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8455: <code class="filename">libfoo.la</code>, not
8456: <code class="filename">foo.la</code></p></li>
1.23 wiz 8457: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8458: </ol></div>
8459: </li>
1.23 wiz 8460: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8461: The function lt_dlinit() should be called and the macro
8462: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8463: executables.</p></li>
8464: </ul></div>
8465: </div>
1.41 asau 8466: <div class="sect2">
1.1 dsieger 8467: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8468: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8469: <p>If a package needs GNU autoconf or automake to be executed
1.223 nia 8470: to regenerate the
8471: <code class="filename">configure</code>
8472: script and <code class="filename">Makefile.in</code> makefile
8473: templates from <code class="filename">configure.ac</code> and
8474: <code class="filename">Makefile.am</code>,
8475: then they should be executed in a pre-configure target:</p>
1.1 dsieger 8476: <pre class="programlisting">
1.223 nia 8477: USE_TOOLS+= autoconf automake autoreconf
8478: GNU_CONFIGURE= yes
1.1 dsieger 8479: ...
8480:
8481: pre-configure:
1.223 nia 8482: set -e; cd ${WRKSRC} && autoreconf -fi
1.1 dsieger 8483: ...
1.111 sevan 8484: </pre>
1.223 nia 8485: <p>Packages which use GNU Automake will sometimes
8486: require GNU Make (<code class="literal">gmake</code> in
8487: <code class="varname">USE_TOOLS</code>),
8488: but not always. Note that autoreconf
8489: only needs to be executed if <code class="filename">configure.ac</code>
8490: or Makefiles are modified, or <code class="filename">configure</code>
8491: is not present.</p>
1.1 dsieger 8492: <p>There are times when the configure process makes
8493: additional changes to the generated files, which then causes
8494: the build process to try to re-execute the automake sequence.
8495: This is prevented by touching various files in the configure
8496: stage. If this causes problems with your package you can set
8497: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8498: Makefile.</p>
8499: </div>
1.223 nia 8500: <div class="sect2">
8501: <div class="titlepage"><div><div><h3 class="title">
8502: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
8503: <p>Packages using Meson to configure need to include:
8504:
8505: </p>
8506: <pre class="programlisting">
8507: .include "../../devel/meson/build.mk"
8508: </pre>
8509: <p>In nearly all cases (any program with dependencies),
8510: pkg-config needs to be added to
8511: <code class="varname">USE_TOOLS</code>. If the package installs
8512: translation files for non-English languages, also
8513: add msgfmt and xgettext:
8514:
8515: </p>
8516: <pre class="programlisting">
8517: USE_TOOLS+= pkg-config msgfmt xgettext
8518: </pre>
8519: <p>If any options need to be passed to Meson, use
8520: <code class="varname">MESON_ARGS</code> instead of
8521: <code class="varname">CONFIGURE_ARGS</code>:
8522:
8523: </p>
8524: <pre class="programlisting">
8525: MESON_ARGS+= -Dx11=false
8526: </pre>
8527: </div>
1.1 dsieger 8528: </div>
1.41 asau 8529: <div class="sect1">
1.1 dsieger 8530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8531: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41 asau 8532: <div class="sect2">
1.1 dsieger 8533: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8534: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.223 nia 8535: <p>Compilers for the C and C++ languages comes with
1.1 dsieger 8536: the NetBSD base system. By default, pkgsrc assumes that a package
8537: is written in C and will hide all other compilers (via the wrapper
1.184 rillig 8538: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8539: <p>To declare which language's compiler a package needs, set
8540: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.212 wiz 8541: currently are:
8542: </p>
8543: <pre class="programlisting">
8544: c99, c++, c++03, gnu++03, c++0x, gnu++0x, c++11, gnu++11,
8545: c++14, gnu++14, c++17, gnu++17, c++20, gnu++20, fortran,
8546: fortran77, java, objc, obj-c++, and ada.
8547: </pre>
8548: <p>
8549: (and any combination). The default is
1.23 wiz 8550: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8551: written in C++, usually need a C compiler for the configure
8552: phase.</p>
1.223 nia 8553: <p>To express a general requirement on a specific C or C++
8554: version, normally only <code class="varname">GCC_REQD</code> needs to be set.
8555: For example, GCC 7 includes support for C++17, so if the package uses
8556: C++17 it should specify:
8557:
8558: </p>
8559: <pre class="programlisting">
8560: GCC_REQD+= 7
8561: </pre>
8562: <p>Language variants like <code class="literal">c++11</code> for
8563: <code class="varname">USE_LANGUAGES</code> should only be specified
8564: if the package does not explicitly set <code class="literal">-std=...</code>
8565: when compiling (i.e. the package assumes the compiler defaults to
8566: C++11 or some other standard). This is usually a bug in the
8567: upstream build system.</p>
8568: <p>GCC version 5 includes support for C++14, while GCC 4.7 includes
8569: more-or-less complete support for C++11. For more information, consult
8570: <a class="ulink" href="https://gcc.gnu.org/projects/cxx-status.html" target="_top">GCC's own documentation on programming language support.</a></p>
1.1 dsieger 8571: </div>
1.41 asau 8572: <div class="sect2">
1.1 dsieger 8573: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8574: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 8575: <p>If a program is written in Java, use the Java framework in
8576: pkgsrc. The package must include
8577: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8578: provides the following variables:</p>
1.41 asau 8579: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8580: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8581: dependency on the JDK is added. If
1.23 wiz 8582: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8583: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8584: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8585: JDK.</p></li>
1.23 wiz 8586: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8587: a package needs a Java2 implementation. The supported values
1.23 wiz 8588: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8589: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8590: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8591: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8592: above. This variable is not set by default.</p></li>
1.24 wiz 8593: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8594: automatically set to the runtime location of the used Java
8595: implementation dependency. It may be used to set
8596: <code class="varname">JAVA_HOME</code> to a good value if the program
8597: needs this variable to be defined.
8598: </p></li>
1.1 dsieger 8599: </ul></div>
8600: </div>
1.41 asau 8601: <div class="sect2">
1.1 dsieger 8602: <div class="titlepage"><div><div><h3 class="title">
1.205 wiz 8603: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
8604: <p>If a program is written in Go and has any dependencies on
8605: other Go modules, have the package include
8606: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8607: <div class="orderedlist"><ol class="orderedlist" type="1">
8608: <li class="listitem"><p>Generate a list of those dependencies with
8609: <span class="command"><strong>make clean && make patch && make show-go-modules >
8610: go-modules.mk</strong></span>.</p></li>
1.223 nia 8611: <li class="listitem"><p>Prepend
8612: <code class="literal">.include "go-modules.mk"</code> to any other
8613: <code class="literal">.include</code>s.</p></li>
8614: <li class="listitem"><p>Incorporate these modules in
8615: <code class="filename">distinfo</code> with <span class="command"><strong>make
8616: makesum</strong></span>.</p></li>
8617: </ol></div>
8618: </div>
8619: <div class="sect2">
8620: <div class="titlepage"><div><div><h3 class="title">
8621: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
8622: <p>If a program is written in Rust and uses Cargo to build,
8623: have the package include
8624: <code class="filename">../../lang/rust/cargo.mk</code>.</p>
8625: <div class="orderedlist"><ol class="orderedlist" type="1">
8626: <li class="listitem"><p>Generate a list of those dependencies with
8627: <span class="command"><strong>make CARGO_ARGS="build --release" build &&
8628: make print-cargo-depends > cargo-depends.mk</strong></span>.</p></li>
8629: <li class="listitem"><p>Prepend
8630: <code class="literal">.include "cargo-depends.mk"</code> to any other
8631: <code class="literal">.include</code>s.</p></li>
1.205 wiz 8632: <li class="listitem"><p>Incorporate these modules in
8633: <code class="filename">distinfo</code> with <span class="command"><strong>make
8634: makesum</strong></span>.</p></li>
8635: </ol></div>
8636: </div>
8637: <div class="sect2">
8638: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8639: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.203 nia 8640: <p>If your package contains interpreted Perl scripts, add
1.23 wiz 8641: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8642: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8643: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8644: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8645: that you want adjusted. Every occurrence of
8646: <code class="filename">*/bin/perl</code> in a she-bang line will be
1.210 gutterid 8647: replaced with the full path to the Perl executable.</p>
8648: <p>If a particular version of Perl is needed, set the
1.1 dsieger 8649: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8650: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.203 nia 8651: <p>See <a class="xref" href="#perl-modules" title="21.6.6. Packages installing Perl modules">Section 21.6.6, “Packages installing Perl modules”</a> for information
1.210 gutterid 8652: about handling Perl modules.</p>
8653: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
8654: for the language now known as Raku.</p>
1.1 dsieger 8655: </div>
1.41 asau 8656: <div class="sect2">
1.1 dsieger 8657: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8658: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 8659: <p><code class="varname">REPLACE_SH</code>,
8660: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8661: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.225 gutterid 8662: she-bangs in files. Please use the appropriate one, preferring
8663: <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.74 wiz 8664: Each should contain a list of scripts, relative to
8665: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8666: occurrence of the matching shell in a she-bang line will be
8667: replaced with the full path to the shell executable.
1.40 wiz 8668: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8669: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8670: </div>
1.41 asau 8671: <div class="sect2">
1.40 wiz 8672: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8673: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.210 gutterid 8674: <p>There are further similar REPLACE variables available, e.g.,
8675: <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
8676: and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.211 gutterid 8677: noted above, have their actions defined centrally in
1.210 gutterid 8678: <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.211 gutterid 8679: languages define the actions of these variables within their own
8680: dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
8681: actioned in <code class="filename">lang/php/phpversion.mk</code>, and
8682: <code class="varname">REPLACE_PYTHON</code> is actioned in
1.210 gutterid 8683: <code class="filename">lang/python/application.mk</code>. For other languages,
8684: consult the mk files found within their specific directories (the
1.216 gutterid 8685: naming convention varies), or check the list found in
8686: <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.210 gutterid 8687: <p>Currently, special handling for other languages varies
1.1 dsieger 8688: in pkgsrc. If a compiler package provides a
8689: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8690: just add a (build) dependency on the appropriate compiler
8691: package.</p>
8692: </div>
8693: </div>
1.41 asau 8694: <div class="sect1">
1.1 dsieger 8695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8696: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8697: <p>The most common failures when building a package are that
8698: some platforms do not provide certain header files, functions or
8699: libraries, or they provide the functions in a library that the
8700: original package author didn't know. To work around this, you
8701: can rewrite the source code in most cases so that it does not
8702: use the missing functions or provides a replacement function.</p>
1.41 asau 8703: <div class="sect2">
1.1 dsieger 8704: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8705: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8706: <p>If a package already comes with a GNU configure script, the
8707: preferred way to fix the build failure is to change the
8708: configure script, not the code. In the other cases, you can
8709: utilize the C preprocessor, which defines certain macros
8710: depending on the operating system and hardware architecture it
8711: compiles for. These macros can be queried using for example
8712: <code class="varname">#if defined(__i386)</code>. Almost every operating
8713: system, hardware architecture and compiler has its own macro.
8714: For example, if the macros <code class="varname">__GNUC__</code>,
8715: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8716: are all defined, you know that you are using NetBSD on an i386
8717: compatible CPU, and your compiler is GCC.</p>
8718: <p>The list of the following macros for hardware and
8719: operating system depends on the compiler that is used. For
8720: example, if you want to conditionally compile code on Solaris,
8721: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8722: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8723: <div class="sect3">
1.1 dsieger 8724: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8725: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.223 nia 8726: <p>To distinguish between specific NetBSD versions,
8727: you should use the following code.</p>
8728: <pre class="programlisting">
8729: #ifdef __NetBSD__
8730: #include <sys/param.h>
8731: #if __NetBSD_Prereq__(9,99,17)
8732: /* use a newer feature */
8733: #else
8734: /* older code */
8735: #endif
8736: #endif
8737:
8738: #ifndef _WIN32
8739: /* Unix-like specific code */
8740: #endif
8741: </pre>
1.1 dsieger 8742: <p>To distinguish between 4.4 BSD-derived systems and the
8743: rest of the world, you should use the following code.</p>
8744: <pre class="programlisting">
8745: #include <sys/param.h>
8746: #if (defined(BSD) && BSD >= 199306)
8747: /* BSD-specific code goes here */
8748: #else
8749: /* non-BSD-specific code goes here */
8750: #endif
8751: </pre>
1.223 nia 8752: <p>You can also test for the following macros:</p>
1.1 dsieger 8753: <pre class="programlisting">
1.45 obache 8754: Cygwin __CYGWIN__
8755: DragonFly __DragonFly__
1.1 dsieger 8756: FreeBSD __FreeBSD__
1.45 obache 8757: Haiku __HAIKU__
1.1 dsieger 8758: Interix __INTERIX
8759: IRIX __sgi (TODO: get a definite source for this)
1.223 nia 8760: Linux __linux
1.83 dholland 8761: Mac OS X __APPLE__
1.45 obache 8762: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8763: Minix3 __minix
1.1 dsieger 8764: NetBSD __NetBSD__
8765: OpenBSD __OpenBSD__
8766: Solaris sun, __sun
8767: </pre>
8768: </div>
1.41 asau 8769: <div class="sect3">
1.1 dsieger 8770: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8771: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1 dsieger 8772: <pre class="programlisting">
8773: i386 i386, __i386, __i386__
1.223 nia 8774: x86-64 __amd64__, __x86_64__
8775: ARM __arm__
1.1 dsieger 8776: MIPS __mips
8777: SPARC sparc, __sparc
1.223 nia 8778: PowerPC __powerpc
1.1 dsieger 8779: </pre>
8780: </div>
1.41 asau 8781: <div class="sect3">
1.1 dsieger 8782: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8783: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1 dsieger 8784: <pre class="programlisting">
8785: GCC __GNUC__ (major version), __GNUC_MINOR__
8786: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8787: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8788: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8789: </pre>
8790: </div>
8791: </div>
1.41 asau 8792: <div class="sect2">
1.1 dsieger 8793: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8794: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8795: <p>Some source files trigger bugs in the compiler, based on
8796: combinations of compiler version and architecture and almost
8797: always relation to optimisation being enabled. Common symptoms
8798: are gcc internal errors or never finishing compiling a
8799: file.</p>
8800: <p>Typically, a workaround involves testing the
8801: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8802: optimisation for that combination of file,
1.87 tnn 8803: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8804: <p>This used to be a big problem in the past, but is rarely
8805: needed now as compiler technology has matured. If you still need
8806: to add a compiler specific workaround, please do so in the file
8807: <code class="filename">hacks.mk</code> and describe the symptom and
8808: compiler version as detailed as possible.</p>
1.1 dsieger 8809: </div>
1.41 asau 8810: <div class="sect2">
1.1 dsieger 8811: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8812: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8813: <p>Compilation sometimes fails with an error message like this:</p>
8814: <pre class="programlisting">
8815: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8816: fatal error: pango/pango.h: No such file or directory
8817: </pre>
8818: <p>The proper way to fix this problem depends on the type of the
8819: header, which is described in the following sections.</p>
8820: <div class="sect3">
8821: <div class="titlepage"><div><div><h4 class="title">
8822: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8823: <p>If the header name looks like it comes from a different package,
8824: that other package should be included via the buildlink3
8825: framework.</p>
8826: <p>First, look whether the header is somewhere in the buildlink3
8827: directory below <code class="varname">WRKDIR</code>. In the above case of
8828: the missing Pango header:</p>
8829: <pre class="programlisting">
8830: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8831: </pre>
8832: <p>In the case of Pango, the output is:</p>
8833: <pre class="programlisting">
8834: work/.buildlink/include/pango-1.0/pango/pango.h
8835: </pre>
8836: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8837: in the <code class="filename">.buildlink</code> directory, it would have been
8838: found automatically. There is an extra <code class="filename">pango-1.0</code>
8839: path component though, which means that the compiler command line must
8840: contain an option of the form
8841: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8842: most cases this option is generated by the configure script, which can be examined using:</p>
8843: <pre class="programlisting">
8844: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8845: -I/usr/pkg/include/pango-1.0
8846: -I/usr/pkg/include/pango-1.0
8847: -I/usr/pkg/include/pango-1.0
8848: -I/usr/pkg/include/pango-1.0
8849: -I/usr/pkg/include/pango-1.0
8850: </pre>
8851: <p>This looks good. These options are transformed by the buildlink
8852: wrapper to refer to the correct path inside
8853: <code class="filename">work/.buildlink</code>.</p>
8854: <p>Since the compilation fails though, examine the compiler command
8855: lines in <code class="filename">work/.work.log</code> to see whether the
8856: <code class="literal">-I</code> option is included in the particular command
8857: line.</p>
8858: <p>To further analyze the situation, run <span class="command"><strong>bmake
8859: build-env</strong></span>, which sets up an interactive, realistic environment
8860: including all the pkgsrc wrapper commands and environment variables. From
8861: there, try to compile some simple example programs that use the
8862: header.</p>
8863: </div>
8864: <div class="sect3">
8865: <div class="titlepage"><div><div><h4 class="title">
8866: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8867: <p>If the name of the header seems to come from the package itself,
8868: and if the build is run with parallel jobs, the package may have some
8869: undeclared dependencies between the <code class="filename">.c</code> and the
8870: <code class="filename">.h</code> files, and a C file is compiled before its
8871: required header is generated.</p>
8872: <p>To see whether the build runs with parallel jobs, run
8873: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8874: like this:</p>
8875: <pre class="programlisting">
8876: usr MAKE_JOBS= 7
8877: pkg MAKE_JOBS_SAFE # undefined
8878: def _MAKE_JOBS_N= 7
8879: </pre>
8880: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8881: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8882: package could have disabled parallel builds by setting
8883: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8884: in this case it hasn't.</p>
8885: <p>To see whether the build failure is caused by parallel builds,
8886: first save the exact error message and a bit of context, maybe you need
8887: it later for reporting a bug. Next, run:</p>
8888: <pre class="programlisting">
8889: MAKE_JOBS_SAFE=no bmake clean build
8890: </pre>
8891: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8892: report</a> against the pkgsrc package, including the exact error
8893: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8894: </div>
1.173 rillig 8895: <div class="sect3">
8896: <div class="titlepage"><div><div><h4 class="title">
8897: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
8898: <p>Pkgsrc does not work reliably if any of
8899: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
8900: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
8901: bootstrap program prevents installing pkgsrc in symlink-based
8902: directories. Existing pkgsrc installations are not checked for symlinks
8903: though.</p>
8904: <p>The "No such file or directory" error messages are a typical
8905: symptom of symlinks, and it's quite difficult to find out that this is
8906: the actual cause.</p>
8907: </div>
8908: <div class="sect3">
8909: <div class="titlepage"><div><div><h4 class="title">
8910: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
8911: <p>When building a hierarchy of packages, it may happen that one
8912: package is built and then pkgsrc is updated. This situation can provoke
8913: various hard to diagnose build errors. To clean up the situation:</p>
8914: <pre class="programlisting">
1.223 nia 8915: <code class="prompt">$</code> (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.173 rillig 8916: </pre>
1.223 nia 8917: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
8918: prevent running this command in the wrong directory.)</p>
1.173 rillig 8919: <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
8920: that directory as well.</p>
8921: </div>
8922: <div class="sect3">
8923: <div class="titlepage"><div><div><h4 class="title">
8924: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
8925: <p>On platforms other than BSD, third-party packages are installed in
8926: <code class="filename">/usr/include</code>, together with the base system. This
8927: means that pkgsrc cannot distinguish between headers provided by the base
8928: system (which it needs) and headers from third-party packages (which are
8929: often included in pkgsrc as well). This can lead to subtle version
8930: mismatches.</p>
8931: <p>In pkgsrc installations that have been active for several years, it
8932: may happen that some files are manually deleted. To exclude this unlikely
8933: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
8934: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
8935: check/fix dependencies.</p>
8936: <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>
8937: for contact information. Be prepared to describe what you have tried so
8938: far and what any error messages were.</p>
8939: </div>
1.172 rillig 8940: </div>
8941: <div class="sect2">
8942: <div class="titlepage"><div><div><h3 class="title">
8943: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 8944: </h3></div></div></div>
1.1 dsieger 8945: <p>This error message often means that a package did not
8946: link to a shared library it needs. The following functions are
8947: known to cause this error message over and over.</p>
8948: <div class="informaltable">
1.106 tnn 8949: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 8950: <colgroup>
8951: <col>
8952: <col>
8953: <col>
8954: </colgroup>
8955: <thead><tr>
8956: <th>Function</th>
8957: <th>Library</th>
8958: <th>Affected platforms</th>
8959: </tr></thead>
8960: <tbody>
8961: <tr>
8962: <td>accept, bind, connect</td>
8963: <td>-lsocket</td>
8964: <td>Solaris</td>
8965: </tr>
8966: <tr>
8967: <td>crypt</td>
8968: <td>-lcrypt</td>
8969: <td>DragonFly, NetBSD</td>
8970: </tr>
8971: <tr>
8972: <td>dlopen, dlsym</td>
8973: <td>-ldl</td>
8974: <td>Linux</td>
8975: </tr>
8976: <tr>
8977: <td>gethost*</td>
8978: <td>-lnsl</td>
8979: <td>Solaris</td>
8980: </tr>
8981: <tr>
8982: <td>inet_aton</td>
8983: <td>-lresolv</td>
8984: <td>Solaris</td>
8985: </tr>
8986: <tr>
8987: <td>nanosleep, sem_*, timer_*</td>
8988: <td>-lrt</td>
8989: <td>Solaris</td>
8990: </tr>
8991: <tr>
8992: <td>openpty</td>
8993: <td>-lutil</td>
8994: <td>Linux</td>
8995: </tr>
8996: </tbody>
8997: </table>
8998: </div>
1.223 nia 8999: <p>To fix these linker errors, it is often sufficient to add
1.1 dsieger 9000: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
9001: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.223 nia 9002: <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.1 dsieger 9003: bmake</strong></span>.</p>
1.41 asau 9004: <div class="sect3">
1.1 dsieger 9005: <div class="titlepage"><div><div><h4 class="title">
1.223 nia 9006: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.1 dsieger 9007: <p>When you are using the SunPro compiler, there is another
9008: possibility. That compiler cannot handle the following code:</p>
9009: <pre class="programlisting">
9010: extern int extern_func(int);
9011:
9012: static inline int
9013: inline_func(int x)
9014: {
9015: return extern_func(x);
9016: }
9017:
9018: int main(void)
9019: {
9020: return 0;
9021: }
9022: </pre>
9023: <p>It generates the code for <code class="function">inline_func</code> even if
9024: that function is never used. This code then refers to
9025: <code class="function">extern_func</code>, which can usually not be resolved. To
9026: solve this problem you can try to tell the package to disable inlining
9027: of functions.</p>
9028: </div>
1.228 gutterid 9029: <div class="sect3">
9030: <div class="titlepage"><div><div><h4 class="title">
9031: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
9032: <p>When building for older machine architectures (e.g., i386, PowerPC),
9033: builds may fail because the package expects modern 64-bit atomic functions
9034: which the underlying hardware either doesn't support, or will only support
9035: with specific compiler flags. This is generally handled via inclusion of
9036: mk/atomic64.mk.</p>
9037: </div>
1.1 dsieger 9038: </div>
1.41 asau 9039: <div class="sect2">
1.1 dsieger 9040: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 9041: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1 dsieger 9042: <p>Sometimes packages fail to build because the compiler runs
9043: into an operating system specific soft limit. With the
9044: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.223 nia 9045: to unlimit the resources. The allowed values are any combination of
9046: <span class="quote">“<span class="quote">cputime</span>”</span>,
9047: <span class="quote">“<span class="quote">datasize</span>”</span>,
9048: <span class="quote">“<span class="quote">memorysize</span>”</span>,
9049: <span class="quote">“<span class="quote">stacksize</span>”</span> and
9050: <span class="quote">“<span class="quote">virtualsize</span>”</span>.
1.1 dsieger 9051: Setting this variable is similar to running the shell builtin
1.10 hubertf 9052: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 9053: segment size or maximum stack size of a process, respectively, to
9054: their hard limits.</p>
9055: </div>
9056: </div>
1.41 asau 9057: <div class="sect1">
1.1 dsieger 9058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9059: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 9060: <div class="sect2">
1.1 dsieger 9061: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9062: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 9063: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 9064: with some operating systems cannot create more than one
9065: directory at a time. As such, you should call
9066: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
9067: <pre class="programlisting">
9068: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
9069: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 9070: </pre>
1.223 nia 9071: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
9072: directly, you can also append <span class="quote">“<span class="quote"><code class="literal">dir1
9073: dir2</code></span>”</span> to the <code class="varname">INSTALLATION_DIRS</code>
9074: variable, which will automatically do the right thing.</p>
1.1 dsieger 9075: </div>
1.41 asau 9076: <div class="sect2">
1.1 dsieger 9077: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9078: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 9079: <p>In general, documentation should be installed into
9080: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.223 nia 9081: <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.1 dsieger 9082: includes the version number of the package).</p>
9083: <p>Many modern packages using GNU autoconf allow to set the
9084: directory where HTML documentation is installed with the
1.223 nia 9085: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag is
9086: needed because otherwise the documentation ends up in
9087: <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
9088: pkgsrc, the HTML documentation should go into the package-specific
9089: directory, just like any other documentation.</p>
1.1 dsieger 9090: <p>An exception to the above is that library API documentation
1.207 leot 9091: generated with the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/index.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.1 dsieger 9092: browsers (devhelp) should be left at their default location, which
9093: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
9094: documentation can be recognized from files ending in
9095: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
9096: (It is also acceptable to install such files in
9097: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
9098: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
9099: <code class="filename">.devhelp*</code> file must be directly in that
9100: directory then, no additional subdirectory level is allowed in
9101: this case. This is usually achieved by using
1.23 wiz 9102: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 9103: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
9104: though.)</p>
9105: </div>
1.41 asau 9106: <div class="sect2">
1.1 dsieger 9107: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9108: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 9109: <p>Certain packages, most of them in the games category, install
9110: a score file that allows all users on the system to record their
9111: highscores. In order for this to work, the binaries need to be
9112: installed setgid and the score files owned by the appropriate
1.35 wiz 9113: group and/or owner (traditionally the "games" user/group). Set
9114: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 9115: following variables, documented in more detail in
9116: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 9117: behaviour: <code class="varname">GAMEDATAMODE</code>,
9118: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 9119: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
9120: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
9121: <code class="varname">GAMEDATA_PERMS</code> and
9122: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
9123: <p>An example that illustrates some of the variables described above is
9124: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
9125: used to properly set directory permissions of the directory where the
9126: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
9127: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
9128: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
9129: binary:</p>
9130: <pre class="programlisting">
1.112 rillig 9131: USE_GAMESGROUP= yes
1.100 leot 9132:
1.112 rillig 9133: BUILD_DEFS+= VARBASE
1.100 leot 9134:
1.112 rillig 9135: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
9136: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
9137: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 9138: </pre>
1.100 leot 9139: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
9140: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
9141: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
9142: needed to be accessed by setgid games and
9143: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 9144: <p>A package should therefore never hard code file ownership or
1.100 leot 9145: access permissions but rely on <code class="varname">*_PERMS</code> as described above
9146: or alternatively on <code class="varname">INSTALL_GAME</code>,
9147: <code class="varname">INSTALL_GAME_DATA</code> and
9148: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 9149: </div>
1.41 asau 9150: <div class="sect2">
1.1 dsieger 9151: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9152: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 9153: <p><code class="varname">DESTDIR</code> support means that a package
9154: installs into a staging directory, not the final location of the
9155: files. Then a binary package is created which can be used for
9156: installation as usual. There are two ways: Either the package must
1.23 wiz 9157: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9158: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 9159: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9160: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 9161: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
9162: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 9163: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9164: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 9165: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9166: the inclusion.</p></li>
1.23 wiz 9167: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 9168: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 9169: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 9170: automatically. Many manual rules and pre/post-install often are
9171: incorrect; fix them.</p></li>
1.23 wiz 9172: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 9173: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 9174: <li class="listitem"><p>In general, packages should support
1.4 rillig 9175: <code class="varname">UNPRIVILEGED</code> to be able to use
9176: DESTDIR.</p></li>
9177: </ul></div>
9178: </div>
1.41 asau 9179: <div class="sect2">
1.4 rillig 9180: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9181: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 9182: <p>Your package may also contain scripts with hardcoded paths to
1.203 nia 9183: other interpreters besides (or as well as) Perl. To correct the
1.1 dsieger 9184: full pathname to the script interpreter, you need to set the
9185: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 9186: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 9187: <pre class="programlisting">
9188: REPLACE_INTERPRETER+= tcl
9189: REPLACE.tcl.old= .*/bin/tclsh
9190: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9191: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9192: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 9193: </pre>
1.1 dsieger 9194: </div>
1.41 asau 9195: <div class="sect2">
1.1 dsieger 9196: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9197: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.1 dsieger 9198: <p>Makefiles of packages providing perl5 modules should include
9199: the Makefile fragment
9200: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 9201: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 9202: configuration for such modules as well as various hooks to tune
9203: this configuration. See comments in this file for
9204: details.</p>
9205: <p>Perl5 modules will install into different places depending
9206: on the version of perl used during the build process. To
9207: address this, pkgsrc will append lines to the
9208: <code class="filename">PLIST</code> corresponding to the files listed in
9209: the installed <code class="filename">.packlist</code> file generated by
9210: most perl5 modules. This is invoked by defining
9211: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 9212: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9213: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9214: e.g.:</p>
1.1 dsieger 9215: <pre class="programlisting">
1.47 wiz 9216: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 9217: </pre>
1.47 wiz 9218: <p>The perl5 config variables
9219: <code class="varname">installarchlib</code>,
9220: <code class="varname">installscript</code>,
9221: <code class="varname">installvendorbin</code>,
9222: <code class="varname">installvendorscript</code>,
9223: <code class="varname">installvendorarch</code>,
9224: <code class="varname">installvendorlib</code>,
9225: <code class="varname">installvendorman1dir</code>, and
9226: <code class="varname">installvendorman3dir</code> represent those
9227: locations in which components of perl5 modules may be installed,
9228: provided as variable with uppercase and prefixed with
9229: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9230: and may be used by perl5 packages that don't have a packlist.
9231: These variables are also substituted for in the
9232: <code class="filename">PLIST</code> as uppercase prefixed with
9233: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 9234: </div>
1.41 asau 9235: <div class="sect2">
1.1 dsieger 9236: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9237: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 9238: <p>Some packages install info files or use the
1.23 wiz 9239: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 9240: commands. <code class="varname">INFO_FILES</code> should be defined in
9241: the package Makefile so that <code class="filename">INSTALL</code> and
9242: <code class="filename">DEINSTALL</code> scripts will be generated to
9243: handle registration of the info files in the Info directory
1.23 wiz 9244: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 9245: files registration is either provided by the system, or by a
9246: special purpose package automatically added as dependency if
9247: needed.</p>
9248: <p><code class="varname">PKGINFODIR</code> is the directory under
9249: <code class="filename">${PREFIX}</code> where info files are primarily
9250: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 9251: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 9252: <p>The info files for the package should be listed in the
9253: package <code class="filename">PLIST</code>; however any split info files
9254: need not be listed.</p>
1.23 wiz 9255: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9256: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 9257: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 9258: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 9259: should be noted with the <code class="varname">TEXINFO_REQD</code>
9260: variable in the package <code class="filename">Makefile</code>. By
9261: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 9262: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 9263: does not match the required minimum, a build dependency on the
1.207 leot 9264: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/index.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.1 dsieger 9265: be added automatically.</p>
9266: <p>The build and installation process of the software provided
9267: by the package should not use the
1.10 hubertf 9268: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 9269: info files is the task of the package
9270: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 9271: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 9272: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 9273: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9274: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 9275: in <code class="varname">PATH</code>.</p>
1.10 hubertf 9276: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 9277: no effect except the logging of a message. The script overriding
1.10 hubertf 9278: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 9279: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 9280: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 9281: </div>
1.41 asau 9282: <div class="sect2">
1.1 dsieger 9283: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9284: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9285: <p>All packages that install manual pages should install them
9286: into the same directory, so that there is one common place to look
9287: for them. In pkgsrc, this place is
9288: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9289: should be used in packages. The default for
9290: <code class="varname">PKGMANDIR</code> is
1.23 wiz 9291: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9292: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 9293: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9294: <h3 class="title">Note</h3>
9295: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9296: is far from complete.</p>
9297: </div>
9298: <p>The <code class="filename">PLIST</code> files can just use
9299: <code class="filename">man/</code> as the top level directory for the man
9300: page file entries, and the pkgsrc framework will convert as
9301: needed. In all other places, the correct
9302: <code class="varname">PKGMANDIR</code> must be used.</p>
9303: <p>Packages that are
9304: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 9305: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 9306: <code class="filename">./configure</code>
9307: --mandir switch to set where the man pages should be installed.
9308: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9309: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9310: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9311: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 9312: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 9313: Or if the <code class="filename">./configure</code> script uses
9314: a non-standard use of --mandir, you can set
9315: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.184 rillig 9316: <p>See <a class="xref" href="#manpage-compression" title="19.5. Man page compression">Section 19.5, “Man page compression”</a> for
1.1 dsieger 9317: information on installation of compressed manual pages.</p>
9318: </div>
1.41 asau 9319: <div class="sect2">
1.1 dsieger 9320: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9321: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9322: <p>If a package installs font files, you will need to rebuild
9323: the fonts database in the directory where they get installed at
9324: installation and deinstallation time. This can be automatically
9325: done by using the pkginstall framework.</p>
9326: <p>You can list the directories where fonts are installed in the
9327: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9328: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 9329: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.1 dsieger 9330: Also make sure that the database file
9331: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9332: <p>Note that you should not create new directories for fonts;
9333: instead use the standard ones to avoid that the user needs to
9334: manually configure his X server to find them.</p>
9335: </div>
1.41 asau 9336: <div class="sect2">
1.1 dsieger 9337: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9338: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9339: <p>If a package installs SGML or XML data files that need to be
9340: registered in system-wide catalogs (like DTDs, sub-catalogs,
9341: etc.), you need to take some extra steps:</p>
1.23 wiz 9342: <div class="orderedlist"><ol class="orderedlist" type="1">
9343: <li class="listitem"><p>Include
1.1 dsieger 9344: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9345: your <code class="filename">Makefile</code>, which takes care of
9346: registering those files in system-wide catalogs at
9347: installation and deinstallation time.</p></li>
1.23 wiz 9348: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9349: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9350: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9351: any XML catalogs installed by the package.</p></li>
1.23 wiz 9352: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9353: to be added to the SGML catalog. These come in groups of
9354: three strings; see xmlcatmgr(1) for more information
9355: (specifically, arguments recognized by the 'add' action).
9356: Note that you will normally not use this variable.</p></li>
1.23 wiz 9357: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9358: to be added to the XML catalog. These come in groups of three
9359: strings; see xmlcatmgr(1) for more information (specifically,
9360: arguments recognized by the 'add' action). Note that you will
9361: normally not use this variable.</p></li>
9362: </ol></div>
9363: </div>
1.41 asau 9364: <div class="sect2">
1.1 dsieger 9365: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9366: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9367: <p>If a package provides extensions to the MIME database by
9368: installing <code class="filename">.xml</code> files inside
9369: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9370: need to take some extra steps to ensure that the database is kept
9371: consistent with respect to these new files:</p>
1.23 wiz 9372: <div class="orderedlist"><ol class="orderedlist" type="1">
9373: <li class="listitem"><p>Include
1.1 dsieger 9374: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9375: (avoid using the <code class="filename">buildlink3.mk</code> file from
9376: this same directory, which is reserved for inclusion from
9377: other <code class="filename">buildlink3.mk</code> files). It takes
9378: care of rebuilding the MIME database at installation and
9379: deinstallation time, and disallows any access to it directly
9380: from the package.</p></li>
1.23 wiz 9381: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9382: <code class="filename">share/mime</code> directory,
9383: <span class="emphasis"><em>except</em></span> for files saved under
9384: <code class="filename">share/mime/packages</code>. The former are
9385: handled automatically by
9386: the update-mime-database program, but the latter are
9387: package-dependent and must be removed by the package that
9388: installed them in the first place.</p></li>
1.23 wiz 9389: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9390: from the PLIST. They will be handled by the shared-mime-info
9391: package.</p></li>
9392: </ol></div>
9393: </div>
1.41 asau 9394: <div class="sect2">
1.1 dsieger 9395: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9396: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.1 dsieger 9397: <p>If a package uses intltool during its build, add
9398: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9399: which forces it to use the intltool package provided by pkgsrc,
9400: instead of the one bundled with the distribution file.</p>
9401: <p>This tracks intltool's build-time dependencies and uses the
9402: latest available version; this way, the package benefits of any
9403: bug fixes that may have appeared since it was released.</p>
9404: </div>
1.41 asau 9405: <div class="sect2">
1.1 dsieger 9406: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9407: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9408: <p>If a package contains a rc.d script, it won't be copied into
9409: the startup directory by default, but you can enable it, by adding
9410: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9411: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9412: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9413: it will automatically remove the scripts when the package is
9414: deinstalled.</p>
9415: </div>
1.41 asau 9416: <div class="sect2">
1.1 dsieger 9417: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9418: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9419: <p>If a package installs TeX packages into the texmf tree,
9420: the <code class="filename">ls-R</code> database of the tree needs to be
9421: updated.</p>
1.41 asau 9422: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9423: <h3 class="title">Note</h3>
1.22 jakllsch 9424: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9425: packages should install files
1.22 jakllsch 9426: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9427: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9428: </div>
1.23 wiz 9429: <div class="orderedlist"><ol class="orderedlist" type="1">
9430: <li class="listitem"><p>Include
1.22 jakllsch 9431: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9432: takes care of rebuilding the <code class="filename">ls-R</code>
9433: database at installation and deinstallation time.</p></li>
1.23 wiz 9434: <li class="listitem">
1.1 dsieger 9435: <p>If your package installs files into a texmf
9436: tree other than the one
1.22 jakllsch 9437: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9438: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9439: trees that need database update.</p>
9440: <p>If your package also installs font map files that need
1.10 hubertf 9441: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9442: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9443: set <code class="varname">TEX_MAP_FILES</code> and/or
9444: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9445: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9446: be run automatically at installation/deinstallation to
9447: enable/disable font map files for TeX output
9448: drivers.</p>
9449: </li>
1.23 wiz 9450: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9451: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9452: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9453: </ol></div>
9454: </div>
1.41 asau 9455: <div class="sect2">
1.1 dsieger 9456: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9457: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.1 dsieger 9458: emulation</h3></div></div></div>
9459: <p>There are some packages that provide libraries and
9460: executables for running binaries from a one operating system
9461: on a different one (if the latter supports it). One example
9462: is running Linux binaries on NetBSD.</p>
1.207 leot 9463: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/index.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.1 dsieger 9464: helps in extracting and packaging Linux rpm packages.</p>
9465: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9466: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9467: if all libraries for each installed executable can be found by
9468: the dynamic linker. Since the standard dynamic linker is run,
9469: this fails for emulation packages, because the libraries used
9470: by the emulation are not in the standard directories.</p>
9471: </div>
1.184 rillig 9472: <div class="sect2">
9473: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9474: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.184 rillig 9475: <p>If a package installs images under the
9476: <code class="filename">share/icons/hicolor</code> and/or updates the
9477: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9478: database, you need to take some extra steps to make sure that the
9479: shared theme directory is handled appropriately and that the cache
9480: database is rebuilt:</p>
9481: <div class="orderedlist"><ol class="orderedlist" type="1">
9482: <li class="listitem"><p>Include
9483: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9484: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9485: entry that refers to the theme cache.</p></li>
9486: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9487: directories from the <code class="filename">share/icons/hicolor</code>
9488: hierarchy because they will be handled automatically.</p></li>
9489: </ol></div>
9490: <p>The best way to verify that the PLIST is correct with
9491: respect to the last two points is to regenerate it using
9492: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9493: </div>
9494: <div class="sect2">
9495: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9496: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.184 rillig 9497: <p>If a package installs <code class="filename">.desktop</code> files
9498: under <code class="filename">share/applications</code> and these include
9499: MIME information (MimeType key), you need to take extra steps to
9500: ensure that they are registered into the MIME database:</p>
9501: <div class="orderedlist"><ol class="orderedlist" type="1">
9502: <li class="listitem"><p>Include
9503: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9504: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9505: <code class="filename">share/applications/mimeinfo.cache</code> file.
9506: It will be handled automatically.</p></li>
9507: </ol></div>
9508: <p>The best way to verify that the PLIST is correct with
9509: respect to the last point is to regenerate it using <span class="command"><strong>make
9510: print-PLIST</strong></span>.</p>
9511: </div>
9512: </div>
9513: <div class="sect1">
9514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9515: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9516: <p>In some cases one does not have the time to solve a problem
9517: immediately. In this case, one can plainly mark a package as broken. For
9518: this, one just sets the variable <code class="varname">BROKEN</code> to the
9519: reason why the package is broken (similar to the
9520: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9521: the package will immediately be shown this message, and the build
9522: will not be even tried.</p>
9523: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9524: intervals.</p>
9525: </div>
9526: </div>
9527: <div class="chapter">
9528: <div class="titlepage"><div><div><h2 class="title">
9529: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9530: <div class="toc">
9531: <p><b>Table of Contents</b></p>
9532: <dl class="toc">
9533: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9534: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9535: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9536: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9537: </dl>
9538: </div>
9539: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9540: site</a>:</p>
9541: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9542: environment, an intuitive and attractive desktop for users, and the
9543: GNOME development platform, an extensive framework for building
9544: applications that integrate into the rest of the desktop.</p></blockquote></div>
9545: <p>pkgsrc provides a seamless way to automatically build and install
9546: a complete GNOME environment <span class="emphasis"><em>under many different
9547: platforms</em></span>. We can say with confidence that pkgsrc is one of
9548: the most advanced build and packaging systems for GNOME due to its
9549: included technologies buildlink3, the wrappers and tools framework and
9550: automatic configuration file management. Lots of efforts are put into
9551: achieving a completely clean deinstallation of installed software
9552: components.</p>
9553: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9554: the above also means that great efforts are put into making GNOME work
1.201 cirnatda 9555: under this operating system.</p>
1.184 rillig 9556: <p>This chapter is aimed at pkgsrc developers and other people
9557: interested in helping our GNOME porting and packaging efforts. It
9558: provides instructions on how to manage the existing packages and some
9559: important information regarding their internals.</p>
9560: <div class="sect1">
9561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9562: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9563: <p>pkgsrc includes three GNOME-related meta packages:</p>
9564: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 9565: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/index.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.184 rillig 9566: the core GNOME desktop environment. It only includes the necessary
9567: bits to get it to boot correctly, although it may lack important
9568: functionality for daily operation. The idea behind this package is
9569: to let end users build their own configurations on top of this one,
9570: first installing this meta package to achieve a functional setup and
9571: then adding individual applications.</p></li>
1.207 leot 9572: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.184 rillig 9573: complete installation of the GNOME platform and desktop as defined
9574: by the GNOME project; this is based on the components distributed in
9575: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9576: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9577: official FTP server. Developer-only tools found in those
9578: directories are not installed unless required by some other
9579: component to work properly. Similarly, packages from the bindings
9580: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9581: in unless required as a dependency for an end-user component. This
1.207 leot 9582: 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>
9583: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.184 rillig 9584: Installs all the tools required to build a GNOME component when
9585: fetched from the CVS repository. These are required to let the
9586: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9587: </ul></div>
9588: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9589: sorted in a way that eases updates: a package may depend on other
9590: packages listed before it but not on any listed after it. It is very
9591: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9592: change it to alphabetical sorting!</em></span></p>
9593: </div>
9594: <div class="sect1">
9595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9596: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9597: <p>Almost all GNOME applications are written in C and use a common
9598: set of tools as their build system. Things get different with the new
9599: bindings to other languages (such as Python), but the following will
9600: give you a general idea on the minimum required tools:</p>
9601: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9602: <li class="listitem">
9603: <p>Almost all GNOME applications use the GNU Autotools as their
9604: build system. As a general rule you will need to tell this to your
9605: package:</p>
9606: <pre class="programlisting">
1.223 nia 9607: GNU_CONFIGURE= yes
9608: USE_LIBTOOL= yes
9609: USE_TOOLS+= gmake
1.184 rillig 9610: </pre>
9611: </li>
9612: <li class="listitem">
9613: <p>If the package uses pkg-config to detect dependencies, add this
9614: tool to the list of required utilities:</p>
9615: <pre class="programlisting">
1.223 nia 9616: USE_TOOLS+= pkg-config
1.184 rillig 9617: </pre>
1.207 leot 9618: <p>Also use <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/index.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.184 rillig 9619: the end of the build process to ensure that you did not miss to
9620: specify any dependency in your package and that the version
9621: requirements are all correct.</p>
9622: </li>
9623: <li class="listitem"><p>If the package uses intltool, be sure to add
9624: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9625: to handle dependencies and to force the package to use the latest
9626: available version.</p></li>
9627: <li class="listitem">
9628: <p>If the package uses gtk-doc (a documentation generation
9629: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9630: tool is rather big and the distfile should come with pregenerated
9631: documentation anyway; if it does not, it is a bug that you ought to
9632: report. For such packages you should disable gtk-doc (unless it is
9633: the default):</p>
9634: <pre class="programlisting">
1.223 nia 9635: CONFIGURE_ARGS+= --disable-gtk-doc
1.184 rillig 9636: </pre>
9637: <p>The default location of installed HTML files
9638: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9639: and should not be changed unless the package insists on installing
9640: them somewhere else. Otherwise programs as
9641: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9642: do that with an entry similar to:</p>
9643: <pre class="programlisting">
1.223 nia 9644: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.184 rillig 9645: </pre>
9646: </li>
9647: </ul></div>
9648: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9649: files under the installation prefix to maintain databases. In this
9650: context, shared means that those exact same directories and files are
9651: used among several different packages, leading to conflicts in the
9652: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9653: handle the most common cases, so you have to forget about using
9654: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9655: omitting shared files from them. If you find yourself doing those,
9656: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9657: <p>The following table lists the common situations that result in
9658: using shared directories or files. For each of them, the appropriate
9659: solution is given. After applying the solution be sure to
9660: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9661: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9662: <div class="table">
9663: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9664: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9665: <colgroup>
9666: <col>
9667: <col>
9668: </colgroup>
9669: <thead><tr>
9670: <th>If the package...</th>
9671: <th>Then...</th>
9672: </tr></thead>
9673: <tbody>
9674: <tr>
9675: <td>Installs icons under the
9676: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9677: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.203 nia 9678: <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.184 rillig 9679: </tr>
9680: <tr>
9681: <td>Installs files under
9682: <code class="filename">share/mime/packages</code>.</td>
1.203 nia 9683: <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.184 rillig 9684: </tr>
9685: <tr>
9686: <td>Installs <code class="filename">.desktop</code> files under
9687: <code class="filename">share/applications</code> and these include MIME
9688: information.</td>
1.203 nia 9689: <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.184 rillig 9690: </tr>
9691: </tbody>
9692: </table></div>
1.1 dsieger 9693: </div>
1.184 rillig 9694: <br class="table-break">
1.1 dsieger 9695: </div>
1.41 asau 9696: <div class="sect1">
1.1 dsieger 9697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 9698: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9699: <p>When seeing GNOME as a whole, there are two kinds of
9700: updates:</p>
9701: <div class="variablelist"><dl class="variablelist">
9702: <dt><span class="term">Major update</span></dt>
9703: <dd>
9704: <p>Given that there is still a very long way for GNOME 3 (if it
9705: ever appears), we consider a major update one that goes from a
9706: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9707: where <code class="literal">Y</code> is even and greater than
9708: <code class="literal">X</code>. These are hard to achieve because they
9709: introduce lots of changes in the components' code and almost all
9710: GNOME distfiles are updated to newer versions. Some of them can
9711: even break API and ABI compatibility with the previous major
9712: version series. As a result, the update needs to be done all at
9713: once to minimize breakage.</p>
9714: <p>A major update typically consists of around 80 package
9715: updates and the addition of some new ones.</p>
9716: </dd>
9717: <dt><span class="term">Minor update</span></dt>
9718: <dd>
9719: <p>We consider a minor update one that goes from a
9720: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9721: one where <code class="literal">Y</code> is greater than
9722: <code class="literal">X</code>. These are easy to achieve because they do
9723: not update all GNOME components, can be done in an incremental way
9724: and do not break API nor ABI compatibility.</p>
9725: <p>A minor update typically consists of around 50 package
9726: updates, although the numbers here may vary a lot.</p>
9727: </dd>
9728: </dl></div>
9729: <p>In order to update the GNOME components in pkgsrc to a new stable
9730: release (either major or minor), the following steps should be
9731: followed:</p>
9732: <div class="orderedlist"><ol class="orderedlist" type="1">
1.23 wiz 9733: <li class="listitem">
1.184 rillig 9734: <p>Get a list of all the tarballs that form the new release by
9735: using the following commands. These will leave the full list of the
9736: components' distfiles into the <code class="filename">list.txt</code>
9737: file:</p>
9738: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9739: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9740: awk '{ print $9 }' >list.txt</code></strong>
9741: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9742: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9743: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.1 dsieger 9744: </li>
1.184 rillig 9745: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9746: bump their version to the release you are updating them to. The
9747: three meta packages should be always consistent with versioning.
9748: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9749: in them.</p></li>
1.23 wiz 9750: <li class="listitem">
1.184 rillig 9751: <p>For each meta package, update all its
9752: <code class="varname">DEPENDS</code> lines to match the latest versions as
9753: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9754: newer version (even if found in the FTP) because the meta packages
9755: are supposed to list the exact versions that form a specific GNOME
9756: release. Exceptions are permitted here if a newer version solves a
9757: serious issue in the overall desktop experience; these typically
9758: come in the form of a revision bump in pkgsrc, not in newer versions
9759: from the developers.</p>
9760: <p>Packages not listed in the <code class="filename">list.txt</code> file
9761: should be updated to the latest version available (if found in
9762: pkgsrc). This is the case, for example, of the dependencies on the
1.207 leot 9763: GNU Autotools in the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.1 dsieger 9764: </li>
1.23 wiz 9765: <li class="listitem">
1.184 rillig 9766: <p>Generate a patch from the modified meta packages and extract the
9767: list of "new" lines. This will provide you an outline on what
9768: packages need to be updated in pkgsrc and in what order:</p>
9769: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
1.1 dsieger 9770: </li>
1.184 rillig 9771: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9772: installed packages and start over from scratch at this point.</p></li>
9773: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9774: of <code class="filename">todo.txt</code> and update the packages listed in
9775: it in order. For major desktop updates none of these should be
9776: committed until the entire set is completed because there are chances
9777: of breaking not-yet-updated packages.</p></li>
9778: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9779: the tree one by one with appropriate log messages. At the end,
9780: commit the three meta package updates and all the corresponding
9781: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9782: <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>
9783: </ol></div>
9784: </div>
9785: <div class="sect1">
9786: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9787: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9788: <p>GNOME is a very big component in pkgsrc which approaches 100
9789: packages. Please, it is very important that you always, always,
9790: <span class="strong"><strong>always</strong></span> feed back any portability
9791: 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
9792: their attention on portability issues and to ensure that future versions
9793: can be built out-of-the box on NetBSD. The less custom patches in
9794: pkgsrc, the easier further updates are. Those developers in charge of
9795: issuing major GNOME updates will be grateful if you do that.</p>
1.200 cirnatda 9796: <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
9797: GitLab</a>. Not all components use these to track bugs, but most
1.184 rillig 9798: of them do. Do not be short on your reports: always provide detailed
9799: explanations of the current failure, how it can be improved to achieve
1.200 cirnatda 9800: maximum portability and, if at all possible, provide a patch against the
9801: main Git branch. The more verbose you are, the higher chances of your
9802: patch being accepted.</p>
1.184 rillig 9803: <p>Also, please avoid using preprocessor magic to fix portability
9804: issues. While the FreeBSD GNOME people are doing a great job in porting
9805: GNOME to their operating system, the official GNOME sources are now
9806: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9807: and similar macros. This hurts portability. Please see our patching
9808: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9809: details.</p>
9810: </div>
1.1 dsieger 9811: </div>
1.41 asau 9812: <div class="chapter">
1.1 dsieger 9813: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9814: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9815: <div class="toc">
9816: <p><b>Table of Contents</b></p>
1.100 leot 9817: <dl class="toc">
1.154 rillig 9818: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9819: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9820: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9821: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9822: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9823: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9824: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9825: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9826: </dl>
9827: </div>
1.41 asau 9828: <div class="sect1">
1.1 dsieger 9829: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9830: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9831: <p>Our policy is that we accept binaries only from pkgsrc
9832: developers to guarantee that the packages don't contain any
9833: trojan horses etc. This is not to annoy anyone but rather to
9834: protect our users! You're still free to put up your home-made
9835: binary packages and tell the world where to get them. NetBSD
9836: developers doing bulk builds and wanting to upload them please
1.154 rillig 9837: see <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.66 asau 9838: builds)</i></a>.</p>
1.1 dsieger 9839: </div>
1.41 asau 9840: <div class="sect1">
1.1 dsieger 9841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9842: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.218 nia 9843: <p>Firstly, you can import new packages into
9844: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
9845: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
9846: for details.</p>
9847: <p>Next, check that your package is complete, compiles and
1.184 rillig 9848: runs well; see <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> and the rest of this
1.218 nia 9849: 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>
9850: tool and fix any errors that appear.</p>
9851: <p>Finally, send a report to the pkgsrc bug tracking system,
1.207 leot 9852: 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.1 dsieger 9853: that, go to the web page
1.174 leot 9854: <a class="ulink" href="https://www.NetBSD.org/support/send-pr.html" target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
1.21 snj 9855: which contains some instructions and a link to a form where you
9856: can submit packages. The
1.207 leot 9857: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/index.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.21 snj 9858: also available as a substitute for either of the above two tools.
9859: </p>
1.1 dsieger 9860: <p>In the form of the problem report, the category should be
1.23 wiz 9861: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9862: and version number, and the description field should contain a
9863: short description of your package (contents of the COMMENT
1.218 nia 9864: variable or DESCR file are OK).</p>
1.1 dsieger 9865: </div>
1.41 asau 9866: <div class="sect1">
1.1 dsieger 9867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9868: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9869: <p>Please note all package additions, updates, moves, and
9870: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9871: important to keep this file up to date and conforming to the
9872: existing format, because it will be used by scripts to
1.174 leot 9873: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9874: sites. Additionally, check the
9875: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9876: for the package you updated or removed, in case it was mentioned
9877: there.</p>
9878: <p>When the <code class="varname">PKGREVISION</code> of a package is
9879: bumped, the change should appear in
9880: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9881: related or otherwise relevant. Mass bumps that result from a
9882: dependency being updated should not be mentioned. In all other
9883: cases it's the developer's decision.</p>
9884: <p>There is a make target that helps in creating proper
1.10 hubertf 9885: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9886: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9887: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9888: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9889: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9890: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9891: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9892: For new packages, or package moves or removals, set the
9893: <code class="varname">CTYPE</code> variable on the command line to "Added",
9894: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9895: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9896: not the same as your NetBSD login name. The target also automatically
9897: removes possibly existing entries for the package in the
9898: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 9899: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 9900: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9901: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9902: makes the cvs commands use the main repository.
9903: </p>
1.1 dsieger 9904: </div>
1.41 asau 9905: <div class="sect1">
1.1 dsieger 9906: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9907: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 9908: <p>For several years, there have been mirrors of pkgsrc in
9909: fossil, git, and hg. Standard practise when using these tools is to
9910: make the first line of a commit message function as a summary that
9911: can be read without the rest, such as is commonly done with "git log
9912: --oneline". For this reason, we have the following guidelines for
9913: pkgsrc commit messages:</p>
9914: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9915: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 9916: big picture in 65 characters or less. When a commit is for one
1.130 wiz 9917: package, include the name of the package. For updates, include the
9918: version to which it is updated.</p></li>
9919: <li class="listitem"><p>Leave the next line empty.</p></li>
9920: <li class="listitem"><p>Then come the details for the commit (changes in that
9921: package, reason for a change) and any relevant PRs. Wrap this
9922: section.</p></li>
9923: </ul></div>
9924: <p>Here is an example:
9925: </p>
9926: <pre class="programlisting">
9927: libxslt: update to 1.0.30
9928:
9929: Changes since 1.0.29:
9930: ...
9931: </pre>
9932: <p>
9933: </p>
9934: <p>Here is another example:
9935: </p>
9936: <pre class="programlisting">
9937: mk/bsd.pkg.mk: enable SSP by default on NetBSD
9938:
9939: (rationale)
9940: </pre>
9941: <p>
9942: </p>
9943: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
9944: allowed on the pkgsrc repository to change commit messages.</p>
9945: </div>
9946: <div class="sect1">
9947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9948: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 9949: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 9950: access to the pkgsrc repository.</p>
9951: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9952: Start by adding the directory and then files in the directory. Don't
9953: forget to add the new package to the category's
9954: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9955: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9956: <pre class="programlisting">
9957: <code class="prompt">$</code> cd .../pkgsrc/category
9958: <code class="prompt">$</code> cvs add pkgname
9959: <code class="prompt">$</code> cd pkgname
9960: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9961: <code class="prompt">$</code> cvs add patches/p*
9962: <code class="prompt">$</code> cvs status | less
1.34 wiz 9963: <code class="prompt">$</code> cvs commit
1.33 wiz 9964: <code class="prompt">$</code> cd ..
9965: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 9966: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 9967: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 9968: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 9969: </pre>
1.1 dsieger 9970: <p>The commit message of the initial import should include part of the
9971: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9972: what the package is/does.</p>
1.33 wiz 9973: <p>Also mention the new package in
9974: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9975: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9976: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 9977: </div>
1.41 asau 9978: <div class="sect1">
1.1 dsieger 9979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9980: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9981: <p>Please always put a concise, appropriate and relevant summary of the
9982: changes between old and new versions into the commit log when updating
9983: a package. There are various reasons for this:</p>
1.41 asau 9984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9985: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 9986: or its information may be overwritten by newer information.</p></li>
1.23 wiz 9987: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9988: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 9989: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9990: repository is very useful for people who read the pkgsrc-changes mailing
9991: list, so that they can make tactical decisions about when to upgrade
9992: the package.</p></li>
9993: </ul></div>
9994: <p>Please also recognize that, just because a new version of a package
9995: has been released, it should not automatically be upgraded in the CVS
9996: repository. We prefer to be conservative in the packages that are
9997: included in pkgsrc - development or beta packages are not really the
9998: best thing for most places in which pkgsrc is used. Please use your
9999: judgement about what should go into pkgsrc, and bear in mind that
10000: stability is to be preferred above new and possibly untested features.</p>
10001: </div>
1.41 asau 10002: <div class="sect1">
1.1 dsieger 10003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10004: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 10005: <p>Renaming packages is not recommended.</p>
1.175 gutterid 10006: <p>When renaming packages, be sure to fix any references to the old name
1.20 snj 10007: in other Makefiles, options, buildlink files, etc.</p>
1.167 leot 10008: <p>
1.175 gutterid 10009: Also, when renaming a package, please add
1.167 leot 10010: the package name and version pattern(s) of the previous package
10011: to <code class="varname">SUPERSEDES</code>.
1.20 snj 10012: This may be repeated for multiple renames.
10013: The new package would be an exact replacement.
1.167 leot 10014: Example:
1.20 snj 10015: </p>
1.167 leot 10016: <pre class="programlisting">
10017: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
10018: SUPERSEDES+= optcomp-[0-9]*
10019: </pre>
1.23 wiz 10020: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 10021: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
10022: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
10023: not be an exact replacement but is a suggestion for the replaced
10024: functionality.</p>
10025: </div>
1.41 asau 10026: <div class="sect1">
1.20 snj 10027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10028: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 10029: <p>It is preferred that packages are not renamed or moved, but if needed
10030: please follow these steps.
10031: </p>
1.23 wiz 10032: <div class="orderedlist"><ol class="orderedlist" type="1">
10033: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
10034: <li class="listitem">
1.1 dsieger 10035: <p>Remove all CVS dirs.</p>
10036: <p>Alternatively to the first two steps you can also do:</p>
10037: <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>
10038: <p>and use that for further work.</p>
10039: </li>
1.23 wiz 10040: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
10041: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
10042: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
10043: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 10044: <code class="varname">PREV_PKGPATH</code> to the previous category/package
10045: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
10046: for doing an update using pkgsrc building; for example, it can
1.207 leot 10047: 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.20 snj 10048: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
10049: new <code class="varname">PKGPATH</code> for that moved package. Note that
10050: it may have multiple matches, so the tool should also check on the
10051: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
10052: probably has no value unless <code class="varname">SUPERSEDES</code> is not
10053: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 10054: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 10055: place.</p></li>
1.23 wiz 10056: <li class="listitem">
1.1 dsieger 10057: <p>Check if any package depends on it:
10058: </p>
10059: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
10060: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
10061: </li>
1.23 wiz 10062: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
10063: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
10064: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
10065: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
10066: <li class="listitem">
1.1 dsieger 10067: <p>Commit the changed and removed files:</p>
10068: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
10069: <p>(and any packages from step 5, of course).</p>
10070: </li>
10071: </ol></div>
10072: </div>
10073: </div>
1.41 asau 10074: <div class="chapter">
1.1 dsieger 10075: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 10076: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 10077: <p>This section contains the answers to questions that may
10078: arise when you are writing a package. If you don't find your
10079: question answered here, first have a look in the other chapters,
10080: and if you still don't have the answer, ask on the
10081: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 10082: <div class="qandaset">
1.174 leot 10083: <a name="devfaq.qandaset"></a><dl>
1.154 rillig 10084: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 10085: MAKEFLAGS, .MAKEFLAGS and
10086: MAKE_FLAGS?</a>
10087: </dt>
1.154 rillig 10088: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 10089: MAKE, GMAKE and
10090: MAKE_PROGRAM?</a>
10091: </dt>
1.154 rillig 10092: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 10093: CC, PKG_CC and
10094: PKGSRC_COMPILER?</a>
10095: </dt>
1.223 nia 10096: <dt>24.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 10097: VARNAME=BUILDLINK_PREFIX.foo
10098: say it's empty?</a>
10099: </dt>
1.223 nia 10100: <dt>24.5. <a href="#devfaq.master_sites">What does
1.1 dsieger 10101: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
10102: don't understand the := inside
10103: it.</a>
10104: </dt>
1.223 nia 10105: <dt>24.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 10106: developers?</a>
10107: </dt>
1.223 nia 10108: <dt>24.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 10109: documentation?</a>
10110: </dt>
1.223 nia 10111: <dt>24.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.174 leot 10112: What shall I do?</a>
1.1 dsieger 10113: </dt>
10114: </dl>
1.41 asau 10115: <table border="0" style="width: 100%;">
10116: <colgroup>
1.1 dsieger 10117: <col align="left" width="1%">
1.23 wiz 10118: <col>
1.41 asau 10119: </colgroup>
1.1 dsieger 10120: <tbody>
1.41 asau 10121: <tr class="question">
1.1 dsieger 10122: <td align="left" valign="top">
1.174 leot 10123: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.1 dsieger 10124: </td>
10125: <td align="left" valign="top"><p>What is the difference between
10126: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10127: <code class="varname">MAKE_FLAGS</code>?</p></td>
10128: </tr>
10129: <tr class="answer">
10130: <td align="left" valign="top"></td>
1.223 nia 10131: <td align="left" valign="top">
10132: <p><code class="varname">MAKEFLAGS</code> are the flags passed
10133: to the pkgsrc-internal invocations of <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.</p>
10134: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
10135: passed to the <code class="varname">MAKE_PROGRAM</code> when building the
10136: package.</p>
10137: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
10138: <span class="command"><strong>bmake</strong></span> and should not be used by
10139: packages.</p>
10140: </td>
1.1 dsieger 10141: </tr>
1.41 asau 10142: <tr class="question">
1.1 dsieger 10143: <td align="left" valign="top">
1.174 leot 10144: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.1 dsieger 10145: </td>
10146: <td align="left" valign="top"><p>What is the difference between
10147: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10148: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10149: </tr>
10150: <tr class="answer">
10151: <td align="left" valign="top"></td>
1.223 nia 10152: <td align="left" valign="top">
10153: <p><code class="varname">MAKE</code> is the path to the
1.207 leot 10154: <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.223 nia 10155: infrastructure.</p>
10156: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
10157: need to say <code class="varname">USE_TOOLS+=gmake</code> to use
10158: that.</p>
10159: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
10160: program that is used for building the package.</p>
10161: </td>
1.1 dsieger 10162: </tr>
1.41 asau 10163: <tr class="question">
1.1 dsieger 10164: <td align="left" valign="top">
1.174 leot 10165: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.1 dsieger 10166: </td>
10167: <td align="left" valign="top"><p>What is the difference between
10168: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10169: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10170: </tr>
10171: <tr class="answer">
10172: <td align="left" valign="top"></td>
10173: <td align="left" valign="top">
1.223 nia 10174: <p><code class="varname">CC</code> is the path to the real C
10175: compiler, which can be configured by the pkgsrc user.</p>
10176: <p><code class="varname">PKG_CC</code> is the path to the compiler
10177: wrapper.</p>
10178: <p><code class="varname">PKGSRC_COMPILER</code> is
10179: <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
10180: compiler that should be used. See
10181: <code class="filename">mk/compiler.mk</code> for more information about
10182: the latter variable.</p>
1.1 dsieger 10183: </td>
10184: </tr>
1.41 asau 10185: <tr class="question">
1.1 dsieger 10186: <td align="left" valign="top">
1.223 nia 10187: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.4.</b></p>
1.1 dsieger 10188: </td>
1.10 hubertf 10189: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 10190: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10191: say it's empty?</p></td>
10192: </tr>
10193: <tr class="answer">
10194: <td align="left" valign="top"></td>
10195: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 10196: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10197: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 10198: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 10199: command.</p></td>
10200: </tr>
1.41 asau 10201: <tr class="question">
1.1 dsieger 10202: <td align="left" valign="top">
1.223 nia 10203: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.5.</b></p>
1.1 dsieger 10204: </td>
10205: <td align="left" valign="top"><p>What does
1.108 rillig 10206: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10207: don't understand the <code class="code">:=</code> inside
1.1 dsieger 10208: it.</p></td>
10209: </tr>
10210: <tr class="answer">
10211: <td align="left" valign="top"></td>
1.223 nia 10212: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
10213: assignment operator, even though it may look like one.
1.1 dsieger 10214: Instead, it is a degenerate form of
1.108 rillig 10215: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.207 leot 10216: 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.108 rillig 10217: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 10218: case of <code class="varname">MASTER_SITE_*</code>,
10219: <em class="replaceable"><code>old_string</code></em> is the empty string and
10220: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 10221: <code class="code">package/</code>. That's where the
10222: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 10223: together.</p></td>
10224: </tr>
1.41 asau 10225: <tr class="question">
1.1 dsieger 10226: <td align="left" valign="top">
1.223 nia 10227: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.6.</b></p>
1.1 dsieger 10228: </td>
10229: <td align="left" valign="top"><p>Which mailing lists are there for package
10230: developers?</p></td>
10231: </tr>
10232: <tr class="answer">
10233: <td align="left" valign="top"></td>
1.41 asau 10234: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.174 leot 10235: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1 dsieger 10236: <dd><p>This is a list for technical discussions related
10237: to pkgsrc development, e.g. soliciting feedback for changes to
10238: pkgsrc infrastructure, proposed new features, questions related
10239: to porting pkgsrc to a new platform, advice for maintaining a
10240: package, patches that affect many packages, help requests moved
10241: from pkgsrc-users when an infrastructure bug is found,
10242: etc.</p></dd>
1.174 leot 10243: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1 dsieger 10244: <dd><p>All bug reports in category "pkg" sent with
1.207 leot 10245: <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.1 dsieger 10246: directly; use one of the other mailing
10247: lists.</p></dd>
10248: </dl></div></td>
10249: </tr>
1.41 asau 10250: <tr class="question">
1.1 dsieger 10251: <td align="left" valign="top">
1.223 nia 10252: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.7.</b></p>
1.1 dsieger 10253: </td>
10254: <td align="left" valign="top"><p>Where is the pkgsrc
10255: documentation?</p></td>
10256: </tr>
10257: <tr class="answer">
10258: <td align="left" valign="top"></td>
10259: <td align="left" valign="top">
10260: <p>There are many places where you can find
10261: documentation about pkgsrc:</p>
1.41 asau 10262: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10263: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 10264: of chapters that explain large parts of pkgsrc, but some
10265: chapters tend to be outdated. Which ones they are is hard to
10266: say.</p></li>
1.174 leot 10267: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>), you can find discussions
1.1 dsieger 10268: about certain features, announcements of new parts of the pkgsrc
10269: infrastructure and sometimes even announcements that a certain
10270: feature has been marked as obsolete. The benefit here is that
10271: each message has a date appended to it.</p></li>
1.23 wiz 10272: <li class="listitem"><p>Many of the files in the
1.1 dsieger 10273: <code class="filename">mk/</code> directory start with a comment that
10274: describes the purpose of the file and how it can be used by the
10275: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 10276: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 10277: help</strong></span>.</p></li>
1.23 wiz 10278: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 10279: information, but they tend to be highly abbreviated, especially
10280: for actions that occur often. Some contain a detailed
10281: description of what has changed, but they are geared towards the
10282: other pkgsrc developers, not towards an average pkgsrc user.
10283: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10284: don't know what has been before, these messages may not be worth
10285: too much to you.</p></li>
1.23 wiz 10286: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10287: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 10288: mind of the developer who wrote the code. To get this
1.10 hubertf 10289: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 10290: to see who has written it and ask on the
10291: <code class="literal">tech-pkg</code> mailing list, so that others can
10292: find your questions later (see above). To be sure that the
10293: developer in charge reads the mail, you may CC him or
10294: her.</p></li>
10295: </ul></div>
1.184 rillig 10296: </td>
10297: </tr>
10298: <tr class="question">
10299: <td align="left" valign="top">
1.223 nia 10300: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.8.</b></p>
1.184 rillig 10301: </td>
1.223 nia 10302: <td align="left" valign="top"><p>I have a little time to kill.
1.184 rillig 10303: What shall I do?</p></td>
10304: </tr>
10305: <tr class="answer">
10306: <td align="left" valign="top"></td>
10307: <td align="left" valign="top">
10308: <p>This is not really an FAQ yet, but here's the answer
10309: anyway.</p>
1.41 asau 10310: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 10311: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.207 leot 10312: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.184 rillig 10313: will tell you about newer versions of installed packages that are
10314: available, but not yet updated in pkgsrc.</p></li>
10315: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10316: — it contains a list of suggested new packages and a list of
10317: cleanups and enhancements for pkgsrc that would be nice to
10318: have.</p></li>
10319: <li class="listitem"><p>Review packages for which review was requested on
10320: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10321: mailing list.</p></li>
1.1 dsieger 10322: </ul></div>
1.184 rillig 10323: </td>
1.1 dsieger 10324: </tr>
10325: </tbody>
1.184 rillig 10326: </table>
1.1 dsieger 10327: </div>
10328: </div>
10329: </div>
1.41 asau 10330: <div class="part">
1.1 dsieger 10331: <div class="titlepage"><div><div><h1 class="title">
10332: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10333: <div class="partintro">
1.1 dsieger 10334: <div></div>
10335: <p>This part of the guide deals with everything
10336: from the infrastructure that is behind the interfaces described
10337: in the developer's guide. A casual package maintainer should not
10338: need anything from this part.</p>
10339: <div class="toc">
10340: <p><b>Table of Contents</b></p>
1.100 leot 10341: <dl class="toc">
1.184 rillig 10342: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10343: <dd><dl>
1.184 rillig 10344: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10345: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10346: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10347: <dd><dl>
1.184 rillig 10348: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10349: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10350: </dl></dd>
1.184 rillig 10351: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10352: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10353: <dd><dl>
1.184 rillig 10354: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10355: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10356: </dl></dd>
1.184 rillig 10357: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10358: <dd><dl>
1.184 rillig 10359: <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>
10360: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10361: </dl></dd>
10362: </dl></dd>
1.184 rillig 10363: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 10364: <dd><dl>
1.184 rillig 10365: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10366: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10367: <dd><dl>
1.184 rillig 10368: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10369: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10370: </dl></dd>
10371: </dl></dd>
1.184 rillig 10372: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10373: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 10374: </dl>
10375: </div>
10376: </div>
1.41 asau 10377: <div class="chapter">
1.1 dsieger 10378: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10379: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10380: <div class="toc">
10381: <p><b>Table of Contents</b></p>
1.100 leot 10382: <dl class="toc">
1.184 rillig 10383: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10384: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10385: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10386: <dd><dl>
1.184 rillig 10387: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10388: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10389: </dl></dd>
1.184 rillig 10390: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10391: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10392: <dd><dl>
1.184 rillig 10393: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10394: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10395: </dl></dd>
1.184 rillig 10396: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10397: <dd><dl>
1.184 rillig 10398: <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>
10399: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10400: </dl></dd>
10401: </dl>
10402: </div>
10403: <p>The pkgsrc infrastructure consists of many small Makefile
10404: fragments. Each such fragment needs a properly specified
10405: interface. This chapter explains how such an interface looks
10406: like.</p>
1.41 asau 10407: <div class="sect1">
1.1 dsieger 10408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10409: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10410: <p>Whenever a variable is defined in the pkgsrc
10411: infrastructure, the location and the way of definition provide
10412: much information about the intended use of that variable.
10413: Additionally, more documentation may be found in a header
10414: comment or in this pkgsrc guide.</p>
10415: <p>A special file is
10416: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10417: variables that are intended to be user-defined. They are either
10418: defined using the <code class="literal">?=</code> operator or they are
10419: left undefined because defining them to anything would
1.23 wiz 10420: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10421: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10422: file.</p>
10423: <p>Outside this file, the following conventions apply:
10424: Variables that are defined using the <code class="literal">?=</code>
10425: operator may be overridden by a package.</p>
10426: <p>Variables that are defined using the <code class="literal">=</code>
10427: operator may be used read-only at run-time.</p>
10428: <p>Variables whose name starts with an underscore must not be
10429: accessed outside the pkgsrc infrastructure at all. They may
10430: change without further notice.</p>
1.41 asau 10431: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10432: <h3 class="title">Note</h3>
10433: <p>These conventions are currently not applied
10434: consistently to the complete pkgsrc
10435: infrastructure.</p>
10436: </div>
10437: </div>
1.41 asau 10438: <div class="sect1">
1.1 dsieger 10439: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10440: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10441: <p>All variables that contain lists of things should default
10442: to being empty. Two examples that do not follow this rule are
10443: <code class="varname">USE_LANGUAGES</code> and
10444: <code class="varname">DISTFILES</code>. These variables cannot simply be
10445: modified using the <code class="literal">+=</code> operator in package
10446: <code class="filename">Makefile</code>s (or other files included by
10447: them), since there is no guarantee whether the variable is
10448: already set or not, and what its value is. In the case of
1.23 wiz 10449: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10450: the default value and just define it as in the following
10451: example.</p>
10452: <pre class="programlisting">
10453: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10454: </pre>
10455: <p>Because of the selection of this default value, the same
10456: value appears in many package Makefiles. Similarly for
10457: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10458: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10459: doesn't stand out. Nevertheless it is mentioned in many
10460: files.</p>
10461: </div>
1.41 asau 10462: <div class="sect1">
1.1 dsieger 10463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10464: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.41 asau 10465: <div class="sect2">
1.1 dsieger 10466: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10467: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.1 dsieger 10468: <p>Variable evaluation takes place either at load time or at
10469: runtime, depending on the context in which they occur. The
10470: contexts where variables are evaluated at load time are:</p>
1.41 asau 10471: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10472: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10473: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10474: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10475: <code class="literal">.for</code>,</p></li>
1.23 wiz 10476: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10477: </ul></div>
10478: <p>A special exception are references to the iteration
10479: variables of <code class="literal">.for</code> loops, which are expanded
10480: inline, no matter in which context they appear.</p>
10481: <p>As the values of variables may change during load time,
10482: care must be taken not to evaluate them by accident. Typical
10483: examples for variables that should not be evaluated at load time
10484: are <code class="varname">DEPENDS</code> and
10485: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10486: clear, here is an example:</p>
10487: <pre class="programlisting">
10488: CONFIGURE_ARGS= # none
10489: CFLAGS= -O
10490: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10491:
10492: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10493:
10494: CFLAGS+= -Wall
1.111 sevan 10495: </pre>
1.1 dsieger 10496: <p>This code shows how the use of the <code class="literal">:=</code>
10497: operator can quickly lead to unexpected results. The first
10498: paragraph is fairly common code. The second paragraph evaluates
10499: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10500: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10501: <code class="literal">-Wall</code> is appended to the
10502: <code class="varname">CFLAGS</code>, but this addition will not appear in
10503: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10504: paragraphs from above typically occur in completely unrelated
10505: files.</p>
10506: </div>
1.41 asau 10507: <div class="sect2">
1.1 dsieger 10508: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10509: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10510: <p>After all the files have been loaded, the values of the
10511: variables cannot be changed anymore. Variables that are used in
10512: the shell commands are expanded at this point.</p>
10513: </div>
10514: </div>
1.41 asau 10515: <div class="sect1">
1.1 dsieger 10516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10517: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10518: <p>There are many ways in which the definition and use of a
1.108 rillig 10519: variable can be restricted in order to detect bugs and violations
10520: of the (mostly unwritten) policies. A package can be checked with
10521: <code class="literal">pkglint -Wall</code> to see whether it meets these
10522: rules.</p>
1.1 dsieger 10523: </div>
1.41 asau 10524: <div class="sect1">
1.1 dsieger 10525: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10526: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10527: <p>Most of the <code class="filename">.mk</code> files fall into one
10528: of the following classes. Cases where a file falls into more
10529: than one class should be avoided as it often leads to subtle
10530: bugs.</p>
1.41 asau 10531: <div class="sect2">
1.1 dsieger 10532: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10533: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10534: <p>In a traditional imperative programming language some of
10535: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10536: procedures. They take some input parameters and—after
10537: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10538: variables in <code class="filename">Makefile</code>s have global scope
10539: care must be taken not to use parameter names that have already
10540: another meaning. For example, <code class="varname">PKGNAME</code> is a
10541: bad choice for a parameter name.</p>
10542: <p>Procedures are completely evaluated at preprocessing time.
10543: That is, when calling a procedure all input parameters must be
10544: completely resolvable. For example,
10545: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10546: parameter since it is very likely that further text will be
10547: added after calling the procedure, which would effectively apply
10548: the procedure to only a part of the variable. Also, references
1.108 rillig 10549: to other variables will be modified after calling the
1.1 dsieger 10550: procedure.</p>
10551: <p>A procedure can declare its output parameters either as
10552: suitable for use in preprocessing directives or as only
10553: available at runtime. The latter alternative is for variables
10554: that contain references to other runtime variables.</p>
10555: <p>Procedures shall be written such that it is possible to
10556: call the procedure more than once. That is, the file must not
10557: contain multiple-inclusion guards.</p>
10558: <p>Examples for procedures are
10559: <code class="filename">mk/bsd.options.mk</code> and
10560: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10561: that the parameters are evaluated at load time, they should be
10562: assigned using the <code class="literal">:=</code> operator, which should
10563: be used only for this purpose.</p>
10564: </div>
1.41 asau 10565: <div class="sect2">
1.1 dsieger 10566: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10567: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10568: <p>Action files take some input parameters and may define
10569: runtime variables. They shall not define loadtime variables.
10570: There are action files that are included implicitly by the
10571: pkgsrc infrastructure, while other must be included
10572: explicitly.</p>
10573: <p>An example for action files is
10574: <code class="filename">mk/subst.mk</code>.</p>
10575: </div>
10576: </div>
1.41 asau 10577: <div class="sect1">
1.1 dsieger 10578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10579: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10580: <p>Package <code class="filename">Makefile</code>s usually consist of
10581: a set of variable definitions, and include the file
10582: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10583: Before that, they may also include various other
10584: <code class="filename">*.mk</code> files if they need to query the
10585: availability of certain features like the type of compiler or
10586: the X11 implementation. Due to the heavy use of preprocessor
10587: directives like <code class="literal">.if</code> and
10588: <code class="literal">.for</code>, the order in which the files are loaded
10589: matters.</p>
10590: <p>This section describes at which point the various files
10591: are loaded and gives reasons for that order.</p>
1.41 asau 10592: <div class="sect2">
1.1 dsieger 10593: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10594: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10595: </h3></div></div></div>
10596: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10597: is to define some essential variables like
10598: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10599: <code class="varname">MACHINE_ARCH</code>.</p>
10600: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10601: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4 rillig 10602: After that, those variables
1.1 dsieger 10603: that have not been overridden by the user are loaded from
10604: <code class="filename">mk/defaults/mk.conf</code>.</p>
10605: <p>After the user settings, the system settings and platform
10606: settings are loaded, which may override the user
10607: settings.</p>
10608: <p>Then, the tool definitions are loaded. The tool wrappers
10609: are not yet in effect. This only happens when building a
10610: package, so the proper variables must be used instead of the
10611: direct tool names.</p>
10612: <p>As the last steps, some essential variables from the
10613: wrapper and the package system flavor are loaded, as well as the
10614: variables that have been cached in earlier phases of a package
10615: build.</p>
10616: </div>
1.41 asau 10617: <div class="sect2">
1.1 dsieger 10618: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10619: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10620: </h3></div></div></div>
10621: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10622: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10623: loaded, which fill default values for those variables that have
10624: not been defined by the package. These variables may later
10625: be used even in unrelated files.</p>
10626: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10627: provides the target <code class="literal">error-check</code> that is added
10628: as a special dependency to all other targets that use
10629: <code class="varname">DELAYED_ERROR_MSG</code> or
10630: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10631: <p>Then, the package-specific hacks from
10632: <code class="filename">hacks.mk</code> are included.</p>
10633: <p>Then, various other files follow. Most of them don't have
10634: any dependencies on what they need to have included before or
10635: after them, though some do.</p>
10636: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10637: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10638: restricts the use of these variables to all the files that have
10639: been included before. Appearances in later files will be
10640: silently ignored.</p>
10641: <p>Then, the files for the main targets are included, in the
10642: order of later execution, though the actual order should not
10643: matter.</p>
10644: <p>At last, some more files are included that don't set any
10645: interesting variables but rather just define make targets to be
10646: executed.</p>
10647: </div>
10648: </div>
10649: </div>
1.41 asau 10650: <div class="chapter">
1.1 dsieger 10651: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10652: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.1 dsieger 10653: <div class="toc">
10654: <p><b>Table of Contents</b></p>
1.100 leot 10655: <dl class="toc">
1.184 rillig 10656: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10657: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10658: <dd><dl>
1.184 rillig 10659: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10660: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10661: </dl></dd>
10662: </dl>
10663: </div>
10664: <p>The pkgsrc infrastructure consists of a large codebase,
10665: and there are many corners where every little bit of a file is
10666: well thought out, making pkgsrc likely to fail as soon as
10667: anything is changed near those parts. To prevent most changes
10668: from breaking anything, a suite of regression tests should go
10669: along with every important part of the pkgsrc infrastructure.
10670: This chapter describes how regression tests work in pkgsrc and
10671: how you can add new tests.</p>
1.41 asau 10672: <div class="sect1">
1.1 dsieger 10673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10674: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.207 leot 10675: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/index.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.10 hubertf 10676: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10677: can simply run that command, which will run all tests in the
1.168 rillig 10678: <code class="filename">regress/</code> directory.</p>
1.1 dsieger 10679: </div>
1.41 asau 10680: <div class="sect1">
1.1 dsieger 10681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10682: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.168 rillig 10683: <p>Every directory in the <code class="filename">regress/</code>
10684: directory that contains a file called <code class="filename">spec</code>
1.1 dsieger 10685: is considered a regression test. This file is a shell program
1.10 hubertf 10686: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10687: The following functions can be overridden to suit your
10688: needs.</p>
1.41 asau 10689: <div class="sect2">
1.1 dsieger 10690: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10691: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 10692: <p>These functions do not take any parameters. Although they
10693: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.174 leot 10694: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108 rillig 10695: question</a> for details.</p>
1.41 asau 10696: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10697: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 10698: <dd><p>This function prepares the environment for the
10699: test. By default it does nothing.</p></dd>
1.108 rillig 10700: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10701: <dd>
10702: <p>This function runs the actual test. By default,
1.1 dsieger 10703: it calls <code class="varname">TEST_MAKE</code> with the arguments
10704: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10705: error messages into the file
1.108 rillig 10706: <code class="varname">TEST_OUTFILE</code>.</p>
10707: <p>When defining this function, make sure that all output that
10708: needs to be checked is written to the correct output file.
10709: Example:</p>
10710: <pre class="programlisting">
10711: do_test() {
1.112 rillig 10712: echo "Example output"
1.108 rillig 10713: } 1>$TEST_OUTFILE 2>&1
10714: </pre>
10715: </dd>
10716: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10717: <dd>
10718: <p>This function is run after the test and is
1.1 dsieger 10719: typically used to compare the actual output from the one that is
10720: expected. It can make use of the various helper functions from
1.108 rillig 10721: the next section. Example:</p>
10722: <pre class="programlisting">
10723: check_result() {
1.112 rillig 10724: exit_status 0
10725: output_require "Example"
10726: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10727: output_prohibit "no such file or directory"
1.168 rillig 10728: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 10729: }
10730: </pre>
10731: </dd>
10732: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 10733: <dd><p>This function cleans everything up after the
10734: test has been run. By default it does nothing.</p></dd>
10735: </dl></div>
10736: </div>
1.41 asau 10737: <div class="sect2">
1.1 dsieger 10738: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10739: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.41 asau 10740: <div class="variablelist"><dl class="variablelist">
1.168 rillig 10741: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10742: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108 rillig 10743: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 10744: <dd><p>This function compares the exitcode of the
1.108 rillig 10745: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 10746: If they differ, the test will fail.</p></dd>
1.108 rillig 10747: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10748: <dd>
10749: <p>This function checks for each of its parameters
10750: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 10751: extended regular expression. If it does not, the test will
1.108 rillig 10752: fail. Example:</p>
10753: <pre class="programlisting">
10754: output_require "looks fine"
10755: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10756: </pre>
10757: </dd>
1.177 leot 10758: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.1 dsieger 10759: <dd><p>This function checks for each of its parameters
1.10 hubertf 10760: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10761: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10762: If any of the regular expressions matches, the test will
10763: fail.</p></dd>
10764: </dl></div>
10765: </div>
10766: </div>
10767: </div>
1.41 asau 10768: <div class="chapter">
1.1 dsieger 10769: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10770: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10771: <div class="toc">
10772: <p><b>Table of Contents</b></p>
1.184 rillig 10773: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.1 dsieger 10774: </div>
10775: <p>The pkgsrc system has already been ported to many
10776: operating systems, hardware architectures and compilers. This
10777: chapter explains the necessary steps to make pkgsrc even more
10778: portable.</p>
1.41 asau 10779: <div class="sect1">
1.1 dsieger 10780: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10781: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10782: <p>To port pkgsrc to a new operating system (called
10783: <code class="literal">MyOS</code> in this example), you need to touch the
10784: following files:</p>
1.41 asau 10785: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10786: <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>
10787: <dd><p>This file contains some basic definitions, for
10788: example the name of the C
10789: compiler.</p></dd>
10790: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10791: <dd><p>Insert code that defines the variables
10792: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.212 wiz 10793: <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.1 dsieger 10794: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10795: <code class="varname">APPEND_ELF</code>, and the other variables that
10796: appear in this file.</p></dd>
10797: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10798: <dd><p>This file contains the platform-specific
10799: definitions that are used by pkgsrc. Start by copying one of the
10800: other files and edit it to your
10801: needs.</p></dd>
10802: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10803: <dd><p>This file defines the paths to all the tools
10804: that are needed by one or the other package in pkgsrc, as well
10805: as by pkgsrc itself. Find out where these tools are on your
10806: platform and add them.</p></dd>
10807: </dl></div>
10808: <p>Now, you should be able to build some basic packages, like
1.207 leot 10809: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/index.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/index.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.1 dsieger 10810: </div>
10811: </div>
10812: </div>
1.41 asau 10813: <div class="appendix">
10814: <div class="titlepage"><div><div><h1 class="title">
10815: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10816: <div class="toc">
10817: <p><b>Table of Contents</b></p>
1.100 leot 10818: <dl class="toc">
1.1 dsieger 10819: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10820: <dd><dl>
10821: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10822: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10823: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 10824: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 10825: </dl></dd>
10826: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10827: </dl>
10828: </div>
10829: <p>We checked to find a piece of software that wasn't in the packages
10830: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10831: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10832: present in the tree is beyond us, but it's useful for the purposes of
10833: this exercise.</p>
1.41 asau 10834: <div class="sect1">
1.1 dsieger 10835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10836: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10837: <div class="sect2">
1.1 dsieger 10838: <div class="titlepage"><div><div><h3 class="title">
10839: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10840: <pre class="programlisting">
10841: # $NetBSD$
10842: #
10843:
10844: DISTNAME= bison-1.25
10845: CATEGORIES= devel
1.171 rillig 10846: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 10847:
1.29 dholland 10848: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 10849: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 10850: COMMENT= GNU yacc clone
10851:
10852: GNU_CONFIGURE= yes
1.46 wiz 10853: INFO_FILES= yes
1.1 dsieger 10854:
10855: .include "../../mk/bsd.pkg.mk"
10856: </pre>
10857: </div>
1.41 asau 10858: <div class="sect2">
1.1 dsieger 10859: <div class="titlepage"><div><div><h3 class="title">
10860: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10861: <pre class="programlisting">
10862: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.207 leot 10863: 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.1 dsieger 10864: of the NetBSD source tree is beyond me.
10865: </pre>
10866: </div>
1.41 asau 10867: <div class="sect2">
1.1 dsieger 10868: <div class="titlepage"><div><div><h3 class="title">
10869: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10870: <pre class="programlisting">
10871: @comment $NetBSD$
10872: bin/bison
10873: man/man1/bison.1.gz
10874: share/bison.simple
10875: share/bison.hairy
10876: </pre>
10877: </div>
1.41 asau 10878: <div class="sect2">
1.1 dsieger 10879: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 10880: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1 dsieger 10881: <p>The NetBSD package system comes with
1.207 leot 10882: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1 dsieger 10883: which helps to check the contents of these
10884: files. After installation it is quite easy to use, just change to the
1.171 rillig 10885: directory of the package you wish to examine and run
1.10 hubertf 10886: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10887: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171 rillig 10888: ERROR: Makefile: Each package must define its LICENSE.
10889: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10890: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10891: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10892: 1 error, 2 warnings and 1 note found.
10893: (Run "pkglint -e" to show explanations.)
10894: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 10895: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1 dsieger 10896: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170 rillig 10897: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1 dsieger 10898: -Wall</strong></span> for a very thorough check.</p>
10899: </div>
10900: </div>
1.41 asau 10901: <div class="sect1">
1.1 dsieger 10902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10903: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10904: <p>Create the directory where the package lives,
10905: plus any auxiliary directories:</p>
10906: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10907: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10908: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10909: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10910: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.184 rillig 10911: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 12. Package components - files, directories and contents">Chapter 12, <i>Package components - files, directories and contents</i></a>)
1.1 dsieger 10912: then continue with fetching the distfile:</p>
10913: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10914: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10915: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10916: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10917: ftp: Error retrieving file: 500 Internal error
10918:
10919: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10920: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10921: ftp: Error retrieving file: 500 Internal error
10922:
10923: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10924: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10925: Successfully retrieved file.</pre>
10926: <p>Generate the checksum of the distfile into
10927: <code class="filename">distinfo</code>:</p>
10928: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10929: <p>Now compile:</p>
10930: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10931: >> Checksum OK for bison-1.25.tar.gz.
10932: ===> Extracting for bison-1.25
10933: ===> Patching for bison-1.25
10934: ===> Ignoring empty patch directory
10935: ===> Configuring for bison-1.25
10936: creating cache ./config.cache
10937: checking for gcc... cc
10938: checking whether we are using GNU C... yes
10939: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10940: checking how to run the C preprocessor... cc -E
10941: checking for minix/config.h... no
10942: checking for POSIXized ISC... no
10943: checking whether cross-compiling... no
10944: checking for ANSI C header files... yes
10945: checking for string.h... yes
10946: checking for stdlib.h... yes
10947: checking for memory.h... yes
10948: checking for working const... yes
10949: checking for working alloca.h... no
10950: checking for alloca... yes
10951: checking for strerror... yes
10952: updating cache ./config.cache
10953: creating ./config.status
10954: creating Makefile
10955: ===> Building for bison-1.25
10956: 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
10957: 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
10958: 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
10959: 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
10960: 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
10961: 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
10962: 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
10963: 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
10964: 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
10965: 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
10966: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g main.c
10967: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g nullable.c
10968: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g output.c
10969: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g print.c
10970: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reader.c
10971: 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
10972: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g symtab.c
10973: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g warshall.c
10974: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g version.c
10975: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt.c
10976: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt1.c
10977: 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
10978: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10979: rm -f bison.s1
10980: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10981: <p>Everything seems OK, so install the files:</p>
10982: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10983: >> Checksum OK for bison-1.25.tar.gz.
10984: ===> Installing for bison-1.25
10985: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10986: rm -f /usr/pkg/bin/bison
10987: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10988: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10989: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10990: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10991: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10992: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10993: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10994: ===> Registering installation for bison-1.25</pre>
10995: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10996: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10997: binary package, do this now:</p>
10998: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10999: >> Checksum OK for bison-1.25.tar.gz.
11000: ===> Building package for bison-1.25
11001: Creating package bison-1.25.tgz
11002: Registering depends:.
11003: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
11004: <p>Now that you don't need the source and object files
11005: any more, clean up:</p>
11006: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
11007: ===> Cleaning for bison-1.25</pre>
11008: </div>
11009: </div>
1.41 asau 11010: <div class="appendix">
11011: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 11012: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.1 dsieger 11013: <div class="toc">
11014: <p><b>Table of Contents</b></p>
1.100 leot 11015: <dl class="toc">
1.207 leot 11016: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
11017: <dd><dl>
11018: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
11019: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
11020: </dl></dd>
11021: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
11022: <dd><dl>
11023: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
11024: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
11025: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
11026: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
11027: </dl></dd>
11028: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
11029: <dd><dl>
11030: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
11031: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
11032: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
11033: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
11034: </dl></dd>
1.1 dsieger 11035: </dl>
11036: </div>
1.207 leot 11037: <p>
11038: A number of mechanisms are available in pkgsrc to improve the security of the
11039: resulting system. This page describes the mechanisms, and gives hints
11040: about detecting and fixing problems.
11041: </p>
11042: <p>
11043: Mechanisms can be enabled individually in
11044: <code class="filename">mk.conf</code>, and are
11045: individually described below.
11046: </p>
11047: <p>
11048: Typically, a feature will cause some programs to fail to build or work
11049: when first enabled. This can be due to latent problems in the
11050: program, and can be due to other reasons. After enough testing to
11051: have confidence that user problems will be quite rare, individual
11052: mechanisms will be enabled by default.
11053: </p>
11054: <p>
11055: For each mechanism, see the Caveats section below for an explanation
11056: of what might go wrong at compile time and at run time, and how to
11057: notice and address these problems.
11058: </p>
1.41 asau 11059: <div class="sect1">
1.1 dsieger 11060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11061: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
11062: <div class="sect2">
11063: <div class="titlepage"><div><div><h3 class="title">
11064: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
11065: <div class="sect3">
11066: <div class="titlepage"><div><div><h4 class="title">
11067: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
11068: <p>
11069: This allows substitute wrappers to be used for some commonly used
11070: library functions that do not have built-in bounds checking - but
11071: could in some cases.
11072: </p>
11073: <p>
11074: Two mitigation levels are available:
11075: </p>
11076: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11077: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
11078: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
11079: </ul></div>
11080: <p>
11081: "strong" has been enabled by default since pkgsrc-2017Q3.
11082: </p>
11083: </div>
11084: <div class="sect3">
11085: <div class="titlepage"><div><div><h4 class="title">
11086: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
11087: <p>
11088: This enables a stack-smashing protection mitigation. It is done by adding a
11089: guard variable to functions with vulnerable objects. The guards are initialized
11090: when a function is entered and then checked when the function exits. The guard
11091: check will fail and the program forcibly exited if the variable was modified in
11092: the meantime. This can happen in case of buffer overflows or memory corruption,
11093: and therefore exposing these bugs.
11094: </p>
11095: <p>
11096: Different mitigation levels are available:
11097: </p>
11098: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11099: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
11100: by the compiler;</p></li>
11101: <li class="listitem"><p>"all", which will protect every function;</p></li>
11102: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
11103: two settings above.</p></li>
11104: </ul></div>
11105: <p>
11106: This mitigation is supported by both GCC and clang. It may be supported in
11107: additional compilers, possibly under a different name. It is particularly useful
11108: for unsafe programming languages, such as C/C++.
11109: </p>
11110: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11111: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
11112: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
11113: </ul></div>
11114: <p>More details can be found here:</p>
11115: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11116: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
11117: </p></li></ul></div>
11118: </div>
11119: <div class="sect3">
11120: <div class="titlepage"><div><div><h4 class="title">
11121: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
11122: <p>
11123: This requests the creation of PIE (Position Independent Executables) for all
11124: executables. The PIE mechanism is normally used for shared libraries, so that
11125: they can be loaded at differing addresses at runtime. PIE itself does not have
11126: useful security properties; however, it is necessary to fully leverage some,
11127: such as ASLR. Some operating systems support Address Space Layout Randomization
11128: (ASLR), which causes different addresses to be used each time a program is run.
11129: This makes it more difficult for an attacker to guess addresses and thus makes
11130: exploits harder to construct. With PIE, ASLR can really be applied to the entire
11131: program, instead of the stack and heap only.
11132: </p>
11133: <p>
11134: PIE executables will only be built for toolchains that are known to support PIE.
11135: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
11136: </p>
11137: <p>
11138: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
11139: </p>
1.1 dsieger 11140: </div>
1.210 gutterid 11141: <div class="sect3">
11142: <div class="titlepage"><div><div><h4 class="title">
1.219 nia 11143: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.207 leot 11144: <p>
11145: This also makes the exploitation of some security vulnerabilities more
11146: difficult in some cases.
11147: </p>
11148: <p>Two different mitigation levels are available:</p>
11149: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11150: <li class="listitem"><p>
1.219 nia 11151: partial (the default): the ELF sections are reordered so that internal data sections
1.207 leot 11152: precede the program's own data sections, and non-PLT GOT is read-only;
11153: </p></li>
11154: <li class="listitem"><p>
11155: full: in addition to partial RELRO, every relocation is performed immediately
1.218 nia 11156: when starting the program, allowing the entire GOT to be read-only. This
11157: can greatly slow down startup of large programs.
1.207 leot 11158: </p></li>
11159: </ul></div>
11160: <p>
11161: This is currently supported by GCC. Many software distributions now enable this
1.220 nia 11162: feature by default, at the "partial" level.
1.207 leot 11163: </p>
11164: <p>
11165: More details can be found here:
11166: </p>
11167: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11168: <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>
11169: </p></li></ul></div>
1.1 dsieger 11170: </div>
1.219 nia 11171: </div>
11172: <div class="sect2">
11173: <div class="titlepage"><div><div><h3 class="title">
11174: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
11175: <div class="sect3">
11176: <div class="titlepage"><div><div><h4 class="title">
11177: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
11178: <p>
11179: With this option, pkgsrc will try to build packages reproducibly. This allows
11180: packages built from the same tree and with the same options, to produce
11181: identical results bit by bit. This option should be combined with ASLR and
11182: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
11183: attackers attempting to exploit security vulnerabilities.
11184: </p>
11185: <p>
11186: More details can be found here:
11187: </p>
11188: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11189: <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>
11190: </p></li></ul></div>
11191: <p>
11192: More work likely needs to be done before pkgsrc is fully reproducible.
11193: </p>
11194: </div>
1.207 leot 11195: <div class="sect3">
11196: <div class="titlepage"><div><div><h4 class="title">
1.219 nia 11197: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.207 leot 11198: <p>
11199: This uses <code class="literal">-fstack-check</code> with GCC for
11200: another stack protection mitigation.
11201: </p>
11202: <p>
11203: It asks the compiler to generate code verifying that it does not corrupt the
11204: stack. According to GCC's manual page, this is really only useful for
11205: multi-threaded programs.
11206: </p>
1.1 dsieger 11207: </div>
11208: </div>
11209: </div>
1.41 asau 11210: <div class="sect1">
1.1 dsieger 11211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11212: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
11213: <div class="sect2">
11214: <div class="titlepage"><div><div><h3 class="title">
11215: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
11216: <div class="sect3">
11217: <div class="titlepage"><div><div><h4 class="title">
11218: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
11219: <p>
11220: A number of packages may fail to build with this option enabled. The
11221: failures are often related to the absence of the <code class="literal">-fPIC</code>
11222: compilation flag when building libraries or executables (or ideally
11223: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
11224: <code class="varname">CFLAGS</code> already, but requires the package to
11225: actually support it.
11226: </p>
11227: <div class="sect4">
11228: <div class="titlepage"><div><div><h5 class="title">
11229: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
11230: <p>
11231: These instructions are meant as a reference only; they likely need to be adapted
11232: for many packages individually.
11233: </p>
11234: <p>
11235: For packages using <code class="filename">Makefiles</code>:
11236: </p>
11237: <pre class="programlisting">
11238: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
11239: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
11240: </pre>
11241: <p>
11242: For packages using <code class="filename">Imakefiles</code>:
11243: </p>
11244: <pre class="programlisting">
11245: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
11246: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
11247: </pre>
11248: </div>
11249: </div>
11250: <div class="sect3">
11251: <div class="titlepage"><div><div><h4 class="title">
11252: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
11253: <p>
11254: Some programs may fail to run, or crash at random times once built as PIE. Two
11255: scenarios are essentially possible. This is nearly always due to a bug in
11256: the program being exposed due to ASLR.
11257: </p>
11258: </div>
11259: <div class="sect3">
11260: <div class="titlepage"><div><div><h4 class="title">
11261: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
11262: <p>
11263: Ideally, packages should be fixed for compatibility with MKPIE.
11264: However, in some cases this is very difficult, due to complex build systems,
11265: packages using non-standard toolchains, or programming languages with odd
11266: bootstrapping mechanisms.
11267: </p>
11268: <p>
11269: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
11270: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
11271: <code class="filename">bsd.prefs.mk</code> is included.
11272: </p>
11273: </div>
11274: </div>
11275: <div class="sect2">
11276: <div class="titlepage"><div><div><h3 class="title">
11277: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
11278: <div class="sect3">
11279: <div class="titlepage"><div><div><h4 class="title">
11280: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
11281: <p>
11282: This feature makes use of pre-processing directives to look for hardened,
11283: alternative implementations of essential library calls. Some programs may fail
11284: to build as a result; this usually happens for those trying too hard to be
11285: portable, or otherwise abusing definitions in the standard library.
11286: </p>
11287: </div>
11288: <div class="sect3">
11289: <div class="titlepage"><div><div><h4 class="title">
11290: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
11291: <p>
11292: This feature may cause some programs to crash, usually indicating an
11293: actual bug in the program. The fix will typically involve patching the
11294: original program's source code.
11295: </p>
11296: </div>
11297: <div class="sect3">
11298: <div class="titlepage"><div><div><h4 class="title">
11299: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
11300: <p>
11301: At least in the case of GCC, FORTIFY will only be applied if optimization is
11302: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
11303: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
11304: optimization level. This cannot easily be applied globally, as some packages
11305: may require specific optimization levels.
11306: </p>
11307: </div>
11308: <div class="sect3">
11309: <div class="titlepage"><div><div><h4 class="title">
11310: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
11311: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11312: <h3 class="title">Note</h3>
11313: <p>FORTIFY should not be disabled to work around runtime crashes in
11314: the program! This is a very bad idea and will expose you to security
11315: vulnerabilities.
11316: </p>
11317: </div>
11318: <p>
11319: To disable FORTIFY on a per-package basis, set the following
11320: in the package's <code class="filename">Makefile</code>
11321: before <code class="filename">bsd.prefs.mk</code> is included:
11322: </p>
11323: <pre class="programlisting">
11324: FORTIFY_SUPPORTED= no
11325: </pre>
11326: </div>
11327: </div>
11328: <div class="sect2">
11329: <div class="titlepage"><div><div><h3 class="title">
11330: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
11331: <div class="sect3">
11332: <div class="titlepage"><div><div><h4 class="title">
11333: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
11334: <p>
11335: For better protection, full RELRO requires every symbol to be resolved when the
11336: program starts, rather than simply when required at run-time. This will have
11337: more impact on programs using a lot of symbols, or linked to libraries exposing
11338: a lot of symbols. Therefore, daemons or programs otherwise running in
11339: background are affected only when started. Programs loading plug-ins at
11340: run-time are affected when loading the plug-ins.
11341: </p>
11342: <p>
11343: The impact is not expected to be noticeable on modern hardware, except in some
11344: cases for big programs.
11345: </p>
11346: </div>
11347: <div class="sect3">
11348: <div class="titlepage"><div><div><h4 class="title">
11349: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
11350: <p>
11351: Some programs handle plug-ins and dependencies in a way that conflicts with
11352: RELRO: for instance, with an initialization routine listing any other plug-in
11353: required. With full RELRO, the missing symbols are resolved before the
11354: initialization routine can run, and the dynamic loader will not be able to find
11355: them directly and abort as a result. Unfortunately, this is how Xorg loads its
11356: drivers. Partial RELRO can be applied instead in this case.
11357: </p>
11358: </div>
11359: <div class="sect3">
11360: <div class="titlepage"><div><div><h4 class="title">
11361: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
11362: <p>
11363: To disable RELRO on a per-package basis, set the following
11364: in the package's <code class="filename">Makefile</code>
11365: before <code class="filename">bsd.prefs.mk</code> is included:
11366: </p>
11367: <pre class="programlisting">
11368: RELRO_SUPPORTED= no
11369: </pre>
1.209 nia 11370: <p>
11371: It is also possible to at most enable partial RELRO, by
11372: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
11373: </p>
1.207 leot 11374: </div>
11375: </div>
11376: <div class="sect2">
11377: <div class="titlepage"><div><div><h3 class="title">
11378: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
11379: <div class="sect3">
11380: <div class="titlepage"><div><div><h4 class="title">
11381: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
11382: <p>
11383: The stack-smashing protection provided by this option does not work for some
11384: programs. The most common situation in which this happens is when the program
11385: allocates variables on the stack, with the size determined at run-time.
11386: </p>
11387: </div>
11388: <div class="sect3">
11389: <div class="titlepage"><div><div><h4 class="title">
11390: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
11391: <p>
11392: Again, this feature may cause some programs to crash via a
11393: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
11394: </p>
11395: <p>
11396: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
11397: messages are sent and - by default -
11398: appended to <code class="filename">/var/log/messages</code>, e.g.:
11399: </p>
11400: <pre class="programlisting">
11401: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
11402: </pre>
11403: <p>
11404: (where <code class="literal">hostname</code> is the hostname(1) and
11405: <code class="literal">program</code> is the basename(1) of the program crashed).
11406: </p>
11407: <p>
11408: Patching the original program is then required.
11409: </p>
11410: <p>
11411: Rebuilding the package via:
11412: </p>
11413: <pre class="programlisting">
11414: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
11415: </pre>
11416: <p>
11417: and inspecting the backtrace of the coredump via the debugger
11418: should point out the problematic call by inspecting the frame
11419: calling the _chk() (SSP) function.
11420: </p>
11421: </div>
11422: <div class="sect3">
11423: <div class="titlepage"><div><div><h4 class="title">
11424: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
11425: <p>
11426: The compiler emits extra code when using this feature: a check for buffer
11427: overflows is performed when entering and exiting functions, requiring an extra
11428: variable on the stack. The level of protection can otherwise be adjusted to
11429: affect only those functions considered more sensitive by the compiler (with
11430: -fstack-protector instead of -fstack-protector-all).
11431: </p>
11432: <p>
11433: The impact is not expected to be noticeable on modern hardware. However,
11434: programs with a hard requirement to run at the fastest possible speed should
11435: avoid using this feature, or using libraries built with this feature.
11436: </p>
11437: </div>
11438: <div class="sect3">
11439: <div class="titlepage"><div><div><h4 class="title">
11440: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
11441: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11442: <h3 class="title">Note</h3>
11443: <p>SSP should not be disabled to work around runtime crashes in
11444: the program! This is a very bad idea and will expose you to security
11445: vulnerabilities.</p>
11446: </div>
11447: <p>
11448: To disable SSP on a per-package basis, set the following
11449: in the package's <code class="filename">Makefile</code>
11450: before <code class="filename">bsd.prefs.mk</code> is included:
11451: </p>
11452: <pre class="programlisting">
11453: SSP_SUPPORTED= no
11454: </pre>
11455: </div>
11456: </div>
11457: </div>
11458: <div class="sect1">
11459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11460: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
11461: <p>
11462: The illusion of security is worse than having no security at all. This section
11463: lists a number of ways to ensure the security features requested are actually
11464: effective.
11465: </p>
11466: <p>
11467: These instructions were obtained and tested on a system derived from NetBSD 7
11468: (amd64). YMMV.
11469: </p>
11470: <div class="sect2">
11471: <div class="titlepage"><div><div><h3 class="title">
11472: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
11473: <p>
11474: The ELF executable type in use changes for binaries built as PIE; without:
11475: </p>
11476: <pre class="programlisting">
11477: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
11478: /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
11479: </pre>
11480: <p>as opposed to the following binary, built as PIE:</p>
11481: <pre class="programlisting">
11482: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
11483: /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
11484: </pre>
11485: <p>
11486: The latter result is then what is expected.
11487: </p>
11488: </div>
11489: <div class="sect2">
11490: <div class="titlepage"><div><div><h3 class="title">
11491: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
11492: <p>
11493: The following command should list a section called RELRO:
11494: </p>
11495: <pre class="programlisting">
11496: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
11497:
11498: /path/to/bin/ary: file format elf64-x86-64
11499:
11500: Program Header:
11501: [...]
11502: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
11503: </pre>
11504: <p>
11505: This check is now performed automatically if
11506: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
11507: </p>
11508: </div>
11509: <div class="sect2">
11510: <div class="titlepage"><div><div><h3 class="title">
11511: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
11512: <p>
11513: The dynamic loader will apply RELRO immediately when detecting the presence of
11514: the <code class="varname">BIND_NOW</code> flag:
11515: </p>
11516: <pre class="programlisting">
11517: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
11518:
11519: /path/to/bin/ary: file format elf64-x86-64
11520:
11521: Dynamic Section:
11522: [...]
11523: BIND_NOW 0x0000000000000000
11524: </pre>
11525: <p>
11526: This has to be combined with partial RELRO (see above) to be fully efficient.
11527: </p>
11528: <p>
11529: This check is now performed automatically (where supported) if
11530: <code class="varname">PKG_DEVELOPER</code> is set.
11531: </p>
11532: </div>
11533: <div class="sect2">
11534: <div class="titlepage"><div><div><h3 class="title">
11535: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.208 nia 11536: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11537: <h3 class="title">Note</h3>
11538: <p>
11539: Checking for SSP using this method only works where the operating system
11540: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
11541: on recent NetBSD/FreeBSD/Linux versions.
11542: </p>
11543: </div>
1.207 leot 11544: <p>
11545: Building objects, binaries and libraries with SSP will affect the presence of
11546: additional symbols in the resulting file:
11547: </p>
11548: <pre class="programlisting">
11549: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
11550: [...]
11551: U __stack_chk_fail
11552: 0000000000600ea0 B __stack_chk_guard
11553: </pre>
11554: <p>
11555: This is an indicator that the program was indeed built with support for SSP.
11556: </p>
11557: <p>
11558: This check is now performed automatically (where supported) if
11559: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
11560: </p>
11561: </div>
11562: </div>
11563: </div>
11564: <div class="appendix">
11565: <div class="titlepage"><div><div><h1 class="title">
11566: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
11567: <div class="toc">
11568: <p><b>Table of Contents</b></p>
11569: <dl class="toc">
11570: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
11571: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
11572: </dl>
11573: </div>
11574: <div class="sect1">
11575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11576: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
11577: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11578: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11579: => figlet221.tar.gz doesn't seem to exist on this system.
11580: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11581: => [172219 bytes]
11582: Connected to ftp.plig.net.
11583: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11584: 331 Guest login ok, send your complete e-mail address as password.
11585: 230-You are user #5 of 500 simultaneous users allowed.
11586: 230-
11587: 230- ___ _ _ _
11588: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11589: 230- | _| _| . |_| . | | | . |_| . | _| . |
11590: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11591: 230- |_| |_| |___| |___|
11592: 230-
11593: 230-** Welcome to ftp.plig.org **
11594: 230-
11595: 230-Please note that all transfers from this FTP site are logged. If you
11596: 230-do not like this, please disconnect now.
11597: 230-
11598: 230-This archive is available via
11599: 230-
11600: 230-HTTP: http://ftp.plig.org/
11601: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11602: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11603: 230-
11604: 230-Please email comments, bug reports and requests for packages to be
11605: 230-mirrored to ftp-admin@plig.org.
11606: 230-
11607: 230-
11608: 230 Logged in anonymously.
11609: Remote system type is UNIX.
11610: Using binary mode to transfer files.
11611: 200 Type okay.
11612: 250 "/pub" is new cwd.
11613: 250-"/pub/figlet" is new cwd.
11614: 250-
11615: 250-Welcome to the figlet archive at ftp.figlet.org
11616: 250-
11617: 250- ftp://ftp.figlet.org/pub/figlet/
11618: 250-
11619: 250-The official FIGlet web page is:
11620: 250- http://www.figlet.org/
11621: 250-
11622: 250-If you have questions, please mailto:info@figlet.org. If you want to
11623: 250-contribute a font or something else, you can email us.
11624: 250
11625: 250 "/pub/figlet/program" is new cwd.
11626: 250 "/pub/figlet/program/unix" is new cwd.
11627: local: figlet221.tar.gz remote: figlet221.tar.gz
11628: 502 Unimplemented command.
11629: 227 Entering Passive Mode (195,40,6,41,246,104)
11630: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11631: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11632: 226 Transfer completed.
11633: 172219 bytes received in 00:02 (75.99 KB/s)
11634: 221 Goodbye.
11635: => Checksum OK for figlet221.tar.gz.
11636: ===> Extracting for figlet-2.2.1nb2
11637: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11638: ===> Patching for figlet-2.2.1nb2
11639: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11640: ===> Overriding tools for figlet-2.2.1nb2
11641: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11642: ===> Configuring for figlet-2.2.1nb2
11643: ===> Building for figlet-2.2.1nb2
11644: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11645: chmod a+x figlet
11646: gcc -O2 -o chkfont chkfont.c
11647: => Unwrapping files-to-be-installed.
11648: <code class="prompt">#</code>
11649: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11650: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11651: ===> Installing for figlet-2.2.1nb2
11652: install -d -o root -g wheel -m 755 /usr/pkg/bin
11653: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11654: mkdir -p /usr/pkg/share/figlet
11655: cp figlet /usr/pkg/bin
11656: cp chkfont /usr/pkg/bin
11657: chmod 555 figlist showfigfonts
11658: cp figlist /usr/pkg/bin
11659: cp showfigfonts /usr/pkg/bin
11660: cp fonts/*.flf /usr/pkg/share/figlet
11661: cp fonts/*.flc /usr/pkg/share/figlet
11662: cp figlet.6 /usr/pkg/man/man6
11663: ===> Registering installation for figlet-2.2.1nb2
11664: <code class="prompt">#</code></pre>
11665: </div>
11666: <div class="sect1">
11667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11668: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
11669: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11670: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11671: ===> Packaging figlet-2.2.1nb2
11672: ===> Building binary package for figlet-2.2.1nb2
11673: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11674: Using SrcDir value of /usr/pkg
11675: Registering depends:.
11676: <code class="prompt">#</code></pre>
11677: </div>
11678: </div>
11679: <div class="appendix">
11680: <div class="titlepage"><div><div><h1 class="title">
11681: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
11682: <div class="toc">
11683: <p><b>Table of Contents</b></p>
11684: <dl class="toc">
11685: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11686: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11687: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11688: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11689: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
11690: <code class="filename">stable</code>,
11691: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11692: source packages</a></span></dt>
11693: </dl>
11694: </div>
11695: <p>As in other big projects, the directory layout of pkgsrc
11696: is quite complex for newbies. This chapter explains where you
11697: find things on the FTP server. The base directory on
11698: <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>.
11699: On other servers it may be different, but inside this directory,
11700: everything should look the same, no matter on which server you
11701: are. This directory contains some subdirectories, which are
11702: explained below.</p>
11703: <div class="sect1">
11704: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11705: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
11706: <p>The directory <code class="filename">distfiles</code> contains lots
11707: of archive files from all pkgsrc packages, which are mirrored
11708: here. The subdirectories are called after their package names
11709: and are used when the distributed files have names that don't
11710: explicitly contain a version number or are otherwise too generic
11711: (for example <code class="filename">release.tar.gz</code>).</p>
11712: </div>
11713: <div class="sect1">
11714: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11715: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
11716: <p>This directory contains things that individual pkgsrc
11717: developers find worth publishing.</p>
11718: </div>
11719: <div class="sect1">
11720: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11721: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
11722: <p>This directory contains binary packages for the various
11723: platforms that are supported by pkgsrc.
11724: 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>
11725: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11726: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
11727: operating system for which the packages have been built. The
11728: name is taken from the output of the <span class="command"><strong>uname</strong></span>
11729: command, so it may differ from the one you are used to
11730: hear.</p></li>
11731: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
11732: architecture of the platform for which the packages have been
11733: built. It also includes the <code class="varname">ABI</code> (Application
11734: Binary Interface) for platforms that have several of
11735: them.</p></li>
11736: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
11737: the operating system. For version numbers that change often (for
11738: example NetBSD-current), the often-changing part should be
11739: replaced with an <code class="literal">x</code>, for example
11740: <code class="literal">4.99.x</code>.</p></li>
11741: <li class="listitem"><p><code class="varname">TAG</code> is either
11742: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11743: for a stable branch, or <code class="literal">head</code> for packages
11744: built from the HEAD branch. The latter should only be used when
11745: the packages are updated on a regular basis. Otherwise the date
11746: from checking out pkgsrc should be appended, for example
11747: <code class="literal">head_20071015</code>.</p></li>
11748: </ul></div>
11749: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11750: can quickly click through the directories on the
11751: server and find the best binary packages for their machines. Since they
11752: usually know the operating system and the hardware architecture, OPSYS
11753: and ARCH are placed first. After these choices, they can select the
11754: best combination of OSVERSION and TAG together, since it is usually the
11755: case that packages stay compatible between different version of the
11756: operating system.</p>
11757: <p>In each of these directories, there is a
11758: whole binary packages collection for a specific platform. It has a directory called
11759: <code class="filename">All</code> which contains all binary packages.
11760: Besides that, there are various category directories that
11761: contain symbolic links to the real binary packages.</p>
11762: </div>
11763: <div class="sect1">
11764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11765: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 11766: <p>Here are the reports from bulk builds, for those who want
11767: to fix packages that didn't build on some of the platforms. The
1.207 leot 11768: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="D.3. packages: Binary packages">Section D.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.8 rillig 11769: </div>
1.41 asau 11770: <div class="sect1">
1.8 rillig 11771: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11772: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.148 leot 11773: <code class="filename">stable</code>,
1.22 jakllsch 11774: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 11775: source packages</h2></div></div></div>
1.23 wiz 11776: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 11777: that is the files that define how to create binary packages from
11778: source archives.</p>
1.149 leot 11779: <p>Each of the <code class="filename">current</code>,
11780: <code class="filename">stable</code> and
11781: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11782: directories share the same structure. They each contain a
11783: <code class="filename">pkgsrc</code> directory and
11784: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 11785: <p>The directory <code class="filename">pkgsrc</code> contains a
11786: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 11787: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11788: as the directory, ready to be downloaded as a whole.</p>
11789: <p>The <code class="filename">current</code> directory contains files
11790: related to the HEAD branch of the CVS repository.
11791: In this directory there is an additional file called
11792: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11793: all pkgsrc <code class="filename">README</code>s with information about
11794: categories and packages.
11795: </p>
11796: <p>The <code class="filename">stable</code> directory is a symlink to
11797: the latest
11798: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11799: </p>
11800: <p>The
11801: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11802: directories contain files related to the
11803: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11804: stable branch of the CVS repository. In these directories there is
11805: an additional file called
11806: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.{bz,gz,xz}</code>,
1.1 dsieger 11807: which contains the state of pkgsrc when it was branched.</p>
11808: </div>
11809: </div>
1.41 asau 11810: <div class="appendix">
11811: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 11812: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.154 rillig 11813: <p>
11814: The following list contains all help topics that are available
11815: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11816: </p>
1.156 leot 11817: <table border="0" summary="Simple list" class="simplelist">
11818: <tr>
11819: <td>#!</td>
11820: <td>-lintl</td>
11821: </tr>
11822: <tr>
1.205 wiz 11823: <td>32bit</td>
1.156 leot 11824: <td>64bit</td>
1.205 wiz 11825: </tr>
11826: <tr>
1.156 leot 11827: <td>ABI</td>
1.205 wiz 11828: <td>ACCEPTABLE_LICENSES</td>
1.156 leot 11829: </tr>
11830: <tr>
11831: <td>ACROREAD_FONTPATH</td>
1.205 wiz 11832: <td>ADDITIONAL</td>
1.156 leot 11833: </tr>
11834: <tr>
11835: <td>AFAIK</td>
1.205 wiz 11836: <td>AIX</td>
1.156 leot 11837: </tr>
11838: <tr>
11839: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.205 wiz 11840: <td>ALL_ENV</td>
1.156 leot 11841: </tr>
11842: <tr>
1.200 cirnatda 11843: <td>ALTERNATIVES_SRC</td>
1.228 gutterid 11844: <td>AMANDA_TMP</td>
1.227 wiz 11845: </tr>
11846: <tr>
11847: <td>AMANDA_USER</td>
1.228 gutterid 11848: <td>AMANDA_VAR</td>
1.223 nia 11849: </tr>
11850: <tr>
1.227 wiz 11851: <td>APACHE_GROUP</td>
1.228 gutterid 11852: <td>APACHE_MODULE_NAME</td>
1.217 rillig 11853: </tr>
11854: <tr>
1.227 wiz 11855: <td>APACHE_MODULE_SRC</td>
1.228 gutterid 11856: <td>APACHE_MODULE_SRCDIR</td>
1.214 leot 11857: </tr>
11858: <tr>
1.227 wiz 11859: <td>APACHE_PKG_PREFIX</td>
1.228 gutterid 11860: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.212 wiz 11861: </tr>
11862: <tr>
1.227 wiz 11863: <td>APACHE_SUEXEC_DOCROOT</td>
1.228 gutterid 11864: <td>APACHE_USER</td>
1.197 leot 11865: </tr>
11866: <tr>
1.227 wiz 11867: <td>APPEND_ABI</td>
1.228 gutterid 11868: <td>APPEND_ELF</td>
1.177 leot 11869: </tr>
11870: <tr>
1.227 wiz 11871: <td>ARLA_CACHE</td>
1.228 gutterid 11872: <td>AUDIT_PACKAGES_FLAGS</td>
1.161 leot 11873: </tr>
11874: <tr>
1.227 wiz 11875: <td>AUTOCONF_REQD</td>
1.228 gutterid 11876: <td>AUTOMAKE_OVERRIDE</td>
1.159 rillig 11877: </tr>
11878: <tr>
1.227 wiz 11879: <td>AUTOMAKE_REQD</td>
1.228 gutterid 11880: <td>AUTO_MKDIRS</td>
1.156 leot 11881: </tr>
11882: <tr>
1.227 wiz 11883: <td>BDB185_DEFAULT</td>
1.228 gutterid 11884: <td>BDBBASE</td>
1.156 leot 11885: </tr>
11886: <tr>
1.227 wiz 11887: <td>BDB_ACCEPTED</td>
1.228 gutterid 11888: <td>BDB_DEFAULT</td>
1.156 leot 11889: </tr>
11890: <tr>
1.227 wiz 11891: <td>BDB_LIBS</td>
1.228 gutterid 11892: <td>BDB_TYPE</td>
1.156 leot 11893: </tr>
11894: <tr>
1.227 wiz 11895: <td>BINCIMAP_GROUP</td>
1.228 gutterid 11896: <td>BINCIMAP_USER</td>
1.156 leot 11897: </tr>
11898: <tr>
1.227 wiz 11899: <td>BIND_DIR</td>
1.228 gutterid 11900: <td>BIND_GROUP</td>
1.156 leot 11901: </tr>
11902: <tr>
1.227 wiz 11903: <td>BIND_USER</td>
1.228 gutterid 11904: <td>BINOWN</td>
1.156 leot 11905: </tr>
11906: <tr>
1.227 wiz 11907: <td>BINPKG_SITES</td>
1.228 gutterid 11908: <td>BIN_INSTALL_FLAGS</td>
1.156 leot 11909: </tr>
11910: <tr>
1.227 wiz 11911: <td>BISON_PKGDATADIR</td>
1.228 gutterid 11912: <td>BLAS</td>
1.156 leot 11913: </tr>
11914: <tr>
1.227 wiz 11915: <td>BLAS_ACCEPTED</td>
1.228 gutterid 11916: <td>BLAS_C_INTERFACE</td>
1.156 leot 11917: </tr>
11918: <tr>
1.227 wiz 11919: <td>BLAS_INCLUDES</td>
1.228 gutterid 11920: <td>BLAS_INDEX64</td>
1.198 leot 11921: </tr>
11922: <tr>
1.227 wiz 11923: <td>BLAS_LIBS</td>
1.229 ! gutterid 11924: <td>BLAS_PC</td>
! 11925: </tr>
! 11926: <tr>
1.228 gutterid 11927: <td>BLAS_TYPE</td>
1.229 ! gutterid 11928: <td>BOOTSTRAP_DEPENDS</td>
1.156 leot 11929: </tr>
11930: <tr>
1.228 gutterid 11931: <td>BROKEN</td>
1.229 ! gutterid 11932: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.156 leot 11933: </tr>
11934: <tr>
1.228 gutterid 11935: <td>BROKEN_ON_PLATFORM</td>
1.229 ! gutterid 11936: <td>BSDSRCDIR</td>
1.189 bacon 11937: </tr>
11938: <tr>
1.228 gutterid 11939: <td>BSDXSRCDIR</td>
1.229 ! gutterid 11940: <td>BSD_MAKE_ENV</td>
1.205 wiz 11941: </tr>
11942: <tr>
1.228 gutterid 11943: <td>BUILDLINK_AUTO_DIRS</td>
1.229 ! gutterid 11944: <td>BUILDLINK_AUTO_VARS</td>
1.156 leot 11945: </tr>
11946: <tr>
1.228 gutterid 11947: <td>BUILDLINK_CFLAGS</td>
1.229 ! gutterid 11948: <td>BUILDLINK_CONTENTS_FILTER</td>
1.177 leot 11949: </tr>
11950: <tr>
1.214 leot 11951: <td>BUILDLINK_CPPFLAGS</td>
1.229 ! gutterid 11952: <td>BUILDLINK_FILES</td>
1.156 leot 11953: </tr>
11954: <tr>
1.216 gutterid 11955: <td>BUILDLINK_FILES_CMD</td>
1.229 ! gutterid 11956: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.205 wiz 11957: </tr>
11958: <tr>
1.216 gutterid 11959: <td>BUILDLINK_LDFLAGS</td>
1.229 ! gutterid 11960: <td>BUILDLINK_LIBS</td>
1.156 leot 11961: </tr>
11962: <tr>
1.216 gutterid 11963: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.229 ! gutterid 11964: <td>BUILDLINK_PKGNAME</td>
1.156 leot 11965: </tr>
11966: <tr>
1.216 gutterid 11967: <td>BUILDLINK_PREFIX</td>
1.229 ! gutterid 11968: <td>BUILDLINK_RPATHDIRS</td>
1.156 leot 11969: </tr>
11970: <tr>
1.216 gutterid 11971: <td>BUILDLINK_TREE</td>
1.229 ! gutterid 11972: <td>BUILD_DEFS</td>
1.156 leot 11973: </tr>
11974: <tr>
1.216 gutterid 11975: <td>BUILD_DEFS_EFFECTS</td>
1.229 ! gutterid 11976: <td>BUILD_DEPENDS</td>
1.156 leot 11977: </tr>
11978: <tr>
1.216 gutterid 11979: <td>BUILD_DIRS</td>
1.229 ! gutterid 11980: <td>BUILD_ENV_SHELL</td>
1.156 leot 11981: </tr>
11982: <tr>
1.216 gutterid 11983: <td>BUILD_MAKE_CMD</td>
1.229 ! gutterid 11984: <td>BUILD_MAKE_FLAGS</td>
1.156 leot 11985: </tr>
11986: <tr>
1.216 gutterid 11987: <td>BUILD_TARGET</td>
1.229 ! gutterid 11988: <td>BUILTIN_FIND_FILES</td>
1.156 leot 11989: </tr>
11990: <tr>
1.216 gutterid 11991: <td>BUILTIN_FIND_FILES_VAR</td>
1.229 ! gutterid 11992: <td>BUILTIN_FIND_GREP</td>
1.156 leot 11993: </tr>
11994: <tr>
1.216 gutterid 11995: <td>BUILTIN_FIND_HEADERS</td>
1.229 ! gutterid 11996: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.156 leot 11997: </tr>
11998: <tr>
1.216 gutterid 11999: <td>BUILTIN_FIND_PKGCONFIG</td>
1.229 ! gutterid 12000: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.156 leot 12001: </tr>
12002: <tr>
1.216 gutterid 12003: <td>BUILTIN_PKG</td>
1.229 ! gutterid 12004: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.195 gutterid 12005: </tr>
12006: <tr>
1.216 gutterid 12007: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.229 ! gutterid 12008: <td>BUILTIN_VERSION_SCRIPT</td>
1.156 leot 12009: </tr>
12010: <tr>
1.216 gutterid 12011: <td>BUILTIN_X11_TYPE</td>
1.229 ! gutterid 12012: <td>BUILTIN_X11_VERSION</td>
1.156 leot 12013: </tr>
12014: <tr>
1.216 gutterid 12015: <td>CACTI_GROUP</td>
1.229 ! gutterid 12016: <td>CACTI_USER</td>
1.156 leot 12017: </tr>
12018: <tr>
1.216 gutterid 12019: <td>CANNA_GROUP</td>
1.229 ! gutterid 12020: <td>CANNA_USER</td>
1.156 leot 12021: </tr>
12022: <tr>
1.216 gutterid 12023: <td>CAT</td>
1.229 ! gutterid 12024: <td>CBLAS_LIBS</td>
1.156 leot 12025: </tr>
12026: <tr>
1.229 ! gutterid 12027: <td>CBLAS_PC</td>
1.216 gutterid 12028: <td>CCACHE_BASE</td>
1.156 leot 12029: </tr>
12030: <tr>
1.189 bacon 12031: <td>CCACHE_DIR</td>
1.216 gutterid 12032: <td>CCACHE_LOGFILE</td>
1.156 leot 12033: </tr>
12034: <tr>
1.189 bacon 12035: <td>CC_VERSION</td>
1.216 gutterid 12036: <td>CC_VERSION_STRING</td>
1.156 leot 12037: </tr>
12038: <tr>
1.189 bacon 12039: <td>CDRECORD_CONF</td>
1.216 gutterid 12040: <td>CDROM_PKG_URL_DIR</td>
1.156 leot 12041: </tr>
12042: <tr>
1.189 bacon 12043: <td>CDROM_PKG_URL_HOST</td>
1.226 gutterid 12044: <td>CHANGES</td>
1.223 nia 12045: </tr>
12046: <tr>
1.226 gutterid 12047: <td>CHECK_COMPILER</td>
1.228 gutterid 12048: <td>CHECK_FAKEHOME</td>
1.227 wiz 12049: </tr>
12050: <tr>
12051: <td>CHECK_FILES</td>
1.228 gutterid 12052: <td>CHECK_FILES_SKIP</td>
1.217 rillig 12053: </tr>
12054: <tr>
1.227 wiz 12055: <td>CHECK_FILES_STRICT</td>
1.228 gutterid 12056: <td>CHECK_HEADERS</td>
1.214 leot 12057: </tr>
12058: <tr>
1.227 wiz 12059: <td>CHECK_HEADERS_SKIP</td>
1.228 gutterid 12060: <td>CHECK_INTERPRETER</td>
1.212 wiz 12061: </tr>
12062: <tr>
1.227 wiz 12063: <td>CHECK_INTERPRETER_SKIP</td>
1.228 gutterid 12064: <td>CHECK_PERMS</td>
1.205 wiz 12065: </tr>
12066: <tr>
1.227 wiz 12067: <td>CHECK_PERMS_AUTOFIX</td>
1.228 gutterid 12068: <td>CHECK_PERMS_SKIP</td>
1.197 leot 12069: </tr>
12070: <tr>
1.227 wiz 12071: <td>CHECK_PIE</td>
1.228 gutterid 12072: <td>CHECK_PIE_SKIP</td>
1.177 leot 12073: </tr>
12074: <tr>
1.227 wiz 12075: <td>CHECK_PIE_SUPPORTED</td>
1.228 gutterid 12076: <td>CHECK_PORTABILITY</td>
1.161 leot 12077: </tr>
12078: <tr>
1.227 wiz 12079: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.228 gutterid 12080: <td>CHECK_PORTABILITY_SKIP</td>
1.216 gutterid 12081: </tr>
12082: <tr>
1.227 wiz 12083: <td>CHECK_RELRO</td>
1.228 gutterid 12084: <td>CHECK_RELRO_SKIP</td>
1.159 rillig 12085: </tr>
12086: <tr>
1.227 wiz 12087: <td>CHECK_RELRO_SUPPORTED</td>
1.228 gutterid 12088: <td>CHECK_SHLIBS</td>
1.156 leot 12089: </tr>
12090: <tr>
1.227 wiz 12091: <td>CHECK_SHLIBS_SKIP</td>
1.228 gutterid 12092: <td>CHECK_SHLIBS_SUPPORTED</td>
1.156 leot 12093: </tr>
12094: <tr>
1.227 wiz 12095: <td>CHECK_SHLIBS_TOXIC</td>
1.228 gutterid 12096: <td>CHECK_SSP</td>
1.156 leot 12097: </tr>
12098: <tr>
1.227 wiz 12099: <td>CHECK_SSP_SKIP</td>
1.228 gutterid 12100: <td>CHECK_SSP_SUPPORTED</td>
1.156 leot 12101: </tr>
12102: <tr>
1.227 wiz 12103: <td>CHECK_STRIPPED</td>
1.228 gutterid 12104: <td>CHECK_STRIPPED_SKIP</td>
1.156 leot 12105: </tr>
12106: <tr>
1.227 wiz 12107: <td>CHECK_WRKREF</td>
1.228 gutterid 12108: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.156 leot 12109: </tr>
12110: <tr>
1.227 wiz 12111: <td>CHECK_WRKREF_SKIP</td>
1.228 gutterid 12112: <td>CLAMAV_DBDIR</td>
1.156 leot 12113: </tr>
12114: <tr>
1.227 wiz 12115: <td>CLAMAV_GROUP</td>
1.228 gutterid 12116: <td>CLAMAV_USER</td>
1.156 leot 12117: </tr>
12118: <tr>
1.227 wiz 12119: <td>CLANGBASE</td>
1.228 gutterid 12120: <td>CLEANDEPENDS</td>
1.156 leot 12121: </tr>
12122: <tr>
1.227 wiz 12123: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.228 gutterid 12124: <td>CMAKE_INSTALL_NAME_DIR</td>
1.156 leot 12125: </tr>
12126: <tr>
1.227 wiz 12127: <td>CMAKE_INSTALL_PREFIX</td>
1.228 gutterid 12128: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.156 leot 12129: </tr>
12130: <tr>
1.227 wiz 12131: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.228 gutterid 12132: <td>CMAKE_PREFIX_PATH</td>
1.156 leot 12133: </tr>
12134: <tr>
1.227 wiz 12135: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.191 bacon 12136: <td>COMPILER_RPATH_FLAG</td>
1.156 leot 12137: </tr>
12138: <tr>
1.226 gutterid 12139: <td>COMPILER_USE_SYMLINKS</td>
1.191 bacon 12140: <td>CONFIGURE_ARGS</td>
1.156 leot 12141: </tr>
12142: <tr>
1.226 gutterid 12143: <td>CONFIGURE_DIRS</td>
1.191 bacon 12144: <td>CONFIGURE_ENV</td>
1.156 leot 12145: </tr>
12146: <tr>
1.226 gutterid 12147: <td>CONFIGURE_ENV_SHELL</td>
1.191 bacon 12148: <td>CONFIGURE_HAS_INFODIR</td>
1.156 leot 12149: </tr>
12150: <tr>
1.226 gutterid 12151: <td>CONFIGURE_HAS_MANDIR</td>
1.191 bacon 12152: <td>CONFIGURE_SCRIPT</td>
1.156 leot 12153: </tr>
12154: <tr>
1.226 gutterid 12155: <td>CONFIG_SHELL</td>
1.191 bacon 12156: <td>CONFIG_SHELL_FLAGS</td>
1.156 leot 12157: </tr>
12158: <tr>
1.226 gutterid 12159: <td>CONF_FILES</td>
1.191 bacon 12160: <td>CONF_FILES_MODE</td>
1.156 leot 12161: </tr>
12162: <tr>
1.226 gutterid 12163: <td>CONF_FILES_PERMS</td>
1.191 bacon 12164: <td>CONSERVER_DEFAULTHOST</td>
1.156 leot 12165: </tr>
12166: <tr>
1.226 gutterid 12167: <td>CONSERVER_DEFAULTPORT</td>
1.191 bacon 12168: <td>CP</td>
1.156 leot 12169: </tr>
12170: <tr>
1.226 gutterid 12171: <td>CPP</td>
1.191 bacon 12172: <td>CPP_PRECOMP_FLAGS</td>
1.156 leot 12173: </tr>
12174: <tr>
1.226 gutterid 12175: <td>CREATE_WRKDIR_SYMLINK</td>
1.191 bacon 12176: <td>CROSSBASE</td>
1.156 leot 12177: </tr>
12178: <tr>
1.226 gutterid 12179: <td>CTFCONVERT</td>
1.191 bacon 12180: <td>CTF_FILES_SKIP</td>
1.156 leot 12181: </tr>
12182: <tr>
1.226 gutterid 12183: <td>CTF_SUPPORTED</td>
1.191 bacon 12184: <td>CTYPE</td>
1.156 leot 12185: </tr>
12186: <tr>
1.226 gutterid 12187: <td>CUPS_GROUP</td>
1.191 bacon 12188: <td>CUPS_SYSTEM_GROUPS</td>
1.156 leot 12189: </tr>
12190: <tr>
1.226 gutterid 12191: <td>CUPS_USER</td>
1.191 bacon 12192: <td>CURSES_DEFAULT</td>
1.177 leot 12193: </tr>
12194: <tr>
1.226 gutterid 12195: <td>CURSES_TYPE</td>
1.228 gutterid 12196: <td>CXX</td>
1.227 wiz 12197: </tr>
12198: <tr>
12199: <td>CYRUS_GROUP</td>
1.228 gutterid 12200: <td>CYRUS_IDLE</td>
1.217 rillig 12201: </tr>
12202: <tr>
1.227 wiz 12203: <td>CYRUS_USER</td>
1.228 gutterid 12204: <td>DAEMONTOOLS_GROUP</td>
1.214 leot 12205: </tr>
12206: <tr>
1.227 wiz 12207: <td>DAEMONTOOLS_LOG_USER</td>
1.228 gutterid 12208: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.212 wiz 12209: </tr>
12210: <tr>
1.227 wiz 12211: <td>DARWIN_REQUIRES_FILTER</td>
1.228 gutterid 12212: <td>DBUS_GROUP</td>
1.205 wiz 12213: </tr>
12214: <tr>
1.227 wiz 12215: <td>DBUS_USER</td>
1.228 gutterid 12216: <td>DEFANG_GROUP</td>
1.197 leot 12217: </tr>
12218: <tr>
1.227 wiz 12219: <td>DEFANG_USER</td>
1.228 gutterid 12220: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.159 rillig 12221: </tr>
12222: <tr>
1.227 wiz 12223: <td>DEFAULT_DISTFILES</td>
1.228 gutterid 12224: <td>DEFAULT_IRC_SERVER</td>
1.156 leot 12225: </tr>
12226: <tr>
1.227 wiz 12227: <td>DEFAULT_SERIAL_DEVICE</td>
1.228 gutterid 12228: <td>DEF_UMASK</td>
1.156 leot 12229: </tr>
12230: <tr>
1.227 wiz 12231: <td>DEINSTALLDEPENDS</td>
1.228 gutterid 12232: <td>DEINSTALL_SRC</td>
1.195 gutterid 12233: </tr>
12234: <tr>
1.227 wiz 12235: <td>DEINSTALL_TEMPLATES</td>
1.228 gutterid 12236: <td>DELAYED_ERROR_MSG</td>
1.156 leot 12237: </tr>
12238: <tr>
1.227 wiz 12239: <td>DELAYED_WARNING_MSG</td>
1.228 gutterid 12240: <td>DEPENDS</td>
1.156 leot 12241: </tr>
12242: <tr>
1.227 wiz 12243: <td>DEPENDS_TARGET</td>
1.228 gutterid 12244: <td>DEPENDS_TYPE</td>
1.156 leot 12245: </tr>
12246: <tr>
1.227 wiz 12247: <td>DESTDIR</td>
1.228 gutterid 12248: <td>DESTDIR_VARNAME</td>
1.156 leot 12249: </tr>
12250: <tr>
1.227 wiz 12251: <td>DIALER_GROUP</td>
1.228 gutterid 12252: <td>DIGEST_REQD</td>
1.156 leot 12253: </tr>
12254: <tr>
1.227 wiz 12255: <td>DISTDIR</td>
1.228 gutterid 12256: <td>DISTFILES</td>
1.156 leot 12257: </tr>
12258: <tr>
1.227 wiz 12259: <td>DISTINFO_FILE</td>
1.228 gutterid 12260: <td>DISTNAME</td>
1.156 leot 12261: </tr>
12262: <tr>
1.227 wiz 12263: <td>DIST_PATH</td>
1.228 gutterid 12264: <td>DIST_SUBDIR</td>
1.156 leot 12265: </tr>
12266: <tr>
1.227 wiz 12267: <td>DJBDNS_AXFR_USER</td>
1.228 gutterid 12268: <td>DJBDNS_CACHE_USER</td>
1.156 leot 12269: </tr>
12270: <tr>
1.227 wiz 12271: <td>DJBDNS_DJBDNS_GROUP</td>
1.228 gutterid 12272: <td>DJBDNS_LOG_USER</td>
1.156 leot 12273: </tr>
12274: <tr>
1.227 wiz 12275: <td>DJBDNS_RBL_USER</td>
1.228 gutterid 12276: <td>DJBDNS_TINY_USER</td>
1.156 leot 12277: </tr>
12278: <tr>
1.227 wiz 12279: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.228 gutterid 12280: <td>DL_AUTO_VARS</td>
1.156 leot 12281: </tr>
12282: <tr>
1.227 wiz 12283: <td>DL_CFLAGS</td>
1.228 gutterid 12284: <td>DL_LDFLAGS</td>
1.156 leot 12285: </tr>
12286: <tr>
1.227 wiz 12287: <td>DL_LIBS</td>
1.228 gutterid 12288: <td>DNS</td>
1.156 leot 12289: </tr>
12290: <tr>
1.227 wiz 12291: <td>DOCOWN</td>
1.228 gutterid 12292: <td>DOWNLOADED_DISTFILE</td>
1.156 leot 12293: </tr>
12294: <tr>
1.227 wiz 12295: <td>DQCACHE_GROUP</td>
1.228 gutterid 12296: <td>DQCACHE_USER</td>
1.156 leot 12297: </tr>
12298: <tr>
1.227 wiz 12299: <td>DT_LAYOUT</td>
1.228 gutterid 12300: <td>DYNAMIC_SITES_CMD</td>
1.218 nia 12301: </tr>
12302: <tr>
1.227 wiz 12303: <td>DYNAMIC_SITES_SCRIPT</td>
1.228 gutterid 12304: <td>ECHO</td>
1.156 leot 12305: </tr>
12306: <tr>
1.227 wiz 12307: <td>ECHO_N</td>
1.228 gutterid 12308: <td>ELK_GUI</td>
1.156 leot 12309: </tr>
12310: <tr>
1.227 wiz 12311: <td>EMACS_TYPE</td>
1.228 gutterid 12312: <td>EMULDIR</td>
1.156 leot 12313: </tr>
12314: <tr>
1.227 wiz 12315: <td>EMULSUBDIR</td>
1.228 gutterid 12316: <td>EMULSUBDIRSLASH</td>
1.156 leot 12317: </tr>
12318: <tr>
1.227 wiz 12319: <td>EMUL_ARCH</td>
1.228 gutterid 12320: <td>EMUL_DISTRO</td>
1.156 leot 12321: </tr>
12322: <tr>
1.227 wiz 12323: <td>EMUL_EXEC_FMT</td>
1.228 gutterid 12324: <td>EMUL_IS_NATIVE</td>
1.156 leot 12325: </tr>
12326: <tr>
1.227 wiz 12327: <td>EMUL_MODULES</td>
1.228 gutterid 12328: <td>EMUL_OPSYS</td>
1.156 leot 12329: </tr>
12330: <tr>
1.227 wiz 12331: <td>EMUL_PKG_FMT</td>
1.228 gutterid 12332: <td>EMUL_PLATFORM</td>
1.156 leot 12333: </tr>
12334: <tr>
1.227 wiz 12335: <td>EMUL_PLATFORMS</td>
1.228 gutterid 12336: <td>EMUL_PREFER</td>
1.156 leot 12337: </tr>
12338: <tr>
1.227 wiz 12339: <td>EMUL_REQD</td>
1.228 gutterid 12340: <td>EMUL_TYPE</td>
1.156 leot 12341: </tr>
12342: <tr>
1.227 wiz 12343: <td>ERROR_MSG</td>
1.228 gutterid 12344: <td>EXIM_GROUP</td>
1.156 leot 12345: </tr>
12346: <tr>
1.227 wiz 12347: <td>EXIM_USER</td>
1.228 gutterid 12348: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.156 leot 12349: </tr>
12350: <tr>
1.227 wiz 12351: <td>EXTRACTOR</td>
1.228 gutterid 12352: <td>EXTRACT_CMD</td>
1.156 leot 12353: </tr>
12354: <tr>
1.227 wiz 12355: <td>EXTRACT_CMD_DEFAULT</td>
1.228 gutterid 12356: <td>EXTRACT_DIR</td>
1.223 nia 12357: </tr>
12358: <tr>
1.227 wiz 12359: <td>EXTRACT_ELEMENTS</td>
1.228 gutterid 12360: <td>EXTRACT_ENV</td>
1.156 leot 12361: </tr>
12362: <tr>
1.227 wiz 12363: <td>EXTRACT_ONLY</td>
1.228 gutterid 12364: <td>EXTRACT_OPTS</td>
1.156 leot 12365: </tr>
12366: <tr>
1.227 wiz 12367: <td>EXTRACT_SUFX</td>
1.228 gutterid 12368: <td>EXTRACT_USING</td>
1.156 leot 12369: </tr>
12370: <tr>
1.227 wiz 12371: <td>FAIL</td>
1.228 gutterid 12372: <td>FAILOVER_FETCH</td>
1.156 leot 12373: </tr>
12374: <tr>
1.227 wiz 12375: <td>FAIL_MSG</td>
1.228 gutterid 12376: <td>FAKE_NCURSES</td>
1.156 leot 12377: </tr>
12378: <tr>
1.227 wiz 12379: <td>FAM</td>
1.228 gutterid 12380: <td>FAM_ACCEPTED</td>
1.156 leot 12381: </tr>
12382: <tr>
1.227 wiz 12383: <td>FAM_DEFAULT</td>
1.228 gutterid 12384: <td>FAM_SERVER</td>
1.156 leot 12385: </tr>
12386: <tr>
1.227 wiz 12387: <td>FCPATH</td>
1.228 gutterid 12388: <td>FEATURE_CPPFLAGS</td>
1.156 leot 12389: </tr>
12390: <tr>
1.227 wiz 12391: <td>FEATURE_LDFLAGS</td>
1.228 gutterid 12392: <td>FEATURE_LIBS</td>
1.156 leot 12393: </tr>
12394: <tr>
1.227 wiz 12395: <td>FETCH_AFTER_ARGS</td>
1.228 gutterid 12396: <td>FETCH_BEFORE_ARGS</td>
1.177 leot 12397: </tr>
12398: <tr>
1.227 wiz 12399: <td>FETCH_CMD</td>
1.228 gutterid 12400: <td>FETCH_OUTPUT_ARGS</td>
1.156 leot 12401: </tr>
12402: <tr>
1.227 wiz 12403: <td>FETCH_PROXY</td>
1.228 gutterid 12404: <td>FETCH_RESUME_ARGS</td>
1.156 leot 12405: </tr>
12406: <tr>
1.227 wiz 12407: <td>FETCH_TIMEOUT</td>
1.228 gutterid 12408: <td>FETCH_USE_IPV4_ONLY</td>
1.156 leot 12409: </tr>
12410: <tr>
1.227 wiz 12411: <td>FETCH_USING</td>
1.228 gutterid 12412: <td>FILES_SUBST</td>
1.156 leot 12413: </tr>
12414: <tr>
1.227 wiz 12415: <td>FILES_SUBST_SED</td>
1.223 nia 12416: <td>FIX_SYSTEM_HEADERS</td>
1.161 leot 12417: </tr>
12418: <tr>
1.226 gutterid 12419: <td>FONTS_DIRS</td>
1.191 bacon 12420: <td>FONTS_VERBOSE</td>
1.177 leot 12421: </tr>
12422: <tr>
1.226 gutterid 12423: <td>FOO_HACKS_MK</td>
1.191 bacon 12424: <td>FOX_USE_XUNICODE</td>
1.156 leot 12425: </tr>
12426: <tr>
1.226 gutterid 12427: <td>FREEWNN_GROUP</td>
1.191 bacon 12428: <td>FREEWNN_USER</td>
1.156 leot 12429: </tr>
12430: <tr>
1.226 gutterid 12431: <td>FTP_PKG_URL_DIR</td>
1.191 bacon 12432: <td>FTP_PKG_URL_HOST</td>
1.156 leot 12433: </tr>
12434: <tr>
1.226 gutterid 12435: <td>GAMEDATAMODE</td>
1.191 bacon 12436: <td>GAMEDATA_PERMS</td>
1.156 leot 12437: </tr>
12438: <tr>
1.226 gutterid 12439: <td>GAMEDIRMODE</td>
1.191 bacon 12440: <td>GAMEDIR_PERMS</td>
1.156 leot 12441: </tr>
12442: <tr>
1.226 gutterid 12443: <td>GAMEGRP</td>
1.191 bacon 12444: <td>GAMEMODE</td>
1.156 leot 12445: </tr>
12446: <tr>
1.226 gutterid 12447: <td>GAMEOWN</td>
1.191 bacon 12448: <td>GAMES_GROUP</td>
1.156 leot 12449: </tr>
12450: <tr>
1.226 gutterid 12451: <td>GAMES_USER</td>
1.191 bacon 12452: <td>GCC</td>
1.156 leot 12453: </tr>
12454: <tr>
1.226 gutterid 12455: <td>GCCBASE</td>
1.191 bacon 12456: <td>GCC_REQD</td>
1.156 leot 12457: </tr>
12458: <tr>
1.226 gutterid 12459: <td>GCC_VERSION_SUFFIX</td>
1.191 bacon 12460: <td>GEM_BUILD</td>
1.156 leot 12461: </tr>
12462: <tr>
1.226 gutterid 12463: <td>GEM_CLEANBUILD</td>
1.191 bacon 12464: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.156 leot 12465: </tr>
12466: <tr>
1.226 gutterid 12467: <td>GEM_DOCDIR</td>
1.191 bacon 12468: <td>GEM_EXTSDIR</td>
1.177 leot 12469: </tr>
12470: <tr>
1.226 gutterid 12471: <td>GEM_HOME</td>
1.191 bacon 12472: <td>GEM_KEEPBUILD</td>
1.156 leot 12473: </tr>
12474: <tr>
1.226 gutterid 12475: <td>GEM_LIBDIR</td>
1.191 bacon 12476: <td>GEM_NAME</td>
1.156 leot 12477: </tr>
12478: <tr>
1.226 gutterid 12479: <td>GEM_PATH</td>
1.198 leot 12480: <td>GEM_PLUGINSDIR</td>
12481: </tr>
12482: <tr>
1.226 gutterid 12483: <td>GEM_SPECFILE</td>
1.180 rillig 12484: <td>GENERATE_PLIST</td>
1.156 leot 12485: </tr>
12486: <tr>
1.226 gutterid 12487: <td>GHC</td>
1.201 cirnatda 12488: <td>GHOSTSCRIPT_REQD</td>
1.156 leot 12489: </tr>
12490: <tr>
1.226 gutterid 12491: <td>GITHUB_PROJECT</td>
1.201 cirnatda 12492: <td>GITHUB_RELEASE</td>
1.177 leot 12493: </tr>
12494: <tr>
1.226 gutterid 12495: <td>GITHUB_SUBMODULES</td>
1.201 cirnatda 12496: <td>GITHUB_TAG</td>
1.159 rillig 12497: </tr>
12498: <tr>
1.226 gutterid 12499: <td>GITHUB_TYPE</td>
1.223 nia 12500: <td>GITLAB_PROJECT</td>
12501: </tr>
12502: <tr>
1.226 gutterid 12503: <td>GITLAB_RELEASE</td>
1.225 gutterid 12504: <td>GITLAB_SUBMODULES</td>
1.223 nia 12505: </tr>
12506: <tr>
1.226 gutterid 12507: <td>GITLAB_TAG</td>
1.225 gutterid 12508: <td>GITLAB_TYPE</td>
1.223 nia 12509: </tr>
12510: <tr>
1.226 gutterid 12511: <td>GNU</td>
1.228 gutterid 12512: <td>GNU_CONFIGURE</td>
1.227 wiz 12513: </tr>
12514: <tr>
12515: <td>GNU_CONFIGURE_INFODIR</td>
1.228 gutterid 12516: <td>GNU_CONFIGURE_MANDIR</td>
1.156 leot 12517: </tr>
12518: <tr>
1.227 wiz 12519: <td>GNU_CONFIGURE_QUIET</td>
1.228 gutterid 12520: <td>GNU_CONFIGURE_STRICT</td>
1.156 leot 12521: </tr>
12522: <tr>
1.227 wiz 12523: <td>GODEP_REDIRECTS</td>
1.228 gutterid 12524: <td>GO_BUILD_PATTERN</td>
1.156 leot 12525: </tr>
12526: <tr>
1.227 wiz 12527: <td>GO_DEPS</td>
1.228 gutterid 12528: <td>GO_DIST_BASE</td>
1.156 leot 12529: </tr>
12530: <tr>
1.227 wiz 12531: <td>GO_EXTRA_MOD_DIRS</td>
1.228 gutterid 12532: <td>GO_MODULE_FILES</td>
1.156 leot 12533: </tr>
12534: <tr>
1.227 wiz 12535: <td>GO_SRCPATH</td>
1.229 ! gutterid 12536: <td>GROUP_SPECIFIC_PKGS</td>
1.156 leot 12537: </tr>
12538: <tr>
1.228 gutterid 12539: <td>GRUB_NETWORK_CARDS</td>
1.229 ! gutterid 12540: <td>GRUB_PRESET_COMMAND</td>
1.156 leot 12541: </tr>
12542: <tr>
1.228 gutterid 12543: <td>GRUB_SCAN_ARGS</td>
1.229 ! gutterid 12544: <td>GZIP</td>
1.156 leot 12545: </tr>
12546: <tr>
1.222 gutterid 12547: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.229 ! gutterid 12548: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.217 rillig 12549: </tr>
12550: <tr>
1.222 gutterid 12551: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.229 ! gutterid 12552: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.226 gutterid 12553: </tr>
12554: <tr>
12555: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.229 ! gutterid 12556: <td>HASKELL_PKG_NAME</td>
1.220 nia 12557: </tr>
12558: <tr>
1.229 ! gutterid 12559: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
1.223 nia 12560: <td>HAS_CONFIGURE</td>
1.229 ! gutterid 12561: </tr>
! 12562: <tr>
1.226 gutterid 12563: <td>HEADER_TEMPLATES</td>
1.229 ! gutterid 12564: <td>HOMEPAGE</td>
1.214 leot 12565: </tr>
12566: <tr>
1.228 gutterid 12567: <td>HOST_PKGTOOLS_ARGS</td>
1.229 ! gutterid 12568: <td>HOST_SPECIFIC_PKGS</td>
1.227 wiz 12569: </tr>
12570: <tr>
1.228 gutterid 12571: <td>HOWL_GROUP</td>
1.229 ! gutterid 12572: <td>HOWL_USER</td>
1.223 nia 12573: </tr>
12574: <tr>
1.228 gutterid 12575: <td>ICCBASE</td>
1.229 ! gutterid 12576: <td>ICECAST_CHROOTDIR</td>
1.156 leot 12577: </tr>
12578: <tr>
1.228 gutterid 12579: <td>ICON_THEMES</td>
1.229 ! gutterid 12580: <td>IDOBASE</td>
1.156 leot 12581: </tr>
12582: <tr>
1.228 gutterid 12583: <td>IGNORE_CCACHE</td>
1.229 ! gutterid 12584: <td>IGNORE_INFO_DIRS</td>
1.191 bacon 12585: </tr>
12586: <tr>
1.228 gutterid 12587: <td>IGNORE_INTERACTIVE_FETCH</td>
1.229 ! gutterid 12588: <td>IMAKE</td>
1.156 leot 12589: </tr>
12590: <tr>
1.228 gutterid 12591: <td>IMAKEOPTS</td>
1.229 ! gutterid 12592: <td>IMAKE_MAKE</td>
1.156 leot 12593: </tr>
12594: <tr>
1.228 gutterid 12595: <td>IMAKE_MANINSTALL</td>
1.229 ! gutterid 12596: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.156 leot 12597: </tr>
12598: <tr>
1.228 gutterid 12599: <td>IMDICTDIR</td>
1.229 ! gutterid 12600: <td>INCOMPAT_CURSES</td>
1.156 leot 12601: </tr>
12602: <tr>
1.228 gutterid 12603: <td>INFO_DIR</td>
1.229 ! gutterid 12604: <td>INFO_FILES</td>
1.156 leot 12605: </tr>
12606: <tr>
1.228 gutterid 12607: <td>INFO_FILES_VERBOSE</td>
1.229 ! gutterid 12608: <td>INFO_MSG</td>
1.156 leot 12609: </tr>
12610: <tr>
1.228 gutterid 12611: <td>INIT_SYSTEM</td>
1.229 ! gutterid 12612: <td>INN_DATA_DIR</td>
1.156 leot 12613: </tr>
12614: <tr>
1.228 gutterid 12615: <td>INN_GROUP</td>
1.229 ! gutterid 12616: <td>INN_USER</td>
1.156 leot 12617: </tr>
12618: <tr>
1.228 gutterid 12619: <td>INSTALLATION_DIRS</td>
1.229 ! gutterid 12620: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.156 leot 12621: </tr>
12622: <tr>
1.228 gutterid 12623: <td>INSTALL_ENV</td>
1.229 ! gutterid 12624: <td>INSTALL_SH_OVERRIDE</td>
1.172 rillig 12625: </tr>
12626: <tr>
1.228 gutterid 12627: <td>INSTALL_SRC</td>
1.229 ! gutterid 12628: <td>INSTALL_TEMPLATES</td>
1.156 leot 12629: </tr>
12630: <tr>
1.228 gutterid 12631: <td>INSTALL_UNSTRIPPED</td>
1.229 ! gutterid 12632: <td>IRCD_HYBRID_IRC_GROUP</td>
1.156 leot 12633: </tr>
12634: <tr>
1.228 gutterid 12635: <td>IRCD_HYBRID_IRC_USER</td>
1.229 ! gutterid 12636: <td>IRCD_HYBRID_MAXCONN</td>
1.156 leot 12637: </tr>
12638: <tr>
1.228 gutterid 12639: <td>IRCD_HYBRID_NICLEN</td>
1.229 ! gutterid 12640: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.156 leot 12641: </tr>
12642: <tr>
1.228 gutterid 12643: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.229 ! gutterid 12644: <td>IRCD_HYBRID_TOPICLEN</td>
1.156 leot 12645: </tr>
12646: <tr>
1.228 gutterid 12647: <td>IRIX</td>
1.229 ! gutterid 12648: <td>IRRD_USE_PGP</td>
1.156 leot 12649: </tr>
12650: <tr>
1.228 gutterid 12651: <td>JABBERD_GROUP</td>
1.229 ! gutterid 12652: <td>JABBERD_LOGDIR</td>
1.156 leot 12653: </tr>
12654: <tr>
1.228 gutterid 12655: <td>JABBERD_PIDDIR</td>
1.229 ! gutterid 12656: <td>JABBERD_SPOOLDIR</td>
1.156 leot 12657: </tr>
12658: <tr>
1.226 gutterid 12659: <td>JABBERD_USER</td>
1.229 ! gutterid 12660: <td>JAVA_BINPREFIX</td>
1.156 leot 12661: </tr>
12662: <tr>
1.228 gutterid 12663: <td>JAVA_CLASSPATH</td>
1.229 ! gutterid 12664: <td>JAVA_HOME</td>
1.227 wiz 12665: </tr>
12666: <tr>
1.228 gutterid 12667: <td>JAVA_LD_LIBRARY_PATH</td>
1.229 ! gutterid 12668: <td>JAVA_NAME</td>
1.177 leot 12669: </tr>
12670: <tr>
1.228 gutterid 12671: <td>JAVA_UNLIMIT</td>
1.229 ! gutterid 12672: <td>JAVA_WRAPPERS</td>
1.156 leot 12673: </tr>
12674: <tr>
1.228 gutterid 12675: <td>JPEG_ACCEPTED</td>
1.229 ! gutterid 12676: <td>JPEG_DEFAULT</td>
1.217 rillig 12677: </tr>
12678: <tr>
1.228 gutterid 12679: <td>KERBEROS</td>
1.229 ! gutterid 12680: <td>KERMIT_SUID_UUCP</td>
1.217 rillig 12681: </tr>
12682: <tr>
1.228 gutterid 12683: <td>KJS_USE_PCRE</td>
1.229 ! gutterid 12684: <td>KNEWS_DOMAIN_FILE</td>
1.156 leot 12685: </tr>
12686: <tr>
1.228 gutterid 12687: <td>KNEWS_DOMAIN_NAME</td>
1.229 ! gutterid 12688: <td>KRB5_ACCEPTED</td>
1.156 leot 12689: </tr>
12690: <tr>
1.228 gutterid 12691: <td>KRB5_DEFAULT</td>
1.229 ! gutterid 12692: <td>LANGUAGES</td>
1.156 leot 12693: </tr>
12694: <tr>
1.228 gutterid 12695: <td>LAPACKE_LIBS</td>
1.229 ! gutterid 12696: <td>LAPACKE_PC</td>
1.156 leot 12697: </tr>
12698: <tr>
1.227 wiz 12699: <td>LAPACK_LIBS</td>
1.229 ! gutterid 12700: <td>LAPACK_PC</td>
1.156 leot 12701: </tr>
12702: <tr>
1.229 ! gutterid 12703: <td>LATEX2HTML_ICONPATH</td>
1.227 wiz 12704: <td>LDCONFIG_ADD_CMD</td>
1.177 leot 12705: </tr>
12706: <tr>
1.229 ! gutterid 12707: <td>LDCONFIG_REMOVE_CMD</td>
1.227 wiz 12708: <td>LDD</td>
1.156 leot 12709: </tr>
12710: <tr>
1.229 ! gutterid 12711: <td>LEAFNODE_DATA_DIR</td>
1.227 wiz 12712: <td>LEAFNODE_GROUP</td>
1.156 leot 12713: </tr>
12714: <tr>
1.229 ! gutterid 12715: <td>LEAFNODE_USER</td>
1.227 wiz 12716: <td>LIBDVDCSS_HOMEPAGE</td>
1.156 leot 12717: </tr>
12718: <tr>
1.229 ! gutterid 12719: <td>LIBDVDCSS_MASTER_SITES</td>
1.227 wiz 12720: <td>LIBRSVG_TYPE</td>
1.156 leot 12721: </tr>
12722: <tr>
1.229 ! gutterid 12723: <td>LIBTOOL</td>
1.227 wiz 12724: <td>LIBTOOLIZE_PLIST</td>
1.205 wiz 12725: </tr>
12726: <tr>
1.229 ! gutterid 12727: <td>LIBTOOL_M4_OVERRIDE</td>
1.227 wiz 12728: <td>LIBUSB_TYPE</td>
1.157 leot 12729: </tr>
12730: <tr>
1.229 ! gutterid 12731: <td>LICENSE</td>
1.227 wiz 12732: <td>LINKER_RPATH_FLAG</td>
1.156 leot 12733: </tr>
12734: <tr>
1.229 ! gutterid 12735: <td>LINK_RPATH_FLAG</td>
1.220 nia 12736: <td>LINUX_LOCALES</td>
1.223 nia 12737: </tr>
12738: <tr>
1.229 ! gutterid 12739: <td>LOCALBASE</td>
1.223 nia 12740: <td>LOCALBASE_LOCKTYPE</td>
1.177 leot 12741: </tr>
12742: <tr>
1.229 ! gutterid 12743: <td>LOCALPATCHES</td>
1.223 nia 12744: <td>LOVE_DATA</td>
1.214 leot 12745: </tr>
12746: <tr>
1.229 ! gutterid 12747: <td>LOVE_GAME</td>
1.223 nia 12748: <td>LOVE_VERSION</td>
1.197 leot 12749: </tr>
12750: <tr>
1.229 ! gutterid 12751: <td>LP32PLATFORMS</td>
1.223 nia 12752: <td>LP64PLATFORMS</td>
1.156 leot 12753: </tr>
12754: <tr>
1.229 ! gutterid 12755: <td>LUA_BUSTED_ARGS</td>
1.223 nia 12756: <td>LUA_CDIR</td>
1.156 leot 12757: </tr>
12758: <tr>
1.229 ! gutterid 12759: <td>LUA_COMPILER</td>
1.223 nia 12760: <td>LUA_DOCDIR</td>
1.221 nia 12761: </tr>
12762: <tr>
1.229 ! gutterid 12763: <td>LUA_EXAMPLESDIR</td>
1.223 nia 12764: <td>LUA_INCDIR</td>
1.218 nia 12765: </tr>
12766: <tr>
1.229 ! gutterid 12767: <td>LUA_INTERPRETER</td>
1.223 nia 12768: <td>LUA_LDIR</td>
1.218 nia 12769: </tr>
12770: <tr>
1.229 ! gutterid 12771: <td>LUA_LINKER_MAGIC</td>
1.223 nia 12772: <td>LUA_PKGPREFIX</td>
1.218 nia 12773: </tr>
12774: <tr>
1.229 ! gutterid 12775: <td>LUA_SELF_CONFLICT</td>
1.223 nia 12776: <td>LUA_USE_BUSTED</td>
1.218 nia 12777: </tr>
12778: <tr>
1.229 ! gutterid 12779: <td>LUA_VERSIONS_ACCEPTED</td>
1.223 nia 12780: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.218 nia 12781: </tr>
12782: <tr>
1.229 ! gutterid 12783: <td>LUA_VERSION_DEFAULT</td>
1.223 nia 12784: <td>LUA_VERSION_REQD</td>
1.218 nia 12785: </tr>
12786: <tr>
1.229 ! gutterid 12787: <td>Lua</td>
1.223 nia 12788: <td>MACHINE_PLATFORM</td>
1.218 nia 12789: </tr>
12790: <tr>
1.229 ! gutterid 12791: <td>MAILAGENT_DOMAIN</td>
1.223 nia 12792: <td>MAILAGENT_EMAIL</td>
1.156 leot 12793: </tr>
12794: <tr>
1.229 ! gutterid 12795: <td>MAILAGENT_FQDN</td>
1.223 nia 12796: <td>MAILAGENT_ORGANIZATION</td>
1.205 wiz 12797: </tr>
12798: <tr>
1.229 ! gutterid 12799: <td>MAJORDOMO_HOMEDIR</td>
1.225 gutterid 12800: <td>MAKEINFO_ARGS</td>
1.227 wiz 12801: </tr>
12802: <tr>
1.229 ! gutterid 12803: <td>MAKE_DIRS</td>
1.227 wiz 12804: <td>MAKE_DIRS_PERMS</td>
1.156 leot 12805: </tr>
12806: <tr>
1.229 ! gutterid 12807: <td>MAKE_ENV</td>
1.227 wiz 12808: <td>MAKE_FILE</td>
1.212 wiz 12809: </tr>
12810: <tr>
1.229 ! gutterid 12811: <td>MAKE_FLAGS</td>
1.227 wiz 12812: <td>MAKE_JOBS</td>
1.156 leot 12813: </tr>
12814: <tr>
1.229 ! gutterid 12815: <td>MAKE_JOBS_SAFE</td>
1.227 wiz 12816: <td>MAKE_PROGRAM</td>
1.156 leot 12817: </tr>
12818: <tr>
1.229 ! gutterid 12819: <td>MANCOMPRESSED_IF_MANZ</td>
1.227 wiz 12820: <td>MANINSTALL</td>
1.156 leot 12821: </tr>
12822: <tr>
1.229 ! gutterid 12823: <td>MANZ</td>
1.227 wiz 12824: <td>MASTER_SITES</td>
1.156 leot 12825: </tr>
12826: <tr>
1.229 ! gutterid 12827: <td>MASTER_SITE_BACKUP</td>
1.227 wiz 12828: <td>MASTER_SITE_LOCAL</td>
1.189 bacon 12829: </tr>
12830: <tr>
1.229 ! gutterid 12831: <td>MASTER_SITE_MOZILLA</td>
1.227 wiz 12832: <td>MASTER_SITE_OVERRIDE</td>
1.156 leot 12833: </tr>
12834: <tr>
1.229 ! gutterid 12835: <td>MASTER_SITE_PERL_CPAN</td>
1.227 wiz 12836: <td>MASTER_SORT</td>
1.156 leot 12837: </tr>
12838: <tr>
1.229 ! gutterid 12839: <td>MASTER_SORT_RANDOM</td>
1.227 wiz 12840: <td>MASTER_SORT_REGEX</td>
1.156 leot 12841: </tr>
12842: <tr>
1.229 ! gutterid 12843: <td>MECAB_CHARSET</td>
1.227 wiz 12844: <td>MEDIATOMB_GROUP</td>
1.156 leot 12845: </tr>
12846: <tr>
1.229 ! gutterid 12847: <td>MEDIATOMB_USER</td>
1.227 wiz 12848: <td>MIPSPROBASE</td>
1.156 leot 12849: </tr>
12850: <tr>
1.229 ! gutterid 12851: <td>MIREDO_GROUP</td>
1.227 wiz 12852: <td>MIREDO_USER</td>
1.156 leot 12853: </tr>
12854: <tr>
1.229 ! gutterid 12855: <td>MISSING_FEATURES</td>
1.227 wiz 12856: <td>MKDIR</td>
1.156 leot 12857: </tr>
12858: <tr>
1.229 ! gutterid 12859: <td>MKPIE_SUPPORTED</td>
1.227 wiz 12860: <td>MLDONKEY_GROUP</td>
1.156 leot 12861: </tr>
12862: <tr>
1.229 ! gutterid 12863: <td>MLDONKEY_HOME</td>
1.227 wiz 12864: <td>MLDONKEY_USER</td>
1.156 leot 12865: </tr>
12866: <tr>
1.229 ! gutterid 12867: <td>MONOTONE_GROUP</td>
1.227 wiz 12868: <td>MONOTONE_USER</td>
1.207 leot 12869: </tr>
12870: <tr>
1.229 ! gutterid 12871: <td>MOTIFBASE</td>
1.227 wiz 12872: <td>MOTIF_TYPE</td>
1.156 leot 12873: </tr>
12874: <tr>
1.229 ! gutterid 12875: <td>MOTIF_TYPE_DEFAULT</td>
1.227 wiz 12876: <td>MPI_TYPE</td>
1.156 leot 12877: </tr>
12878: <tr>
1.229 ! gutterid 12879: <td>MSGFMT_STRIP_MSGCTXT</td>
1.227 wiz 12880: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.156 leot 12881: </tr>
12882: <tr>
1.229 ! gutterid 12883: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.221 nia 12884: <td>MV</td>
1.223 nia 12885: </tr>
12886: <tr>
1.229 ! gutterid 12887: <td>MYSQL_CHARSET</td>
1.223 nia 12888: <td>MYSQL_DATADIR</td>
1.214 leot 12889: </tr>
12890: <tr>
1.229 ! gutterid 12891: <td>MYSQL_EXTRA_CHARSET</td>
1.223 nia 12892: <td>MYSQL_GROUP</td>
1.197 leot 12893: </tr>
12894: <tr>
1.229 ! gutterid 12895: <td>MYSQL_USER</td>
1.223 nia 12896: <td>MYSQL_VERSION</td>
1.205 wiz 12897: </tr>
12898: <tr>
1.229 ! gutterid 12899: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.223 nia 12900: <td>MYSQL_VERSIONS_ALL</td>
1.156 leot 12901: </tr>
12902: <tr>
1.229 ! gutterid 12903: <td>MYSQL_VERSION_DEFAULT</td>
1.223 nia 12904: <td>NAGIOSCMD_GROUP</td>
1.156 leot 12905: </tr>
12906: <tr>
1.229 ! gutterid 12907: <td>NAGIOSDIR</td>
1.223 nia 12908: <td>NAGIOS_GROUP</td>
1.156 leot 12909: </tr>
12910: <tr>
1.229 ! gutterid 12911: <td>NAGIOS_USER</td>
1.223 nia 12912: <td>NATIVE_APPEND_ABI</td>
1.156 leot 12913: </tr>
12914: <tr>
1.229 ! gutterid 12915: <td>NATIVE_APPEND_ELF</td>
1.223 nia 12916: <td>NATIVE_EXEC_FMT</td>
1.195 gutterid 12917: </tr>
12918: <tr>
1.229 ! gutterid 12919: <td>NATIVE_MACHINE_PLATFORM</td>
1.223 nia 12920: <td>NATIVE_OBJECT_FMT</td>
1.156 leot 12921: </tr>
12922: <tr>
1.229 ! gutterid 12923: <td>NBPAX_PROGRAM_PREFIX</td>
1.223 nia 12924: <td>NETBSD_LOGIN_NAME</td>
1.156 leot 12925: </tr>
12926: <tr>
1.229 ! gutterid 12927: <td>NMH_EDITOR</td>
1.223 nia 12928: <td>NMH_MTA</td>
1.156 leot 12929: </tr>
12930: <tr>
1.229 ! gutterid 12931: <td>NMH_PAGER</td>
1.223 nia 12932: <td>NODE_VERSIONS_ACCEPTED</td>
1.156 leot 12933: </tr>
12934: <tr>
1.229 ! gutterid 12935: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.223 nia 12936: <td>NODE_VERSION_DEFAULT</td>
1.156 leot 12937: </tr>
12938: <tr>
1.229 ! gutterid 12939: <td>NODE_VERSION_REQD</td>
1.223 nia 12940: <td>NOLOGIN</td>
1.229 ! gutterid 12941: </tr>
! 12942: <tr>
1.226 gutterid 12943: <td>NOTE</td>
1.229 ! gutterid 12944: <td>NOT_FOR_PLATFORM</td>
1.218 nia 12945: </tr>
12946: <tr>
1.226 gutterid 12947: <td>NOT_PAX_ASLR_SAFE</td>
1.229 ! gutterid 12948: <td>NOT_PAX_MPROTECT_SAFE</td>
1.218 nia 12949: </tr>
12950: <tr>
1.226 gutterid 12951: <td>NO_BUILD</td>
1.229 ! gutterid 12952: <td>NO_CHECKSUM</td>
1.156 leot 12953: </tr>
12954: <tr>
1.226 gutterid 12955: <td>NO_CONFIGURE</td>
1.229 ! gutterid 12956: <td>NO_SKIP</td>
1.178 rillig 12957: </tr>
12958: <tr>
1.226 gutterid 12959: <td>NS_PREFERRED</td>
1.229 ! gutterid 12960: <td>NULLMAILER_GROUP</td>
1.156 leot 12961: </tr>
12962: <tr>
1.226 gutterid 12963: <td>NULLMAILER_USER</td>
1.229 ! gutterid 12964: <td>OASIS</td>
1.156 leot 12965: </tr>
12966: <tr>
1.226 gutterid 12967: <td>OASIS_BUILD_ARGS</td>
1.229 ! gutterid 12968: <td>OBJHOSTNAME</td>
1.156 leot 12969: </tr>
12970: <tr>
1.226 gutterid 12971: <td>OBJMACHINE</td>
1.229 ! gutterid 12972: <td>OCAML_FINDLIB_DIRS</td>
1.156 leot 12973: </tr>
12974: <tr>
1.226 gutterid 12975: <td>OCAML_FINDLIB_REGISTER</td>
1.229 ! gutterid 12976: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.156 leot 12977: </tr>
12978: <tr>
1.226 gutterid 12979: <td>OCAML_SITELIBDIR</td>
1.229 ! gutterid 12980: <td>OCAML_TOPKG_DOCDIR</td>
1.156 leot 12981: </tr>
12982: <tr>
1.226 gutterid 12983: <td>OCAML_USE_DUNE</td>
1.229 ! gutterid 12984: <td>OCAML_USE_FINDLIB</td>
1.156 leot 12985: </tr>
12986: <tr>
1.226 gutterid 12987: <td>OCAML_USE_OASIS</td>
1.229 ! gutterid 12988: <td>OCAML_USE_OASIS_DYNRUN</td>
1.156 leot 12989: </tr>
12990: <tr>
1.226 gutterid 12991: <td>OCAML_USE_OPAM</td>
1.229 ! gutterid 12992: <td>OCAML_USE_TOPKG</td>
1.156 leot 12993: </tr>
12994: <tr>
1.226 gutterid 12995: <td>OMF</td>
1.229 ! gutterid 12996: <td>ONLY_FOR_COMPILER</td>
1.156 leot 12997: </tr>
12998: <tr>
1.226 gutterid 12999: <td>ONLY_FOR_PLATFORM</td>
1.229 ! gutterid 13000: <td>OPENSSH_CHROOT</td>
1.156 leot 13001: </tr>
13002: <tr>
1.226 gutterid 13003: <td>OPENSSH_GROUP</td>
1.229 ! gutterid 13004: <td>OPENSSH_USER</td>
1.156 leot 13005: </tr>
13006: <tr>
1.226 gutterid 13007: <td>OPSYS</td>
1.229 ! gutterid 13008: <td>OPSYS_EMULDIR</td>
1.156 leot 13009: </tr>
13010: <tr>
1.226 gutterid 13011: <td>OPSYS_VERSION</td>
1.229 ! gutterid 13012: <td>OS</td>
1.156 leot 13013: </tr>
13014: <tr>
1.226 gutterid 13015: <td>OSS_TYPE</td>
1.229 ! gutterid 13016: <td>OSX</td>
1.156 leot 13017: </tr>
13018: <tr>
1.226 gutterid 13019: <td>OSX_TOLERATE_SDK_SKEW</td>
1.229 ! gutterid 13020: <td>OS_VARIANT</td>
1.156 leot 13021: </tr>
13022: <tr>
1.226 gutterid 13023: <td>OS_VERSION</td>
1.229 ! gutterid 13024: <td>OTF_FONTS_DIR</td>
1.223 nia 13025: </tr>
13026: <tr>
1.226 gutterid 13027: <td>OVERRIDE_DIRDEPTH</td>
1.229 ! gutterid 13028: <td>OVERRIDE_GEMSPEC</td>
1.212 wiz 13029: </tr>
13030: <tr>
1.226 gutterid 13031: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.229 ! gutterid 13032: <td>OWN_DIRS</td>
1.214 leot 13033: </tr>
13034: <tr>
1.228 gutterid 13035: <td>OWN_DIRS_PERMS</td>
1.229 ! gutterid 13036: <td>P4GROUP</td>
1.227 wiz 13037: </tr>
13038: <tr>
1.228 gutterid 13039: <td>P4PORT</td>
1.229 ! gutterid 13040: <td>P4ROOT</td>
1.205 wiz 13041: </tr>
13042: <tr>
1.228 gutterid 13043: <td>P4USER</td>
1.229 ! gutterid 13044: <td>PACKAGES</td>
1.161 leot 13045: </tr>
13046: <tr>
1.228 gutterid 13047: <td>PALMOS_DEFAULT_SDK</td>
1.229 ! gutterid 13048: <td>PAMBASE</td>
1.156 leot 13049: </tr>
13050: <tr>
1.228 gutterid 13051: <td>PAM_DEFAULT</td>
1.229 ! gutterid 13052: <td>PAPERSIZE</td>
1.156 leot 13053: </tr>
13054: <tr>
1.228 gutterid 13055: <td>PASSIVE_FETCH</td>
1.229 ! gutterid 13056: <td>PATCHDIR</td>
1.156 leot 13057: </tr>
13058: <tr>
1.228 gutterid 13059: <td>PATCHFILES</td>
1.229 ! gutterid 13060: <td>PATCH_ARGS</td>
1.156 leot 13061: </tr>
13062: <tr>
1.228 gutterid 13063: <td>PATCH_DEBUG</td>
1.229 ! gutterid 13064: <td>PATCH_DIST_ARGS</td>
1.156 leot 13065: </tr>
13066: <tr>
1.228 gutterid 13067: <td>PATCH_DIST_CAT</td>
1.229 ! gutterid 13068: <td>PATCH_DIST_STRIP</td>
1.209 nia 13069: </tr>
13070: <tr>
1.228 gutterid 13071: <td>PATCH_FUZZ_FACTOR</td>
1.229 ! gutterid 13072: <td>PATCH_STRIP</td>
1.156 leot 13073: </tr>
13074: <tr>
1.228 gutterid 13075: <td>PATH</td>
1.229 ! gutterid 13076: <td>PCCBASE</td>
1.156 leot 13077: </tr>
13078: <tr>
1.228 gutterid 13079: <td>PEAR_CMD</td>
1.229 ! gutterid 13080: <td>PEAR_LIB</td>
1.227 wiz 13081: </tr>
13082: <tr>
1.228 gutterid 13083: <td>PEAR_PACKAGE_XML</td>
1.229 ! gutterid 13084: <td>PERL5</td>
1.156 leot 13085: </tr>
13086: <tr>
1.228 gutterid 13087: <td>PERL5_CONFIGURE</td>
1.229 ! gutterid 13088: <td>PERL5_CONFIGURE_DIRS</td>
1.217 rillig 13089: </tr>
13090: <tr>
1.228 gutterid 13091: <td>PERL5_LDFLAGS</td>
1.229 ! gutterid 13092: <td>PERL5_LICENSE</td>
1.205 wiz 13093: </tr>
13094: <tr>
1.228 gutterid 13095: <td>PERL5_MODULE_TYPE</td>
1.229 ! gutterid 13096: <td>PERL5_PACKLIST</td>
1.177 leot 13097: </tr>
13098: <tr>
1.228 gutterid 13099: <td>PERL5_PACKLIST_DIR</td>
1.229 ! gutterid 13100: <td>PERL5_PERLBASE</td>
1.161 leot 13101: </tr>
13102: <tr>
1.228 gutterid 13103: <td>PERL5_SITEBASE</td>
1.229 ! gutterid 13104: <td>PERL5_USE_PACKLIST</td>
1.161 leot 13105: </tr>
13106: <tr>
1.228 gutterid 13107: <td>PERL5_VENDORBASE</td>
1.229 ! gutterid 13108: <td>PFCTL</td>
1.156 leot 13109: </tr>
13110: <tr>
1.228 gutterid 13111: <td>PFVAR_H</td>
1.229 ! gutterid 13112: <td>PF_VERSION</td>
1.156 leot 13113: </tr>
13114: <tr>
1.228 gutterid 13115: <td>PGGROUP</td>
1.229 ! gutterid 13116: <td>PGHOME</td>
1.156 leot 13117: </tr>
13118: <tr>
1.228 gutterid 13119: <td>PGPKGSRCDIR</td>
1.229 ! gutterid 13120: <td>PGSQL_TYPE</td>
1.156 leot 13121: </tr>
13122: <tr>
1.228 gutterid 13123: <td>PGSQL_VERSION</td>
1.229 ! gutterid 13124: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.156 leot 13125: </tr>
13126: <tr>
1.228 gutterid 13127: <td>PGSQL_VERSION_DEFAULT</td>
1.229 ! gutterid 13128: <td>PGUSER</td>
1.156 leot 13129: </tr>
13130: <tr>
1.228 gutterid 13131: <td>PG_LIB_EXT</td>
1.229 ! gutterid 13132: <td>PHP</td>
1.156 leot 13133: </tr>
13134: <tr>
1.228 gutterid 13135: <td>PHPCOMMON_MK</td>
1.229 ! gutterid 13136: <td>PHPPKGSRCDIR</td>
1.156 leot 13137: </tr>
13138: <tr>
1.228 gutterid 13139: <td>PHP_BASE_VERS</td>
1.229 ! gutterid 13140: <td>PHP_CHECK_INSTALLED</td>
1.156 leot 13141: </tr>
13142: <tr>
1.228 gutterid 13143: <td>PHP_EXTENSION_DIR</td>
1.229 ! gutterid 13144: <td>PHP_INITIAL_TEENY</td>
1.156 leot 13145: </tr>
13146: <tr>
1.228 gutterid 13147: <td>PHP_PKG_PREFIX</td>
1.229 ! gutterid 13148: <td>PHP_VERSION</td>
1.156 leot 13149: </tr>
13150: <tr>
1.228 gutterid 13151: <td>PHP_VERSIONS_ACCEPTED</td>
1.229 ! gutterid 13152: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.156 leot 13153: </tr>
13154: <tr>
1.228 gutterid 13155: <td>PHP_VERSION_DEFAULT</td>
1.229 ! gutterid 13156: <td>PHP_VERSION_REQD</td>
1.156 leot 13157: </tr>
13158: <tr>
1.228 gutterid 13159: <td>PILRC_USE_GTK</td>
1.229 ! gutterid 13160: <td>PKGCONFIG_BASE</td>
1.156 leot 13161: </tr>
13162: <tr>
1.228 gutterid 13163: <td>PKGCONFIG_FILE</td>
1.229 ! gutterid 13164: <td>PKGCONFIG_OVERRIDE</td>
1.156 leot 13165: </tr>
13166: <tr>
1.228 gutterid 13167: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.229 ! gutterid 13168: <td>PKGDIR</td>
1.156 leot 13169: </tr>
13170: <tr>
1.228 gutterid 13171: <td>PKGGNUDIR</td>
1.229 ! gutterid 13172: <td>PKGINFODIR</td>
1.156 leot 13173: </tr>
13174: <tr>
1.228 gutterid 13175: <td>PKGLOCALEDIR</td>
1.229 ! gutterid 13176: <td>PKGMANDIR</td>
1.156 leot 13177: </tr>
13178: <tr>
1.228 gutterid 13179: <td>PKGNAME</td>
1.229 ! gutterid 13180: <td>PKGNAME_REQD</td>
1.156 leot 13181: </tr>
13182: <tr>
1.228 gutterid 13183: <td>PKGPATH</td>
1.229 ! gutterid 13184: <td>PKGREVISION</td>
1.156 leot 13185: </tr>
13186: <tr>
1.228 gutterid 13187: <td>PKGSRC_BLAS_TYPES</td>
1.229 ! gutterid 13188: <td>PKGSRC_CHANGES</td>
1.156 leot 13189: </tr>
13190: <tr>
1.228 gutterid 13191: <td>PKGSRC_COMPILER</td>
1.229 ! gutterid 13192: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.156 leot 13193: </tr>
13194: <tr>
1.228 gutterid 13195: <td>PKGSRC_LOCKTYPE</td>
1.229 ! gutterid 13196: <td>PKGSRC_MAKE_ENV</td>
1.156 leot 13197: </tr>
13198: <tr>
1.228 gutterid 13199: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.229 ! gutterid 13200: <td>PKGSRC_MKPIE</td>
1.156 leot 13201: </tr>
13202: <tr>
1.228 gutterid 13203: <td>PKGSRC_MKREPRO</td>
1.229 ! gutterid 13204: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.177 leot 13205: </tr>
13206: <tr>
1.228 gutterid 13207: <td>PKGSRC_RUN_TEST</td>
1.229 ! gutterid 13208: <td>PKGSRC_SETENV</td>
1.156 leot 13209: </tr>
13210: <tr>
1.228 gutterid 13211: <td>PKGSRC_SLEEPSECS</td>
1.229 ! gutterid 13212: <td>PKGSRC_TODO</td>
1.159 rillig 13213: </tr>
13214: <tr>
1.228 gutterid 13215: <td>PKGSRC_USE_CTF</td>
1.229 ! gutterid 13216: <td>PKGSRC_USE_FORTIFY</td>
1.156 leot 13217: </tr>
13218: <tr>
1.228 gutterid 13219: <td>PKGSRC_USE_MKTOOLS</td>
1.229 ! gutterid 13220: <td>PKGSRC_USE_RELRO</td>
1.156 leot 13221: </tr>
13222: <tr>
1.228 gutterid 13223: <td>PKGSRC_USE_SSP</td>
1.229 ! gutterid 13224: <td>PKGSRC_USE_STACK_CHECK</td>
1.156 leot 13225: </tr>
13226: <tr>
1.228 gutterid 13227: <td>PKGTASKS_DATAFILE</td>
1.229 ! gutterid 13228: <td>PKGTOOLS_ARGS</td>
1.156 leot 13229: </tr>
13230: <tr>
1.228 gutterid 13231: <td>PKGTOOLS_ENV</td>
1.229 ! gutterid 13232: <td>PKG_ALTERNATIVES</td>
1.156 leot 13233: </tr>
13234: <tr>
1.228 gutterid 13235: <td>PKG_APACHE</td>
1.229 ! gutterid 13236: <td>PKG_APACHE_ACCEPTED</td>
1.156 leot 13237: </tr>
13238: <tr>
1.228 gutterid 13239: <td>PKG_APACHE_DEFAULT</td>
1.229 ! gutterid 13240: <td>PKG_BEST_EXISTS</td>
1.156 leot 13241: </tr>
13242: <tr>
1.228 gutterid 13243: <td>PKG_BUILD_OPTIONS</td>
1.229 ! gutterid 13244: <td>PKG_COMPRESSION</td>
1.156 leot 13245: </tr>
13246: <tr>
1.228 gutterid 13247: <td>PKG_CONFIG</td>
1.229 ! gutterid 13248: <td>PKG_CONFIG_PERMS</td>
1.156 leot 13249: </tr>
13250: <tr>
1.228 gutterid 13251: <td>PKG_CREATE_USERGROUP</td>
1.229 ! gutterid 13252: <td>PKG_DB_TMPDIR</td>
1.156 leot 13253: </tr>
13254: <tr>
1.228 gutterid 13255: <td>PKG_DEBUG_LEVEL</td>
1.229 ! gutterid 13256: <td>PKG_DEFAULT_OPTIONS</td>
1.156 leot 13257: </tr>
13258: <tr>
1.228 gutterid 13259: <td>PKG_DESTDIR_SUPPORT</td>
1.229 ! gutterid 13260: <td>PKG_DEVELOPER</td>
1.156 leot 13261: </tr>
13262: <tr>
1.228 gutterid 13263: <td>PKG_DISABLED_OPTIONS</td>
1.229 ! gutterid 13264: <td>PKG_FATAL_ERRORS</td>
1.156 leot 13265: </tr>
13266: <tr>
1.228 gutterid 13267: <td>PKG_FC</td>
1.229 ! gutterid 13268: <td>PKG_FILELIST_CMD</td>
1.156 leot 13269: </tr>
13270: <tr>
1.228 gutterid 13271: <td>PKG_GECOS</td>
1.229 ! gutterid 13272: <td>PKG_GID</td>
1.156 leot 13273: </tr>
13274: <tr>
1.228 gutterid 13275: <td>PKG_GROUPS</td>
1.229 ! gutterid 13276: <td>PKG_GROUPS_VARS</td>
1.156 leot 13277: </tr>
13278: <tr>
1.228 gutterid 13279: <td>PKG_HOME</td>
1.229 ! gutterid 13280: <td>PKG_INIT_SCRIPTS</td>
1.156 leot 13281: </tr>
13282: <tr>
1.228 gutterid 13283: <td>PKG_JAVA_HOME</td>
1.229 ! gutterid 13284: <td>PKG_JVM</td>
1.156 leot 13285: </tr>
13286: <tr>
1.228 gutterid 13287: <td>PKG_JVMS_ACCEPTED</td>
1.229 ! gutterid 13288: <td>PKG_JVM_DEFAULT</td>
1.156 leot 13289: </tr>
13290: <tr>
1.228 gutterid 13291: <td>PKG_LEGACY_OPTIONS</td>
1.229 ! gutterid 13292: <td>PKG_LIBTOOL</td>
1.156 leot 13293: </tr>
13294: <tr>
1.228 gutterid 13295: <td>PKG_MKSYMLINKS</td>
1.229 ! gutterid 13296: <td>PKG_OPTIONS</td>
1.156 leot 13297: </tr>
13298: <tr>
1.228 gutterid 13299: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.229 ! gutterid 13300: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.226 gutterid 13301: </tr>
13302: <tr>
1.228 gutterid 13303: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.229 ! gutterid 13304: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.156 leot 13305: </tr>
13306: <tr>
1.228 gutterid 13307: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.229 ! gutterid 13308: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.156 leot 13309: </tr>
13310: <tr>
1.228 gutterid 13311: <td>PKG_OPTIONS_VAR</td>
1.229 ! gutterid 13312: <td>PKG_PHP</td>
1.156 leot 13313: </tr>
13314: <tr>
1.228 gutterid 13315: <td>PKG_PHP_MAJOR_VERS</td>
1.229 ! gutterid 13316: <td>PKG_PHP_VERSION</td>
1.156 leot 13317: </tr>
13318: <tr>
1.228 gutterid 13319: <td>PKG_RCD_SCRIPTS</td>
1.229 ! gutterid 13320: <td>PKG_REFCOUNT_DBDIR</td>
1.156 leot 13321: </tr>
13322: <tr>
1.228 gutterid 13323: <td>PKG_REGISTER_SHELLS</td>
1.229 ! gutterid 13324: <td>PKG_RESUME_TRANSFERS</td>
1.156 leot 13325: </tr>
13326: <tr>
1.228 gutterid 13327: <td>PKG_SHELL</td>
1.229 ! gutterid 13328: <td>PKG_SUGGESTED_OPTIONS</td>
1.156 leot 13329: </tr>
13330: <tr>
1.228 gutterid 13331: <td>PKG_SUPPORTED_OPTIONS</td>
1.229 ! gutterid 13332: <td>PKG_SYSCONFBASE</td>
1.156 leot 13333: </tr>
13334: <tr>
1.228 gutterid 13335: <td>PKG_SYSCONFBASEDIR</td>
1.229 ! gutterid 13336: <td>PKG_SYSCONFDIR</td>
1.156 leot 13337: </tr>
13338: <tr>
1.228 gutterid 13339: <td>PKG_SYSCONFDIR_PERMS</td>
1.229 ! gutterid 13340: <td>PKG_SYSCONFSUBDIR</td>
1.156 leot 13341: </tr>
13342: <tr>
1.228 gutterid 13343: <td>PKG_SYSCONFVAR</td>
1.229 ! gutterid 13344: <td>PKG_TOOLS_BIN</td>
1.156 leot 13345: </tr>
13346: <tr>
1.228 gutterid 13347: <td>PKG_UID</td>
1.229 ! gutterid 13348: <td>PKG_UPDATE_FONTS_DB</td>
1.156 leot 13349: </tr>
13350: <tr>
1.228 gutterid 13351: <td>PKG_USERS</td>
1.229 ! gutterid 13352: <td>PKG_USERS_VARS</td>
1.156 leot 13353: </tr>
13354: <tr>
1.228 gutterid 13355: <td>PKG_VERBOSE</td>
1.229 ! gutterid 13356: <td>PLEASE</td>
1.156 leot 13357: </tr>
13358: <tr>
1.228 gutterid 13359: <td>PLIST</td>
1.229 ! gutterid 13360: <td>PLIST_AWK</td>
1.156 leot 13361: </tr>
13362: <tr>
1.228 gutterid 13363: <td>PLIST_AWK_ENV</td>
1.229 ! gutterid 13364: <td>PLIST_SRC</td>
1.156 leot 13365: </tr>
13366: <tr>
1.228 gutterid 13367: <td>PLIST_SUBST</td>
1.229 ! gutterid 13368: <td>PLIST_TYPE</td>
1.156 leot 13369: </tr>
13370: <tr>
1.228 gutterid 13371: <td>PLIST_VARS</td>
1.229 ! gutterid 13372: <td>POPTOP_USE_MPPE</td>
1.156 leot 13373: </tr>
13374: <tr>
1.228 gutterid 13375: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.229 ! gutterid 13376: <td>POST_FETCH_HOOK</td>
1.156 leot 13377: </tr>
13378: <tr>
1.228 gutterid 13379: <td>PREFER</td>
1.229 ! gutterid 13380: <td>PREFER_NATIVE</td>
1.156 leot 13381: </tr>
13382: <tr>
1.228 gutterid 13383: <td>PREFER_NATIVE_PTHREADS</td>
1.229 ! gutterid 13384: <td>PREFER_PKGSRC</td>
1.156 leot 13385: </tr>
13386: <tr>
1.228 gutterid 13387: <td>PREFIX</td>
1.229 ! gutterid 13388: <td>PREPEND_PATH</td>
1.156 leot 13389: </tr>
13390: <tr>
1.228 gutterid 13391: <td>PRE_ROOT_CMD</td>
1.229 ! gutterid 13392: <td>PRIVILEGED_STAGES</td>
1.156 leot 13393: </tr>
13394: <tr>
1.228 gutterid 13395: <td>PS</td>
1.229 ! gutterid 13396: <td>PTHREAD_AUTO_VARS</td>
1.156 leot 13397: </tr>
13398: <tr>
1.228 gutterid 13399: <td>PTHREAD_CFLAGS</td>
1.229 ! gutterid 13400: <td>PTHREAD_LDFLAGS</td>
1.156 leot 13401: </tr>
13402: <tr>
1.228 gutterid 13403: <td>PTHREAD_LIBS</td>
1.229 ! gutterid 13404: <td>PTHREAD_OPTS</td>
1.156 leot 13405: </tr>
13406: <tr>
1.228 gutterid 13407: <td>PTHREAD_TYPE</td>
1.229 ! gutterid 13408: <td>PVM_SSH</td>
1.156 leot 13409: </tr>
13410: <tr>
1.228 gutterid 13411: <td>PYPKGPREFIX</td>
1.229 ! gutterid 13412: <td>PYTHON_FOR_BUILD_ONLY</td>
1.156 leot 13413: </tr>
13414: <tr>
1.228 gutterid 13415: <td>PYTHON_SELF_CONFLICT</td>
1.229 ! gutterid 13416: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.156 leot 13417: </tr>
13418: <tr>
1.228 gutterid 13419: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.229 ! gutterid 13420: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.156 leot 13421: </tr>
13422: <tr>
1.228 gutterid 13423: <td>PYTHON_VERSION_DEFAULT</td>
1.229 ! gutterid 13424: <td>PYTHON_VERSION_REQD</td>
1.156 leot 13425: </tr>
13426: <tr>
1.228 gutterid 13427: <td>PYVERSSUFFIX</td>
1.229 ! gutterid 13428: <td>QMAILDIR</td>
1.156 leot 13429: </tr>
13430: <tr>
1.228 gutterid 13431: <td>QMAIL_ALIAS_USER</td>
1.229 ! gutterid 13432: <td>QMAIL_DAEMON_USER</td>
1.156 leot 13433: </tr>
13434: <tr>
1.228 gutterid 13435: <td>QMAIL_LOG_USER</td>
1.229 ! gutterid 13436: <td>QMAIL_NOFILES_GROUP</td>
1.156 leot 13437: </tr>
13438: <tr>
1.228 gutterid 13439: <td>QMAIL_PASSWD_USER</td>
1.229 ! gutterid 13440: <td>QMAIL_QMAIL_GROUP</td>
1.156 leot 13441: </tr>
13442: <tr>
1.228 gutterid 13443: <td>QMAIL_QUEUE_DIR</td>
1.229 ! gutterid 13444: <td>QMAIL_QUEUE_EXTRA</td>
1.156 leot 13445: </tr>
13446: <tr>
1.228 gutterid 13447: <td>QMAIL_QUEUE_USER</td>
1.229 ! gutterid 13448: <td>QMAIL_REMOTE_USER</td>
1.156 leot 13449: </tr>
13450: <tr>
1.228 gutterid 13451: <td>QMAIL_ROOT_USER</td>
1.229 ! gutterid 13452: <td>QMAIL_SEND_USER</td>
1.156 leot 13453: </tr>
13454: <tr>
1.228 gutterid 13455: <td>QORE_LATEST_MODULE_API</td>
1.229 ! gutterid 13456: <td>QORE_MODULE_API</td>
1.156 leot 13457: </tr>
13458: <tr>
1.228 gutterid 13459: <td>QORE_MODULE_DIR</td>
1.229 ! gutterid 13460: <td>QORE_USER_MODULE_DIR</td>
1.156 leot 13461: </tr>
13462: <tr>
1.228 gutterid 13463: <td>QORE_VERSION</td>
1.229 ! gutterid 13464: <td>QPOPPER_FAC</td>
1.156 leot 13465: </tr>
13466: <tr>
1.228 gutterid 13467: <td>QPOPPER_SPOOL_DIR</td>
1.229 ! gutterid 13468: <td>QPOPPER_USER</td>
1.218 nia 13469: </tr>
13470: <tr>
1.228 gutterid 13471: <td>RAKE_NAME</td>
1.229 ! gutterid 13472: <td>RASMOL_DEPTH</td>
1.218 nia 13473: </tr>
13474: <tr>
1.228 gutterid 13475: <td>RCD_SCRIPTS</td>
1.229 ! gutterid 13476: <td>RCD_SCRIPTS_DIR</td>
1.227 wiz 13477: </tr>
13478: <tr>
1.228 gutterid 13479: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.229 ! gutterid 13480: <td>RCD_SCRIPTS_MODE</td>
1.156 leot 13481: </tr>
13482: <tr>
1.228 gutterid 13483: <td>RCD_SCRIPTS_SHELL</td>
1.229 ! gutterid 13484: <td>RCD_SCRIPT_SRC</td>
1.214 leot 13485: </tr>
13486: <tr>
1.226 gutterid 13487: <td>RDOC</td>
1.229 ! gutterid 13488: <td>READLINE_DEFAULT</td>
1.205 wiz 13489: </tr>
13490: <tr>
1.226 gutterid 13491: <td>READLINE_TYPE</td>
1.229 ! gutterid 13492: <td>REAL_ROOT_GROUP</td>
1.223 nia 13493: </tr>
13494: <tr>
1.226 gutterid 13495: <td>REAL_ROOT_USER</td>
1.229 ! gutterid 13496: <td>RECURSIVE_MAKE</td>
1.177 leot 13497: </tr>
13498: <tr>
1.226 gutterid 13499: <td>RELAY_CTRL_DIR</td>
1.229 ! gutterid 13500: <td>RELRO_SUPPORTED</td>
1.214 leot 13501: </tr>
13502: <tr>
1.226 gutterid 13503: <td>REPLACE_AWK</td>
1.229 ! gutterid 13504: <td>REPLACE_BASH</td>
1.212 wiz 13505: </tr>
13506: <tr>
1.226 gutterid 13507: <td>REPLACE_CSH</td>
1.229 ! gutterid 13508: <td>REPLACE_KSH</td>
1.156 leot 13509: </tr>
13510: <tr>
1.226 gutterid 13511: <td>REPLACE_LUA</td>
1.229 ! gutterid 13512: <td>REPLACE_NODEJS</td>
1.205 wiz 13513: </tr>
13514: <tr>
1.226 gutterid 13515: <td>REPLACE_OCTAVE</td>
1.229 ! gutterid 13516: <td>REPLACE_PERL</td>
1.197 leot 13517: </tr>
13518: <tr>
1.226 gutterid 13519: <td>REPLACE_PERL6</td>
1.229 ! gutterid 13520: <td>REPLACE_PHP</td>
1.156 leot 13521: </tr>
13522: <tr>
1.226 gutterid 13523: <td>REPLACE_PYTHON</td>
1.229 ! gutterid 13524: <td>REPLACE_QORE</td>
1.218 nia 13525: </tr>
13526: <tr>
1.226 gutterid 13527: <td>REPLACE_R</td>
1.229 ! gutterid 13528: <td>REPLACE_RUBY</td>
1.161 leot 13529: </tr>
13530: <tr>
1.226 gutterid 13531: <td>REPLACE_RUBY_DIRS</td>
1.229 ! gutterid 13532: <td>REPLACE_RUBY_PAT</td>
1.216 gutterid 13533: </tr>
13534: <tr>
1.226 gutterid 13535: <td>REPLACE_SH</td>
1.229 ! gutterid 13536: <td>REPLACE_TEXLUA</td>
1.156 leot 13537: </tr>
13538: <tr>
1.226 gutterid 13539: <td>REPLACE_WISH</td>
1.229 ! gutterid 13540: <td>REQD_DIRS</td>
1.218 nia 13541: </tr>
13542: <tr>
1.226 gutterid 13543: <td>REQD_DIRS_PERMS</td>
1.229 ! gutterid 13544: <td>REQD_FILES</td>
1.156 leot 13545: </tr>
13546: <tr>
1.226 gutterid 13547: <td>REQD_FILES_MODE</td>
1.229 ! gutterid 13548: <td>REQD_FILES_PERMS</td>
1.156 leot 13549: </tr>
13550: <tr>
1.226 gutterid 13551: <td>RESOLV_AUTO_VARS</td>
1.229 ! gutterid 13552: <td>RESOLV_LDFLAGS</td>
1.156 leot 13553: </tr>
13554: <tr>
1.226 gutterid 13555: <td>RESOLV_LIBS</td>
1.229 ! gutterid 13556: <td>RM</td>
1.156 leot 13557: </tr>
13558: <tr>
1.226 gutterid 13559: <td>ROOT_CMD</td>
1.229 ! gutterid 13560: <td>ROOT_GROUP</td>
1.156 leot 13561: </tr>
13562: <tr>
1.226 gutterid 13563: <td>ROOT_USER</td>
1.229 ! gutterid 13564: <td>RPCGEN</td>
1.205 wiz 13565: </tr>
13566: <tr>
1.226 gutterid 13567: <td>RPM</td>
1.229 ! gutterid 13568: <td>RPM2PKG_PLIST</td>
1.217 rillig 13569: </tr>
13570: <tr>
1.226 gutterid 13571: <td>RPM2PKG_PREFIX</td>
1.229 ! gutterid 13572: <td>RPM2PKG_STAGE</td>
1.214 leot 13573: </tr>
13574: <tr>
1.226 gutterid 13575: <td>RPM2PKG_STRIP</td>
1.229 ! gutterid 13576: <td>RPM2PKG_SUBPREFIX</td>
1.212 wiz 13577: </tr>
13578: <tr>
1.226 gutterid 13579: <td>RPMFILES</td>
1.229 ! gutterid 13580: <td>RPMIGNOREPATH</td>
1.156 leot 13581: </tr>
13582: <tr>
1.226 gutterid 13583: <td>RPM_DB_PREFIX</td>
1.229 ! gutterid 13584: <td>RSSH_CVS_PATH</td>
1.197 leot 13585: </tr>
13586: <tr>
1.226 gutterid 13587: <td>RSSH_RDIST_PATH</td>
1.229 ! gutterid 13588: <td>RSSH_RSYNC_PATH</td>
1.156 leot 13589: </tr>
13590: <tr>
1.226 gutterid 13591: <td>RSSH_SCP_PATH</td>
1.229 ! gutterid 13592: <td>RSSH_SFTP_SERVER_PATH</td>
1.156 leot 13593: </tr>
13594: <tr>
1.226 gutterid 13595: <td>RUBY</td>
1.229 ! gutterid 13596: <td>RUBYGEM</td>
1.156 leot 13597: </tr>
13598: <tr>
1.226 gutterid 13599: <td>RUBYGEM_NAME</td>
1.229 ! gutterid 13600: <td>RUBYGEM_OPTIONS</td>
1.156 leot 13601: </tr>
13602: <tr>
1.226 gutterid 13603: <td>RUBYGEM_VERBOSE</td>
1.229 ! gutterid 13604: <td>RUBY_ABI_VERSION</td>
1.156 leot 13605: </tr>
13606: <tr>
1.226 gutterid 13607: <td>RUBY_ARCH</td>
1.229 ! gutterid 13608: <td>RUBY_ARCHINC</td>
1.156 leot 13609: </tr>
13610: <tr>
1.226 gutterid 13611: <td>RUBY_ARCHLIB</td>
1.229 ! gutterid 13612: <td>RUBY_BASE</td>
1.156 leot 13613: </tr>
13614: <tr>
1.226 gutterid 13615: <td>RUBY_BASERIDIR</td>
1.229 ! gutterid 13616: <td>RUBY_BUILD_DOCUMENT</td>
1.156 leot 13617: </tr>
13618: <tr>
1.226 gutterid 13619: <td>RUBY_DLEXT</td>
1.229 ! gutterid 13620: <td>RUBY_DOC</td>
1.156 leot 13621: </tr>
13622: <tr>
1.226 gutterid 13623: <td>RUBY_DYNAMIC_DIRS</td>
1.229 ! gutterid 13624: <td>RUBY_EG</td>
1.156 leot 13625: </tr>
13626: <tr>
1.226 gutterid 13627: <td>RUBY_ENCODING_ARG</td>
1.229 ! gutterid 13628: <td>RUBY_EXTCONF</td>
1.198 leot 13629: </tr>
13630: <tr>
1.226 gutterid 13631: <td>RUBY_EXTCONF_CHECK</td>
1.229 ! gutterid 13632: <td>RUBY_EXTCONF_DEBUG</td>
1.156 leot 13633: </tr>
13634: <tr>
1.226 gutterid 13635: <td>RUBY_EXTCONF_MAKEFILE</td>
1.229 ! gutterid 13636: <td>RUBY_GEM_ARCH</td>
1.156 leot 13637: </tr>
13638: <tr>
1.226 gutterid 13639: <td>RUBY_GEM_BASE</td>
1.229 ! gutterid 13640: <td>RUBY_INC</td>
1.156 leot 13641: </tr>
13642: <tr>
1.226 gutterid 13643: <td>RUBY_LIB</td>
1.229 ! gutterid 13644: <td>RUBY_LIB_BASE</td>
1.156 leot 13645: </tr>
13646: <tr>
1.226 gutterid 13647: <td>RUBY_NAME</td>
1.229 ! gutterid 13648: <td>RUBY_NOVERSION</td>
1.223 nia 13649: </tr>
13650: <tr>
1.226 gutterid 13651: <td>RUBY_PKGPREFIX</td>
1.229 ! gutterid 13652: <td>RUBY_RAILS</td>
1.156 leot 13653: </tr>
13654: <tr>
1.226 gutterid 13655: <td>RUBY_RAILS52_VERSION</td>
1.229 ! gutterid 13656: <td>RUBY_RAILS60_VERSION</td>
1.156 leot 13657: </tr>
13658: <tr>
1.226 gutterid 13659: <td>RUBY_RAILS61_VERSION</td>
1.229 ! gutterid 13660: <td>RUBY_RAILS70_VERSION</td>
1.156 leot 13661: </tr>
13662: <tr>
1.226 gutterid 13663: <td>RUBY_RAILS_ACCEPTED</td>
1.229 ! gutterid 13664: <td>RUBY_RAILS_DEFAULT</td>
1.156 leot 13665: </tr>
13666: <tr>
1.226 gutterid 13667: <td>RUBY_RAILS_REQD</td>
1.229 ! gutterid 13668: <td>RUBY_RAILS_STRICT_DEP</td>
1.156 leot 13669: </tr>
13670: <tr>
1.226 gutterid 13671: <td>RUBY_RIDIR</td>
1.229 ! gutterid 13672: <td>RUBY_SETUP</td>
1.156 leot 13673: </tr>
13674: <tr>
1.226 gutterid 13675: <td>RUBY_SHLIB</td>
1.229 ! gutterid 13676: <td>RUBY_SHLIBALIAS</td>
1.156 leot 13677: </tr>
13678: <tr>
1.226 gutterid 13679: <td>RUBY_SHLIBVER</td>
1.229 ! gutterid 13680: <td>RUBY_SIMPLE_INSTALL</td>
1.156 leot 13681: </tr>
13682: <tr>
1.226 gutterid 13683: <td>RUBY_SITEARCHLIB</td>
1.229 ! gutterid 13684: <td>RUBY_SITELIB</td>
1.156 leot 13685: </tr>
13686: <tr>
1.226 gutterid 13687: <td>RUBY_SITELIB_BASE</td>
1.229 ! gutterid 13688: <td>RUBY_SITERIDIR</td>
1.174 leot 13689: </tr>
13690: <tr>
1.226 gutterid 13691: <td>RUBY_SLEXT</td>
1.229 ! gutterid 13692: <td>RUBY_SRCDIR</td>
1.156 leot 13693: </tr>
13694: <tr>
1.226 gutterid 13695: <td>RUBY_STATICLIB</td>
1.229 ! gutterid 13696: <td>RUBY_SUFFIX</td>
1.156 leot 13697: </tr>
13698: <tr>
1.226 gutterid 13699: <td>RUBY_SYSRIDIR</td>
1.229 ! gutterid 13700: <td>RUBY_USE_PTHREAD</td>
1.156 leot 13701: </tr>
13702: <tr>
1.226 gutterid 13703: <td>RUBY_VENDORARCHLIB</td>
1.229 ! gutterid 13704: <td>RUBY_VENDORLIB</td>
1.156 leot 13705: </tr>
13706: <tr>
1.226 gutterid 13707: <td>RUBY_VENDORLIB_BASE</td>
1.229 ! gutterid 13708: <td>RUBY_VER</td>
1.156 leot 13709: </tr>
13710: <tr>
1.226 gutterid 13711: <td>RUBY_VERSION</td>
1.229 ! gutterid 13712: <td>RUBY_VERSIONS_ACCEPTED</td>
1.156 leot 13713: </tr>
13714: <tr>
1.226 gutterid 13715: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.229 ! gutterid 13716: <td>RUBY_VERSION_DEFAULT</td>
1.156 leot 13717: </tr>
13718: <tr>
1.226 gutterid 13719: <td>RUBY_VERSION_REQD</td>
1.229 ! gutterid 13720: <td>RUBY_VER_DIR</td>
1.156 leot 13721: </tr>
13722: <tr>
1.226 gutterid 13723: <td>RUN</td>
1.229 ! gutterid 13724: <td>RUN_LDCONFIG</td>
1.156 leot 13725: </tr>
13726: <tr>
1.226 gutterid 13727: <td>RUST_TYPE</td>
1.229 ! gutterid 13728: <td>SCO</td>
1.156 leot 13729: </tr>
13730: <tr>
1.226 gutterid 13731: <td>SCREWS_GROUP</td>
1.229 ! gutterid 13732: <td>SCREWS_USER</td>
1.156 leot 13733: </tr>
13734: <tr>
1.226 gutterid 13735: <td>SCRIPTS_ENV</td>
1.229 ! gutterid 13736: <td>SCROLLKEEPER_DATADIR</td>
1.156 leot 13737: </tr>
13738: <tr>
1.226 gutterid 13739: <td>SCROLLKEEPER_REBUILDDB</td>
1.229 ! gutterid 13740: <td>SCROLLKEEPER_UPDATEDB</td>
1.156 leot 13741: </tr>
13742: <tr>
1.226 gutterid 13743: <td>SDIST_PAWD</td>
1.229 ! gutterid 13744: <td>SDL12_TYPE</td>
1.156 leot 13745: </tr>
13746: <tr>
1.226 gutterid 13747: <td>SERIAL_DEVICES</td>
1.229 ! gutterid 13748: <td>SETGIDGAME</td>
1.156 leot 13749: </tr>
13750: <tr>
1.226 gutterid 13751: <td>SETGID_GAMES_PERMS</td>
1.229 ! gutterid 13752: <td>SETUID_ROOT_PERMS</td>
1.221 nia 13753: </tr>
13754: <tr>
1.226 gutterid 13755: <td>SH</td>
1.229 ! gutterid 13756: <td>SHLIB</td>
1.156 leot 13757: </tr>
13758: <tr>
1.228 gutterid 13759: <td>SIGN_PACKAGES</td>
1.229 ! gutterid 13760: <td>SILC_CLIENT_WITH_PERL</td>
1.227 wiz 13761: </tr>
13762: <tr>
1.228 gutterid 13763: <td>SITE_SPECIFIC_PKGS</td>
1.229 ! gutterid 13764: <td>SKIP_DEPENDS</td>
1.156 leot 13765: </tr>
13766: <tr>
1.228 gutterid 13767: <td>SMF_INSTANCES</td>
1.229 ! gutterid 13768: <td>SMF_MANIFEST</td>
1.156 leot 13769: </tr>
13770: <tr>
1.228 gutterid 13771: <td>SMF_METHODS</td>
1.229 ! gutterid 13772: <td>SMF_METHOD_SHELL</td>
1.177 leot 13773: </tr>
13774: <tr>
1.228 gutterid 13775: <td>SMF_METHOD_SRC</td>
1.229 ! gutterid 13776: <td>SMF_NAME</td>
1.156 leot 13777: </tr>
13778: <tr>
1.228 gutterid 13779: <td>SMF_PREFIX</td>
1.229 ! gutterid 13780: <td>SMF_SRCDIR</td>
1.217 rillig 13781: </tr>
13782: <tr>
1.228 gutterid 13783: <td>SNIPROXY_GROUP</td>
1.229 ! gutterid 13784: <td>SNIPROXY_USER</td>
1.156 leot 13785: </tr>
13786: <tr>
1.228 gutterid 13787: <td>SOURCE_BUFFSIZE</td>
1.229 ! gutterid 13788: <td>SPECIAL_PERMS</td>
1.159 rillig 13789: </tr>
13790: <tr>
1.228 gutterid 13791: <td>SPECIFIC_PKGS</td>
1.229 ! gutterid 13792: <td>SSH_SUID</td>
1.156 leot 13793: </tr>
13794: <tr>
1.228 gutterid 13795: <td>SSP_SUPPORTED</td>
1.229 ! gutterid 13796: <td>SSYNC_PAWD</td>
1.156 leot 13797: </tr>
13798: <tr>
1.228 gutterid 13799: <td>STEP_MSG</td>
1.229 ! gutterid 13800: <td>STRIP</td>
1.156 leot 13801: </tr>
13802: <tr>
1.228 gutterid 13803: <td>STRIP_DBG</td>
1.229 ! gutterid 13804: <td>STRIP_DEBUG</td>
1.156 leot 13805: </tr>
13806: <tr>
1.228 gutterid 13807: <td>STRIP_DEBUG_SUPPORTED</td>
1.229 ! gutterid 13808: <td>STRIP_FILES_SKIP</td>
1.156 leot 13809: </tr>
13810: <tr>
1.228 gutterid 13811: <td>SU</td>
1.229 ! gutterid 13812: <td>SUBDIR</td>
1.156 leot 13813: </tr>
13814: <tr>
1.228 gutterid 13815: <td>SUBST</td>
1.229 ! gutterid 13816: <td>SUBST_CLASSES</td>
1.156 leot 13817: </tr>
13818: <tr>
1.228 gutterid 13819: <td>SUBST_FILES</td>
1.229 ! gutterid 13820: <td>SUBST_FILTER_CMD</td>
1.156 leot 13821: </tr>
13822: <tr>
1.228 gutterid 13823: <td>SUBST_MESSAGE</td>
1.229 ! gutterid 13824: <td>SUBST_NOOP_OK</td>
1.156 leot 13825: </tr>
13826: <tr>
1.228 gutterid 13827: <td>SUBST_SED</td>
1.229 ! gutterid 13828: <td>SUBST_SHOW_DIFF</td>
1.156 leot 13829: </tr>
13830: <tr>
1.228 gutterid 13831: <td>SUBST_SKIP_TEXT_CHECK</td>
1.229 ! gutterid 13832: <td>SUBST_STAGE</td>
1.156 leot 13833: </tr>
13834: <tr>
1.228 gutterid 13835: <td>SUBST_VARS</td>
1.229 ! gutterid 13836: <td>SUNWSPROBASE</td>
1.174 leot 13837: </tr>
13838: <tr>
1.228 gutterid 13839: <td>SUSE_PREFER</td>
1.229 ! gutterid 13840: <td>SU_CMD</td>
1.156 leot 13841: </tr>
13842: <tr>
1.228 gutterid 13843: <td>SYSCONFBASE</td>
1.229 ! gutterid 13844: <td>TARGET_ARCH</td>
1.227 wiz 13845: </tr>
13846: <tr>
1.228 gutterid 13847: <td>TBL</td>
1.229 ! gutterid 13848: <td>TERMCAP_TYPE</td>
1.156 leot 13849: </tr>
13850: <tr>
1.228 gutterid 13851: <td>TERMINFO_DEFAULT</td>
1.229 ! gutterid 13852: <td>TERMINFO_TYPE</td>
1.217 rillig 13853: </tr>
13854: <tr>
1.228 gutterid 13855: <td>TEST</td>
1.229 ! gutterid 13856: <td>TEST_DEPENDS</td>
1.212 wiz 13857: </tr>
13858: <tr>
1.228 gutterid 13859: <td>TEST_DIRS</td>
1.229 ! gutterid 13860: <td>TEST_ENV</td>
1.217 rillig 13861: </tr>
13862: <tr>
1.228 gutterid 13863: <td>TEST_ENV_SHELL</td>
1.229 ! gutterid 13864: <td>TEST_MAKE_CMD</td>
1.205 wiz 13865: </tr>
13866: <tr>
1.228 gutterid 13867: <td>TEST_MAKE_FLAGS</td>
1.229 ! gutterid 13868: <td>TEST_TARGET</td>
1.189 bacon 13869: </tr>
13870: <tr>
1.228 gutterid 13871: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.229 ! gutterid 13872: <td>TEXLIVE_REV</td>
1.161 leot 13873: </tr>
13874: <tr>
1.228 gutterid 13875: <td>TEXLIVE_UNVERSIONED</td>
1.229 ! gutterid 13876: <td>TEXMFSITE</td>
1.159 rillig 13877: </tr>
13878: <tr>
1.228 gutterid 13879: <td>TEX_FORMATS</td>
1.229 ! gutterid 13880: <td>TEX_HYPHEN_DAT</td>
1.156 leot 13881: </tr>
13882: <tr>
1.228 gutterid 13883: <td>TEX_HYPHEN_DEF</td>
1.229 ! gutterid 13884: <td>TEX_TEXMF_DIRS</td>
1.156 leot 13885: </tr>
13886: <tr>
1.228 gutterid 13887: <td>THTTPD_LOG_FACILITY</td>
1.229 ! gutterid 13888: <td>TINYDYN_USER</td>
1.156 leot 13889: </tr>
13890: <tr>
1.228 gutterid 13891: <td>TLSWRAPPER_CHROOT</td>
1.229 ! gutterid 13892: <td>TO</td>
1.156 leot 13893: </tr>
13894: <tr>
1.228 gutterid 13895: <td>TOOLS_ALIASES</td>
1.229 ! gutterid 13896: <td>TOOLS_ALWAYS_WRAP</td>
1.156 leot 13897: </tr>
13898: <tr>
1.228 gutterid 13899: <td>TOOLS_ARGS</td>
1.229 ! gutterid 13900: <td>TOOLS_BROKEN</td>
1.156 leot 13901: </tr>
13902: <tr>
1.228 gutterid 13903: <td>TOOLS_CMD</td>
1.229 ! gutterid 13904: <td>TOOLS_CMDLINE_SED</td>
1.156 leot 13905: </tr>
13906: <tr>
1.228 gutterid 13907: <td>TOOLS_CREATE</td>
1.229 ! gutterid 13908: <td>TOOLS_CROSS_DESTDIR</td>
1.156 leot 13909: </tr>
13910: <tr>
1.228 gutterid 13911: <td>TOOLS_DIR</td>
1.229 ! gutterid 13912: <td>TOOLS_FAIL</td>
1.156 leot 13913: </tr>
13914: <tr>
1.228 gutterid 13915: <td>TOOLS_GNU_MISSING</td>
1.229 ! gutterid 13916: <td>TOOLS_LDCONFIG</td>
1.156 leot 13917: </tr>
13918: <tr>
1.228 gutterid 13919: <td>TOOLS_NOOP</td>
1.229 ! gutterid 13920: <td>TOOLS_PATH</td>
1.156 leot 13921: </tr>
13922: <tr>
1.228 gutterid 13923: <td>TOOLS_SCRIPT</td>
1.229 ! gutterid 13924: <td>TOOLS_USE_CROSS_COMPILE</td>
1.156 leot 13925: </tr>
13926: <tr>
1.226 gutterid 13927: <td>TOOL_DEPENDS</td>
1.229 ! gutterid 13928: <td>TTF_FONTS_DIR</td>
1.156 leot 13929: </tr>
13930: <tr>
1.226 gutterid 13931: <td>TYPE</td>
1.229 ! gutterid 13932: <td>UAC_REQD_EXECS</td>
1.223 nia 13933: </tr>
13934: <tr>
1.226 gutterid 13935: <td>UCSPI_SSL_GROUP</td>
1.229 ! gutterid 13936: <td>UCSPI_SSL_USER</td>
1.156 leot 13937: </tr>
13938: <tr>
1.226 gutterid 13939: <td>UNLIMIT_RESOURCES</td>
1.229 ! gutterid 13940: <td>UNPRIVILEGED</td>
1.214 leot 13941: </tr>
13942: <tr>
1.226 gutterid 13943: <td>UNPRIVILEGED_GROUP</td>
1.229 ! gutterid 13944: <td>UNPRIVILEGED_GROUPS</td>
1.212 wiz 13945: </tr>
13946: <tr>
1.226 gutterid 13947: <td>UNPRIVILEGED_USER</td>
1.229 ! gutterid 13948: <td>UNWRAP_FILES</td>
1.156 leot 13949: </tr>
13950: <tr>
1.226 gutterid 13951: <td>UNWRAP_PATTERNS</td>
1.229 ! gutterid 13952: <td>UPDATE_GEMSPEC</td>
1.156 leot 13953: </tr>
13954: <tr>
1.226 gutterid 13955: <td>UPDATE_TARGET</td>
1.229 ! gutterid 13956: <td>URI</td>
1.156 leot 13957: </tr>
13958: <tr>
1.226 gutterid 13959: <td>USERGROUP_PHASE</td>
1.229 ! gutterid 13960: <td>USERPPP_GROUP</td>
1.156 leot 13961: </tr>
13962: <tr>
1.226 gutterid 13963: <td>USER_SPECIFIC_PKGS</td>
1.229 ! gutterid 13964: <td>USE_ABI_DEPENDS</td>
1.156 leot 13965: </tr>
13966: <tr>
1.226 gutterid 13967: <td>USE_APR</td>
1.229 ! gutterid 13968: <td>USE_BSD_MAKEFILE</td>
1.156 leot 13969: </tr>
13970: <tr>
1.226 gutterid 13971: <td>USE_BUILTIN</td>
1.229 ! gutterid 13972: <td>USE_CROSS_COMPILE</td>
1.156 leot 13973: </tr>
13974: <tr>
1.226 gutterid 13975: <td>USE_CURSES</td>
1.229 ! gutterid 13976: <td>USE_CWRAPPERS</td>
1.156 leot 13977: </tr>
13978: <tr>
1.226 gutterid 13979: <td>USE_DB185</td>
1.229 ! gutterid 13980: <td>USE_FEATURES</td>
1.156 leot 13981: </tr>
13982: <tr>
1.226 gutterid 13983: <td>USE_GAMESGROUP</td>
1.229 ! gutterid 13984: <td>USE_GCC_RUNTIME</td>
1.205 wiz 13985: </tr>
13986: <tr>
1.226 gutterid 13987: <td>USE_IMAKE</td>
1.229 ! gutterid 13988: <td>USE_JAVA</td>
1.156 leot 13989: </tr>
13990: <tr>
1.226 gutterid 13991: <td>USE_JAVA2</td>
1.229 ! gutterid 13992: <td>USE_LANGUAGES</td>
1.156 leot 13993: </tr>
13994: <tr>
1.226 gutterid 13995: <td>USE_LIBTOOL</td>
1.229 ! gutterid 13996: <td>USE_NATIVE_GCC</td>
1.156 leot 13997: </tr>
13998: <tr>
1.226 gutterid 13999: <td>USE_NETBSD_REPO</td>
1.229 ! gutterid 14000: <td>USE_PKGSRC_GCC</td>
1.156 leot 14001: </tr>
14002: <tr>
1.226 gutterid 14003: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.229 ! gutterid 14004: <td>USE_PKGTASKS</td>
1.156 leot 14005: </tr>
14006: <tr>
1.226 gutterid 14007: <td>USE_PKG_ADMIN_DIGEST</td>
1.229 ! gutterid 14008: <td>USE_RUBY_EXTCONF</td>
1.156 leot 14009: </tr>
14010: <tr>
1.226 gutterid 14011: <td>USE_RUBY_INSTALL</td>
1.229 ! gutterid 14012: <td>USE_RUBY_SETUP</td>
1.156 leot 14013: </tr>
14014: <tr>
1.226 gutterid 14015: <td>USE_RUBY_SETUP_PKG</td>
1.229 ! gutterid 14016: <td>USE_TOOLS</td>
1.156 leot 14017: </tr>
14018: <tr>
1.226 gutterid 14019: <td>UUCP_GROUP</td>
1.229 ! gutterid 14020: <td>UUCP_USER</td>
1.156 leot 14021: </tr>
14022: <tr>
1.226 gutterid 14023: <td>VARBASE</td>
1.229 ! gutterid 14024: <td>VARNAME</td>
1.156 leot 14025: </tr>
14026: <tr>
1.226 gutterid 14027: <td>VIM_EXTRA_OPTS</td>
1.229 ! gutterid 14028: <td>WARNING_MSG</td>
1.156 leot 14029: </tr>
14030: <tr>
1.226 gutterid 14031: <td>WCALC_CGIDIR</td>
1.229 ! gutterid 14032: <td>WCALC_CGIPATH</td>
1.156 leot 14033: </tr>
14034: <tr>
1.226 gutterid 14035: <td>WCALC_HTMLDIR</td>
1.229 ! gutterid 14036: <td>WCALC_HTMLPATH</td>
1.156 leot 14037: </tr>
14038: <tr>
1.226 gutterid 14039: <td>WDM_MANAGERS</td>
1.229 ! gutterid 14040: <td>WRAPPER_CC</td>
1.156 leot 14041: </tr>
14042: <tr>
1.226 gutterid 14043: <td>WRAPPER_REORDER_CMDS</td>
1.229 ! gutterid 14044: <td>WRKDIR</td>
1.156 leot 14045: </tr>
14046: <tr>
1.226 gutterid 14047: <td>WRKDIR_BASENAME</td>
1.229 ! gutterid 14048: <td>WRKDIR_LOCKTYPE</td>
1.156 leot 14049: </tr>
14050: <tr>
1.226 gutterid 14051: <td>WRKLOG</td>
1.229 ! gutterid 14052: <td>WRKOBJDIR</td>
1.156 leot 14053: </tr>
14054: <tr>
1.226 gutterid 14055: <td>WRKSRC</td>
1.229 ! gutterid 14056: <td>X10_PORT</td>
1.156 leot 14057: </tr>
14058: <tr>
1.226 gutterid 14059: <td>X11</td>
1.229 ! gutterid 14060: <td>X11BASE</td>
1.156 leot 14061: </tr>
14062: <tr>
1.226 gutterid 14063: <td>X11_PKGSRCDIR</td>
1.229 ! gutterid 14064: <td>X11_TYPE</td>
1.189 bacon 14065: </tr>
14066: <tr>
1.226 gutterid 14067: <td>X509_CERTIFICATE</td>
1.229 ! gutterid 14068: <td>X509_KEY</td>
1.156 leot 14069: </tr>
14070: <tr>
1.226 gutterid 14071: <td>XAW_TYPE</td>
1.229 ! gutterid 14072: <td>XLOCK_DEFAULT_MODE</td>
1.156 leot 14073: </tr>
14074: <tr>
1.226 gutterid 14075: <td>XMKMF</td>
1.229 ! gutterid 14076: <td>XMKMF_FLAGS</td>
1.156 leot 14077: </tr>
14078: <tr>
1.226 gutterid 14079: <td>XXX</td>
1.229 ! gutterid 14080: <td>YES</td>
1.156 leot 14081: </tr>
14082: <tr>
1.228 gutterid 14083: <td>ZSH_STATIC</td>
1.229 ! gutterid 14084: <td>__stdc__</td>
1.227 wiz 14085: </tr>
14086: <tr>
1.228 gutterid 14087: <td>_vargroups</td>
1.229 ! gutterid 14088: <td>accept</td>
1.156 leot 14089: </tr>
14090: <tr>
1.228 gutterid 14091: <td>acquire-localbase-lock</td>
1.229 ! gutterid 14092: <td>acquire-lock</td>
1.159 rillig 14093: </tr>
14094: <tr>
1.228 gutterid 14095: <td>add</td>
1.229 ! gutterid 14096: <td>added</td>
1.217 rillig 14097: </tr>
14098: <tr>
1.228 gutterid 14099: <td>administrator</td>
1.229 ! gutterid 14100: <td>alloca</td>
1.156 leot 14101: </tr>
14102: <tr>
1.228 gutterid 14103: <td>alternatives</td>
1.229 ! gutterid 14104: <td>aslr</td>
1.201 cirnatda 14105: </tr>
14106: <tr>
1.228 gutterid 14107: <td>asprintf</td>
1.229 ! gutterid 14108: <td>atlas</td>
1.174 leot 14109: </tr>
14110: <tr>
1.228 gutterid 14111: <td>autoconf</td>
1.229 ! gutterid 14112: <td>automake</td>
1.156 leot 14113: </tr>
14114: <tr>
1.228 gutterid 14115: <td>autoreconf</td>
1.229 ! gutterid 14116: <td>awk</td>
1.156 leot 14117: </tr>
14118: <tr>
1.228 gutterid 14119: <td>bash</td>
1.229 ! gutterid 14120: <td>big-endian</td>
1.174 leot 14121: </tr>
14122: <tr>
1.228 gutterid 14123: <td>bin-install</td>
1.229 ! gutterid 14124: <td>bind</td>
1.156 leot 14125: </tr>
14126: <tr>
1.228 gutterid 14127: <td>binpkg-list</td>
1.229 ! gutterid 14128: <td>blas</td>
1.161 leot 14129: </tr>
14130: <tr>
1.228 gutterid 14131: <td>bootstrap-depends</td>
1.229 ! gutterid 14132: <td>broken</td>
1.156 leot 14133: </tr>
14134: <tr>
1.228 gutterid 14135: <td>broken_on_platform</td>
1.229 ! gutterid 14136: <td>bsd</td>
1.156 leot 14137: </tr>
14138: <tr>
1.228 gutterid 14139: <td>bsd.prog.mk</td>
1.229 ! gutterid 14140: <td>build</td>
1.156 leot 14141: </tr>
14142: <tr>
1.228 gutterid 14143: <td>build-env</td>
1.229 ! gutterid 14144: <td>buildlink-directories</td>
1.177 leot 14145: </tr>
14146: <tr>
1.228 gutterid 14147: <td>buildlink-oss-soundcard-h</td>
1.229 ! gutterid 14148: <td>c</td>
1.159 rillig 14149: </tr>
14150: <tr>
1.228 gutterid 14151: <td>c++</td>
1.229 ! gutterid 14152: <td>ccache</td>
1.156 leot 14153: </tr>
14154: <tr>
1.228 gutterid 14155: <td>cce</td>
1.229 ! gutterid 14156: <td>cdefs</td>
1.174 leot 14157: </tr>
14158: <tr>
1.228 gutterid 14159: <td>ceil</td>
1.229 ! gutterid 14160: <td>changes</td>
1.156 leot 14161: </tr>
14162: <tr>
1.228 gutterid 14163: <td>changes-entry</td>
1.229 ! gutterid 14164: <td>changes-entry-noupdate</td>
1.156 leot 14165: </tr>
14166: <tr>
1.228 gutterid 14167: <td>check</td>
1.229 ! gutterid 14168: <td>check-clean</td>
1.156 leot 14169: </tr>
14170: <tr>
1.228 gutterid 14171: <td>check-files</td>
1.229 ! gutterid 14172: <td>check-files-clean</td>
1.156 leot 14173: </tr>
14174: <tr>
1.228 gutterid 14175: <td>check-vulnerable</td>
1.229 ! gutterid 14176: <td>checksum</td>
1.174 leot 14177: </tr>
14178: <tr>
1.228 gutterid 14179: <td>checksum-phase</td>
1.229 ! gutterid 14180: <td>clean</td>
1.156 leot 14181: </tr>
14182: <tr>
1.228 gutterid 14183: <td>clean-depends</td>
1.229 ! gutterid 14184: <td>cleandir</td>
1.156 leot 14185: </tr>
14186: <tr>
1.228 gutterid 14187: <td>commit</td>
1.229 ! gutterid 14188: <td>commit-changes-entry</td>
1.156 leot 14189: </tr>
14190: <tr>
1.228 gutterid 14191: <td>compact</td>
1.229 ! gutterid 14192: <td>compiler</td>
1.156 leot 14193: </tr>
14194: <tr>
1.228 gutterid 14195: <td>conf</td>
1.229 ! gutterid 14196: <td>config.guess</td>
1.156 leot 14197: </tr>
14198: <tr>
1.228 gutterid 14199: <td>config.sub</td>
1.229 ! gutterid 14200: <td>configuration</td>
1.156 leot 14201: </tr>
14202: <tr>
1.228 gutterid 14203: <td>configure</td>
1.229 ! gutterid 14204: <td>configure-env</td>
1.156 leot 14205: </tr>
14206: <tr>
1.228 gutterid 14207: <td>configure-help</td>
1.229 ! gutterid 14208: <td>configure_args</td>
1.156 leot 14209: </tr>
14210: <tr>
1.228 gutterid 14211: <td>connect</td>
1.229 ! gutterid 14212: <td>cos</td>
1.156 leot 14213: </tr>
14214: <tr>
1.228 gutterid 14215: <td>cputime</td>
1.229 ! gutterid 14216: <td>create-usergroup</td>
1.156 leot 14217: </tr>
14218: <tr>
1.228 gutterid 14219: <td>csh</td>
1.229 ! gutterid 14220: <td>ctf</td>
1.156 leot 14221: </tr>
14222: <tr>
1.225 gutterid 14223: <td>debug</td>
1.229 ! gutterid 14224: <td>declaration</td>
1.223 nia 14225: </tr>
14226: <tr>
1.225 gutterid 14227: <td>declare</td>
1.229 ! gutterid 14228: <td>defined</td>
1.174 leot 14229: </tr>
14230: <tr>
1.225 gutterid 14231: <td>depend</td>
1.229 ! gutterid 14232: <td>dependencies</td>
1.214 leot 14233: </tr>
14234: <tr>
1.225 gutterid 14235: <td>depends</td>
1.229 ! gutterid 14236: <td>depends-checksum</td>
1.205 wiz 14237: </tr>
14238: <tr>
1.225 gutterid 14239: <td>depends-fetch</td>
1.229 ! gutterid 14240: <td>deps</td>
1.161 leot 14241: </tr>
14242: <tr>
1.225 gutterid 14243: <td>describe</td>
1.229 ! gutterid 14244: <td>destdir</td>
1.197 leot 14245: </tr>
14246: <tr>
1.225 gutterid 14247: <td>disable</td>
1.229 ! gutterid 14248: <td>distclean</td>
1.156 leot 14249: </tr>
14250: <tr>
1.225 gutterid 14251: <td>distinfo</td>
1.229 ! gutterid 14252: <td>dl</td>
1.156 leot 14253: </tr>
14254: <tr>
1.225 gutterid 14255: <td>dlopen</td>
1.229 ! gutterid 14256: <td>do-buildlink</td>
1.156 leot 14257: </tr>
14258: <tr>
1.225 gutterid 14259: <td>do-clean</td>
1.229 ! gutterid 14260: <td>do-configure</td>
1.156 leot 14261: </tr>
14262: <tr>
1.225 gutterid 14263: <td>do-configure-post-hook</td>
1.229 ! gutterid 14264: <td>do-extract</td>
1.156 leot 14265: </tr>
14266: <tr>
1.225 gutterid 14267: <td>do-fetch</td>
1.229 ! gutterid 14268: <td>do-install</td>
1.162 rillig 14269: </tr>
14270: <tr>
1.225 gutterid 14271: <td>emul</td>
1.229 ! gutterid 14272: <td>emul-distinfo</td>
1.156 leot 14273: </tr>
14274: <tr>
1.225 gutterid 14275: <td>emul-fetch</td>
1.229 ! gutterid 14276: <td>emulation</td>
1.217 rillig 14277: </tr>
14278: <tr>
1.225 gutterid 14279: <td>emulator</td>
1.229 ! gutterid 14280: <td>enable</td>
1.156 leot 14281: </tr>
14282: <tr>
1.221 nia 14283: <td>endian</td>
1.229 ! gutterid 14284: <td>enomem</td>
1.156 leot 14285: </tr>
14286: <tr>
1.228 gutterid 14287: <td>ensurepip</td>
1.229 ! gutterid 14288: <td>err</td>
1.227 wiz 14289: </tr>
14290: <tr>
1.228 gutterid 14291: <td>errx</td>
1.229 ! gutterid 14292: <td>etc</td>
1.214 leot 14293: </tr>
14294: <tr>
1.228 gutterid 14295: <td>exp</td>
1.229 ! gutterid 14296: <td>extract-rpm</td>
1.156 leot 14297: </tr>
14298: <tr>
1.228 gutterid 14299: <td>fabs</td>
1.229 ! gutterid 14300: <td>feature</td>
1.205 wiz 14301: </tr>
14302: <tr>
1.228 gutterid 14303: <td>features</td>
1.229 ! gutterid 14304: <td>fetch</td>
1.197 leot 14305: </tr>
14306: <tr>
1.228 gutterid 14307: <td>fetch-list</td>
1.229 ! gutterid 14308: <td>follows</td>
1.156 leot 14309: </tr>
14310: <tr>
1.228 gutterid 14311: <td>forbids</td>
1.229 ! gutterid 14312: <td>form</td>
1.156 leot 14313: </tr>
14314: <tr>
1.228 gutterid 14315: <td>format</td>
1.229 ! gutterid 14316: <td>fortify</td>
1.174 leot 14317: </tr>
14318: <tr>
1.220 nia 14319: <td>fortify_source</td>
1.229 ! gutterid 14320: <td>friend</td>
1.217 rillig 14321: </tr>
14322: <tr>
1.225 gutterid 14323: <td>fts</td>
1.229 ! gutterid 14324: <td>fts_close</td>
1.223 nia 14325: </tr>
14326: <tr>
1.225 gutterid 14327: <td>fts_open</td>
1.229 ! gutterid 14328: <td>fts_read</td>
1.156 leot 14329: </tr>
14330: <tr>
1.225 gutterid 14331: <td>fts_set</td>
1.229 ! gutterid 14332: <td>gcc</td>
1.156 leot 14333: </tr>
14334: <tr>
1.225 gutterid 14335: <td>gethostbyaddr</td>
1.229 ! gutterid 14336: <td>gethostbyname</td>
1.156 leot 14337: </tr>
14338: <tr>
1.225 gutterid 14339: <td>gethostbyname2</td>
1.229 ! gutterid 14340: <td>getopt_long</td>
1.156 leot 14341: </tr>
14342: <tr>
1.225 gutterid 14343: <td>getprogname</td>
1.229 ! gutterid 14344: <td>getservbyname</td>
1.174 leot 14345: </tr>
14346: <tr>
1.225 gutterid 14347: <td>getservbyport</td>
1.229 ! gutterid 14348: <td>getservent</td>
1.156 leot 14349: </tr>
14350: <tr>
1.217 rillig 14351: <td>gettext</td>
1.229 ! gutterid 14352: <td>github</td>
1.174 leot 14353: </tr>
14354: <tr>
1.228 gutterid 14355: <td>gitlab</td>
1.229 ! gutterid 14356: <td>glob</td>
1.227 wiz 14357: </tr>
14358: <tr>
1.228 gutterid 14359: <td>gnu</td>
1.229 ! gutterid 14360: <td>gnu_configure_strict</td>
1.223 nia 14361: </tr>
14362: <tr>
1.228 gutterid 14363: <td>go</td>
1.229 ! gutterid 14364: <td>go-deps</td>
1.217 rillig 14365: </tr>
14366: <tr>
1.228 gutterid 14367: <td>golang</td>
1.229 ! gutterid 14368: <td>guess-license</td>
1.156 leot 14369: </tr>
14370: <tr>
1.228 gutterid 14371: <td>hashbang</td>
1.229 ! gutterid 14372: <td>heimdal</td>
1.159 rillig 14373: </tr>
14374: <tr>
1.223 nia 14375: <td>help</td>
1.229 ! gutterid 14376: <td>imake</td>
1.156 leot 14377: </tr>
14378: <tr>
1.225 gutterid 14379: <td>increment</td>
1.229 ! gutterid 14380: <td>indirect</td>
1.214 leot 14381: </tr>
14382: <tr>
1.225 gutterid 14383: <td>inet_aton</td>
1.229 ! gutterid 14384: <td>interp</td>
1.156 leot 14385: </tr>
14386: <tr>
1.225 gutterid 14387: <td>interpreter</td>
1.229 ! gutterid 14388: <td>intl</td>
1.205 wiz 14389: </tr>
14390: <tr>
1.225 gutterid 14391: <td>ip4</td>
1.229 ! gutterid 14392: <td>ip6</td>
1.197 leot 14393: </tr>
14394: <tr>
1.225 gutterid 14395: <td>ipv4</td>
1.229 ! gutterid 14396: <td>ipv6</td>
1.161 leot 14397: </tr>
14398: <tr>
1.225 gutterid 14399: <td>iso</td>
1.229 ! gutterid 14400: <td>kerberos</td>
1.156 leot 14401: </tr>
14402: <tr>
1.225 gutterid 14403: <td>krb</td>
1.229 ! gutterid 14404: <td>krb5</td>
1.156 leot 14405: </tr>
14406: <tr>
1.225 gutterid 14407: <td>ksh</td>
1.229 ! gutterid 14408: <td>lapack</td>
1.156 leot 14409: </tr>
14410: <tr>
1.225 gutterid 14411: <td>latex</td>
1.229 ! gutterid 14412: <td>libintl_bindtextdomain</td>
1.189 bacon 14413: </tr>
14414: <tr>
1.225 gutterid 14415: <td>libintl_gettext</td>
1.229 ! gutterid 14416: <td>libintl_textdomain</td>
1.189 bacon 14417: </tr>
14418: <tr>
1.225 gutterid 14419: <td>libnbcompat</td>
1.229 ! gutterid 14420: <td>libs</td>
1.156 leot 14421: </tr>
14422: <tr>
1.225 gutterid 14423: <td>libtool</td>
1.229 ! gutterid 14424: <td>licence</td>
1.177 leot 14425: </tr>
14426: <tr>
1.225 gutterid 14427: <td>license</td>
1.229 ! gutterid 14428: <td>lintl</td>
1.156 leot 14429: </tr>
14430: <tr>
1.225 gutterid 14431: <td>little-endian</td>
1.229 ! gutterid 14432: <td>lock</td>
1.174 leot 14433: </tr>
14434: <tr>
1.225 gutterid 14435: <td>locking</td>
1.229 ! gutterid 14436: <td>lua</td>
1.159 rillig 14437: </tr>
14438: <tr>
1.225 gutterid 14439: <td>lvalue</td>
1.229 ! gutterid 14440: <td>make</td>
1.156 leot 14441: </tr>
14442: <tr>
1.225 gutterid 14443: <td>makesum</td>
1.229 ! gutterid 14444: <td>memory</td>
1.156 leot 14445: </tr>
14446: <tr>
1.228 gutterid 14447: <td>meta</td>
1.229 ! gutterid 14448: <td>meta-package</td>
1.227 wiz 14449: </tr>
14450: <tr>
1.228 gutterid 14451: <td>meta_package</td>
1.229 ! gutterid 14452: <td>mit-krb5</td>
1.156 leot 14453: </tr>
14454: <tr>
1.228 gutterid 14455: <td>mk.conf</td>
1.229 ! gutterid 14456: <td>mkl</td>
1.156 leot 14457: </tr>
14458: <tr>
1.228 gutterid 14459: <td>mount</td>
1.229 ! gutterid 14460: <td>move</td>
1.177 leot 14461: </tr>
14462: <tr>
1.228 gutterid 14463: <td>moved</td>
1.229 ! gutterid 14464: <td>mprotect</td>
1.159 rillig 14465: </tr>
14466: <tr>
1.228 gutterid 14467: <td>mremap</td>
1.229 ! gutterid 14468: <td>nb</td>
1.226 gutterid 14469: </tr>
14470: <tr>
1.228 gutterid 14471: <td>nbcompat</td>
1.229 ! gutterid 14472: <td>netlib</td>
1.156 leot 14473: </tr>
14474: <tr>
1.228 gutterid 14475: <td>node</td>
1.229 ! gutterid 14476: <td>node.js</td>
1.156 leot 14477: </tr>
14478: <tr>
1.228 gutterid 14479: <td>nodejs</td>
1.229 ! gutterid 14480: <td>obstack</td>
1.218 nia 14481: </tr>
14482: <tr>
1.228 gutterid 14483: <td>obstack_ptr_grow</td>
1.229 ! gutterid 14484: <td>occurs</td>
1.218 nia 14485: </tr>
14486: <tr>
1.228 gutterid 14487: <td>only</td>
1.229 ! gutterid 14488: <td>openblas</td>
1.205 wiz 14489: </tr>
14490: <tr>
1.228 gutterid 14491: <td>options</td>
1.229 ! gutterid 14492: <td>options.mk</td>
1.156 leot 14493: </tr>
14494: <tr>
1.228 gutterid 14495: <td>order</td>
1.229 ! gutterid 14496: <td>override</td>
1.161 leot 14497: </tr>
14498: <tr>
1.228 gutterid 14499: <td>override-intltool</td>
1.229 ! gutterid 14500: <td>override-message-intltool</td>
1.156 leot 14501: </tr>
14502: <tr>
1.228 gutterid 14503: <td>package</td>
1.229 ! gutterid 14504: <td>parallel</td>
1.156 leot 14505: </tr>
14506: <tr>
1.228 gutterid 14507: <td>path</td>
1.229 ! gutterid 14508: <td>pax</td>
1.156 leot 14509: </tr>
14510: <tr>
1.228 gutterid 14511: <td>paxctl</td>
1.229 ! gutterid 14512: <td>pbulk-index</td>
1.156 leot 14513: </tr>
14514: <tr>
1.228 gutterid 14515: <td>pc</td>
1.229 ! gutterid 14516: <td>perl</td>
1.156 leot 14517: </tr>
14518: <tr>
1.228 gutterid 14519: <td>perl5</td>
1.229 ! gutterid 14520: <td>perms</td>
1.156 leot 14521: </tr>
14522: <tr>
1.228 gutterid 14523: <td>php</td>
1.229 ! gutterid 14524: <td>pkg-build-options</td>
1.156 leot 14525: </tr>
14526: <tr>
1.228 gutterid 14527: <td>pkg-config</td>
1.229 ! gutterid 14528: <td>pkg_build_options</td>
1.156 leot 14529: </tr>
14530: <tr>
1.228 gutterid 14531: <td>platform</td>
1.229 ! gutterid 14532: <td>plist</td>
1.156 leot 14533: </tr>
14534: <tr>
1.228 gutterid 14535: <td>post-extract</td>
1.229 ! gutterid 14536: <td>post-fetch</td>
1.156 leot 14537: </tr>
14538: <tr>
1.228 gutterid 14539: <td>post-wrapper</td>
1.229 ! gutterid 14540: <td>pre-build-checks-hook</td>
1.156 leot 14541: </tr>
14542: <tr>
1.228 gutterid 14543: <td>pre-configure</td>
1.229 ! gutterid 14544: <td>pre-configure-checks-hook</td>
1.156 leot 14545: </tr>
14546: <tr>
1.228 gutterid 14547: <td>pre-extract</td>
1.229 ! gutterid 14548: <td>pre-fetch</td>
1.156 leot 14549: </tr>
14550: <tr>
1.228 gutterid 14551: <td>print-go-deps</td>
1.229 ! gutterid 14552: <td>print-plist</td>
1.174 leot 14553: </tr>
14554: <tr>
1.228 gutterid 14555: <td>print-summary-data</td>
1.229 ! gutterid 14556: <td>privileged-install-hook</td>
1.156 leot 14557: </tr>
14558: <tr>
1.228 gutterid 14559: <td>pypi</td>
1.229 ! gutterid 14560: <td>python</td>
1.156 leot 14561: </tr>
14562: <tr>
1.228 gutterid 14563: <td>r</td>
1.229 ! gutterid 14564: <td>readme-all</td>
1.156 leot 14565: </tr>
14566: <tr>
1.228 gutterid 14567: <td>recursive</td>
1.229 ! gutterid 14568: <td>recv</td>
1.156 leot 14569: </tr>
14570: <tr>
1.228 gutterid 14571: <td>recvfrom</td>
1.229 ! gutterid 14572: <td>regcomp</td>
1.156 leot 14573: </tr>
14574: <tr>
1.228 gutterid 14575: <td>release-localbase-lock</td>
1.229 ! gutterid 14576: <td>release-lock</td>
1.174 leot 14577: </tr>
14578: <tr>
1.228 gutterid 14579: <td>relro</td>
1.229 ! gutterid 14580: <td>remove</td>
1.174 leot 14581: </tr>
14582: <tr>
1.228 gutterid 14583: <td>removed</td>
1.229 ! gutterid 14584: <td>rename</td>
1.156 leot 14585: </tr>
14586: <tr>
1.228 gutterid 14587: <td>renamed</td>
1.229 ! gutterid 14588: <td>reorder</td>
1.226 gutterid 14589: </tr>
14590: <tr>
1.228 gutterid 14591: <td>replace</td>
1.229 ! gutterid 14592: <td>replace_interpreter</td>
1.226 gutterid 14593: </tr>
14594: <tr>
1.228 gutterid 14595: <td>reproducible</td>
1.229 ! gutterid 14596: <td>resolv</td>
1.156 leot 14597: </tr>
14598: <tr>
1.228 gutterid 14599: <td>root</td>
1.229 ! gutterid 14600: <td>ruby</td>
1.156 leot 14601: </tr>
14602: <tr>
1.228 gutterid 14603: <td>send</td>
1.229 ! gutterid 14604: <td>sendfile</td>
1.156 leot 14605: </tr>
14606: <tr>
1.228 gutterid 14607: <td>sendto</td>
1.229 ! gutterid 14608: <td>setenv</td>
1.174 leot 14609: </tr>
14610: <tr>
1.228 gutterid 14611: <td>setgid</td>
1.229 ! gutterid 14612: <td>setprogname</td>
1.156 leot 14613: </tr>
14614: <tr>
1.228 gutterid 14615: <td>setuid</td>
1.229 ! gutterid 14616: <td>sh</td>
1.156 leot 14617: </tr>
14618: <tr>
1.228 gutterid 14619: <td>shebang</td>
1.229 ! gutterid 14620: <td>show</td>
1.156 leot 14621: </tr>
14622: <tr>
1.228 gutterid 14623: <td>show-all</td>
1.229 ! gutterid 14624: <td>show-build-defs</td>
1.156 leot 14625: </tr>
14626: <tr>
1.228 gutterid 14627: <td>show-depends</td>
1.229 ! gutterid 14628: <td>show-depends-dirs</td>
1.181 rillig 14629: </tr>
14630: <tr>
1.228 gutterid 14631: <td>show-depends-pkgpaths</td>
1.229 ! gutterid 14632: <td>show-depends-recursive</td>
1.156 leot 14633: </tr>
14634: <tr>
1.228 gutterid 14635: <td>show-deps</td>
1.229 ! gutterid 14636: <td>show-distfiles</td>
1.222 gutterid 14637: </tr>
14638: <tr>
1.228 gutterid 14639: <td>show-downlevel</td>
1.229 ! gutterid 14640: <td>show-subdir-var</td>
1.223 nia 14641: </tr>
14642: <tr>
1.228 gutterid 14643: <td>show-tools</td>
1.229 ! gutterid 14644: <td>show-var</td>
1.156 leot 14645: </tr>
14646: <tr>
1.228 gutterid 14647: <td>show-vars</td>
1.229 ! gutterid 14648: <td>snprintf</td>
1.156 leot 14649: </tr>
14650: <tr>
1.228 gutterid 14651: <td>socket</td>
1.229 ! gutterid 14652: <td>ssp</td>
1.156 leot 14653: </tr>
14654: <tr>
1.228 gutterid 14655: <td>st_mode</td>
1.229 ! gutterid 14656: <td>stage-install</td>
1.156 leot 14657: </tr>
14658: <tr>
1.228 gutterid 14659: <td>strcasestr</td>
1.229 ! gutterid 14660: <td>strict</td>
1.174 leot 14661: </tr>
14662: <tr>
1.228 gutterid 14663: <td>strip</td>
1.229 ! gutterid 14664: <td>strndup</td>
1.156 leot 14665: </tr>
14666: <tr>
1.228 gutterid 14667: <td>strnlen</td>
1.229 ! gutterid 14668: <td>strsep</td>
1.156 leot 14669: </tr>
14670: <tr>
1.228 gutterid 14671: <td>subst</td>
1.229 ! gutterid 14672: <td>substitutions</td>
1.162 rillig 14673: </tr>
14674: <tr>
1.226 gutterid 14675: <td>sun</td>
1.229 ! gutterid 14676: <td>sunpro</td>
1.214 leot 14677: </tr>
14678: <tr>
1.226 gutterid 14679: <td>sunwspro</td>
1.229 ! gutterid 14680: <td>symlink</td>
1.212 wiz 14681: </tr>
14682: <tr>
1.228 gutterid 14683: <td>test</td>
1.229 ! gutterid 14684: <td>test-env</td>
1.227 wiz 14685: </tr>
14686: <tr>
1.228 gutterid 14687: <td>tex</td>
1.229 ! gutterid 14688: <td>texlive</td>
1.223 nia 14689: </tr>
14690: <tr>
1.228 gutterid 14691: <td>tmp</td>
1.229 ! gutterid 14692: <td>todo</td>
1.161 leot 14693: </tr>
14694: <tr>
1.228 gutterid 14695: <td>tool</td>
1.229 ! gutterid 14696: <td>tools</td>
1.156 leot 14697: </tr>
14698: <tr>
1.228 gutterid 14699: <td>tools-libtool-m4-override</td>
1.229 ! gutterid 14700: <td>transitive</td>
1.156 leot 14701: </tr>
14702: <tr>
1.228 gutterid 14703: <td>type</td>
1.229 ! gutterid 14704: <td>ulimit</td>
1.156 leot 14705: </tr>
14706: <tr>
1.228 gutterid 14707: <td>undefined</td>
1.229 ! gutterid 14708: <td>undo-replace</td>
1.156 leot 14709: </tr>
14710: <tr>
1.228 gutterid 14711: <td>unlimit</td>
1.229 ! gutterid 14712: <td>unprivileged</td>
1.156 leot 14713: </tr>
14714: <tr>
1.228 gutterid 14715: <td>unprivileged-install-hook</td>
1.229 ! gutterid 14716: <td>unstripped</td>
1.156 leot 14717: </tr>
14718: <tr>
1.228 gutterid 14719: <td>update</td>
1.229 ! gutterid 14720: <td>updated</td>
1.156 leot 14721: </tr>
14722: <tr>
1.228 gutterid 14723: <td>upload</td>
1.229 ! gutterid 14724: <td>upload-distfiles</td>
1.156 leot 14725: </tr>
14726: <tr>
1.228 gutterid 14727: <td>use_tools</td>
1.229 ! gutterid 14728: <td>user</td>
1.156 leot 14729: </tr>
14730: <tr>
1.228 gutterid 14731: <td>utimes</td>
1.229 ! gutterid 14732: <td>vasprintf</td>
1.156 leot 14733: </tr>
14734: <tr>
1.228 gutterid 14735: <td>verbose</td>
1.229 ! gutterid 14736: <td>vsnprintf</td>
1.156 leot 14737: </tr>
14738: <tr>
1.228 gutterid 14739: <td>warn</td>
1.229 ! gutterid 14740: <td>warning</td>
1.156 leot 14741: </tr>
14742: <tr>
1.228 gutterid 14743: <td>warnings</td>
1.229 ! gutterid 14744: <td>warnx</td>
1.156 leot 14745: </tr>
14746: <tr>
1.228 gutterid 14747: <td>wattr_off</td>
1.229 ! gutterid 14748: <td>wattr_on</td>
1.156 leot 14749: </tr>
14750: <tr>
1.228 gutterid 14751: <td>work</td>
1.229 ! gutterid 14752: <td>wrapper</td>
1.156 leot 14753: </tr>
14754: <tr>
1.174 leot 14755: <td>wrkdir</td>
1.229 ! gutterid 14756: <td> </td>
1.156 leot 14757: </tr>
14758: </table>
1.154 rillig 14759: </div>
14760: <div class="appendix">
14761: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 14762: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 14763: <div class="toc">
14764: <p><b>Table of Contents</b></p>
1.100 leot 14765: <dl class="toc">
1.207 leot 14766: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
14767: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 14768: </dl>
14769: </div>
14770: <p>This section contains information on editing the pkgsrc
14771: guide itself.</p>
1.41 asau 14772: <div class="sect1">
1.1 dsieger 14773: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 14774: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.1 dsieger 14775: <p>The pkgsrc guide's source code is stored in
14776: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
14777: are created from it:</p>
1.41 asau 14778: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 14779: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
14780: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.174 leot 14781: <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>
14782: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1 dsieger 14783: The PDF version of the pkgsrc guide.</p></li>
1.174 leot 14784: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1 dsieger 14785: PostScript version of the pkgsrc guide.</p></li>
14786: </ul></div>
14787: </div>
1.41 asau 14788: <div class="sect1">
1.1 dsieger 14789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 14790: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.1 dsieger 14791: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 14792: <div class="procedure"><ol class="procedure" type="1">
1.190 bacon 14793: <li class="step"><p>Make sure you have checked out the htdocs repository
14794: into a sibling directory of your pkgsrc directory. You will need
14795: the ability to commit from both pkgsrc and htdocs.</p></li>
1.41 asau 14796: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 14797: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 14798: documentation) installed. These are automatically installed when
1.207 leot 14799: you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/index.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.41 asau 14800: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 14801: right directory. All further steps will take place
14802: here.</p></li>
1.41 asau 14803: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 14804: <code class="filename">files/</code>.</p></li>
1.41 asau 14805: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 14806: guide for valid XML and to build the final output files. If you
14807: get any errors at this stage, you can just edit the files, as
14808: there are only symbolic links in the working directory, pointing
14809: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 14810: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 14811: commit)</strong></span></p></li>
1.41 asau 14812: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 14813: regenerate the output files with the proper RCS
14814: Ids.</p></li>
1.41 asau 14815: <li class="step">
1.10 hubertf 14816: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 14817: commit the files in both <code class="filename">pkgsrc/doc</code> and
14818: <code class="filename">htdocs</code>.</p>
1.41 asau 14819: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 14820: <h3 class="title">Note</h3>
14821: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 14822: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
14823: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 14824: directory.</p>
14825: </div>
14826: </li>
14827: </ol></div>
14828: </div>
14829: </div>
14830: </div></body>
14831: </html>
CVSweb <webmaster@jp.NetBSD.org>