Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.240
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.231 jnemeth 33: <div><p class="copyright">Copyright © 1994-2023 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.42 2023/01/02 05:45:23 jnemeth Exp $</p></div>
1.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>
1.239 dholland 299: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
300: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
301: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 302: </dl></dd>
303: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
304: <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>
305: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
306: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
307: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
308: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
309: <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 310: </dl></dd>
311: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
312: <dd><dl>
313: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
314: <dd><dl>
315: <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>
316: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
317: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
318: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
319: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
320: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
321: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
322: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
323: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
324: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
325: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
326: </dl></dd>
327: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
328: <dd><dl>
329: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
330: <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>
331: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
332: </dl></dd>
333: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
334: <dd><dl>
335: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
336: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
337: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 338: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154 rillig 339: </dl></dd>
340: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
341: <dd><dl>
342: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
343: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 344: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 345: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
346: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
347: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
348: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 349: </dl></dd>
350: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
351: <dd><dl>
352: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
353: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 354: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
355: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
356: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 357: </dl></dd>
358: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
359: <dd><dl>
360: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
361: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
362: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
363: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
364: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 365: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154 rillig 366: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
367: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203 nia 368: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
369: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
370: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
371: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
372: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
373: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
374: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1 dsieger 375: emulation</a></span></dt>
1.203 nia 376: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
377: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1 dsieger 378: </dl></dd>
1.154 rillig 379: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 380: </dl></dd>
1.184 rillig 381: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
382: <dd><dl>
383: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
384: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
385: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
386: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
387: </dl></dd>
1.154 rillig 388: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 389: <dd><dl>
1.154 rillig 390: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
391: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
392: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
393: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
394: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
395: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
396: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
397: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
398: </dl></dd>
399: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 400: </dl></dd>
401: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
402: <dd><dl>
1.184 rillig 403: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 404: <dd><dl>
1.184 rillig 405: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
406: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
407: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 408: <dd><dl>
1.184 rillig 409: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
410: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 411: </dl></dd>
1.184 rillig 412: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
413: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 414: <dd><dl>
1.184 rillig 415: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
416: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 417: </dl></dd>
1.184 rillig 418: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 419: <dd><dl>
1.184 rillig 420: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
421: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 422: </dl></dd>
423: </dl></dd>
1.184 rillig 424: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 425: <dd><dl>
1.184 rillig 426: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
427: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 428: <dd><dl>
1.184 rillig 429: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
430: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 431: </dl></dd>
432: </dl></dd>
1.184 rillig 433: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
434: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 435: </dl></dd>
436: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
437: <dd><dl>
438: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
439: <dd><dl>
440: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
441: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
442: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 443: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 444: </dl></dd>
445: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
446: </dl></dd>
1.207 leot 447: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.1 dsieger 448: <dd><dl>
1.207 leot 449: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
450: <dd><dl>
451: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
452: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
453: </dl></dd>
454: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
455: <dd><dl>
456: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
457: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
458: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
459: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
460: </dl></dd>
461: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
462: <dd><dl>
463: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
464: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
465: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
466: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
467: </dl></dd>
468: </dl></dd>
469: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
470: <dd><dl>
471: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
472: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.1 dsieger 473: </dl></dd>
1.207 leot 474: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.1 dsieger 475: <dd><dl>
1.207 leot 476: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
477: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
478: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
479: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
480: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.148 leot 481: <code class="filename">stable</code>,
1.23 wiz 482: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 483: source packages</a></span></dt>
484: </dl></dd>
1.207 leot 485: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
486: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1 dsieger 487: <dd><dl>
1.207 leot 488: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
489: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 490: </dl></dd>
491: </dl>
492: </div>
493: <div class="list-of-tables">
494: <p><b>List of Tables</b></p>
495: <dl>
496: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
497: </dt>
1.184 rillig 498: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 499: </dt>
1.184 rillig 500: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 501: </dt>
502: </dl>
503: </div>
1.41 asau 504: <div class="chapter">
505: <div class="titlepage"><div><div><h1 class="title">
506: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 507: <div class="toc">
508: <p><b>Table of Contents</b></p>
1.100 leot 509: <dl class="toc">
1.1 dsieger 510: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
511: <dd><dl>
512: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
513: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
514: </dl></dd>
515: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
516: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
517: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
518: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
519: </dl>
520: </div>
1.41 asau 521: <div class="sect1">
1.1 dsieger 522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
523: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
524: <p>There is a lot of software freely available for Unix-based
525: systems, which is usually available in form of the source code. Before
526: such software can be used, it needs to be configured to the local
527: system, compiled and installed, and this is exactly what The NetBSD
528: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
529: to handle binary packages, so that not every user has to build the
530: packages for himself, which is a time-costly task.</p>
531: <p>pkgsrc currently contains several thousand packages,
532: including:</p>
1.41 asau 533: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 534: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.1 dsieger 535: web server</p></li>
1.207 leot 536: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1 dsieger 537: web browser</p></li>
1.207 leot 538: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1 dsieger 539: Desktop Environment</p></li>
1.207 leot 540: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.1 dsieger 541: Desktop Environment</p></li>
542: </ul></div>
1.108 rillig 543: <p>… just to name a few.</p>
1.1 dsieger 544: <p>pkgsrc has built-in support for handling varying dependencies,
545: such as pthreads and X11, and extended features such as IPv6 support on
546: a range of platforms.</p>
1.41 asau 547: <div class="sect2">
1.1 dsieger 548: <div class="titlepage"><div><div><h3 class="title">
549: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
550: <p>
551: pkgsrc provides the following key features:
552: </p>
1.41 asau 553: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 554: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 555: and installation of binary packages. The source and latest
556: patches are retrieved from a master or mirror download site, checksum
557: verified, then built on your system. Support for binary-only
558: distributions is available for both native platforms and NetBSD
559: emulated platforms.</p></li>
1.23 wiz 560: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 561: including binaries, libraries, man pages and other
562: documentation.</p></li>
1.104 sevan 563: <li class="listitem"><p>Tracking of package dependencies automatically, including when
564: performing updates, to ensure required packages are installed. The
565: configuration files of various packages are handled automatically during
566: updates, so local changes are preserved.</p></li>
1.23 wiz 567: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 568: consists of highly portable code. This allows the greatest speed of
1.25 spz 569: development when porting to a new platform. This portability also
1.1 dsieger 570: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
571: platforms</em></span>.</p></li>
1.23 wiz 572: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 573: international encryption requirements and build-time options for a
574: large number of packages are all set in a simple, central
575: configuration file.</p></li>
1.23 wiz 576: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 577: freely available under a BSD license, so you may extend and adapt
578: pkgsrc to your needs. Support for local packages and patches is
579: available right out of the box, so you can configure it specifically
580: for your environment.</p></li>
581: </ul></div>
582: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 583: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 584: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 585: — That means, if a package contains bugs, it's better to find
1.1 dsieger 586: them and to complain about them rather than to just install the package
587: and hope that it works. There are numerous checks in pkgsrc that try to
1.207 leot 588: find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.1 dsieger 589: of shell scripts), and post-installation checks (installed files,
590: references to shared libraries, script interpreters).</p></li>
1.23 wiz 591: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 592: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 593: pkgsrc has been ported to many operating systems. Care is taken that
594: packages behave the same on all platforms.</p></li>
595: </ul></div>
596: </div>
1.41 asau 597: <div class="sect2">
1.1 dsieger 598: <div class="titlepage"><div><div><h3 class="title">
599: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
600: <p>pkgsrc consists of both a source distribution and a binary
601: distribution for these operating systems. After retrieving the required
602: source or binaries, you can be up and running with pkgsrc in just
603: minutes!</p>
604: <p>pkgsrc was derived from FreeBSD's ports system, and
605: initially developed for NetBSD only. Since then, pkgsrc has
606: grown a lot, and now supports the following platforms:</p>
607: <div class="table">
608: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 609: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 610: <colgroup>
611: <col>
612: <col>
1.92 sevan 613: <col>
1.1 dsieger 614: </colgroup>
615: <thead><tr>
616: <th>Platform</th>
617: <th>Date Support Added</th>
1.92 sevan 618: <th>Notes</th>
1.1 dsieger 619: </tr></thead>
620: <tbody>
621: <tr>
1.174 leot 622: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 623: <td align="center">Aug 1997</td>
1.92 sevan 624: <td class="auto-generated"> </td>
1.1 dsieger 625: </tr>
626: <tr>
1.10 hubertf 627: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 628: <td align="center">Mar 1999</td>
1.151 sevan 629: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1 dsieger 630: </tr>
631: <tr>
1.174 leot 632: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 633: <td align="center">Jun 1999</td>
1.151 sevan 634: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1 dsieger 635: </tr>
636: <tr>
637: <td>
1.118 sevan 638: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 639: </td>
640: <td align="center">Oct 2001</td>
1.191 bacon 641: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.1 dsieger 642: </tr>
643: <tr>
1.174 leot 644: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 645: <td align="center">Nov 2002</td>
1.151 sevan 646: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1 dsieger 647: </tr>
648: <tr>
1.174 leot 649: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 650: <td align="center">Nov 2002</td>
1.151 sevan 651: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1 dsieger 652: </tr>
653: <tr>
1.174 leot 654: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 655: <td align="center">Dec 2002</td>
1.92 sevan 656: <td>
1.151 sevan 657: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.92 sevan 658: </td>
1.1 dsieger 659: </tr>
660: <tr>
661: <td>BSD/OS</td>
662: <td align="center">Dec 2003</td>
1.92 sevan 663: <td class="auto-generated"> </td>
1.1 dsieger 664: </tr>
665: <tr>
1.174 leot 666: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 667: <td align="center">Dec 2003</td>
1.151 sevan 668: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1 dsieger 669: </tr>
670: <tr>
671: <td>
1.174 leot 672: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 673: (Microsoft Windows Services for Unix)
674: </td>
675: <td align="center">Mar 2004</td>
1.151 sevan 676: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1 dsieger 677: </tr>
678: <tr>
1.174 leot 679: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 680: <td align="center">Oct 2004</td>
1.92 sevan 681: <td class="auto-generated"> </td>
1.1 dsieger 682: </tr>
683: <tr>
1.10 hubertf 684: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 685: <td align="center">Nov 2004</td>
1.151 sevan 686: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1 dsieger 687: </tr>
688: <tr>
1.174 leot 689: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 690: <td align="center">Apr 2007</td>
1.151 sevan 691: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1 dsieger 692: </tr>
1.23 wiz 693: <tr>
1.174 leot 694: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.23 wiz 695: <td align="center">Sep 2010</td>
1.151 sevan 696: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23 wiz 697: </tr>
1.45 obache 698: <tr>
1.174 leot 699: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 700: <td align="center">Jan 2011</td>
1.92 sevan 701: <td class="auto-generated"> </td>
1.45 obache 702: </tr>
703: <tr>
1.174 leot 704: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.45 obache 705: <td align="center">Nov 2011</td>
1.151 sevan 706: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45 obache 707: </tr>
708: <tr>
1.174 leot 709: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.45 obache 710: <td align="center">Mar 2013</td>
1.151 sevan 711: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45 obache 712: </tr>
1.58 ryoon 713: <tr>
1.174 leot 714: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.58 ryoon 715: <td align="center">Jul 2013</td>
1.151 sevan 716: <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 717: </tr>
1.104 sevan 718: <tr>
1.174 leot 719: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.104 sevan 720: <td align="center">Jun 2014</td>
1.229 gutterid 721: <td>Removed from pkgsrc Sep 2022</td>
1.104 sevan 722: </tr>
1.1 dsieger 723: </tbody>
724: </table></div>
725: </div>
726: <br class="table-break">
727: </div>
728: </div>
1.41 asau 729: <div class="sect1">
1.1 dsieger 730: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
731: <a name="overview"></a>1.2. Overview</h2></div></div></div>
732: <p>This document is divided into three parts. The first,
1.10 hubertf 733: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 734: describes how one can use one of the packages in the Package
735: Collection, either by installing a precompiled binary package,
736: or by building one's own copy using the NetBSD package system.
1.10 hubertf 737: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1 dsieger 738: package so it can be easily built by other NetBSD users without
739: knowing about the package's building details. The third part,
1.10 hubertf 740: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 741: is intended for those who want to understand how pkgsrc is
742: implemented.</p>
743: <p>This document is available in various formats:
1.10 hubertf 744: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1 dsieger 745: </div>
1.41 asau 746: <div class="sect1">
1.1 dsieger 747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
748: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 749: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
750: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 751: terminology used within this document.</p>
1.41 asau 752: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 753: <dt><span class="term">Package</span></dt>
754: <dd><p>A set of files and building instructions
755: that describe what's necessary
756: to build a certain piece of software using
757: pkgsrc. Packages are traditionally stored under
1.123 wiz 758: <code class="filename">/usr/pkgsrc</code>,
759: but may be stored in any location,
760: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1 dsieger 761: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 762: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 763: is part of the NetBSD operating system and can be bootstrapped
764: to run on non-NetBSD operating systems as well. It handles
765: building (compiling), installing, and removing of
766: packages.</p></dd>
767: <dt><span class="term">Distfile</span></dt>
768: <dd><p>This term describes the file or files that are
769: provided by the author of the piece of software to
770: distribute his work. All the changes necessary to build on
771: NetBSD are reflected in the corresponding package. Usually
772: the distfile is in the form of a compressed tar-archive,
773: but other types are possible, too. Distfiles are usually
774: stored below
775: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
776: <dt><span class="term">Port</span></dt>
777: <dd><p>This is the term used by FreeBSD and OpenBSD people
778: for what we call a package.
1.23 wiz 779: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 780: architecture.</p></dd>
781: <dt><span class="term">Precompiled/binary package</span></dt>
782: <dd>
783: <p>A set of binaries built with pkgsrc from a distfile
784: and stuffed together in a single <code class="filename">.tgz</code>
785: file so it can be installed on machines of the same
786: machine architecture without the need to
787: recompile. Packages are usually generated in
788: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 789: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 790: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 791: especially in the context of precompiled packages.</p>
792: </dd>
793: <dt><span class="term">Program</span></dt>
794: <dd><p>The piece of software to be installed which will be
795: constructed from all the files in the distfile by the
796: actions defined in the corresponding package.</p></dd>
797: </dl></div>
1.41 asau 798: <div class="sect2">
1.1 dsieger 799: <div class="titlepage"><div><div><h3 class="title">
800: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 801: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 802: <dt><span class="term">pkgsrc users</span></dt>
803: <dd>
804: <p>The
805: pkgsrc users are people who use the packages provided by pkgsrc.
806: Typically they are system administrators. The people using the
1.23 wiz 807: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
808: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 809: <p>There are two kinds of pkgsrc users: Some only want to
810: install pre-built binary packages. Others build the pkgsrc
811: packages from source, either for installing them directly or for
1.10 hubertf 812: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.1 dsieger 813: documentation.</p>
814: </dd>
815: <dt><span class="term">package maintainers</span></dt>
816: <dd><p>A
1.10 hubertf 817: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.1 dsieger 818: <dt><span class="term">infrastructure developers</span></dt>
819: <dd><p>These people are involved in all those files
820: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 821: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.1 dsieger 822: too.</p></dd>
823: </dl></div>
824: </div>
825: </div>
1.41 asau 826: <div class="sect1">
1.1 dsieger 827: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
828: <a name="typography"></a>1.4. Typography</h2></div></div></div>
829: <p>When giving examples for commands, shell prompts are used to
830: show if the command should/can be issued as root, or if
1.23 wiz 831: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 832: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
833: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.229 gutterid 834: Bourne shell and derivatives.</p>
1.1 dsieger 835: </div>
836: </div>
1.41 asau 837: <div class="part">
1.1 dsieger 838: <div class="titlepage"><div><div><h1 class="title">
839: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
840: <div class="toc">
841: <p><b>Table of Contents</b></p>
1.100 leot 842: <dl class="toc">
1.154 rillig 843: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
844: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1 dsieger 845: <dd><dl>
1.154 rillig 846: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 847: <dd><dl>
1.154 rillig 848: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
849: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 850: </dl></dd>
1.154 rillig 851: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 852: <dd><dl>
1.154 rillig 853: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
854: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 855: </dl></dd>
856: </dl></dd>
1.154 rillig 857: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 858: <dd><dl>
1.154 rillig 859: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
860: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 861: </dl></dd>
1.154 rillig 862: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 863: <dd><dl>
1.154 rillig 864: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 865: <dd><dl>
1.154 rillig 866: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
867: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 868: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
869: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
870: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
871: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
872: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
873: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1 dsieger 874: </dl></dd>
1.154 rillig 875: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 876: <dd><dl>
1.154 rillig 877: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
878: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
879: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 880: </dl></dd>
881: </dl></dd>
1.154 rillig 882: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 883: <dd><dl>
1.154 rillig 884: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
885: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
886: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
887: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 888: <dd><dl>
1.154 rillig 889: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
890: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
891: <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 892: </dl></dd>
1.154 rillig 893: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
894: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 895: </dl></dd>
1.154 rillig 896: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 897: <dd><dl>
1.154 rillig 898: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
899: <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 900: </dl></dd>
1.154 rillig 901: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 902: builds)</a></span></dt>
1.1 dsieger 903: <dd><dl>
1.154 rillig 904: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 905: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 906: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
907: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 908: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
909: <dd><dl>
1.179 rillig 910: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
911: <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 912: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
913: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
914: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
915: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
916: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
917: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
918: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
919: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 920: </dl></dd>
921: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
922: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 923: </dl></dd>
924: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
925: <dd><dl>
926: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
927: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
928: </dl></dd>
929: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
930: <dd><dl>
931: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
932: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
933: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
934: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
935: <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>
936: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
937: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
938: <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>
939: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
940: <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 941: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 942: <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 943: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 944: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
945: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
946: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
947: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
948: <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 949: </dl></dd>
950: </dl>
951: </div>
1.41 asau 952: <div class="chapter">
1.1 dsieger 953: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 954: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
955: <p>
956: To get help when using pkgsrc, the definitive source is this
957: document, the pkgsrc guide. If you don't find anything here,
958: there are alternatives:
959: </p>
960: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
961: <li class="listitem">
962: <p>
963: The built-in pkgsrc help, which is available after bootstrapping
964: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
965: help for any topic, such as a variable name like
966: <code class="varname">BUILD_DEFS</code>, a make target like
967: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
968: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.207 leot 969: <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 970: </li>
971: <li class="listitem"><p>
1.163 rillig 972: To see the value of a single variable, run <span class="command"><strong>bmake
973: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
974: </p></li>
975: <li class="listitem"><p>
976: To see the values of the most common variables, run
977: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
978: topic. To see the variables for a single topic, run
979: <span class="command"><strong>bmake
980: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
981: <span class="command"><strong>bmake show-all-fetch</strong></span>.
982: </p></li>
983: <li class="listitem"><p>
1.154 rillig 984: The pkgsrc-users mailing list, to which
985: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
986: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
987: questions</a>.</p></li>
988: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
989: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
990: or by using a specialized chat program such as
991: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
992: Pick any user name and join the channel #pkgsrc.</p></li>
993: </ul></div>
994: </div>
995: <div class="chapter">
996: <div class="titlepage"><div><div><h2 class="title">
997: <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 998: <div class="toc">
999: <p><b>Table of Contents</b></p>
1.100 leot 1000: <dl class="toc">
1.154 rillig 1001: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 1002: <dd><dl>
1.154 rillig 1003: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
1004: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 1005: </dl></dd>
1.154 rillig 1006: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 1007: <dd><dl>
1.154 rillig 1008: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
1009: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 1010: </dl></dd>
1011: </dl>
1012: </div>
1013: <p>Before you download and extract the files, you need to decide
1014: where you want to extract them. When using pkgsrc as root user, pkgsrc
1015: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
1016: free to install the sources and binary packages wherever you want in
1017: your filesystem, provided that the pathname does not contain white-space
1018: or other characters that are interpreted specially by the shell and some
1019: other programs. A safe bet is to use only letters, digits, underscores
1020: and dashes.</p>
1.41 asau 1021: <div class="sect1">
1.1 dsieger 1022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1023: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 1024: <p>Before you download any pkgsrc files, you should decide
1025: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1026: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1027: quarterly basis from the current branch and only gets modified
1028: for security updates. The names of the stable branches are built
1029: from the year and the quarter, for example
1.214 leot 1030: <code class="literal">2021Q4</code>.</p>
1.1 dsieger 1031: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 1032: want to download pkgsrc. You can get it as a tar file or via CVS.
1033: Both ways are described here.</p>
1.51 asau 1034: <p>Note that tar archive contains CVS working copy.
1035: Thus you can switch to using CVS at any later time.</p>
1.41 asau 1036: <div class="sect2">
1.1 dsieger 1037: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1038: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 1039: <p>The primary download location for all pkgsrc files is
1.151 sevan 1040: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 1041: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1042: (it points to the same location).
1043: There are a number of subdirectories for different purposes,
1.207 leot 1044: 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 1045: <p>The tar archive for the current branch is in the directory
1.151 sevan 1046: <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 1047: It is autogenerated weekly.</p>
1.51 asau 1048: <p>To save download time we provide bzip2- and
1049: xz-compressed archives which are published at
1.151 sevan 1050: <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 1051: and
1.151 sevan 1052: <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 1053: respectively.
1054: </p>
1055: <p>You can fetch the same files using FTP.</p>
1.214 leot 1056: <p>The tar file for the stable branch 2021Q4 is in the
1057: 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 1058: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 1059: <pre class="screen">
1.214 leot 1060: <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 1061: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1062: or your web browser.</p>
1.12 weinem 1063: <p>Then, extract it with:</p>
1.78 snj 1064: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1065: <p>This will create the directory <code class="filename">pkgsrc/</code>
1066: in <code class="filename">/usr/</code> and all the package source will be
1067: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1068: <p>To download pkgsrc-current, run:</p>
1069: <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 1070: </div>
1.41 asau 1071: <div class="sect2">
1.1 dsieger 1072: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1073: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1074: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.214 leot 1075: <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 1076: </pre>
1077: <p>This will create the directory <code class="filename">pkgsrc/</code>
1078: in your <code class="filename">/usr/</code> directory and all the package source
1079: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1080: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1081: <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 1082: </pre>
1.174 leot 1083: <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 1084: <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 1085: <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 1086: </pre>
1087: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1088: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1089: or better globally in <code class="filename">/etc/profile</code>:</p>
1090: <pre class="programlisting">
1091: # set CVS remote shell command
1092: CVS_RSH=ssh
1093: export CVS_RSH
1094: </pre>
1095: <p>By default, CVS doesn't do things like most people would expect it to do.
1096: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1097: in your home directory and saving the following lines to it.
1098: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1099: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1100: <pre class="programlisting">
1101: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1102: cvs -q
1.2 rillig 1103: checkout -P
1.4 rillig 1104: update -dP
1105: diff -upN
1.2 rillig 1106: rdiff -u
1.23 wiz 1107: release -d
1.2 rillig 1108: </pre>
1.1 dsieger 1109: </div>
1110: </div>
1.41 asau 1111: <div class="sect1">
1.1 dsieger 1112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1113: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1114: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1115: (which also works if you have first installed it via a tar
1116: file). It saves bandwidth and hard disk activity, compared to
1117: downloading the tar file again.</p>
1.41 asau 1118: <div class="sect2">
1.1 dsieger 1119: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1120: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1121: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1122: <h3 class="title">Warning</h3>
1123: <p>When updating from a tar file, you first need to
1124: completely remove the old pkgsrc directory. Otherwise those
1125: files that have been removed from pkgsrc in the mean time will
1126: not be removed on your local disk, resulting in inconsistencies.
1127: When removing the old files, any changes that you have done to
1128: the pkgsrc files will be lost after updating. Therefore updating
1129: via CVS is strongly recommended.</p>
1130: </div>
1131: <p>Note that by default the distfiles and the binary packages
1132: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1133: before updating. You can also configure pkgsrc to store distfiles
1134: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1135: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154 rillig 1136: 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 1137: <p>To update pkgsrc from a tar file, download the tar file as
1138: explained above. Then, make sure that you have not made any
1139: changes to the files in the pkgsrc directory. Remove the pkgsrc
1140: directory and extract the new tar file. Done.</p>
1141: </div>
1.41 asau 1142: <div class="sect2">
1.1 dsieger 1143: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1144: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1145: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1146: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1147: </pre>
1148: <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>
1149: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1150: </pre>
1.41 asau 1151: <div class="sect3">
1.1 dsieger 1152: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1153: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1154: <p>When updating pkgsrc, the CVS program keeps track of the
1155: branch you selected. But if you, for whatever reason, want to
1156: switch from the stable branch to the current one, you can do it
1.23 wiz 1157: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1158: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1159: back to the stable branch, add the
1.214 leot 1160: <span class="quote">“<span class="quote">-rpkgsrc-2021Q4</span>”</span> option.</p>
1.1 dsieger 1161: </div>
1.41 asau 1162: <div class="sect3">
1.1 dsieger 1163: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1164: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1165: <p>When you update pkgsrc, the CVS program will only touch
1166: those files that are registered in the CVS repository. That
1167: means that any packages that you created on your own will stay
1168: unmodified. If you change files that are managed by CVS, later
1169: updates will try to merge your changes with those that have been
1170: done by others. See the CVS manual, chapter
1.23 wiz 1171: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1172: </div>
1173: </div>
1174: </div>
1175: </div>
1.41 asau 1176: <div class="chapter">
1.1 dsieger 1177: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1178: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1179: <div class="toc">
1180: <p><b>Table of Contents</b></p>
1.100 leot 1181: <dl class="toc">
1.154 rillig 1182: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1183: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1184: </dl>
1185: </div>
1.41 asau 1186: <div class="sect1">
1.1 dsieger 1187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1188: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1189: <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 1190: </div>
1.41 asau 1191: <div class="sect1">
1.1 dsieger 1192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1193: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1194: <p>pkgsrc can be bootstrapped for use in two different modes:
1195: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1196: to privileged one all programs are installed under one particular user
1.43 asau 1197: and cannot utilise privileged operations (packages don't create
1198: special users and all special file permissions like setuid are ignored).
1199: </p>
1.1 dsieger 1200: <p>Installing the bootstrap kit from source should be as simple as:</p>
1201: <pre class="screen">
1.60 asau 1202: <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 1203: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1204: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1205: </pre>
1.43 asau 1206: <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>
1207: <p>By default, in privileged mode pkgsrc uses
1208: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1209: where programs will be installed in,
1.118 sevan 1210: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1211: directory where pkgsrc will do its internal bookkeeping,
1212: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1213: where packages install their persistent data.
1214: In unprivileged mode pkgsrc uses
1215: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1216: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1217: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1218: </p>
1219: <p>You can change default layout using command-line arguments.
1220: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1221: </p>
1.41 asau 1222: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1223: <h3 class="title">Note</h3>
1.10 hubertf 1224: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1225: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1226: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1227: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1228: </div>
1.43 asau 1229: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1230: <h3 class="title">Note</h3>
1231: <p>It is possible to bootstrap multiple instances of pkgsrc
1232: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1233: corresponding to the installation you're working with to build
1234: and install packages.
1235: </p>
1236: </div>
1.1 dsieger 1237: </div>
1238: </div>
1.41 asau 1239: <div class="chapter">
1.1 dsieger 1240: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1241: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1242: <div class="toc">
1243: <p><b>Table of Contents</b></p>
1.100 leot 1244: <dl class="toc">
1.154 rillig 1245: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1246: <dd><dl>
1.154 rillig 1247: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1248: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 1249: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1250: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1251: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1252: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1253: <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>
1254: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.154 rillig 1255: </dl></dd>
1256: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1257: <dd><dl>
1258: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1259: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1260: <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 1261: </dl></dd>
1262: </dl>
1263: </div>
1264: <p>Basically, there are two ways of using pkgsrc. The first
1265: is to only install the package tools and to use binary packages
1.23 wiz 1266: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1267: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1268: of pkgsrc, too. Then you are able to build your own packages,
1269: and you can still use binary packages from someone else.</p>
1.41 asau 1270: <div class="sect1">
1.1 dsieger 1271: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1272: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.202 nia 1273: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.151 sevan 1274: site and mirrors, there are collections of binary packages,
1.9 rillig 1275: ready to be installed. These binary packages have been built using the
1276: default settings for the directories, that is:</p>
1.41 asau 1277: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1278: <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>
1279: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1280: <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 1281: </ul></div>
1282: <p>If you cannot use these directories for whatever reasons (maybe
1283: because you're not root), you cannot use these binary packages, but
1.154 rillig 1284: 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 1285: <div class="sect2">
1.1 dsieger 1286: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1287: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1288: <p>To install binary packages, you first need to know from where
1289: to get them. The first place where you should look is on the main
1.202 nia 1290: 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 1291: <p>This directory contains binary packages for multiple
1.226 gutterid 1292: platforms. First, select your operating system. Then, select your
1293: hardware architecture, and in the third step, the OS version and
1294: the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1295: <p>In this directory, you may find a file called
1.9 rillig 1296: <code class="filename">bootstrap.tar.gz</code> which contains the package
1297: management tools. If the file is missing, it is likely that your
1298: operating system already provides those tools. Download the file and
1299: extract it in the <code class="filename">/</code> directory. It will create
1300: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1301: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1302: </div>
1.41 asau 1303: <div class="sect2">
1.1 dsieger 1304: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1305: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1306: <p>In the directory from the last section, there is a
1.85 wiz 1307: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1308: binary packages that are available for the platform, excluding those
1.202 nia 1309: that may not be distributed via HTTP or FTP.</p>
1.9 rillig 1310: <p>To install packages directly from an FTP or HTTP server, run
1311: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1312: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1313: <pre class="screen">
1.202 nia 1314: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1315: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.169 rillig 1316: <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 1317: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.202 nia 1318: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.9 rillig 1319: </pre>
1320: <p>Instead of URLs, you can also use local paths, for example if
1321: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1322: repository. If you want to install packages from multiple sources,
1323: you can separate them by a semicolon in
1324: <code class="varname">PKG_PATH</code>.</p>
1325: <p>After these preparations, installing a package is very
1326: easy:</p>
1327: <pre class="screen">
1.202 nia 1328: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1329: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1330: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1331: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1332: </pre>
1333: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1334: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1335: <p>Any prerequisite packages needed to run the
1.1 dsieger 1336: package in question will be installed, too, assuming they are
1.202 nia 1337: present in the repository.</p>
1.1 dsieger 1338: <p>After you've installed packages, be sure to have
1339: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1340: <code class="varname">PATH</code> so you can actually start the just
1341: installed program.</p>
1342: </div>
1.41 asau 1343: <div class="sect2">
1.1 dsieger 1344: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1345: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1346: <p>To update binary packages, it is recommended that you use
1347: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1348: package repository to your locally installed packages and safely
1349: replace any older packages.</p>
1350: <p>Note that pkgsrc is released as quarterly branches.
1351: If you are updating to a newer quarterly branch of pkgsrc, you may
1352: need to adjust the repository in
1353: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1354: </div>
1355: <div class="sect2">
1356: <div class="titlepage"><div><div><h3 class="title">
1357: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1358: <p>To deinstall a package, it does not matter whether it was
1.202 nia 1359: installed from source code or from a binary package. Neither the
1360: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1361: command need to know.</p>
1362: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.1 dsieger 1363: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.202 nia 1364: name can be given with or without version number.</p>
1.1 dsieger 1365: </div>
1.41 asau 1366: <div class="sect2">
1.1 dsieger 1367: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1368: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1369: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.202 nia 1370: installed packages or binary package files.
1371: As with other management tools, it works with packages installed
1372: from source or binaries.</p>
1.1 dsieger 1373: </div>
1.41 asau 1374: <div class="sect2">
1.1 dsieger 1375: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1376: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1377: <p>
1.164 leot 1378: The pkgsrc Security Team and Packages Groups maintain a list of
1.202 nia 1379: known vulnerabilities to packages which are (or have been)
1.1 dsieger 1380: included in pkgsrc. The list is available from the NetBSD
1.202 nia 1381: 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>.
1382: </p>
1383: <p>
1384: Please note that not every "vulnerability" with a CVE assignment is
1385: exploitable in every configuration.
1386: Some bugs are marked as active simply because an fix was not
1387: marked as such.
1388: Operating system specific hardening and mitigation features may also
1389: reduce the impact of bugs.
1.1 dsieger 1390: </p>
1391: <p>
1.22 jakllsch 1392: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1393: this list can be downloaded
1394: automatically, and a security audit of all packages installed on a system
1395: can take place.
1396: </p>
1397: <p>
1.22 jakllsch 1398: There are two components to auditing. The first
1399: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1400: is for downloading
1.1 dsieger 1401: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1402: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1403: installed packages are vulnerable. If a package is vulnerable, you
1404: will see output similar to the following:
1405: </p>
1406: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1407: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.1 dsieger 1408: <p>
1.22 jakllsch 1409: You may wish to have the
1.202 nia 1410: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1411: file downloaded daily so that
1412: it remains current. This may be done by adding an appropriate entry
1.207 leot 1413: 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 1414: </p>
1415: <pre class="screen">
1.121 sevan 1416: # Download vulnerabilities file
1.118 sevan 1417: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1418: # Audit the installed packages and email results to root
1419: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1420: root >/dev/null 2>&1
1.22 jakllsch 1421: </pre>
1422: <p>
1.118 sevan 1423: will update the vulnerability list every day at 3AM, followed by an audit
1424: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1425:
1.118 sevan 1426: On NetBSD this may be accomplished instead by adding the following
1427: line to <code class="filename">/etc/daily.conf</code>:
1428: </p>
1429: <pre class="screen">
1430: fetch_pkg_vulnerabilities=YES
1431: </pre>
1432: <p>
1433: to fetch the vulnerability list from the daily security script. The system
1434: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1435: desired (not required), by adding the following line to
1.118 sevan 1436: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1437: </p>
1438: <pre class="screen">
1.118 sevan 1439: check_pkg_vulnerabilities=YES
1.22 jakllsch 1440: </pre>
1441: <p>
1.207 leot 1442: 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 1443: </p>
1444: </div>
1.41 asau 1445: <div class="sect2">
1.1 dsieger 1446: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1447: <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 1448: <p>
1.207 leot 1449: 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 1450: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.202 nia 1451: argument to check if any packages are stale, e.g.
1.1 dsieger 1452: </p>
1453: <pre class="screen">
1454: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1455: ...
1456: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1457: </pre>
1458: </div>
1.41 asau 1459: <div class="sect2">
1.1 dsieger 1460: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1461: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.10 hubertf 1462: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1463: administrative functions on the package system.</p>
1464: </div>
1465: </div>
1.41 asau 1466: <div class="sect1">
1.1 dsieger 1467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1468: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1 dsieger 1469: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1470: directory now contains a set of packages, organized into
1471: categories. You can browse the online index of packages, or run
1.10 hubertf 1472: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1473: directory to build local <code class="filename">README.html</code> files for
1.207 leot 1474: 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 1475: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1476: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1477: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1478: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1479: different <code class="varname">LOCALBASE</code> definitions on the same
1480: system (inside a chroot is an exception). </p>
1481: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1482: 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 1483: instructions how to create your own packages.</p>
1.41 asau 1484: <div class="sect2">
1.1 dsieger 1485: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1486: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1 dsieger 1487: <p>To build packages from source, you need a working C
1488: compiler. On NetBSD, you need to install the
1.23 wiz 1489: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1490: sets. If you want to build X11-related packages, the
1.23 wiz 1491: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1492: sets are required, too.</p>
1493: </div>
1.41 asau 1494: <div class="sect2">
1.1 dsieger 1495: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1496: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1 dsieger 1497: <p>The first step for building a package is downloading the
1498: distfiles (i.e. the unmodified source). If they have not yet been
1499: downloaded, pkgsrc will fetch them automatically.</p>
1500: <p>If you have all files that you need in the
1501: <code class="filename">distfiles</code> directory,
1502: you don't need to connect. If the distfiles are on CD-ROM, you can
1503: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1504: </p>
1505: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1506: <p>
1.10 hubertf 1507: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1508: <p>By default a list of distribution sites will be randomly
1509: intermixed to prevent huge load on servers which holding popular
1510: packages (for example, SourceForge.net mirrors). Thus, every
1511: time when you need to fetch yet another distfile all the mirrors
1512: will be tried in new (random) order. You can turn this feature
1513: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1514: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1515: <p>You can overwrite some of the major distribution sites to
1516: fit to sites that are close to your own. By setting one or two
1517: variables you can modify the order in which the master sites are
1518: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1519: delimited list of domain suffixes.
1520: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1521: contains a whitespace delimited list of regular expressions. It
1522: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1523: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1524: some examples. This may save some of your bandwidth and
1525: time.</p>
1526: <p>You can change these settings either in your shell's environment, or,
1527: if you want to keep the settings, by editing the
1.10 hubertf 1528: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1529: and adding the definitions there.</p>
1530: <p>
1531: If a package depends on many other packages (such as
1.207 leot 1532: <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 1533: alternate between periods of
1534: downloading source, and compiling. To ensure you have all the source
1535: downloaded initially you can run the command:
1536: </p>
1537: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1538: <p>
1539: which will output and run a set of shell commands to fetch the
1540: necessary files into the <code class="filename">distfiles</code> directory. You can
1541: also choose to download the files manually.
1542: </p>
1543: </div>
1.41 asau 1544: <div class="sect2">
1.1 dsieger 1545: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1546: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1 dsieger 1547: <p>
1548: Once the software has downloaded, any patches will be applied, then it
1549: will be compiled for you. This may take some time depending on your
1550: computer, and how many other packages the software depends on and their
1551: compile time.
1552: </p>
1.41 asau 1553: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1554: <h3 class="title">Note</h3>
1555: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1556: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1557: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1558: </div>
1559: <p>For example, type</p>
1560: <pre class="screen">
1561: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1562: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1563: </pre>
1564: <p>at the shell prompt to build the various components of the
1565: package.</p>
1566: <p>The next stage is to actually install the newly compiled
1567: program onto your system. Do this by entering:
1568:
1569: </p>
1570: <pre class="screen">
1571: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1572: </pre>
1573: <p>
1574:
1575: while you are still in the directory for whatever package you
1576: are installing.</p>
1577: <p>Installing the package on your system may require you to
1578: be root. However, pkgsrc has a
1579: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1580: to only become root for the actual installation step.</p>
1581: <p>That's it, the software should now be installed and setup for use.
1582: You can now enter:
1583:
1584: </p>
1585: <pre class="screen">
1586: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1587: </pre>
1588: <p>
1589:
1590: to remove the compiled files in the work directory, as you shouldn't need
1591: them any more. If other packages were also added to your system
1592: (dependencies) to allow your program to compile, you can tidy these up
1593: also with the command:</p>
1594: <pre class="screen">
1595: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1596: </pre>
1597: <p>Taking the figlet utility as an example, we can install it on our
1.207 leot 1598: 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 1599: <p>The program is installed under the default root of the
1600: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1601: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1602: variable in your environment, and it will use that value as the
1603: root of your packages tree. So, to use
1604: <code class="filename">/usr/local</code>, set
1605: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1606: Please note that you should use a directory which is dedicated to
1607: packages and not shared with other programs (i.e., do not try and
1608: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1609: to add any of your own files or directories (such as
1610: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1611: <code class="filename">pkgsrc/</code>) below the
1612: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1613: conflicts between programs and other files installed by the
1614: package system and whatever else may have been installed
1615: there.</p>
1.10 hubertf 1616: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1617: alter some configuration options at build time. Have a look at
1618: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1619: of what will be set there by default. Environment variables such
1620: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1621: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1622: set them each time you want to use pkgsrc.</p>
1.23 wiz 1623: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1624: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1625: or being installed. This may be for debugging purposes, or out of
1626: simple curiosity. A number of utility values have been added to
1627: help with this.</p>
1.23 wiz 1628: <div class="orderedlist"><ol class="orderedlist" type="1">
1629: <li class="listitem">
1.207 leot 1630: <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 1631: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1632: information will be displayed. For example,</p>
1633: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1634: <p>will show all the commands that are invoked, up to and
1.23 wiz 1635: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1636: </li>
1.23 wiz 1637: <li class="listitem">
1.207 leot 1638: <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 1639: definition, then the <code class="varname">VARNAME</code> definition
1640: should be used, in conjunction with the show-var
1.207 leot 1641: 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 1642: variable <code class="varname">LOCALBASE</code>:</p>
1643: <pre class="screen">
1644: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1645: /usr/pkg
1646: <code class="prompt">%</code>
1647: </pre>
1648: </li>
1649: </ol></div>
1650: <p>If you want to install a binary package that you've either
1651: created yourself (see next section), that you put into
1652: pkgsrc/packages manually or that is located on a remote FTP
1653: server, you can use the "bin-install" target. This target will
1.207 leot 1654: 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 1655: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1656: sites searched is kept in the variable
1657: <code class="varname">BINPKG_SITES</code>, which defaults to
1.207 leot 1658: 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 1659: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1660: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1661: details.</p>
1662: <p>A final word of warning: If you set up a system that has a
1663: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1664: set that before any packages are installed, as you cannot use
1665: several directories for the same purpose. Doing so will result in
1666: pkgsrc not being able to properly detect your installed packages,
1667: and fail miserably. Note also that precompiled binary packages are
1668: usually built with the default <code class="varname">LOCALBASE</code> of
1669: <code class="filename">/usr/pkg</code>, and that you should
1670: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1671: <code class="varname">LOCALBASE</code>.</p>
1672: </div>
1673: </div>
1674: </div>
1.41 asau 1675: <div class="chapter">
1.1 dsieger 1676: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1677: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1 dsieger 1678: <div class="toc">
1679: <p><b>Table of Contents</b></p>
1.100 leot 1680: <dl class="toc">
1.154 rillig 1681: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1682: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1683: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
1684: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1685: <dd><dl>
1686: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
1687: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1688: <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 1689: </dl></dd>
1.154 rillig 1690: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
1691: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 1692: </dl>
1693: </div>
1.4 rillig 1694: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1695: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1696: that file depends on the installation. On NetBSD, when you use
1.207 leot 1697: <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 1698: <code class="filename">/etc/</code>. In all other cases the default location is
1699: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1700: bootstrap program to install the binary packages.</p>
1701: <p>The format of the configuration file is that of the usual
1702: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1703: is done by setting variables in this file. Note that you can define all
1704: kinds of variables, and no special error checking (for example for
1.112 rillig 1705: spelling mistakes) takes place.</p>
1.41 asau 1706: <div class="sect1">
1.1 dsieger 1707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1708: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112 rillig 1709: <p>The following variables apply to all
1.1 dsieger 1710: pkgsrc packages. A complete list of the variables that can be
1711: configured by the user is available in
1712: <code class="filename">mk/defaults/mk.conf</code>, together with some
1713: comments that describe each variable's intent.</p>
1.41 asau 1714: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1715: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1716: packages will be installed. The default is
1717: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1718: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1719: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1720: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1721: installed. The default is
1722: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1723: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1724: X11 is installed on the system. The default is
1.84 wiz 1725: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1726: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1727: downloaded copies of the original source distributions used
1728: for building pkgsrc packages. The default is
1729: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1730: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1731: database about installed packages is stored. The default is
1.118 sevan 1732: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1733: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1734: If set, override the packages'
1735: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1736: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1737: Backup location(s) for distribution files and patch files
1738: if not found locally or in
1739: <code class="filename">${MASTER_SITES}</code> or
1740: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1741: The defaults is
1742: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1743: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1744: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1745: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1746: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1747: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1748: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1749: List of acceptable licenses. License names are case-sensitive.
1750: Whenever you try to build a package whose license is not in this
1751: list, you will get an error message. If the license condition is
1752: simple enough, the error message will include specific
1753: instructions on how to change this variable.</p></li>
1.1 dsieger 1754: </ul></div>
1755: </div>
1.41 asau 1756: <div class="sect1">
1.1 dsieger 1757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1758: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1759: <p>
1.1 dsieger 1760: </p>
1.41 asau 1761: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1762: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1763: directory for the binary packages. The default is
1764: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1765: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1766: The top level directory where, if defined, the separate
1767: working directories will get created, and symbolically
1768: linked to from <code class="filename">${WRKDIR}</code> (see below).
1769: This is useful for building packages on several
1770: architectures, then <code class="filename">${PKGSRCDIR}</code>
1771: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1772: is local to every architecture. (It should be noted that
1773: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1774: — it is an internal definition which refers to the
1.1 dsieger 1775: root of the pkgsrc tree. It is possible to have many
1776: pkgsrc tree instances.)</p></li>
1.23 wiz 1777: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1778: Directory for local patches that aren't part of pkgsrc.
1.184 rillig 1779: 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 1780: information.</p></li>
1.23 wiz 1781: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1782: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1783: BSD-style Makefile. If this is not set,
1784: <code class="varname">MAKECONF</code> is set to
1785: <code class="filename">/dev/null</code> to avoid picking up
1786: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1787: </ul></div>
1788: </div>
1.41 asau 1789: <div class="sect1">
1.1 dsieger 1790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1791: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.198 leot 1792: <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 1793: By default, binary packages of built packages are
1.150 leot 1794: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143 maya 1795: this variable to "no" prevents this.</p></li></ul></div>
1.107 jnemeth 1796: <p>Packages have to support installation into a
1.4 rillig 1797: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1798: to be built, before the actual filesystem is touched. DESTDIR
1799: support exists in two variations:</p>
1.41 asau 1800: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1801: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1802: installation and packaging is still run as root.</p></li>
1803: <li class="listitem"><p>Full DESTDIR support can run the complete
1804: build, installation and packaging as normal user. Root
1805: privileges are only needed to add packages.</p></li>
1806: </ul></div>
1.4 rillig 1807: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1808: clean</code></strong> needs to be run as root.</p>
1.17 imil 1809: <p>Considering the <code class="filename">foo/bar</code> package,
1810: DESTDIR full support can be tested using the following commands
1811:
1812: </p>
1813: <pre class="programlisting">
1814: <code class="prompt">$</code> id
1815: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1816: <code class="prompt">$</code> mkdir $HOME/packages
1817: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1818: </pre>
1819: <p>
1820:
1821: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1822: should be needed
1823:
1824: </p>
1825: <pre class="programlisting">
1.66 asau 1826: <code class="prompt">$</code> make stage-install
1.17 imil 1827: </pre>
1828: <p>
1829:
1830: Create a package without root privileges
1831:
1832: </p>
1833: <pre class="programlisting">
1.66 asau 1834: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1835: </pre>
1836: <p>
1837:
1838: For the following command, you must be able to gain root
1.207 leot 1839: 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 1840:
1841: </p>
1842: <pre class="programlisting">
1.66 asau 1843: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1844: </pre>
1845: <p>
1846:
1847: Then, as a simple user
1848:
1849: </p>
1850: <pre class="programlisting">
1851: <code class="prompt">$</code> make clean
1852: </pre>
1853: <p>
1854:
1855: </p>
1.4 rillig 1856: </div>
1.41 asau 1857: <div class="sect1">
1.4 rillig 1858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1859: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1860: <div class="sect2">
1.1 dsieger 1861: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1862: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1863: <p>By default, pkgsrc will use GCC to build packages. This may be
1864: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1865: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1866: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1867: <dd>
1868: <p>This is a list of values specifying the chain of
1869: compilers to invoke when building packages. Valid values
1870: are:</p>
1.41 asau 1871: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1872: <li class="listitem"><p><code class="varname">ccc</code>:
1873: Compaq C Compilers (Tru64)</p></li>
1874: <li class="listitem"><p><code class="varname">ccache</code>:
1875: compiler cache (chainable)</p></li>
1876: <li class="listitem"><p><code class="varname">clang</code>:
1877: Clang C and Objective-C compiler</p></li>
1.23 wiz 1878: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1879: distributed C/C++ (chainable)</p></li>
1.66 asau 1880: <li class="listitem"><p><code class="varname">f2c</code>:
1881: Fortran 77 to C compiler (chainable)</p></li>
1882: <li class="listitem"><p><code class="varname">icc</code>:
1883: Intel C++ Compiler (Linux)</p></li>
1884: <li class="listitem"><p><code class="varname">ido</code>:
1885: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1886: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1887: GNU C/C++ Compiler</p></li>
1.66 asau 1888: <li class="listitem"><p><code class="varname">hp</code>:
1889: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1890: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1891: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1892: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1893: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1894: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1895: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1896: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1897: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1898: </ul></div>
1899: <p>The default is
1.23 wiz 1900: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1901: <code class="varname">ccache</code> and/or
1902: <code class="varname">distcc</code> with an appropriate
1903: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1904: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1905: variable should always be terminated with a value for
1906: a real compiler. Note that only one real compiler
1.23 wiz 1907: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1908: is not allowed).</p>
1909: </dd>
1910: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1911: <dd><p>This specifies the minimum version of GCC to use
1912: when building packages. If the system GCC doesn't
1913: satisfy this requirement, then pkgsrc will build and
1914: install one of the GCC packages to use instead.</p></dd>
1.153 leot 1915: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114 maya 1916: <dd><p>Specifies which version of python to use when several
1917: options are available.</p></dd>
1918: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.176 gutterid 1919: <dd><p>Specifies the Fortran compiler to use.
1920: The default is <code class="varname">gfortran</code>.</p></dd>
1.114 maya 1921: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1922: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1923: <code class="varname">gfortran</code> is used, this option specifies which
1924: version to use.</p></dd>
1.1 dsieger 1925: </dl></div>
1926: </div>
1.41 asau 1927: <div class="sect2">
1.1 dsieger 1928: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1929: <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 1930: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1931: please make sure to use the <code class="literal">+=</code> operator
1932: instead of the <code class="literal">=</code> operator:</p>
1933: <pre class="programlisting">
1934: CFLAGS+= -your -flags
1935: </pre>
1936: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1937: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1938: need to add their own flags. You may want to take a look
1.207 leot 1939: 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 1940: package if you're interested in optimization specifically
1941: for the current CPU. </p>
1.1 dsieger 1942: </div>
1.41 asau 1943: <div class="sect2">
1.1 dsieger 1944: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1945: <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 1946: <p>If you want to pass flags to the linker, both in the configure
1947: step and the build step, you can do this in two ways. Either set
1948: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1949: between the two is that <code class="varname">LIBS</code> will be appended to
1950: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1951: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1952: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1953: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1954: <code class="varname">CFLAGS</code>, if you do not wish to override these
1955: settings, use the <code class="literal">+=</code> operator:</p>
1956: <pre class="programlisting">
1957: LDFLAGS+= -your -linkerflags
1958: </pre>
1959: </div>
1960: </div>
1.41 asau 1961: <div class="sect1">
1.1 dsieger 1962: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1963: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1964: <p>
1.1 dsieger 1965: </p>
1.41 asau 1966: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1967: <li class="listitem">
1.1 dsieger 1968: <p><code class="varname">PKG_DEVELOPER</code>:
1.232 gutterid 1969: Run some sanity checks that package developers want:
1970: </p>
1.41 asau 1971: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1972: <li class="listitem"><p>make sure patches apply with zero
1.232 gutterid 1973: fuzz</p></li>
1.23 wiz 1974: <li class="listitem"><p>run check-shlibs to see that all
1.232 gutterid 1975: binaries will find their shared libs.</p></li>
1.1 dsieger 1976: </ul></div>
1977: </li>
1.232 gutterid 1978: <li class="listitem"><p><code class="varname">CHECK_FILES_STRICT</code>:
1979: Also check <code class="varname">VARBASE</code> and <code class="varname">PKG_SYSCONFDIR
1980: </code> values in PLIST entries.
1981: </p></li>
1.23 wiz 1982: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.232 gutterid 1983: of debugging output which is displayed whilst making and
1984: installing the package. The default value for this is 0,
1985: which will not display the commands as they are executed
1986: (normal, default, quiet operation); the value 1 will display
1987: all shell commands before their invocation, and the value 2
1988: will display both the shell commands before their invocation,
1989: as well as their actual execution progress with <span class="command"><strong>set
1990: -x</strong></span>.</p></li>
1.1 dsieger 1991: </ul></div>
1992: <p>
1993: </p>
1994: </div>
1.41 asau 1995: <div class="sect1">
1.1 dsieger 1996: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1997: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1998: <p>Some packages have build time options, usually to select
1999: between different dependencies, enable optional support for big
2000: dependencies or enable experimental features.</p>
2001: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2002: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2003: show-options</strong></span>, for example:</p>
2004: <pre class="programlisting">
2005: The following options are supported by this package:
2006: ssl Enable SSL support.
2007: Exactly one of the following gecko options is required:
2008: firefox Use firefox as gecko rendering engine.
2009: mozilla Use mozilla as gecko rendering engine.
2010: At most one of the following database options may be selected:
2011: mysql Enable support for MySQL database.
2012: pgsql Enable support for PostgreSQL database.
2013:
2014: These options are enabled by default: firefox
2015: These options are currently enabled: mozilla ssl
2016: </pre>
2017: <p>The following variables can be defined in
1.10 hubertf 2018: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2019: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2020: which can be used to select or disable options for all packages
2021: that support them, and
2022: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2023: which can be used to select or disable options specifically for
2024: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 2025: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2026: are disabled. A few examples:</p>
2027: <pre class="screen">
1.10 hubertf 2028: <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 2029: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2030: PKG_OPTIONS.kdebase= debug -sasl
2031: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2032: <p>It is important to note that options that were specifically
1.18 snj 2033: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2034: you do not wish to include the option. If you are unsure you can view
2035: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2036: <p>The following settings are consulted in the order given, and
2037: the last setting that selects or disables an option is
2038: used:</p>
1.23 wiz 2039: <div class="orderedlist"><ol class="orderedlist" type="1">
2040: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2041: maintainer</p></li>
1.23 wiz 2042: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2043: variables (see below)</p></li>
1.23 wiz 2044: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2045: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2046: </ol></div>
2047: <p>For groups of mutually exclusive options, the last option
2048: selected is used, all others are automatically disabled. If an
2049: option of the group is explicitly disabled, the previously
2050: selected option, if any, is used. It is an error if no option
2051: from a required group of options is selected, and building the
2052: package will fail.</p>
2053: <p>Before the options framework was introduced, build options
2054: were selected by setting a variable (often named
2055: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2056: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2057: transition to the options framework for the user, these legacy
2058: variables are converted to the appropriate options setting
2059: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2060: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2061: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2062: directly. Support for the legacy variables will be removed
2063: eventually.</p>
2064: </div>
2065: </div>
1.41 asau 2066: <div class="chapter">
1.1 dsieger 2067: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2068: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1 dsieger 2069: <div class="toc">
2070: <p><b>Table of Contents</b></p>
1.100 leot 2071: <dl class="toc">
1.154 rillig 2072: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2073: <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 2074: </dl>
2075: </div>
1.41 asau 2076: <div class="sect1">
1.1 dsieger 2077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2078: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1 dsieger 2079: <p>Once you have built and installed a package, you can create
2080: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.207 leot 2081: 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 2082: the same package on a group of hosts and wasting CPU time. It also
2083: provides a simple means for others to install your package, should
2084: you distribute it.</p>
2085: <p>To create a binary package, change into the appropriate
1.10 hubertf 2086: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2087: package</strong></span>:</p>
2088: <pre class="screen">
1.112 rillig 2089: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2090: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2091: </pre>
1.1 dsieger 2092: <p>This will build and install your package (if not already done),
2093: and then build a binary package from what was installed. You can
1.10 hubertf 2094: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2095: it. Binary packages are created by default in
2096: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.207 leot 2097: gzipped tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a
2098: 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 2099: <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 2100: such a binary package.</p>
2101: </div>
1.41 asau 2102: <div class="sect1">
1.1 dsieger 2103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2104: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.184 rillig 2105: <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 2106: </div>
2107: </div>
1.41 asau 2108: <div class="chapter">
1.6 rillig 2109: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2110: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 2111: builds)</h2></div></div></div>
2112: <div class="toc">
2113: <p><b>Table of Contents</b></p>
1.100 leot 2114: <dl class="toc">
1.154 rillig 2115: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 2116: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 2117: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2118: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 2119: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2120: <dd><dl>
1.179 rillig 2121: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2122: <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 2123: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
2124: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
2125: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
2126: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
2127: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
2128: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
2129: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
2130: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 2131: </dl></dd>
2132: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2133: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2134: </dl>
2135: </div>
1.175 gutterid 2136: <p>For a number of reasons, you may want to build binary packages
2137: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.71 wiz 2138: For instance, when you have multiple machines that should run the same software,
2139: it is wasted time if they all build their packages themselves from source.
2140: Or you may want to build a list of packages you want and check them before
1.175 gutterid 2141: deploying onto production systems.
1.71 wiz 2142: There is a way of getting a set of binary packages:
1.175 gutterid 2143: the bulk build system, or pbulk ("p" stands for "parallel").
1.112 rillig 2144: This chapter describes how to set it up.</p>
1.41 asau 2145: <div class="sect1">
1.6 rillig 2146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2147: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71 wiz 2148: <p>First of all, you have to decide whether you build all packages
2149: or a limited set of them. Full bulk builds usually consume a lot more resources,
2150: both space and time, than builds for some practical sets of packages.
1.175 gutterid 2151: A number of particularly heavy packages exist that are not actually
2152: interesting to a wide audience. (The approximate resource consumption for a
2153: 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>.)
2154: For limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2155: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2156: </p>
2157: <p>During bulk builds various packages are installed and deinstalled
2158: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2159: so make sure that you don't need any package during the builds.
1.112 rillig 2160: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2161: or something even more restrictive, depending on what the operating system provides,
2162: or dedicate the whole physical machine.
2163: As a useful side effect this makes sure that bulk builds cannot
2164: break anything in your system. There have been numerous cases where
1.6 rillig 2165: certain packages tried to install files outside the
2166: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2167: <code class="filename">/etc</code>.
2168: </p>
1.6 rillig 2169: </div>
1.41 asau 2170: <div class="sect1">
1.6 rillig 2171: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 rillig 2172: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
2173: <p>Running a bulk build works roughly as follows:</p>
1.41 asau 2174: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2175: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2176: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2177: </ul></div>
1.41 asau 2178: <div class="sect2">
1.15 rillig 2179: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2180: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112 rillig 2181: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2182: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2183: Configure network access to fetch distribution files.
1.112 rillig 2184: Create a user with name "pbulk".</p>
1.68 asau 2185: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2186: <pre class="screen">
1.151 sevan 2187: <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>
2188: <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 2189: <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 2190: </pre>
2191: <p>Or any other way that fits (e.g., curl, wget).</p>
2192: <p>Deploy and configure pbulk tools, e.g.:</p>
2193: <pre class="screen">
1.118 sevan 2194: <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 2195: <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>
2196: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2197: </pre>
2198: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2199: <h3 class="title">Note</h3>
2200: <p><code class="filename">mk.conf.frag</code> is a fragment of
2201: <code class="filename">mk.conf</code> that contains settings you want to
2202: apply to packages you build. For instance,</p>
2203: <pre class="programlisting">
1.112 rillig 2204: PKG_DEVELOPER= yes # perform more checks
2205: X11_TYPE= modular # use pkgsrc X11
2206: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2207: # when building all packages)
1.68 asau 2208: </pre>
2209: </div>
2210: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2211: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2212: <pre class="programlisting">
2213: www/firefox
2214: mail/thunderbird
2215: misc/libreoffice4
2216: </pre>
1.69 asau 2217: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2218: and make final amendments, if wanted.</p>
1.68 asau 2219: <p>Start it:</p>
2220: <pre class="screen">
2221: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2222: </pre>
2223: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2224: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2225: </p>
2226: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2227: <h3 class="title">Note</h3>
2228: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2229: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2230: The script is kept small enough for better understanding.</p>
2231: </div>
2232: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2233: <h3 class="title">Note</h3>
2234: <p>The <code class="filename">pbulk.sh</code> script supports running
1.205 wiz 2235: unprivileged bulk build and helps configuring distributed bulk builds.
2236: Distributed bulk builds support either building in worker chroots
2237: (each node is a path to a different chroot)
2238: that replicate the target system, including the pbulk prefix,
2239: or remote machines (each node is
2240: an IP address that must be accessible over SSH without a password).</p>
1.68 asau 2241: </div>
1.6 rillig 2242: </div>
2243: </div>
1.41 asau 2244: <div class="sect1">
1.6 rillig 2245: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2246: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71 wiz 2247: <p>A complete bulk build requires lots of disk space. Some of the
2248: disk space can be read-only, some other must be writable. Some can be on
2249: remote filesystems (such as NFS) and some should be local. Some can be
2250: temporary filesystems, others must survive a sudden reboot.</p>
2251: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.205 wiz 2252: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2253: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.71 wiz 2254: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2255: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2256: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2257: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2258: </ul></div>
2259: </div>
2260: <div class="sect1">
2261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.178 rillig 2262: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2263: <p>To ensure that pkgsrc packages work in different configurations, it
2264: makes sense to run non-default bulk builds from time to time. This
2265: section lists some ideas for bulk builds that intentionally let packages
2266: fail if they don't follow the pkgsrc style.</p>
2267: <div class="sect2">
2268: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2269: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.178 rillig 2270: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2271: <pre class="programlisting">
2272: GNU_CONFIGURE_STRICT= yes
2273: </pre>
2274: <p>When a package fails this additional check, the most common cause
2275: is that the configure option was valid for an older version of the
2276: package but does not apply anymore. In that case, just remove it.</p>
2277: </div>
2278: <div class="sect2">
2279: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2280: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.178 rillig 2281: <p>The job of a compiler is not restricted to producing executable
1.179 rillig 2282: code, most compilers also detect typical programming mistakes. The pkgsrc
2283: compiler wrappers make it easy to force compiler options when the package
2284: is built. This can be used to find typical bugs across all packages that
2285: are in pkgsrc. By reporting these bugs upstream, the packages will be
2286: more reliable with the next updates.</p>
2287: <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 2288: <pre class="programlisting">
2289: CFLAGS+= -Werror=char-subscripts
1.179 rillig 2290: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 2291: </pre>
1.179 rillig 2292: <p>When a package fails to build using these stricter compiler
2293: options, document the circumstances in which the compiler produced the
2294: error message. This includes:</p>
1.178 rillig 2295: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2296: <li class="listitem"><p>The platform
2297: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2298: <li class="listitem"><p>The source file</p></li>
2299: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2300: part of the diagnostic.</p></li>
1.179 rillig 2301: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.178 rillig 2302: </ul></div>
2303: <p>If a package produces these error messages, but the package is
1.179 rillig 2304: 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
2305: in the next builds:</p>
1.178 rillig 2306: <pre class="programlisting">
1.179 rillig 2307: .if ${PKGPATH} == category/package
1.178 rillig 2308: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2309: # error message
2310: # code
1.179 rillig 2311: # Reason why the code does not need to be fixed.
1.178 rillig 2312: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 2313: .endif
1.178 rillig 2314: </pre>
2315: <p>If the error messages from the compiler are valid and the code
1.179 rillig 2316: needs to be fixed, prepare a local patch (see
2317: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2318: authors of the package, providing them with the information you collected
2319: above.</p>
2320: <p>Patches that are not essential for the package to work should only
2321: be reported upstream but not committed to pkgsrc, to make future updates
2322: easier.</p>
1.178 rillig 2323: </div>
2324: <div class="sect2">
2325: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2326: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
2327: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2328: these apply to all phases of the package build process. Especially in the
2329: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2330: decisions. The GNU configure scripts feed many small test programs to the
2331: C compiler to see whether certain headers are available, functions are
2332: defined in a library and programs can be run. In many cases these
2333: programs would not survive a strict compiler run with <code class="literal">-Wall
2334: -Wextra -Werror</code>.</p>
2335: <p>The pkgsrc infrastructure is flexible enough to support compiler
2336: options being added between the <code class="literal">configure</code> and
2337: <code class="literal">build</code> phases. It's a little more complicated than the
2338: other examples in this section but still easy enough.</p>
2339: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2340: desired compiler options. The compiler wrapper's original task is to hide
2341: unwanted directories of include files and to normalize compiler options.
2342: It does this by wrapping the compiler command and rewriting the command
2343: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2344: package directory and examine the
2345: <code class="filename">work/.cwrappers/config</code> directory. It contains
2346: individual configurations for the C compiler and the related tools. The
2347: plan is to find a hook between the configure and build phases, and to
2348: modify these configuration files at that point.</p>
2349: <p>To find this hook, have a look at
2350: <code class="filename">mk/build/build.mk</code>, which contains among others the
2351: <code class="literal">pre-build-checks-hook</code>. The word
2352: <code class="literal">checks</code> doesn't quite fit, but the
2353: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2354: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2355: <pre class="programlisting">
2356: # Just a few example options.
2357: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2358:
2359: .if ${BUILD_ONLY_CFLAGS:U:M*}
2360: pre-build-checks-hook: add-build-only-cflags
2361:
2362: add-build-only-cflags: .PHONY
2363: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2364: ${TEST} ! -f ${.TARGET} || exit 0; \
2365: for flag in ${BUILD_ONLY_CFLAGS}; do \
2366: ${ECHO} "append=$$flag" >> cc; \
2367: done; \
2368: > ${.TARGET}
2369: .endif
2370: </pre>
2371: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2372: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2373: not with spaces.)</p>
2374: <p>The condition in the <code class="literal">.if</code> statement contains the
2375: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2376: should be undefined, possibly because it is only defined for a subset of
2377: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2378: at least one compiler option, to prevent a syntax error in the shell
2379: parser.</p>
2380: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2381: that the additional compiler options are only appended once, even if
2382: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2383: creates a marker file.</p>
2384: <p>To verify that this setup works, run <span class="command"><strong>bmake
2385: configure</strong></span> in a package directory. Up to now, everything works
2386: as usual. Examine the directory
2387: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2388: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2389: the file <code class="filename">cc</code>. Examine the tail of the
2390: <code class="filename">work/.work.log</code> file to see that the normal compiler
2391: options are used.</p>
2392: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2393: options to the file <code class="filename">cc</code> and will create the marker
2394: file in the same directory. After that, the build starts as usual, but
2395: with the added compiler options. Examine the tail of the file
2396: <code class="filename">work/.work.log</code> to see that the lines starting with
2397: <code class="literal">[*]</code> don't contain the compiler options, but the
2398: corresponding lines starting with <code class="literal"><.></code> do end
2399: with these options.</p>
2400: <p>Building packages using this setup variant and fixing the resulting
2401: 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>
2402: </div>
2403: <div class="sect2">
2404: <div class="titlepage"><div><div><h3 class="title">
2405: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.178 rillig 2406: <p>Some directories like <code class="varname">PREFIX</code>,
2407: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2408: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2409: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2410: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2411: <pre class="programlisting">
2412: PREFIX= /a-random-uuid
2413: PKG_SYSCONFDIR= /a-random-uuid
2414: VARBASE= /a-random-uuid
2415: PKGMANDIR= a-random-uuid
2416: PKG_INFODIR= a-random-uuid
2417: </pre>
2418: </div>
2419: <div class="sect2">
2420: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2421: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.178 rillig 2422: <p>When building a package, warnings are typically ignored since they
2423: just flow by and do not cause the build to fail immediately. To find
2424: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2425: <pre class="programlisting">
2426: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2427: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2428: </pre>
2429: <p>(There are many more classes of warnings in pkgsrc, and most of
2430: them can be redefined with a simple definition like above.</p>
1.179 rillig 2431: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.178 rillig 2432: the package Makefile, research whether the package actually needs Perl.
2433: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2434: Makefile, and if it doesn't, add
2435: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2436: </div>
2437: <div class="sect2">
2438: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2439: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.178 rillig 2440: <p>Using pkglint as part of the regular build process is mostly a
2441: waste of time. If you want to fix some of the warnings, just run pkglint
2442: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2443: 10), which is much faster than a complete bulk build.</p>
2444: </div>
2445: <div class="sect2">
2446: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2447: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.178 rillig 2448: <p>To ensure that the binary packages don't contain references to the
2449: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2450: that variable includes the item <code class="literal">extra</code>, it is
2451: possible to define additional patterns that must not appear in any
2452: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2453: <pre class="programlisting">
2454: CHECK_WRKREF= extra
2455: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2456: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2457: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2458: </pre>
2459: <p>The above patterns will probably generate many false positives,
2460: therefore the results need to be taken with a grain of salt.</p>
2461: </div>
2462: <div class="sect2">
2463: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2464: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.178 rillig 2465: <p>To run the test suites that come with each package, add this line
2466: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2467: <pre class="programlisting">
2468: PKGSRC_RUN_TEST= yes
2469: </pre>
2470: <p>Be prepared that even the most basic packages fail this test. When
2471: doing a bulk build with this, it will often abort in the early phase
2472: where the packages are scanned for their dependencies since there are
2473: cyclic dependencies. There is still a lot to do in this area.</p>
2474: </div>
2475: <div class="sect2">
2476: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2477: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.178 rillig 2478: <p>To catch typos in the shell snippets from the Makefile fragments,
2479: add the <code class="literal">-u</code> flag to most of the commands by adding this
2480: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2481: <pre class="programlisting">
2482: RUN= @set -eu;
2483: </pre>
1.181 rillig 2484: <p>After that, ensure that none of the bulk build log files (even
2485: those for successfully built packages) contains the string
2486: <code class="literal">parameter not set</code> or whatever error message the
2487: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.178 rillig 2488: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2489: definition.</p>
2490: </div>
2491: <div class="sect2">
2492: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2493: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.178 rillig 2494: <p>The build logs of a package are often quite long. This allows error
2495: messages or other interesting details to hide between the noise. To make
2496: the actual error message stand out more, add these lines to
2497: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2498: <pre class="programlisting">
2499: GNU_CONFIGURE_QUIET= yes
2500: MAKE_FLAGS+= -s
2501: </pre>
2502: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2503: Make. On exotic platforms with their own make, it may be a little
2504: different.</p>
2505: </div>
2506: </div>
2507: <div class="sect1">
2508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2509: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2510: <p>After your pkgsrc bulk-build has completed, you may wish to
2511: create a CD-ROM set of the resulting binary packages to assist
2512: in installing packages on other machines. The
1.207 leot 2513: <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 2514: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2515: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2516: way that keeps all the dependencies for a given package on the same
2517: CD as that package.</p>
1.41 asau 2518: <div class="sect2">
1.1 dsieger 2519: <div class="titlepage"><div><div><h3 class="title">
1.178 rillig 2520: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2521: <p>Complete documentation for cdpack is found in the cdpack(1)
2522: man page. The following short example assumes that the binary
2523: packages are left in
2524: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2525: sufficient disk space exists in <code class="filename">/u2</code> to
2526: hold the ISO 9660 images.</p>
2527: <pre class="screen">
2528: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2529: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2530: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2531: </pre>
2532: <p>If you wish to include a common set of files
2533: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2534: etc.) on each CD in the collection, then you need to create a
1.175 gutterid 2535: directory which contains these files, e.g.:</p>
1.1 dsieger 2536: <pre class="screen">
2537: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2538: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2539: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2540: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2541: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2542: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2543: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2544: </pre>
2545: <p>Now create the images:</p>
2546: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2547: <p>Each image will contain <code class="filename">README</code>,
2548: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2549: in their root directories.</p>
2550: </div>
2551: </div>
2552: </div>
1.41 asau 2553: <div class="chapter">
1.1 dsieger 2554: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2555: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2556: <div class="toc">
2557: <p><b>Table of Contents</b></p>
1.100 leot 2558: <dl class="toc">
1.154 rillig 2559: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2560: <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 2561: </dl>
2562: </div>
2563: <p>The files that are installed by pkgsrc are organized in a way that
2564: is similar to what you find in the <code class="filename">/usr</code> directory
2565: of the base system. But some details are different. This is because
2566: pkgsrc initially came from FreeBSD and had adopted its file system
2567: hierarchy. Later it was largely influenced by NetBSD. But no matter
2568: which operating system you are using pkgsrc with, you can expect the
2569: same layout for pkgsrc.</p>
2570: <p>There are mainly four root directories for pkgsrc, which are all
2571: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2572: When pkgsrc has been installed as root, the default locations
2573: are:</p>
2574: <pre class="programlisting">
2575: LOCALBASE= /usr/pkg
2576: PKG_SYSCONFBASE= /usr/pkg/etc
2577: VARBASE= /var
1.119 sevan 2578: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2579: </pre>
2580: <p>In unprivileged mode (when pkgsrc has been installed as any other
2581: user), the default locations are:</p>
2582: <pre class="programlisting">
2583: LOCALBASE= ${HOME}/pkg
2584: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2585: VARBASE= ${HOME}/pkg/var
1.119 sevan 2586: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2587: </pre>
2588: <p>What these four directories are for, and what they look like is
2589: explained below.</p>
1.41 asau 2590: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2591: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2592: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2593: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2594: the well-known subdirectories like <code class="filename">bin</code>,
2595: <code class="filename">include</code>, <code class="filename">lib</code>,
2596: <code class="filename">share</code> and
2597: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2598: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2599: <code class="filename">/var</code> in the base system. Some programs (especially
2600: games, network daemons) need write access to it during normal
2601: operation.</p></li>
1.23 wiz 2602: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2603: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2604: 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 2605: itself.</p></li>
2606: </ul></div>
1.41 asau 2607: <div class="sect1">
1.1 dsieger 2608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2609: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2610: </h2></div></div></div>
2611: <p>The following directories exist in a typical pkgsrc installation
2612: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2613: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2614: <dt><span class="term"><code class="filename">bin</code></span></dt>
2615: <dd><p>Contains executable programs that are intended to be
2616: directly used by the end user.</p></dd>
2617: <dt><span class="term"><code class="filename">emul</code></span></dt>
2618: <dd><p>Contains files for the emulation layers of various other
2619: operating systems, especially for
2620: NetBSD.</p></dd>
2621: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2622: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2623: <dd><p>Contains
2624: the configuration files.</p></dd>
2625: <dt><span class="term"><code class="filename">include</code></span></dt>
2626: <dd><p>Contains headers for the C and C++ programming
2627: languages.</p></dd>
2628: <dt><span class="term"><code class="filename">info</code></span></dt>
2629: <dd><p>Contains GNU info files of various
2630: packages.</p></dd>
2631: <dt><span class="term"><code class="filename">lib</code></span></dt>
2632: <dd><p>Contains shared and static
2633: libraries.</p></dd>
2634: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2635: <dd><p>Contains data files that don't change after
2636: installation. Other data files belong into
2637: <code class="filename">${VARBASE}</code>.</p></dd>
2638: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2639: <dd><p>Contains programs that are not intended to be used by
2640: end users, such as helper programs or network
2641: daemons.</p></dd>
2642: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2643: <dd><p>Contains programs that are intended to be executed as
2644: CGI scripts by a web server.</p></dd>
2645: <dt><span class="term"><code class="filename">man</code> (the usual value of
2646: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2647: <dd><p>Contains brief
2648: documentation in form of manual pages.</p></dd>
2649: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2650: <dd><p>Contains programs that are intended to be used only by
2651: the super-user.</p></dd>
2652: <dt><span class="term"><code class="filename">share</code></span></dt>
2653: <dd><p>Contains platform-independent data files that don't
2654: change after installation.</p></dd>
2655: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2656: <dd><p>Contains documentation files provided by the
2657: packages.</p></dd>
2658: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2659: <dd><p>Contains example files provided by the packages. Among
2660: others, the original configuration files are saved here and copied to
2661: <code class="filename">${PKG_SYSCONFDIR}</code> during
2662: installation.</p></dd>
2663: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2664: <dd><p>Contains the original files for rc.d
2665: scripts.</p></dd>
2666: <dt><span class="term"><code class="filename">var</code> (the usual location of
2667: <code class="filename">${VARBASE}</code>)</span></dt>
2668: <dd><p>Contains files
2669: that may be modified after
2670: installation.</p></dd>
2671: </dl></div>
2672: </div>
1.41 asau 2673: <div class="sect1">
1.1 dsieger 2674: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2675: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2676: </h2></div></div></div>
1.41 asau 2677: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2678: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2679: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2680: <dd><p>Contains
2681: information about the currently installed
2682: packages.</p></dd>
2683: <dt><span class="term"><code class="filename">games</code></span></dt>
2684: <dd><p>Contains highscore
2685: files.</p></dd>
2686: <dt><span class="term"><code class="filename">log</code></span></dt>
2687: <dd><p>Contains log files.</p></dd>
2688: <dt><span class="term"><code class="filename">run</code></span></dt>
2689: <dd><p>Contains informational files about daemons that are
2690: currently running.</p></dd>
2691: </dl></div>
2692: </div>
2693: </div>
1.41 asau 2694: <div class="chapter">
1.1 dsieger 2695: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2696: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2697: <div class="toc">
2698: <p><b>Table of Contents</b></p>
1.100 leot 2699: <dl class="toc">
1.154 rillig 2700: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2701: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2702: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2703: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2704: <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>
2705: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2706: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2707: <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>
2708: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2709: <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 2710: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 2711: <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 2712: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 2713: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2714: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2715: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2716: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2717: <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 2718: </dl>
2719: </div>
2720: <p>This section contains hints, tips & tricks on special things in
2721: pkgsrc that we didn't find a better place for in the previous chapters, and
2722: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2723: <div class="sect1">
1.1 dsieger 2724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2725: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2726: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2727: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2728: <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 2729: This is a general purpose list for most issues regarding
2730: pkgsrc, regardless of platform, e.g. soliciting user help
2731: for pkgsrc configuration, unexpected build failures, using
2732: particular packages, upgrading pkgsrc installations,
2733: questions regarding the pkgsrc release branches, etc. General announcements or
2734: proposals for changes that impact the pkgsrc user community,
2735: e.g. major infrastructure changes, new features, package
2736: removals, etc., may also be posted.</p></li>
1.174 leot 2737: <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 2738: A list where the results of pkgsrc bulk builds are sent and
2739: discussed.</p></li>
1.174 leot 2740: <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 2741: This list is for those who are interested in getting a
2742: commit message for every change committed to pkgsrc. It is
2743: also available in digest form, meaning one daily message
2744: containing all commit messages for changes to the package
2745: source tree in that 24 hour period.</p></li>
2746: </ul></div>
2747: <p>To subscribe, do:</p>
2748: <pre class="programlisting">
2749: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2750: </pre>
2751: <p>Archives for all these mailing lists are available from
1.174 leot 2752: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2753: </div>
1.41 asau 2754: <div class="sect1">
1.1 dsieger 2755: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2756: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2757: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2758: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2759: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2760: they might be useful, and not to duplicate the documentation that comes
2761: with each package.</p>
2762: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.207 leot 2763: <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 2764: Symlinks for use by buildlink.</p></li></ul></div>
2765: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2766: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2767: <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 2768: Calculates various kinds of checksums (including SHA3).</p></li>
1.207 leot 2769: <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 2770: Compatibility library for pkgsrc tools.</p></li>
1.207 leot 2771: <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 2772: non-BSD systems due to lack of native mtree.</p></li>
1.207 leot 2773: <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 2774: Up-to-date replacement for
2775: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2776: systems where pkg_install is not present.</p></li>
2777: </ul></div>
2778: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2779: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2780: <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 2781: Create a binary package from an
1.10 hubertf 2782: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2783: save the old package.</p></li>
1.207 leot 2784: <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 2785: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2786: from multiple locations. It currently supports the following
2787: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.207 leot 2788: <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 2789: the best compiler flags to optimise code for your current
1.23 wiz 2790: CPU and compiler. </p></li>
1.1 dsieger 2791: </ul></div>
2792: <p>Utilities for keeping track of installed packages, being up to date,
2793: etc:</p>
1.41 asau 2794: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2795: <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 2796: update tool similar to apt(1). Download, install, and upgrade
2797: binary packages easily.</p></li>
1.207 leot 2798: <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 2799: packages whose installed versions do not match the latest pkgsrc
2800: entries.</p></li>
1.207 leot 2801: <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 2802: dependency graphs of packages, to aid in choosing a strategy for
2803: updating.</p></li>
1.207 leot 2804: <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
2805: 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>
2806: <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 2807: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.207 leot 2808: <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 2809: does various checks on the complete pkgsrc system.</p></li>
1.207 leot 2810: <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 2811: packages you have installed.</p></li>
2812: </ul></div>
2813: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2814: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2815: <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 2816: making and maintaining patches for a package (includes pkgdiff,
2817: pkgvi, mkpatches, etc.).</p></li>
1.207 leot 2818: <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 2819: converting to pkgsrc.</p></li>
2820: </ul></div>
2821: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2822: utilities)</p>
1.41 asau 2823: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2824: <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 2825: packages in a chrooted area.</p></li>
1.207 leot 2826: <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 2827: kernel version for chrooted cross builds.</p></li>
2828: </ul></div>
2829: </div>
1.41 asau 2830: <div class="sect1">
1.1 dsieger 2831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2832: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2833: <p>To install packages from source as a non-root user, download
1.154 rillig 2834: 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 2835: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2836: --unprivileged</strong></span>.</p>
2837: <p>This will install the binary part of pkgsrc to
2838: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2839: into <code class="filename">~/pkg/etc</code>.</p>
2840: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2841: </div>
1.41 asau 2842: <div class="sect1">
1.1 dsieger 2843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2844: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2845: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2846: enable this feature by adding the option
2847: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2848: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2849: distfile is found, pkgsrc will try to resume it.</p>
2850: <p>You can also
1.61 wiz 2851: use a different program than the platform default program by changing the
1.16 jnemeth 2852: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2853: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2854: by using the value manual. A value of custom disables the system defaults
2855: and dependency tracking for the fetch program. In that case you have to
2856: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2857: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2858: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2859: <p>For example, if you want to use
1.16 jnemeth 2860: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2861: like:</p>
2862: <pre class="programlisting">
1.112 rillig 2863: FETCH_USING= wget
1.1 dsieger 2864: </pre>
2865: </div>
1.41 asau 2866: <div class="sect1">
1.1 dsieger 2867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2868: <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 2869: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2870: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2871: you will have to add the following line into
1.10 hubertf 2872: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2873: <pre class="programlisting">
1.4 rillig 2874: X11_TYPE=modular
1.1 dsieger 2875: </pre>
2876: </div>
1.41 asau 2877: <div class="sect1">
1.1 dsieger 2878: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2879: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2880: <p>If you are sitting behind a firewall which does not allow direct
2881: connections to Internet hosts (i.e. non-NAT), you may specify the
2882: relevant proxy hosts. This is done using an environment variable in the
2883: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2884: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2885: port 80 as the proxy port number. So the proxy environment variables
2886: are:</p>
2887: <pre class="programlisting">
2888: ftp_proxy=ftp://orpheus.amdahl.com:80/
2889: http_proxy=http://orpheus.amdahl.com:80/
2890: </pre>
2891: </div>
1.41 asau 2892: <div class="sect1">
1.1 dsieger 2893: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2894: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2895: <p>Some fetch tools are not prepared to support HTTPS by default
2896: (for example, the one in NetBSD 6.0), or the one installed by the
2897: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2898: dependency graph).</p>
2899: <p>Usually you won't notice, because distribution files are
2900: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2901: be often enough if you are following pkgsrc-current. In that case, set
2902: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2903: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2904: with HTTPS support by default. Of course, these tools need to be
2905: installed before you can use them this way.</p>
2906: </div>
2907: <div class="sect1">
2908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2909: <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 2910: <p>This depends on which utility is used to retrieve distfiles. From
2911: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2912: the first available command from the following list:</p>
1.41 asau 2913: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2914: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2915: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2916: </ul></div>
2917: <p>On a default NetBSD installation, this will be
2918: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2919: connections first, and falls back to active connections if the server
2920: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2921: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2922: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2923: <p>Having that option present will prevent
2924: <code class="filename">/usr/bin/ftp</code> from falling back to active
2925: transfers.</p>
2926: </div>
1.41 asau 2927: <div class="sect1">
1.1 dsieger 2928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2929: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2930: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2931: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2932: 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 2933: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2934: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2935: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2936: resulting list to your machine at work/school and use it there. If you
1.207 leot 2937: 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 2938: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2939: URL:</p>
2940: <p>At home:</p>
2941: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2942: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2943: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2944: <p>At work:</p>
2945: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2946: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2947: home.</p>
2948: <p>If you have a machine running NetBSD, and you want to get
2949: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2950: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2951: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2952: directly by running:</p>
2953: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2954: <p>If you even decide to ignore
2955: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2956: by running:</p>
2957: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2958: </div>
1.41 asau 2959: <div class="sect1">
1.1 dsieger 2960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2961: <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 2962: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.207 leot 2963: <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 2964: package, you get the error from make that it doesn't know how to make
2965: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2966: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2967: the NetBSD base distribution on your machine. It is recommended to do
2968: that to format man pages.</p>
1.207 leot 2969: <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 2970: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2971: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2972: </div>
1.41 asau 2973: <div class="sect1">
1.1 dsieger 2974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2975: <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 2976: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2977: when you installed your NetBSD machine. Please get and install it, by
2978: extracting it in <code class="filename">/</code>:</p>
2979: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2980: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2981: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2982: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2983: -r</strong></span>).</p>
2984: </div>
1.41 asau 2985: <div class="sect1">
1.1 dsieger 2986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.221 nia 2987: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.1 dsieger 2988: <p>When installing packages as non-root user and using the just-in-time
1.207 leot 2989: <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 2990: password for each required package installed. To avoid this, the sudo
2991: package can be used, which does password caching over a limited time. To
1.221 nia 2992: use it, install <span class="command"><strong>sudo</strong></span> or
2993: <span class="command"><strong>priv</strong></span> (either as binary package, from
2994: <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 2995: <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 2996: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2997: <span class="emphasis"><em>after</em></span> the definition of the
2998: <code class="varname">LOCALBASE</code> variable:</p>
2999: <pre class="programlisting">
3000: .if exists(${LOCALBASE}/bin/sudo)
3001: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3002: .endif
3003: </pre>
3004: </div>
1.41 asau 3005: <div class="sect1">
1.1 dsieger 3006: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3007: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3008: <p>As the system administrator, you can choose where configuration files
3009: are installed. The default settings make all these files go into
3010: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3011: be suboptimal depending on your expectations (e.g., a read-only,
3012: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3013: configuration of the provided packages).</p>
3014: <p>In order to change the defaults, you can modify the
3015: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3016: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3017: directory; some common examples include <code class="filename">/etc</code> or
3018: <code class="filename">/etc/pkg</code>.</p>
3019: <p>Furthermore, you can change this value on a per-package basis by
3020: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3021: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3022: package you would like to modify, that is, the contents of
3023: <code class="varname">PKGBASE</code>.</p>
3024: <p>Note that after changing these settings, you must rebuild and
3025: reinstall any affected packages.</p>
3026: </div>
1.41 asau 3027: <div class="sect1">
1.1 dsieger 3028: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3029: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3030: <p>Please be aware that there can often be bugs in third-party software,
3031: and some of these bugs can leave a machine vulnerable to exploitation by
3032: attackers. In an effort to lessen the exposure, the NetBSD packages team
3033: maintains a database of known-exploits to packages which have at one time
3034: been included in pkgsrc. The database can be downloaded automatically, and
3035: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3036: do this, refer to the following two tools (installed as part of the
1.207 leot 3037: <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 3038: <div class="orderedlist"><ol class="orderedlist" type="1">
3039: <li class="listitem">
1.20 snj 3040: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3041: download a list of the security vulnerabilities information. This list
1.25 spz 3042: is kept up to date by the pkgsrc security team, and is distributed
3043: from the NetBSD ftp server:</p>
1.177 leot 3044: <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 3045: </li>
1.23 wiz 3046: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3047: current machine, checking each known vulnerability. If a
1.1 dsieger 3048: vulnerable package is installed, it will be shown by output to stdout,
3049: including a description of the type of vulnerability, and a URL
3050: containing more information.</p></li>
3051: </ol></div>
1.121 sevan 3052: <p>Use of these tools is strongly recommended!
1.202 nia 3053: 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 3054: reporting.</p>
3055: <p>If this database is installed, pkgsrc builds will use it to
3056: perform a security check before building any package.</p>
1.1 dsieger 3057: </div>
1.41 asau 3058: <div class="sect1">
1.1 dsieger 3059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3060: <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 3061: <p>When you add your own preferences to the
3062: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3063: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3064: environment variables to the <code class="filename">./configure</code>
1.207 leot 3065: 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 3066: <code class="varname">CFLAGS</code> from the environment variable by
3067: overriding them in the <code class="filename">Makefile</code>s of their
3068: package.</p>
3069: <p>Currently there is no solution to this problem. If you
3070: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3071: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3072: directory and then inspect any <code class="filename">Makefile</code> and
3073: <code class="filename">Makefile.in</code> for whether they define
3074: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3075: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3076: programmers write so bad code that it only works for the
3077: specific combination of <code class="varname">CFLAGS</code> they have
3078: chosen.</p>
1.172 rillig 3079: <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>
3080: <pre class="programlisting">
3081: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3082: CFLAGS+= -Dpkgsrc___CFLAGS
3083: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3084: </pre>
3085: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3086: to see whether the above flags are passed to the actual build
3087: commands in general.</p>
3088: <p>To find out whether the flags are passed to individual compiler
3089: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3090: most cases, the flags from the original command lines (the lines starting
3091: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3092: (the lines starting with <code class="literal"><.></code>). If the flag is
3093: missing from the actual compiler command, it must have been removed by
1.184 rillig 3094: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.1 dsieger 3095: </div>
1.41 asau 3096: <div class="sect1">
1.1 dsieger 3097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3098: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3099: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3100: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3101: case that occurs often is that people only update pkgsrc in
3102: parts, because of performance reasons. Since pkgsrc is one large
3103: system, not a collection of many small systems, there are
3104: sometimes changes that only work when the whole pkgsrc tree is
3105: updated.</p></li>
1.41 asau 3106: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3107: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3108: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3109: files.</p></li>
1.41 asau 3110: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3111: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3112: verify this.</p></li>
1.108 rillig 3113: <li class="step"><p>If you are a package developer who wants to invest
1.154 rillig 3114: 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 3115: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3116: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3117: </ol></div>
3118: </div>
1.41 asau 3119: <div class="sect1">
1.1 dsieger 3120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3121: <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 3122: <p>You have modified a file from pkgsrc, and someone else has
3123: modified that same file afterwards in the CVS repository. Both changes
3124: are in the same region of the file, so when you updated pkgsrc, the
3125: <code class="literal">cvs</code> command marked the conflicting changes in the
3126: file. Because of these markers, the file is no longer a valid
3127: <code class="filename">Makefile</code>.</p>
3128: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3129: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3130: -dP</strong></span> in that directory to download the current version.</p>
3131: </div>
3132: </div>
3133: </div>
1.41 asau 3134: <div class="part">
1.1 dsieger 3135: <div class="titlepage"><div><div><h1 class="title">
3136: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3137: <div class="partintro">
1.1 dsieger 3138: <div></div>
3139: <p>This part of the book deals with creating and
1.23 wiz 3140: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3141: guide on creating a new package. The remaining chapters are more
3142: like a reference manual for pkgsrc.</p>
3143: <div class="toc">
3144: <p><b>Table of Contents</b></p>
1.100 leot 3145: <dl class="toc">
1.154 rillig 3146: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 3147: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 3148: <dd><dl>
1.184 rillig 3149: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3150: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3151: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 3152: <dd><dl>
1.184 rillig 3153: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3154: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3155: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3156: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3157: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 3158: </dl></dd>
1.184 rillig 3159: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3160: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3161: <dd><dl>
3162: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3163: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3164: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3165: </dl></dd>
3166: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3167: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3168: </dl></dd>
1.184 rillig 3169: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 3170: <dd><dl>
1.184 rillig 3171: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3172: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3173: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3174: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3175: <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 3176: <dd><dl>
1.184 rillig 3177: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3178: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 3179: </dl></dd>
1.184 rillig 3180: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3181: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3182: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3183: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3184: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3185: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3186: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3187: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3188: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3189: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3190: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3191: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3192: </dl></dd>
3193: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3194: <dd><dl>
3195: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 3196: <dd><dl>
1.219 nia 3197: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
3198: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
3199: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.6 rillig 3200: </dl></dd>
1.184 rillig 3201: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3202: <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 3203: </dl></dd>
1.184 rillig 3204: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3205: <dd><dl>
1.184 rillig 3206: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3207: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3208: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3209: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 3210: <dd><dl>
1.184 rillig 3211: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3212: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3213: <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>
3214: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 3215: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.6 rillig 3216: </dl></dd>
3217: </dl></dd>
1.184 rillig 3218: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 3219: <dd><dl>
1.184 rillig 3220: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3221: <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>
3222: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3223: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3224: </dl></dd>
1.184 rillig 3225: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 3226: <dd><dl>
1.184 rillig 3227: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3228: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3229: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3230: </dl></dd>
3231: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3232: <dd><dl>
3233: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3234: <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 3235: <dd><dl>
1.184 rillig 3236: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3237: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 3238: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3239: and
3240: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3241: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3242: </dl></dd>
1.184 rillig 3243: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3244: <dd><dl>
3245: <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>
3246: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3247: </dl></dd>
3248: </dl></dd>
3249: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 3250: <dd><dl>
1.184 rillig 3251: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3252: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3253: <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>
3254: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3255: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3256: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3257: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3258: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3259: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 3260: </dl></dd>
1.184 rillig 3261: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3262: <dd><dl>
3263: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3264: <dd><dl>
3265: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3266: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 3267: </dl></dd>
1.184 rillig 3268: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 3269: <dd><dl>
1.184 rillig 3270: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3271: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.239 dholland 3272: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
3273: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
3274: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 3275: </dl></dd>
3276: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3277: <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>
3278: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3279: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3280: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3281: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3282: <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 3283: </dl></dd>
3284: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3285: <dd><dl>
3286: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3287: <dd><dl>
3288: <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>
3289: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3290: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3291: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3292: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3293: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3294: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3295: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3296: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3297: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3298: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3299: </dl></dd>
3300: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3301: <dd><dl>
3302: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3303: <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>
3304: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3305: </dl></dd>
3306: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3307: <dd><dl>
3308: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3309: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3310: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 3311: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154 rillig 3312: </dl></dd>
3313: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3314: <dd><dl>
3315: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3316: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 3317: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 3318: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
3319: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
3320: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
3321: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 3322: </dl></dd>
3323: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3324: <dd><dl>
3325: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3326: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 3327: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3328: <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>
3329: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 3330: </dl></dd>
3331: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3332: <dd><dl>
3333: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3334: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3335: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3336: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3337: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 3338: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154 rillig 3339: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
3340: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203 nia 3341: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
3342: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
3343: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
3344: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
3345: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
3346: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
3347: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1 dsieger 3348: emulation</a></span></dt>
1.203 nia 3349: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
3350: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1 dsieger 3351: </dl></dd>
1.154 rillig 3352: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3353: </dl></dd>
1.184 rillig 3354: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3355: <dd><dl>
3356: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3357: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3358: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3359: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3360: </dl></dd>
1.154 rillig 3361: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3362: <dd><dl>
1.154 rillig 3363: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3364: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3365: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3366: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3367: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3368: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3369: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3370: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3371: </dl></dd>
3372: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 3373: </dl>
3374: </div>
3375: </div>
1.41 asau 3376: <div class="chapter">
1.1 dsieger 3377: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3378: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3379: <p>
3380: To get help when developing pkgsrc, the definitive source is this
3381: document, the pkgsrc guide. If you don't find anything here,
3382: there are alternatives:
3383: </p>
3384: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3385: <li class="listitem">
3386: <p>
3387: The built-in pkgsrc help, which is available after bootstrapping
3388: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3389: help for any topic, such as a variable name like
3390: <code class="varname">BUILD_DEFS</code>, a make target like
3391: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3392: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.207 leot 3393: <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 3394: </li>
3395: <li class="listitem"><p>
1.163 rillig 3396: To see the value of a single variable, run <span class="command"><strong>bmake
3397: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3398: </p></li>
3399: <li class="listitem"><p>
3400: To see the values of the most common variables, run
3401: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3402: topic. To see the variables for a single topic, run
3403: <span class="command"><strong>bmake
3404: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3405: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3406: </p></li>
3407: <li class="listitem"><p>
1.154 rillig 3408: The tech-pkg mailing list, to which
3409: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3410: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3411: questions</a>.</p></li>
3412: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3413: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3414: or by using a specialized chat program such as
3415: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3416: Pick any user name and join the channel #pkgsrc.</p></li>
3417: </ul></div>
3418: </div>
3419: <div class="chapter">
3420: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 3421: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3422: <div class="toc">
3423: <p><b>Table of Contents</b></p>
1.100 leot 3424: <dl class="toc">
1.184 rillig 3425: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3426: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3427: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3428: <dd><dl>
3429: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3430: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3431: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3432: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3433: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3434: </dl></dd>
3435: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3436: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3437: <dd><dl>
3438: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3439: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3440: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3441: </dl></dd>
1.184 rillig 3442: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3443: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3444: </dl>
3445: </div>
1.184 rillig 3446: <p>Whenever you're preparing a package, there are a number of
3447: files involved which are described in the following
3448: sections.</p>
3449: <div class="sect1">
3450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3451: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3452: </h2></div></div></div>
3453: <p>Building, installation and creation of a binary package are all
3454: controlled by the package's <code class="filename">Makefile</code>.
3455: The <code class="filename">Makefile</code> describes various things about
3456: a package, for example from where to get it, how to configure,
3457: build, and install it.</p>
3458: <p>A package <code class="filename">Makefile</code> contains several
3459: sections that describe the package.</p>
3460: <p>In the first section there are the following variables, which
3461: should appear exactly in the order given here. The order and
3462: grouping of the variables is mostly historical and has no further
3463: meaning.</p>
3464: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3465: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3466: distribution file to be downloaded from the package's
3467: website.</p></li>
3468: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3469: package, as used by pkgsrc. You need to provide it if
3470: <code class="varname">DISTNAME</code> (which is the default) is not a good
3471: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3472: provided (no distribution file is required). Usually it is the pkgsrc
3473: directory name together with the version number. It must match the
3474: regular expression
3475: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3476: starts with a letter or digit, and contains only letters, digits,
1.204 nia 3477: dashes, underscores, dots and plus signs.
3478: New packages should have entirely lower-case names, with the exception
3479: of some that must follow pre-existing conventions
3480: (e.g. R packages begin with <code class="varname">R-</code>).
3481: You can use the <code class="code">:tl</code> variable modifier to lower-case
3482: the package name.</p></li>
1.184 rillig 3483: <li class="listitem">
3484: <p><code class="varname">CATEGORIES</code> is a list of categories
3485: which the package fits in. You can choose any of the top-level
3486: directories of pkgsrc for it.</p>
3487: <p>Currently the following values are available for
3488: <code class="varname">CATEGORIES</code>. If more than
3489: one is used, they need to be separated by spaces:</p>
1.1 dsieger 3490: <pre class="programlisting">
1.184 rillig 3491: archivers cross geography meta-pkgs security
3492: audio databases graphics misc shells
3493: benchmarks devel ham multimedia sysutils
3494: biology editors inputmethod net textproc
3495: cad emulators lang news time
3496: chat finance mail parallel wm
3497: comms fonts math pkgtools www
3498: converters games mbone print x11
1.1 dsieger 3499: </pre>
3500: </li>
1.184 rillig 3501: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3502: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3503: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3504: and <code class="varname">DISTFILES</code> are discussed in detail in
3505: <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>
3506: </ul></div>
3507: <p>The second section contains information about separately
3508: downloaded patches, if any.
3509: </p>
3510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3511: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3512: Name(s) of additional files that contain distribution patches.
3513: There is no default. pkgsrc will look for them at
3514: <code class="varname">PATCH_SITES</code>.
3515: They will automatically be uncompressed before patching if
3516: the names end with <code class="filename">.gz</code> or
3517: <code class="filename">.Z</code>.</p></li>
3518: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3519: Primary location(s) for distribution patch files (see
3520: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3521: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.207 leot 3522: 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 3523: help find the correct files to patch. It defaults to
3524: <span class="command"><strong>-p0</strong></span>.</p></li>
3525: </ul></div>
3526: <p>The third section contains the following variables.
3527: </p>
3528: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3529: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
3530: address of the person who feels responsible for this package,
3531: and who is most likely to look at problems or questions regarding
1.207 leot 3532: 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 3533: Other developers may contact the <code class="varname">MAINTAINER</code>
3534: before making changes to the package, but are not required to
3535: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3536: to yourself. If you really can't maintain the package for future
3537: updates, set it to
3538: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
3539: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
3540: of <code class="varname">MAINTAINER</code> when you do not want other
3541: developers to update or change the package without contacting
3542: you first. A package Makefile should contain one of
3543: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3544: not both. </p></li>
3545: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3546: find more information about the package.</p></li>
3547: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3548: description of the package (should not include the package
3549: name).</p></li>
3550: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3551: 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>
3552: </ul></div>
3553: <p>Other variables that affect the build:
3554: </p>
3555: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3556: <p><code class="varname">WRKSRC</code>: The directory where the
3557: interesting distribution files of the package are found. The
3558: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3559: works for most packages.</p>
3560: <p>If a package doesn't create a subdirectory for itself
3561: (most GNU software does, for instance), but extracts itself in
3562: the current directory, you should set
3563: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3564: <p>If a package doesn't create a subdirectory with the
3565: name of <code class="varname">DISTNAME</code> but some different name,
3566: set <code class="varname">WRKSRC</code> to point to the proper name in
3567: <code class="filename">${WRKDIR}</code>, for example
3568: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.207 leot 3569: <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 3570: <p>The name of the working directory created by pkgsrc is
3571: taken from the <code class="varname">WRKDIR_BASENAME</code>
3572: variable. By default, its value is
3573: <code class="filename">work</code>. If you want to use the same
3574: pkgsrc tree for building different kinds of binary packages,
3575: you can change the variable according to your needs. Two
3576: other variables handle common cases of setting
3577: <code class="varname">WRKDIR_BASENAME</code> individually. If
3578: <code class="varname">OBJHOSTNAME</code> is defined in
3579: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3580: the host's name is attached to the directory name. If
3581: <code class="varname">OBJMACHINE</code> is defined, the platform name
3582: is attached, which might look like
3583: <code class="filename">work.i386</code> or
3584: <code class="filename">work.sparc</code>.</p>
3585: </li></ul></div>
3586: <p>Please pay attention to the following gotchas:</p>
3587: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3588: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3589: installed in compressed form by the package. For packages using
3590: BSD-style makefiles which honor MANZ, there is
3591: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3592: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3593: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3594: below).</p></li>
3595: <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>
3596: </ul></div>
3597: </div>
1.41 asau 3598: <div class="sect1">
1.1 dsieger 3599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 3600: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3601: </h2></div></div></div>
3602: <p>The <code class="filename">distinfo</code> file contains the message
3603: digest, or checksum, of each distfile needed for the package. This
3604: ensures that the distfiles retrieved from the Internet have not been
3605: corrupted during transfer or altered by a malign force to introduce
3606: a security hole. To provide maximum security, all distfiles are
3607: protected using three different message digest algorithms (SHA1,
3608: RMD160, SHA512), as well as the file size.</p>
3609: <p>The <code class="filename">distinfo</code> file also contains the
3610: checksums for all the patches found in the
3611: <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
3612: are only applied intentionally and that they don't accidentally change,
3613: e.g. when merging different changes together. They also make sure that
3614: new patches are actually added to CVS and old ones are removed.
3615: Too see whether the patches and the <code class="filename">distinfo</code> file
3616: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3617: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3618: <span class="command"><strong>make distinfo</strong></span> command.</p>
3619: <p>Some packages have different sets of distfiles depending on
1.207 leot 3620: 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 3621: <code class="filename">distinfo</code> file and care should be taken when
3622: upgrading such a package to ensure distfile information is not
3623: lost.</p>
3624: </div>
3625: <div class="sect1">
3626: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3627: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3628: </h2></div></div></div>
3629: <p>Some packages don't work out-of-the box on the various
3630: platforms that are supported by pkgsrc. These packages need
3631: to be patched to make them work. The patch files can be
3632: found in the <code class="filename">patches/</code> directory.</p>
3633: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3634: applied to the files in <code class="varname">WRKSRC</code> directory after
3635: extracting them, in alphabetic order.</p>
1.41 asau 3636: <div class="sect2">
1.1 dsieger 3637: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3638: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3639: <p>The <code class="filename">patch-*</code> files should be in
3640: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3641: problems. (To force patches to apply with fuzz you can set
3642: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3643: should contain only changes for a single file, and no file should be
3644: patched by more than one patch file. This helps to keep future
3645: modifications simple.</p>
3646: <p>Each patch file is structured as follows: In the first line,
3647: there is the RCS Id of the patch itself. The second line should be
3648: empty for aesthetic reasons. After that, there should be a comment for
3649: each change that the patch does. There are a number of standard
3650: cases:</p>
3651: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3652: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3653: mention the vulnerability ID (CAN, CVE).</p></li>
3654: <li class="listitem"><p>Patches that change source code should mention the
3655: platform and other environment (for example, the compiler) that the
3656: patch is needed for.</p></li>
3657: </ul></div>
3658: <p>The patch should be commented so that any
3659: developer who knows the code of the application can make some use of
3660: the patch. Special care should be taken for the upstream developers,
3661: since we generally want that they accept our patches, so we have less
3662: work in the future.</p>
1.1 dsieger 3663: </div>
1.41 asau 3664: <div class="sect2">
1.1 dsieger 3665: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3666: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3667: <p>One important thing to mention is to pay attention that no RCS
3668: IDs get stored in the patch files, as these will cause problems when
3669: later checked into the NetBSD CVS tree. Use the
1.207 leot 3670: <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 3671: problems.</p>
3672: <p>For even more automation, we recommend using
3673: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.222 gutterid 3674: whole set of patches. You just have to back up files before you
3675: edit them to <code class="filename">filename.orig</code>, e.g., with
1.184 rillig 3676: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3677: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3678: you upgrade a package this way, you can easily compare the new
3679: set of patches with the previously existing one with
3680: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3681: are replaced by new files, so carefully check if you want to take all
3682: the changes.</p>
3683: <p>When you have finished a package, remember to generate
3684: the checksums for the patch files by using the <span class="command"><strong>make
3685: 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>
3686: <p>When adding a patch that corrects a problem in the
3687: distfile (rather than e.g. enforcing pkgsrc's view of where
3688: man pages should go), send the patch as a bug report to the
3689: maintainer. This benefits non-pkgsrc users of the package,
3690: and usually makes it possible to remove the patch in future
3691: version.</p>
3692: <p>The file names of the patch files are usually of the form
3693: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3694: Many packages still use the previous convention
3695: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3696: but new patches should be of the form containing the filename.
1.207 leot 3697: <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 3698: automatically.</p>
1.222 gutterid 3699: <p>When updating pre-existing patch files, if a file uses the old
3700: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
3701: convention, it's best not to change it to the new form, as that will
3702: just cause churn that makes it harder to track changes to patching
3703: over time. Similarly, if a patch now applies at different line offsets,
3704: but still applies cleanly as-is, there's no need to update it, as that
3705: also unnecessarily complicates the patch history.</p>
1.17 imil 3706: </div>
1.160 brook 3707: <div class="sect2">
3708: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3709: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3710: <p>If you want to share patches between multiple packages
3711: in pkgsrc, e.g. because they use the same distfiles, set
3712: <code class="varname">PATCHDIR</code> to the path where the patch files
3713: can be found, e.g.:</p>
3714: <pre class="programlisting">
3715: PATCHDIR= ../../editors/xemacs/patches
3716: </pre>
3717: <p>Patch files that are distributed by the author or other
3718: maintainers can be listed in
3719: <code class="varname">PATCHFILES</code>.</p>
3720: <p>If it is desired to store any patches that should not be
3721: committed into pkgsrc, they can be kept outside the pkgsrc
3722: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3723: directory tree there is expected to have the same
3724: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3725: patches are expected to be stored inside these dirs (also
3726: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3727: example, if you want to keep a private patch for
3728: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3729: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3730: files in the named directory are expected to be patch files,
3731: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3732: applied</em></span>.</p>
1.160 brook 3733: </div>
3734: <div class="sect2">
3735: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3736: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3737: <p>When fixing a portability issue in the code do not use
3738: preprocessor magic to check for the current operating system nor
3739: platform. Doing so hurts portability to other platforms because
3740: the OS-specific details are not abstracted appropriately.</p>
3741: <p>The general rule to follow is: instead of checking for the
3742: operating system the application is being built on, check for the
3743: specific <span class="emphasis"><em>features</em></span> you need. For example,
3744: instead of assuming that kqueue is available under NetBSD and
3745: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3746: kqueue support, add a check that detects kqueue itself —
3747: yes, this generally involves patching the
3748: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3749: that prevents some OSes from adopting interfaces from other OSes
3750: (e.g. Linux implementing kqueue), something that the above checks
3751: cannot take into account.</p>
3752: <p>Of course, checking for features generally involves more
3753: work on the developer's side, but the resulting changes are
3754: cleaner and there are chances they will work on many other
3755: platforms. Not to mention that there are higher chances of being
3756: later integrated into the mainstream sources. Remember:
3757: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3758: <p>Some typical examples:</p>
3759: <div class="table">
3760: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3761: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3762: <colgroup>
3763: <col>
3764: <col>
3765: <col>
3766: </colgroup>
3767: <thead><tr>
3768: <th>Where</th>
3769: <th>Incorrect</th>
3770: <th>Correct</th>
3771: </tr></thead>
3772: <tbody>
3773: <tr>
3774: <td>configure script</td>
3775: <td>
1.160 brook 3776: <pre class="programlisting">
1.184 rillig 3777: case ${target_os} in
3778: netbsd*) have_kvm=yes ;;
3779: *) have_kvm=no ;;
3780: esac
1.160 brook 3781: </pre>
1.184 rillig 3782: </td>
3783: <td>
1.160 brook 3784: <pre class="programlisting">
1.184 rillig 3785: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.160 brook 3786: </pre>
1.184 rillig 3787: </td>
3788: </tr>
3789: <tr>
3790: <td>C source file</td>
3791: <td>
1.1 dsieger 3792: <pre class="programlisting">
1.184 rillig 3793: #if defined(__NetBSD__)
3794: # include <sys/event.h>
3795: #endif
1.1 dsieger 3796: </pre>
1.184 rillig 3797: </td>
3798: <td>
1.1 dsieger 3799: <pre class="programlisting">
1.184 rillig 3800: #if defined(HAVE_SYS_EVENT_H)
3801: # include <sys/event.h>
3802: #endif
1.1 dsieger 3803: </pre>
1.184 rillig 3804: </td>
3805: </tr>
3806: <tr>
3807: <td>C source file</td>
3808: <td>
1.1 dsieger 3809: <pre class="programlisting">
1.184 rillig 3810: int
3811: monitor_file(...)
3812: {
3813: #if defined(__NetBSD__)
3814: int fd = kqueue();
3815: ...
3816: #else
3817: ...
3818: #endif
3819: }
1.1 dsieger 3820: </pre>
1.184 rillig 3821: </td>
3822: <td>
1.1 dsieger 3823: <pre class="programlisting">
1.184 rillig 3824: int
3825: monitor_file(...)
3826: {
3827: #if defined(HAVE_KQUEUE)
3828: int fd = kqueue();
3829: ...
3830: #else
3831: ...
3832: #endif
3833: }
1.1 dsieger 3834: </pre>
1.184 rillig 3835: </td>
3836: </tr>
3837: </tbody>
3838: </table></div>
3839: </div>
3840: <br class="table-break">
3841: </div>
3842: <div class="sect2">
3843: <div class="titlepage"><div><div><h3 class="title">
3844: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3845: <p>Always, always, <span class="strong"><strong>always</strong></span>
3846: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3847: improvements you do to a package to the mainstream developers.
3848: This is the only way to get their attention on portability issues
3849: and to ensure that future versions can be built out-of-the box on
3850: NetBSD. Furthermore, any user that gets newer distfiles will get
3851: the fixes straight from the packaged code.</p>
3852: <p>This generally involves cleaning up the patches
3853: (because sometimes the patches that are
3854: added to pkgsrc are quick hacks), filing bug reports in the
3855: appropriate trackers for the projects and working with the
3856: mainstream authors to accept your changes. It is
3857: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3858: the packages in pkgsrc are kept simple and thus further changes
3859: can be done without much hassle.</p>
3860: <p>When you have done this, please add a URL to the upstream
3861: bug report to the patch comment.</p>
3862: <p>Support the idea of free software!</p>
3863: </div>
1.1 dsieger 3864: </div>
1.184 rillig 3865: <div class="sect1">
3866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3867: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3868: <div class="variablelist"><dl class="variablelist">
3869: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3870: <dd><p>A multi-line description of the piece of software. This should include
3871: any credits where they are due. Please bear in mind that others do not
3872: share your sense of humour (or spelling idiosyncrasies), and that others
3873: will read everything that you write here.</p></dd>
3874: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3875: <dd><p>This file governs the files that are installed on your
3876: system: all the binaries, manual pages, etc. There are other
3877: directives which may be entered in this file, to control the
3878: creation and deletion of directories, and the location of
3879: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3880: information.</p></dd>
3881: </dl></div>
3882: </div>
3883: <div class="sect1">
3884: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3885: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3886: <div class="sect2">
3887: <div class="titlepage"><div><div><h3 class="title">
3888: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3889: <div class="variablelist"><dl class="variablelist">
3890: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3891: <dd>
1.207 leot 3892: <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 3893: First time after package extraction and before files are
3894: moved in place, the second time after the files to install
3895: are moved in place. This can be used to do any custom
3896: procedures not possible with @exec commands in
1.207 leot 3897: <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
3898: <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 3899: Please note that you can modify variables in it easily by using
3900: <code class="varname">FILES_SUBST</code> in the package's
3901: <code class="filename">Makefile</code>:</p>
1.1 dsieger 3902: <pre class="programlisting">
1.184 rillig 3903: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3904: </pre>
1.184 rillig 3905: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3906: <code class="filename">INSTALL</code>. By default, substitution is
3907: performed for <code class="varname">PREFIX</code>,
3908: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3909: <code class="varname">VARBASE</code>, and a few others, type
3910: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3911: complete list.</p>
3912: </dd>
3913: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3914: <dd><p>This script is executed before and after any files are removed. It is
3915: this script's responsibility to clean up any additional messy details
3916: around the package's installation, since all pkg_delete knows is how to
3917: delete the files created in the original distribution.
1.207 leot 3918: 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>
3919: 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 3920: The same methods to replace variables can be used as for
3921: the <code class="filename">INSTALL</code> file.</p></dd>
3922: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3923: <dd>
3924: <p>This file is displayed after installation of the package.
1.198 leot 3925: While this was used often in the past, it has two
3926: problems: the display will be missed if many packages are
3927: intalled at once, and the person installing the package
3928: and the one using or configuring it may be different. It
3929: should therefore be used only in exceptional circumstances
3930: where lasting negative consequences would result from
3931: someone not reading it.</p>
3932: <p>MESSAGE should not be used for:</p>
3933: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3934: <li class="listitem"><p>exhortations to read the documentation</p></li>
3935: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
3936: <li class="listitem"><p>anything that should be explained in the
3937: installation/configuration documentation that should
3938: come with the package</p></li>
3939: </ul></div>
3940: <p>If the documentation provided by upstream needs
3941: enhancing, create e.g. files/README.pkgsrc and install it
3942: in the package's documentation directory.
3943: </p>
3944: <p>Note that MESSAGE is shown for all operating
3945: systems and all init systems. If a MESSAGE is necessary,
3946: it should be narrowed to only those operating systems and
3947: init systems to which it applies.</p>
3948: <p>Note that you can modify variables in it easily by using
1.184 rillig 3949: <code class="varname">MESSAGE_SUBST</code> in the package's
3950: <code class="filename">Makefile</code>:</p>
1.1 dsieger 3951: <pre class="programlisting">
1.184 rillig 3952: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3953: </pre>
1.184 rillig 3954: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
3955: <code class="filename">MESSAGE</code>. By default, substitution is
3956: performed for <code class="varname">PKGNAME</code>,
3957: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
3958: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3959: <code class="varname">PKG_SYSCONFDIR</code>,
3960: <code class="varname">ROOT_GROUP</code>, and
3961: <code class="varname">ROOT_USER</code>.</p>
3962: <p>You can display a different or additional files by
3963: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3964: default is <code class="filename">MESSAGE</code>, if the file
3965: exists.</p>
3966: </dd>
3967: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
3968: <dd>
3969: <p>This file is used by the alternatives framework.
3970: It creates, configures, and destroys generic wrappers used to
3971: run programs with similar interfaces.
3972: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3973: for more information.</p>
3974: <p>Each line of the file contains two filenames, first
3975: the wrapper and then the alternative provided by the package.
3976: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3977: </dd>
3978: </dl></div>
3979: </div>
3980: <div class="sect2">
3981: <div class="titlepage"><div><div><h3 class="title">
3982: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
3983: <div class="variablelist"><dl class="variablelist">
3984: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3985: <dd><p>This file contains arbitrary things that could
3986: also go into a <code class="filename">Makefile</code>, but its purpose is
3987: to be used by more than one package. This file should only be
3988: used when the packages that will use the file are known in
3989: advance. For other purposes it is often better to write a
3990: <code class="filename">*.mk</code> file and give it a good name that
3991: describes what it does.</p></dd>
3992: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3993: <dd><p>This file contains the dependency information
3994: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
3995: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3996: <dd><p>This file contains workarounds for compiler bugs
3997: and similar things. It is included automatically by the pkgsrc
3998: infrastructure, so you don't need an extra
3999: <code class="literal">.include</code> line for
4000: it.</p></dd>
4001: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4002: <dd><p>This file contains the code for the
4003: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
4004: selected by the user. If a package has only one or two options,
4005: it is equally acceptable to put the code directly into the
4006: <code class="filename">Makefile</code>.</p></dd>
4007: </dl></div>
4008: </div>
4009: <div class="sect2">
4010: <div class="titlepage"><div><div><h3 class="title">
4011: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
4012: <div class="variablelist"><dl class="variablelist">
4013: <dt><span class="term"><code class="filename">README*</code></span></dt>
4014: <dd><p>These files do not take place in the creation of
4015: a package and thus are purely informative to the package
4016: developer.</p></dd>
4017: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4018: <dd><p>This file contains things that need to be done
4019: to make the package even
4020: better.</p></dd>
4021: </dl></div>
4022: </div>
4023: </div>
4024: <div class="sect1">
4025: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4026: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
4027: </h2></div></div></div>
4028: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4029: unpacked into the directory denoted by
4030: <code class="varname">WRKDIR</code>. It can be removed by running
4031: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4032: directory is also used to keep various timestamp files.
4033: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4034: The default is <code class="filename">${.CURDIR}/work</code>
4035: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4036: if <code class="varname">OBJMACHINE</code> is set.</p>
1.1 dsieger 4037: </div>
1.184 rillig 4038: <div class="sect1">
4039: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4040: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
4041: </h2></div></div></div>
4042: <p>If you have any files that you wish to be placed in the package
4043: prior to configuration or building, you can place these files here
4044: and use a <span class="command"><strong>${CP}</strong></span> command in the
4045: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4046: <p>If you want to share files in this way with other
4047: packages, set the <code class="varname">FILESDIR</code> variable to point
4048: to the other package's <code class="filename">files</code> directory,
4049: e.g.:</p>
1.1 dsieger 4050: <pre class="programlisting">
1.184 rillig 4051: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 4052: </pre>
4053: </div>
4054: </div>
1.41 asau 4055: <div class="chapter">
1.1 dsieger 4056: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 4057: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.1 dsieger 4058: <div class="toc">
4059: <p><b>Table of Contents</b></p>
1.100 leot 4060: <dl class="toc">
1.184 rillig 4061: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4062: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4063: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4064: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4065: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4066: <dd><dl>
4067: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4068: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4069: </dl></dd>
4070: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4071: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4072: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4073: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4074: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4075: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4076: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4077: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4078: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4079: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4080: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4081: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.1 dsieger 4082: </dl>
4083: </div>
1.41 asau 4084: <div class="sect1">
1.1 dsieger 4085: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4086: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4087: <p>This chapter gives a detailed description on how a package is
4088: built. Building a package is separated into different
4089: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4090: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4091: described in the following sections. Each phase is split into
4092: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4093: containing phase, prefixed by one of <code class="varname">pre-</code>,
4094: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4095: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4096: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4097: <p>Never override the regular targets (like
4098: <code class="varname">fetch</code>), if you have to, override the
4099: <code class="varname">do-*</code> ones instead.</p>
4100: <p>The basic steps for building a program are always the same. First
4101: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4102: the local system and then extracted. After any pkgsrc-specific patches
4103: to compile properly are applied, the software can be configured, then
4104: built (usually by compiling), and finally the generated binaries, etc.
4105: can be put into place on the system.</p>
4106: <p>To get more details about what is happening at each step,
4107: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4108: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4109: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4110: </div>
4111: <div class="sect1">
4112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4113: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4114: <p>Before outlining the process performed by the NetBSD package system in
4115: the next section, here's a brief discussion on where programs are
4116: installed, and which variables influence this.</p>
4117: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4118: where all files of the final program shall be installed. It is
4119: usually set to <code class="varname">LOCALBASE</code>
4120: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4121: for pkgs in the <code class="filename">cross</code> category. The value of
4122: <code class="varname">PREFIX</code> needs to be put
4123: into the various places in the program's source where paths to
4124: 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>
4125: <p>When choosing which of these variables to use,
4126: follow the following rules:</p>
1.41 asau 4127: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 4128: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4129: where the current pkg will be installed. When referring to a
4130: pkg's own installation path, use
4131: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
1.223 nia 4132: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.184 rillig 4133: are installed. If you need to construct a -I or -L argument
4134: to the compiler to find includes and libraries installed by
1.223 nia 4135: another pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.184 rillig 4136: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4137: installed all packages in <code class="filename">/usr/local</code>. As
4138: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4139: administrator, this variable is a misnomer.</p></li>
4140: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4141: distribution (from xsrc, etc.) is installed. When looking for
4142: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4143: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4144: <li class="listitem"><p>X11-based packages using imake must set
4145: <code class="varname">USE_IMAKE</code> to be installed correctly under
4146: <code class="varname">LOCALBASE</code>.</p></li>
4147: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.207 leot 4148: 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 4149: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4150: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4151: </ul></div>
4152: </div>
4153: <div class="sect1">
4154: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4155: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4156: <p>When building a package, various directories are used to store
4157: source files, temporary files, pkgsrc-internal files, and so on. These
4158: directories are explained here.</p>
4159: <p>Some of the directory variables contain relative pathnames. There
4160: are two common base directories for these relative directories:
4161: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4162: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4163: inside the package itself.</p>
4164: <div class="variablelist"><dl class="variablelist">
4165: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4166: <dd><p>This is an absolute pathname that points to the pkgsrc
4167: root directory. Generally, you don't need
4168: it.</p></dd>
4169: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4170: <dd><p>This is an absolute pathname that points to the
4171: current package.</p></dd>
4172: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.228 gutterid 4173: <dd>
4174: <p>This is a pathname relative to
4175: <code class="varname">PKGSRCDIR</code> that points to the current package.
4176: It is defined after including <code class="filename">bsd.prefs.mk</code>
4177: and can be used in makefile fragments that are used by several
4178: packages to distinguish between these packages. Other variables
4179: that would serve the same purpose are <code class="varname">PKGBASE</code>
4180: and <code class="varname">PKGNAME</code>, but these are only defined after
4181: including <code class="filename">bsd.pkg.mk</code>, which is too
4182: late.</p>
4183: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
4184: <code class="varname">PKGPATH</code> to tweak variables like
4185: <code class="varname">MAKE_JOBS</code> and
4186: <code class="varname">CFLAGS</code>.</p>
4187: </dd>
1.184 rillig 4188: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4189: <dd><p>This is an absolute pathname pointing to the directory
4190: where all work takes place. The distfiles are extracted to this
4191: directory. It also contains temporary directories and log files used by
4192: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4193: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4194: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4195: <dd><p>This is an absolute pathname pointing to the directory
4196: where the distfiles are extracted. It is usually a direct subdirectory
4197: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4198: that isn't hidden. This variable may be changed by a package
4199: <code class="filename">Makefile</code>.</p></dd>
4200: </dl></div>
4201: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4202: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4203: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4204: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4205: If users would like to have their pkgsrc trees behave in a
4206: read-only manner, then the value of
4207: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4208: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 4209: </div>
1.41 asau 4210: <div class="sect1">
1.1 dsieger 4211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4212: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4213: <p>You can run a particular phase by typing <span class="command"><strong>make
1.228 gutterid 4214: <em class="replaceable"><code>phase</code></em></strong></span>, where
4215: <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
4216: automatically run all phases that are required for this phase. The
4217: default phase is <code class="varname">build</code>, that is, when you run
4218: <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.184 rillig 4219: the package will be built, but not installed.</p>
1.1 dsieger 4220: </div>
1.41 asau 4221: <div class="sect1">
1.1 dsieger 4222: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4223: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4224: <p>The first step in building a package is to fetch the
4225: distribution files (distfiles) from the sites that are providing
4226: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4227: phase.</p>
1.41 asau 4228: <div class="sect2">
1.1 dsieger 4229: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 4230: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4231: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4232: defines all URLs from where the distfile, whose name is
4233: derived from the <code class="varname">DISTNAME</code> variable, is
4234: fetched. The more complicated cases are described
4235: below.</p>
4236: <p>The variable <code class="varname">DISTFILES</code> specifies
4237: the list of distfiles that have to be fetched. Its value
4238: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4239: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4240: so that most packages don't need to define it at all.
4241: <code class="varname">EXTRACT_SUFX</code> is
4242: <code class="literal">.tar.gz</code> by default, but can be changed
4243: freely. Note that if your package requires additional
4244: distfiles to the default one, you cannot just append the
4245: additional filenames using the <code class="literal">+=</code>
4246: operator, but you have write for example:</p>
4247: <pre class="programlisting">
4248: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4249: </pre>
4250: <p>Each distfile is fetched from a list of sites, usually
4251: <code class="varname">MASTER_SITES</code>. If the package has multiple
4252: <code class="varname">DISTFILES</code> or multiple
4253: <code class="varname">PATCHFILES</code> from different sites, you can
4254: set
4255: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4256: to the list of URLs where the file
4257: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4258: (including the suffix) can be found.</p>
4259: <pre class="programlisting">
4260: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4261: DISTFILES+= foo-file.tar.gz
4262: SITES.foo-file.tar.gz= \
4263: https://www.somewhere.com/somehow/ \
4264: https://www.somewhereelse.com/mirror/somehow/
4265: </pre>
4266: <p>When actually fetching the distfiles, each item from
4267: <code class="varname">MASTER_SITES</code> or
4268: <code class="varname">SITES.*</code> gets the name of each distfile
4269: appended to it, without an intermediate slash. Therefore,
4270: all site values have to end with a slash or other separator
4271: character. This allows for example to set
4272: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4273: that gets the name of the distfile as a parameter. In this
4274: case, the definition would look like:</p>
4275: <pre class="programlisting">
4276: MASTER_SITES= https://www.example.com/download.cgi?file=
4277: </pre>
4278: <p> The exception to this rule are URLs starting with a dash.
4279: In that case the URL is taken as is, fetched and the result
4280: stored under the name of the distfile. You can use this style
4281: for the case when the download URL style does not match the
4282: above common case. For example, if permanent download URL is a
4283: redirector to the real download URL, or the download file name
4284: is offered by an HTTP Content-Disposition header. In the
4285: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4286: created instead of the default
4287: <code class="filename">v1.0.0.tar.gz</code>.</p>
4288: <pre class="programlisting">
4289: DISTNAME= foo-1.0.0
4290: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4291: </pre>
4292: <p>There are some predefined values for
4293: <code class="varname">MASTER_SITES</code>, which can be used in
4294: packages. The names of the variables should speak for
4295: themselves.</p>
4296: <table border="0" summary="Simple list" class="simplelist">
4297: <tr>
4298: <td>MASTER_SITE_APACHE</td>
4299: <td>MASTER_SITE_BACKUP</td>
4300: </tr>
4301: <tr>
4302: <td>MASTER_SITE_CRATESIO</td>
4303: <td>MASTER_SITE_CYGWIN</td>
4304: </tr>
4305: <tr>
4306: <td>MASTER_SITE_DEBIAN</td>
4307: <td>MASTER_SITE_FREEBSD</td>
4308: </tr>
4309: <tr>
4310: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4311: <td>MASTER_SITE_GENTOO</td>
4312: </tr>
4313: <tr>
4314: <td>MASTER_SITE_GITHUB</td>
1.225 gutterid 4315: <td>MASTER_SITE_GITLAB</td>
4316: </tr>
4317: <tr>
1.184 rillig 4318: <td>MASTER_SITE_GNOME</td>
1.225 gutterid 4319: <td>MASTER_SITE_GNU</td>
1.184 rillig 4320: </tr>
4321: <tr>
4322: <td>MASTER_SITE_GNUSTEP</td>
1.225 gutterid 4323: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.184 rillig 4324: </tr>
4325: <tr>
4326: <td>MASTER_SITE_IFARCHIVE</td>
1.225 gutterid 4327: <td>MASTER_SITE_KDE</td>
1.184 rillig 4328: </tr>
4329: <tr>
4330: <td>MASTER_SITE_MOZILLA</td>
1.225 gutterid 4331: <td>MASTER_SITE_MOZILLA_ALL</td>
1.184 rillig 4332: </tr>
4333: <tr>
4334: <td>MASTER_SITE_MYSQL</td>
1.225 gutterid 4335: <td>MASTER_SITE_NETLIB</td>
1.184 rillig 4336: </tr>
4337: <tr>
4338: <td>MASTER_SITE_OPENBSD</td>
1.225 gutterid 4339: <td>MASTER_SITE_OPENOFFICE</td>
1.184 rillig 4340: </tr>
4341: <tr>
4342: <td>MASTER_SITE_OSDN</td>
1.225 gutterid 4343: <td>MASTER_SITE_PERL_CPAN</td>
1.184 rillig 4344: </tr>
4345: <tr>
4346: <td>MASTER_SITE_PGSQL</td>
1.225 gutterid 4347: <td>MASTER_SITE_PYPI</td>
1.184 rillig 4348: </tr>
4349: <tr>
4350: <td>MASTER_SITE_RUBYGEMS</td>
1.225 gutterid 4351: <td>MASTER_SITE_R_CRAN</td>
1.184 rillig 4352: </tr>
4353: <tr>
4354: <td>MASTER_SITE_SOURCEFORGE</td>
1.225 gutterid 4355: <td>MASTER_SITE_SUNSITE</td>
1.184 rillig 4356: </tr>
1.1 dsieger 4357: <tr>
1.184 rillig 4358: <td>MASTER_SITE_SUSE</td>
1.225 gutterid 4359: <td>MASTER_SITE_TEX_CTAN</td>
1.1 dsieger 4360: </tr>
4361: <tr>
1.184 rillig 4362: <td>MASTER_SITE_XCONTRIB</td>
1.225 gutterid 4363: <td>MASTER_SITE_XEMACS</td>
1.1 dsieger 4364: </tr>
4365: <tr>
1.184 rillig 4366: <td>MASTER_SITE_XORG</td>
1.225 gutterid 4367: <td> </td>
1.184 rillig 4368: </tr>
4369: </table>
4370: <p>Some explanations for the less self-explaining ones:
4371: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
4372: 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
4373: 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>
4374: <p>If you choose one of these predefined sites, you may
4375: want to specify a subdirectory of that site. Since these
4376: macros may expand to more than one actual site, you
4377: <span class="emphasis"><em>must</em></span> use the following construct to
4378: specify a subdirectory:</p>
1.1 dsieger 4379: <pre class="programlisting">
1.184 rillig 4380: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4381: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 4382: </pre>
1.184 rillig 4383: <p>Note the trailing slash after the subdirectory
4384: name.</p>
4385: </div>
4386: <div class="sect2">
4387: <div class="titlepage"><div><div><h3 class="title">
4388: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4389: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4390: all the distfiles exist in a local directory
4391: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4392: user). If the files do not exist, they are fetched using
4393: commands of the form</p>
1.1 dsieger 4394: <pre class="programlisting">
1.184 rillig 4395: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4396: </pre>
4397: <p>where <code class="literal">${site}</code> varies through
4398: several possibilities in turn: first,
4399: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4400: sites specified in either <code class="varname">SITES.file</code> if
4401: defined, else <code class="varname">MASTER_SITES</code> or
4402: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4403: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4404: all except the first and the last can be optionally sorted
4405: by the user, via setting either
4406: <code class="varname">MASTER_SORT_RANDOM</code>, and
4407: <code class="varname">MASTER_SORT_AWK</code> or
4408: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4409: <p> The specific command and arguments used depend on the
4410: <code class="varname">FETCH_USING</code> parameter. The example above is
4411: for <code class="literal">FETCH_USING=custom</code>.</p>
4412: <p>The distfiles mirror run by the NetBSD Foundation uses the
4413: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4414: distfiles, if they are freely distributable. Packages setting
4415: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4416: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4417: mirrored.</p>
1.1 dsieger 4418: </div>
4419: </div>
1.184 rillig 4420: <div class="sect1">
4421: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4422: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4423: <p>After the distfile(s) are fetched, their checksum is
4424: generated and compared with the checksums stored in the
4425: distinfo file. If the checksums don't match, the build is
4426: aborted. This is to ensure the same distfile is used for
4427: building, and that the distfile wasn't changed, e.g. by some
4428: malign force, deliberately changed distfiles on the master
4429: distribution site or network lossage.</p>
1.1 dsieger 4430: </div>
1.41 asau 4431: <div class="sect1">
1.1 dsieger 4432: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4433: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4434: <p>When the distfiles are present on the local system, they
4435: need to be extracted, as they usually come in the form of some
4436: compressed archive format.</p>
4437: <p>By default, all <code class="varname">DISTFILES</code> are
4438: extracted. If you only need some of them, you can set the
4439: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4440: files.</p>
4441: <p>Extracting the files is usually done by a little
4442: program, <code class="filename">mk/extract/extract</code>, which
4443: already knows how to extract various archive formats, so most
4444: likely you will not need to change anything here. But if you
4445: need, the following variables may help you:</p>
1.41 asau 4446: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4447: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4448: <dd><p>Use these variables to override the default
4449: options for an extract command, which are defined in
4450: <code class="filename">mk/extract/extract</code>.</p></dd>
4451: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4452: <dd><p>This variable can be set to
4453: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4454: (which is the default value), <code class="literal">pax</code>, or an
4455: absolute pathname pointing to the command with which tar
4456: archives should be extracted. It is preferred to choose bsdtar over gtar
4457: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 4458: </dl></div>
1.184 rillig 4459: <p>If the <code class="filename">extract</code> program doesn't
4460: serve your needs, you can also override the
4461: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4462: command used for extracting the files. This command is
4463: executed in the <code class="filename">${WRKSRC}</code>
4464: directory. During execution of this command, the shell
4465: variable <code class="varname">extract_file</code> holds the absolute
4466: pathname of the file that is going to be extracted.</p>
4467: <p>And if that still does not suffice, you can override the
4468: <code class="varname">do-extract</code> target in the package
4469: Makefile.</p>
1.1 dsieger 4470: </div>
1.41 asau 4471: <div class="sect1">
1.1 dsieger 4472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4473: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4474: <p>After extraction, all the patches named by the
4475: <code class="varname">PATCHFILES</code>, those present in the patches
4476: subdirectory of the package as well as in
4477: $LOCALPATCHES/$PKGPATH (e.g.
4478: <code class="filename">/usr/local/patches/graphics/png</code>) are
4479: applied. Patchfiles ending in <code class="filename">.Z</code> or
4480: <code class="filename">.gz</code> are uncompressed before they are
4481: applied, files ending in <code class="filename">.orig</code> or
4482: <code class="filename">.rej</code> are ignored. Any special options to
1.207 leot 4483: <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 4484: <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 4485: <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 4486: fail if the expected text from the patch context is not found in the
4487: patched file. If that happens, fix the patch file by comparing it
4488: with the actual text in the file to be patched.</p>
1.1 dsieger 4489: </div>
1.41 asau 4490: <div class="sect1">
1.1 dsieger 4491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4492: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4493: <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>.
4494: </p>
1.1 dsieger 4495: </div>
1.41 asau 4496: <div class="sect1">
1.1 dsieger 4497: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4498: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4499: <p>This phase creates wrapper programs for the compilers and
4500: linkers. The following variables can be used to tweak the
4501: wrappers.</p>
4502: <div class="variablelist"><dl class="variablelist">
4503: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4504: <dd><p>The command used to print progress
4505: messages. Does nothing by default. Set to
4506: <code class="literal">${ECHO}</code> to see the progress
4507: messages.</p></dd>
4508: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4509: <dd><p>This variable can be set to
4510: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4511: depending on whether you want additional information in the
4512: wrapper log file.</p></dd>
4513: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4514: <dd><p>This variable can be set to
4515: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4516: on whether the wrapper should use its cache, which will
4517: improve the speed. The default value is
4518: <code class="literal">yes</code>, but is forced to
4519: <code class="literal">no</code> if the platform does not support
4520: it.</p></dd>
4521: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4522: <dd><p>A list of reordering commands. A reordering
4523: command has the form
4524: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4525: It ensures that that
4526: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4527: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4528: </p></dd>
4529: </dl></div>
4530: </div>
4531: <div class="sect1">
4532: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4533: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4534: <p>Most pieces of software need information on the header
4535: files, system calls, and library routines which are available
4536: on the platform they run on. The process of determining this
4537: information is known as configuration, and is usually
4538: automated. In most cases, a script is supplied with the
4539: distfiles, and its invocation results in generation of header
4540: files, Makefiles, etc.</p>
4541: <p>If the package contains a configure script, this can be
4542: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4543: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4544: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.187 rillig 4545: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4546: <p>In the <code class="literal">do-configure</code> stage, a rough
4547: equivalent of the following command is run. See
4548: <code class="filename">mk/configure/configure.mk</code>, target
4549: <code class="literal">do-configure-script</code> for the exact
4550: definition.</p>
4551: <pre class="programlisting">
4552: .for dir in ${CONFIGURE_DIRS}
4553: cd ${WRKSRC} && cd ${dir} \
4554: && env ${CONFIGURE_ENV} \
4555: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 4556: .endfor
1.1 dsieger 4557: </pre>
1.184 rillig 4558: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4559: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4560: <code class="varname">WRKSRC</code>. In each of these directories, the
4561: configure script is run with the environment
4562: <code class="varname">CONFIGURE_ENV</code> and arguments
4563: <code class="varname">CONFIGURE_ARGS</code>. The variables
4564: <code class="varname">CONFIGURE_ENV</code>,
4565: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4566: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4567: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4568: package.</p>
4569: <p>If the program uses the Perl way of configuration (mainly Perl
4570: modules, but not only), i.e. a file called
4571: <code class="filename">Makefile.PL</code>, it should include
4572: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4573: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4574: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4575: <p>If the program uses an <code class="filename">Imakefile</code>
4576: for configuration, the appropriate steps can be invoked by
4577: setting <code class="varname">USE_IMAKE</code> to
4578: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4579: You can add variables to xmkmf's environment by adding them to the
4580: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4581: <p>If the program uses <code class="filename">cmake</code>
4582: for configuration, the appropriate steps can be invoked by
1.233 wiz 4583: including <code class="filename">../../devel/cmake/build.mk</code>.
1.184 rillig 4584: You can add variables to cmake's environment by adding them to the
4585: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
4586: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
1.233 wiz 4587: If you want to add arguments only for particular stages, you can use the
4588: <code class="varname">CMAKE_CONFIGURE_ARGS</code>,
4589: <code class="varname">CMAKE_BUILD_ARGS</code>, and
4590: <code class="varname">CMAKE_INSTALL_ARGS</code> variables.
4591: You can set the <code class="varname">CONFIGURE_DIRS</code> variable to the
4592: directories in which CMake should be run, relative to
4593: <code class="varname">WRKSRC</code>. This defaults to to <span class="quote">“<span class="quote">.</span>”</span>.
4594: </p>
1.184 rillig 4595: <p>If there is no configure step at all, set
4596: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4597: </div>
1.41 asau 4598: <div class="sect1">
1.1 dsieger 4599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4600: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.187 rillig 4601: <p>For building a package, a rough equivalent of the following
4602: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4603: <code class="literal">do-build</code> for the exact definition.</p>
1.1 dsieger 4604: <pre class="programlisting">
1.187 rillig 4605: .for dir in ${BUILD_DIRS}
4606: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 4607: && env ${MAKE_ENV} \
1.187 rillig 4608: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 4609: -f ${MAKE_FILE} \
4610: ${BUILD_TARGET}
4611: .endfor
1.1 dsieger 4612: </pre>
1.184 rillig 4613: <p><code class="varname">BUILD_DIRS</code> (default:
4614: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4615: <code class="varname">WRKSRC</code>. In each of these directories,
4616: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4617: <code class="varname">MAKE_ENV</code> and arguments
4618: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4619: <code class="varname">MAKE_ENV</code>,
4620: <code class="varname">BUILD_MAKE_FLAGS</code>,
4621: <code class="varname">MAKE_FILE</code> and
4622: <code class="varname">BUILD_TARGET</code> may all be changed by the
4623: package.</p>
4624: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4625: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4626: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4627: default value of <code class="varname">MAKE_FILE</code> is
4628: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4629: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4630: <p>If there is no build step at all, set
4631: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4632: </div>
1.41 asau 4633: <div class="sect1">
1.1 dsieger 4634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4635: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4636: <p>[TODO]</p>
1.1 dsieger 4637: </div>
1.41 asau 4638: <div class="sect1">
1.1 dsieger 4639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4640: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4641: <p>Once the build stage has completed, the final step is to
4642: install the software in public directories, so users can
4643: access the programs and files.</p>
1.187 rillig 4644: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4645: of the following code is executed; see
4646: <code class="filename">mk/install/install.mk</code>, target
4647: <code class="literal">do-install</code> for the exact definition. Additionally,
4648: before and after this code, several consistency checks are run
4649: against the files-to-be-installed, see
4650: <code class="filename">mk/check/*.mk</code> for details.</p>
4651: <pre class="programlisting">
4652: .for dir in ${INSTALL_DIRS}
4653: cd ${WRKSRC} && cd ${dir} \
4654: && env ${INSTALL_ENV} ${MAKE_ENV} \
4655: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4656: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 4657: .endfor
1.1 dsieger 4658: </pre>
1.184 rillig 4659: <p>The variable's meanings are analogous to the ones in the
4660: <span class="emphasis"><em>build</em></span> phase.
4661: <code class="varname">INSTALL_DIRS</code> defaults to
4662: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4663: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4664: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4665: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4666: defined.</p>
4667: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4668: variables are useful. They are all variations of the
1.207 leot 4669: <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 4670: permissions preset. <code class="varname">INSTALL</code> is the plain
4671: install command. The specialized variants, together with their
4672: intended use, are:</p>
4673: <div class="variablelist"><dl class="variablelist">
4674: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4675: <dd><p>directories that contain
4676: binaries</p></dd>
4677: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4678: <dd><p>directories that contain
4679: scripts</p></dd>
4680: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4681: <dd><p>directories that contain shared and static
4682: libraries</p></dd>
4683: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4684: <dd><p>directories that contain data
4685: files</p></dd>
4686: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4687: <dd><p>directories that contain man
4688: pages</p></dd>
4689: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4690: <dd><p>directories that contain data files for games
4691: </p></dd>
4692: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4693: <dd><p>binaries that can be stripped from debugging
4694: symbols</p></dd>
4695: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4696: <dd><p>binaries that cannot be
4697: stripped</p></dd>
4698: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4699: <dd><p>game
4700: binaries</p></dd>
4701: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4702: <dd><p>shared and static
4703: libraries</p></dd>
4704: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4705: <dd><p>data files</p></dd>
4706: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4707: <dd><p>data files for
4708: games</p></dd>
4709: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4710: <dd><p>man pages</p></dd>
4711: </dl></div>
4712: <p>Some other variables are:</p>
4713: <div class="variablelist"><dl class="variablelist">
4714: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.207 leot 4715: <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 4716: when installing binaries. Any debugging sections and symbols present in
4717: binaries will be preserved.
4718: </p></dd>
4719: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4720: <dd><p>A list of directories relative to
4721: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4722: beginning of the <span class="emphasis"><em>install</em></span> phase.
4723: The package is supposed to create all needed directories itself
4724: before installing files to it and list all other directories here.
4725: </p></dd>
4726: </dl></div>
4727: <p>In the rare cases that a package shouldn't install anything,
4728: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4729: mostly relevant for packages in the <code class="filename">regress</code>
4730: category.</p>
1.1 dsieger 4731: </div>
1.41 asau 4732: <div class="sect1">
1.1 dsieger 4733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4734: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4735: <p>Once the install stage has completed, a binary package of
4736: the installed files can be built. These binary packages can be
4737: used for quick installation without previous compilation, e.g. by
4738: the <span class="command"><strong>make bin-install</strong></span> or by using
4739: <span class="command"><strong>pkg_add</strong></span>.</p>
4740: <p>By default, the binary packages are created in
4741: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4742: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4743: one for each category in the <code class="varname">CATEGORIES</code>
4744: variable. <code class="varname">PACKAGES</code> defaults to
4745: <code class="filename">pkgsrc/packages</code>.</p>
1.1 dsieger 4746: </div>
1.41 asau 4747: <div class="sect1">
1.1 dsieger 4748: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4749: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4750: <p>Once you're finished with a package, you can clean the work
4751: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4752: to clean the work directories of all dependencies too, use
4753: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 4754: </div>
1.41 asau 4755: <div class="sect1">
1.1 dsieger 4756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4757: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.41 asau 4758: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4759: <dt><span class="term">pre/post-*</span></dt>
4760: <dd>
4761: <p>For any of the main targets described in the previous
4762: section (configure, build, install, etc.), two auxiliary
4763: targets exist with
4764: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4765: prefix for the main target's name. These targets are
4766: invoked before and after the main target is called,
4767: allowing extra configuration or installation steps be
4768: performed from a package's Makefile, for example, which
4769: a program's configure script or install target
4770: omitted.</p>
4771: <p>About 5% of the pkgsrc packages define their custom
4772: post-extract target, another 5% define pre-configure, and 10%
4773: define post-install. The other pre/post-* targets are defined
4774: even less often.</p>
4775: </dd>
4776: <dt><span class="term">do-*</span></dt>
1.1 dsieger 4777: <dd>
1.184 rillig 4778: <p>Should one of the main targets do the wrong thing,
4779: and should there be no variable to fix this, you can
4780: redefine it with the do-* target. (Note that redefining
4781: the target itself instead of the do-* target is a bad
4782: idea, as the pre-* and post-* targets won't be called
4783: anymore, etc.)</p>
4784: <p>About 15% of the pkgsrc packages override the default
4785: do-install, the other do-* targets are overridden even less
4786: often.</p>
1.1 dsieger 4787: </dd>
1.184 rillig 4788: <dt><span class="term">reinstall</span></dt>
1.1 dsieger 4789: <dd>
1.184 rillig 4790: <p>If you did a <span class="command"><strong>make install</strong></span> and
4791: you noticed some file was not installed properly, you
4792: can repeat the installation with this target, which will
4793: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4794: <p>This is the default value of
4795: <code class="varname">DEPENDS_TARGET</code> except in the case of
4796: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4797: package</strong></span>, where the defaults are
4798: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4799: respectively.</p>
1.1 dsieger 4800: </dd>
1.184 rillig 4801: <dt><span class="term">deinstall</span></dt>
4802: <dd>
1.207 leot 4803: <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 4804: current directory, effectively de-installing the
4805: package. The following variables can be used to tune the
4806: behaviour:</p>
4807: <div class="variablelist"><dl class="variablelist">
4808: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.207 leot 4809: <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 4810: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4811: <dd><p>Remove all packages that require (depend on)
4812: the given package. This can be used to remove any
4813: packages that may have been pulled in by a given
4814: package, e.g. if <span class="command"><strong>make deinstall
4815: DEINSTALLDEPENDS=1</strong></span> is done in
4816: <code class="filename">pkgsrc/x11/kde</code>, this is
4817: likely to remove whole KDE. Works by adding
1.207 leot 4818: <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 4819: command line.</p></dd>
4820: </dl></div>
4821: </dd>
4822: <dt><span class="term">bin-install</span></dt>
4823: <dd><p>Install a binary package from local disk and via FTP
4824: from a list of sites (see the
4825: <code class="varname">BINPKG_SITES</code> variable), and do a
4826: <span class="command"><strong>make package</strong></span> if no binary package is
4827: available anywhere. The arguments given to
4828: <span class="command"><strong>pkg_add</strong></span> can be set via
4829: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4830: operation, etc.</p></dd>
4831: <dt><span class="term">install-clean</span></dt>
4832: <dd><p>This target removes the state files for the "install" and later
4833: phases so that the "install" target may be re-invoked. This can be
4834: used after editing the PLIST to install the package without
4835: rebuilding it.</p></dd>
4836: <dt><span class="term">build-clean</span></dt>
4837: <dd><p>This target removes the state files for the "build" and later
4838: phases so that the "build" target may be re-invoked.</p></dd>
4839: <dt><span class="term">update</span></dt>
4840: <dd>
4841: <p>This target causes the current package to be
4842: updated to the latest version. The package and all
4843: depending packages first get de-installed, then current
4844: versions of the corresponding packages get compiled and
4845: installed. This is similar to manually noting which
4846: packages are currently installed, then performing a
4847: series of <span class="command"><strong>make deinstall</strong></span> and
4848: <span class="command"><strong>make install</strong></span> (or whatever
4849: <code class="varname">UPDATE_TARGET</code> is set to) for these
4850: packages.</p>
4851: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4852: resume package updating in case a previous <span class="command"><strong>make
4853: update</strong></span> was interrupted for some reason.
4854: However, in this case, make sure you don't call
4855: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4856: list of dependent packages in <code class="varname">WRKDIR</code>.
4857: Otherwise, you lose the ability to automatically update
4858: the current package along with the dependent packages
4859: you have installed.</p>
4860: <p>Resuming an interrupted <span class="command"><strong>make
4861: update</strong></span> will only work as long as the package
4862: tree remains unchanged. If the source code for one of
4863: the packages to be updated has been changed, resuming
4864: <span class="command"><strong>make update</strong></span> will most certainly
4865: fail!</p>
4866: <p>The following variables can be used either on the
4867: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4868: alter the behaviour of <span class="command"><strong>make
4869: update</strong></span>:</p>
4870: <div class="variablelist"><dl class="variablelist">
4871: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4872: <dd><p>Install target to recursively use for the
4873: updated package and the dependent packages.
4874: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4875: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4876: <span class="command"><strong>make update</strong></span>. Other good
4877: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4878: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4879: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4880: endless loop!</p></dd>
4881: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4882: <dd><p>Don't clean up after updating. Useful if
4883: you want to leave the work sources of the updated
4884: packages around for inspection or other purposes.
4885: Be sure you eventually clean up the source tree
4886: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4887: or you may run into troubles with old source code
4888: still lying around on your next
4889: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4890: update</strong></span>.</p></dd>
4891: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4892: <dd><p>Deinstall each package before installing
4893: (making <code class="varname">DEPENDS_TARGET</code>). This
4894: may be necessary if the
4895: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4896: called after interrupting a running <span class="command"><strong>make
4897: update</strong></span>.</p></dd>
4898: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4899: <dd><p>Allows you to disable recursion and hardcode
4900: the target for packages. The default is
4901: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4902: facilitating a recursive update of prerequisite
4903: packages. Only set
4904: <code class="varname">DEPENDS_TARGET</code> if you want to
4905: disable recursive updates. Use
4906: <code class="varname">UPDATE_TARGET</code> instead to just
4907: set a specific target for each package to be
4908: installed during <span class="command"><strong>make update</strong></span>
4909: (see above).</p></dd>
4910: </dl></div>
4911: </dd>
4912: <dt><span class="term">clean-update</span></dt>
4913: <dd>
4914: <p>Clean the source tree for all packages that would
4915: get updated if <span class="command"><strong>make update</strong></span> was called
4916: from the current directory. This target should not be
4917: used if the current package (or any of its depending
4918: packages) have already been de-installed (e.g., after
4919: calling <span class="command"><strong>make update</strong></span>) or you may lose
4920: some packages you intended to update. As a rule of
4921: thumb: only use this target <span class="emphasis"><em>before</em></span>
4922: the first time you run <span class="command"><strong>make update</strong></span>
4923: and only if you have a dirty package tree (e.g., if you
4924: used <code class="varname">NOCLEAN</code>).</p>
4925: <p>If you are unsure about whether your tree is
4926: clean, you can either perform a <span class="command"><strong>make
4927: clean</strong></span> at the top of the tree, or use the
4928: following sequence of commands from the directory of the
4929: package you want to update (<span class="emphasis"><em>before</em></span>
4930: running <span class="command"><strong>make update</strong></span> for the first
4931: time, otherwise you lose all the packages you wanted to
4932: update!):</p>
4933: <pre class="screen">
4934: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
4935: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
4936: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
4937: </pre>
4938: <p>The following variables can be used either on the
4939: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
4940: <span class="command"><strong>make clean-update</strong></span>:</p>
4941: <div class="variablelist"><dl class="variablelist">
4942: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
4943: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
4944: reconstruct the list of directories to update for
4945: this package. Only use this if <span class="command"><strong>make
4946: update</strong></span> successfully installed all
4947: packages you wanted to update. Normally, this is
4948: done automatically on <span class="command"><strong>make
4949: update</strong></span>, but may have been suppressed by
4950: the <code class="varname">NOCLEAN</code> variable (see
4951: above).</p></dd>
4952: </dl></div>
4953: </dd>
4954: <dt><span class="term">replace</span></dt>
4955: <dd>
4956: <p>Update the installation of the current package. This
4957: differs from update in that it does not replace dependent
1.207 leot 4958: 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 4959: target to work.</p>
4960: <p><span class="emphasis"><em>Be careful when using this
4961: target!</em></span> There are no guarantees that dependent
4962: packages will still work, in particular they will most
4963: certainly break if you <span class="command"><strong>make replace</strong></span> a
4964: library package whose shared library major version changed
4965: between your installed version and the new one. For this
4966: reason, this target is not officially supported and only
4967: recommended for advanced users.</p>
4968: </dd>
4969: <dt><span class="term">info</span></dt>
1.207 leot 4970: <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 4971: package. You can use this to check which version of a
4972: package is installed.</p></dd>
4973: <dt><span class="term">index</span></dt>
4974: <dd>
4975: <p>This is a top-level command, i.e. it should be used in
4976: the <code class="filename">pkgsrc</code> directory. It creates a
4977: database of all packages in the local pkgsrc tree, including
4978: dependencies, comment, maintainer, and some other useful
4979: information. Individual entries are created by running
4980: <span class="command"><strong>make describe</strong></span> in the packages'
4981: directories. This index file is saved as
4982: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
4983: verbose format by running <span class="command"><strong>make
4984: print-index</strong></span>. You can search in it with
4985: <span class="command"><strong>make search
4986: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
4987: extract a list of all packages that depend on a particular
4988: one by running <span class="command"><strong>make show-deps
4989: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
4990: <p>Running this command takes a very long time, some
4991: hours even on fast machines!</p>
4992: </dd>
4993: <dt><span class="term">readme</span></dt>
4994: <dd>
4995: <p>This target generates a
1.199 nia 4996: <code class="filename">index.html</code> file, which can be
1.207 leot 4997: 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 4998: contain references to any packages which are in the
4999: <code class="varname">PACKAGES</code> directory on the local
5000: host. The generated files can be made to refer to URLs
5001: based on <code class="varname">FTP_PKG_URL_HOST</code> and
5002: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.199 nia 5003: wanted to generate <code class="filename">index.html</code>
1.184 rillig 5004: files which pointed to binary packages on the local
5005: machine, in the directory
5006: <code class="filename">/usr/packages</code>, set
5007: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
5008: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
5009: <code class="varname">${PACKAGES}</code> directory and its
5010: subdirectories will be searched for all the binary
5011: packages.</p>
5012: <p>The target can be run at the toplevel or in category
5013: directories, in which case it descends recursively.</p>
5014: </dd>
5015: <dt><span class="term">readme-all</span></dt>
5016: <dd><p>This is a top-level command, run it in
5017: <code class="filename">pkgsrc</code>. Use this target to create a
5018: file <code class="filename">README-all.html</code> which contains a
5019: list of all packages currently available in the NetBSD
5020: Packages Collection, together with the category they belong
5021: to and a short description. This file is compiled from the
1.199 nia 5022: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.184 rillig 5023: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
5024: readme</strong></span>.</p></dd>
5025: <dt><span class="term">cdrom-readme</span></dt>
5026: <dd><p>This is very much the same as the
5027: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
5028: used when generating a pkgsrc tree to be written to a
5029: CD-ROM. This target also produces
1.199 nia 5030: <code class="filename">index.html</code> files, and can be made
1.184 rillig 5031: to refer to URLs based on
5032: <code class="varname">CDROM_PKG_URL_HOST</code> and
5033: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
5034: <dt><span class="term">show-distfiles</span></dt>
5035: <dd><p>This target shows which distfiles and patchfiles
5036: are needed to build the package
5037: (<code class="varname">ALLFILES</code>, which contains all
5038: <code class="varname">DISTFILES</code> and
5039: <code class="varname">PATCHFILES</code>, but not
5040: <code class="filename">patches/*</code>).</p></dd>
5041: <dt><span class="term">show-downlevel</span></dt>
5042: <dd><p>This target shows nothing if the package is not
5043: installed. If a version of this package is installed,
5044: but is not the version provided in this version of
5045: pkgsrc, then a warning message is displayed. This target
5046: can be used to show which of your installed packages are
5047: downlevel, and so the old versions can be deleted, and
5048: the current ones added.</p></dd>
5049: <dt><span class="term">show-pkgsrc-dir</span></dt>
5050: <dd><p>This target shows the directory in the pkgsrc
5051: hierarchy from which the package can be built and
5052: installed. This may not be the same directory as the one
5053: from which the package was installed. This target is
5054: intended to be used by people who may wish to upgrade
5055: many packages on a single host, and can be invoked from
5056: the top-level pkgsrc Makefile by using the
5057: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
5058: <dt><span class="term">show-installed-depends</span></dt>
5059: <dd><p>This target shows which installed packages match
5060: the current package's <code class="varname">DEPENDS</code>. Useful
5061: if out of date dependencies are causing build
5062: problems.</p></dd>
5063: <dt><span class="term">print-build-depends-list</span></dt>
5064: <dd><p>This target shows the list of packages that the current package
5065: depends on for building.</p></dd>
5066: <dt><span class="term">print-run-depends-list</span></dt>
5067: <dd><p>This target shows the list of packages that the current package
5068: depends on for running.</p></dd>
5069: <dt><span class="term">check-shlibs</span></dt>
5070: <dd><p>After a package is installed, check all its
5071: binaries and (on ELF platforms) shared libraries to see
5072: if they find the shared libs they need. Run by default
5073: 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>
5074: <dt><span class="term">print-PLIST</span></dt>
5075: <dd>
5076: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5077: upgraded pkg, this prints out an attempt to generate a
5078: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5079: -newer work/.extract_done</strong></span>. An attempt is made
5080: to care for shared libs etc., but it is
5081: <span class="emphasis"><em>strongly</em></span> recommended to review the
5082: result before putting it into
5083: <code class="filename">PLIST</code>. On upgrades, it's useful to
5084: diff the output of this command against an already
5085: existing <code class="filename">PLIST</code> file.</p>
1.207 leot 5086: <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 5087: other methods that don't update file access times, be
5088: sure to add these files manually to your
5089: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5090: -newer</span>”</span> command used by this target won't catch
5091: them!</p>
5092: <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
5093: information on this target.</p>
5094: </dd>
5095: </dl></div>
5096: </div>
5097: </div>
5098: <div class="chapter">
5099: <div class="titlepage"><div><div><h2 class="title">
5100: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5101: <div class="toc">
5102: <p><b>Table of Contents</b></p>
5103: <dl class="toc">
5104: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5105: <dd><dl>
1.219 nia 5106: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
5107: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
5108: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.184 rillig 5109: </dl></dd>
5110: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5111: <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>
5112: </dl>
5113: </div>
5114: <p>When you find a package that is not yet in pkgsrc, you
5115: most likely have a URL from where you can download the source
5116: code. Starting with this URL, creating a package involves only a
5117: few steps.</p>
5118: <div class="procedure"><ol class="procedure" type="1">
5119: <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
5120: enable the basic quality checks.</p></li>
5121: <li class="step">
1.207 leot 5122: <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 5123: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5124: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5125: <span class="command"><strong>mkpatches</strong></span>:</p>
5126: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5127: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5128: </li>
5129: <li class="step">
5130: <p>Choose one of the top-level directories as the category in
5131: which you want to place your package. You can also create a directory of
1.219 nia 5132: your own (maybe called <code class="filename">local</code>). Change into that
5133: category directory:</p>
5134: <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 5135: </li>
5136: <li class="step">
1.219 nia 5137: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
5138: argument the URL of the distribution file (in most cases a
5139: <code class="filename">.tar.gz</code> file). This will download the distribution
5140: file and create the necessary files of the package, based on what's in
5141: the distribution file:</p>
1.184 rillig 5142: <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>
5143: </li>
5144: <li class="step">
5145: <p>Examine the extracted files to determine the dependencies of
5146: your package. Ideally, this is mentioned in some
5147: <code class="filename">README</code> file, but things may differ. For each of
5148: these dependencies, look where it exists in pkgsrc, and if there is a
5149: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5150: line to your package <code class="filename">Makefile</code> which includes that
5151: file just before the last line. If the
5152: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5153: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5154: that the package's include files and libraries are provided.</p>
1.219 nia 5155: <p>If you just need binaries from a dependent package, add a
1.184 rillig 5156: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5157: version of the dependency and where it can be found in pkgsrc. This line
5158: should be placed in the third paragraph. If the dependency is only
5159: needed for building the package, but not when using it, use
5160: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5161: instead of <code class="varname">DEPENDS</code>.
5162: The difference between <code class="varname">TOOL_DEPENDS</code> and
5163: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5164: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.219 nia 5165: packages, i.e. packages for the platform where the package is built;
1.184 rillig 5166: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.219 nia 5167: packages, i.e. packages for the platform for which the package
5168: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
5169: specifies a dependency used only for testing the resulting package
5170: built, using the upstream project's included test suite, on the native
5171: platform.
1.184 rillig 5172: Your package may then look like this:</p>
5173: <pre class="programlisting">
5174: [...]
5175:
5176: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5177: DEPENDS+= screen-[0-9]*:../../misc/screen
5178: DEPENDS+= screen>=4.0:../../misc/screen
5179:
5180: [...]
5181:
5182: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5183: .include "../../devel/glib2/buildlink3.mk"
5184: .include "../../mk/bsd.pkg.mk"
5185: </pre>
5186: </li>
5187: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5188: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5189: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5190: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5191: additional explanations.</p></li>
5192: <li class="step"><p>In many cases the package is not yet ready to build. You can
5193: 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
5194: over there, you can hopefully continue here.</p></li>
5195: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5196: directory from the extracted files. Besides these files, a lot of cache
1.219 nia 5197: files and other system information have been saved in the working
5198: directory, which may have become outdated after you edited the
1.184 rillig 5199: <code class="filename">Makefile</code>.</p></li>
5200: <li class="step">
5201: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5202: 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 5203: <p>If the extracted files from the package need to be fixed, run
5204: multiple rounds of these commands:</p>
5205: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.184 rillig 5206: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5207: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.219 nia 5208: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
5209: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.184 rillig 5210: </li>
5211: <li class="step"><p>When the package builds fine, the next step is to install
5212: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5213: everything works.</p></li>
5214: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5215: contains a list of the files that are installed by the package, is
5216: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5217: >PLIST</strong></span> to generate a probably correct list. Check
5218: the file using your preferred text editor to see if the list of
5219: files looks plausible.</p></li>
5220: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5221: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5222: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5223: had been registered in the database of installed files, but with an
5224: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5225: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5226: registered with the list of files from
5227: <code class="filename">PLIST</code>.</p></li>
5228: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5229: from above again in a single step, making sure that the PLIST is correct
5230: and the whole package is created as intended.</p></li>
1.219 nia 5231: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
5232: left to do.</p></li>
1.184 rillig 5233: <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>
5234: </ol></div>
5235: <div class="sect1">
5236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5237: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5238: <div class="sect2">
5239: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5240: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.184 rillig 5241: <p>Python modules and programs packages are easily created using a
5242: set of predefined variables.</p>
5243: <p>
5244: If some Python versions are not supported by the software, set the
5245: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5246: that are not supported, e.g.
5247: </p>
5248: <pre class="programlisting">
5249: PYTHON_VERSIONS_INCOMPATIBLE= 27
5250: </pre>
5251: <p>
5252: If the packaged software is a Python module, include one of
1.215 wiz 5253: <code class="filename">../../lang/python/egg.mk</code> or
1.184 rillig 5254: <code class="filename">../../lang/python/extension.mk</code>.</p>
1.215 wiz 5255: <p>Most Python packages use setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
1.184 rillig 5256: If the packaged software is using setuptools, you only need
5257: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
1.215 wiz 5258: </p>
1.184 rillig 5259: <p>Either way, the package directory should be called
5260: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5261: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5262: </p>
5263: <pre class="programlisting">
5264: DISTNAME= foopymodule-1.2.10
5265: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5266: </pre>
1.226 gutterid 5267: <p>
5268: For software in PyPi, the name should match what PyPi specifies for
5269: "pip install software".
5270: </p>
1.184 rillig 5271: <p>If it is an application, include
5272: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5273: In order to correctly set the path to the Python interpreter, use the
5274: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5275: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5276: For example:
5277: </p>
5278: <pre class="programlisting">
5279: REPLACE_PYTHON= *.py
5280: </pre>
5281: <p>Some Python modules have separate distributions for Python-2.x
5282: and Python-3.x support. In pkgsrc this is handled by the
5283: <code class="filename">versioned_dependencies.mk</code> file. Set
5284: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
5285: packages that should be depended upon and include
5286: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
5287: then the pkgsrc infrastructure will depend on the appropriate package
5288: version. For example:
5289: </p>
5290: <pre class="programlisting">
5291: PYTHON_VERSIONED_DEPENDENCIES=dialog
5292: </pre>
5293: <p>
5294: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
5295: of supported packages.</p>
5296: </div>
5297: <div class="sect2">
5298: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5299: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.184 rillig 5300: <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>
5301: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.207 leot 5302: 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 5303: Individual packages (and optionally their dependencies) may be created
5304: and updated. R packages generally follow the same form, and most of
5305: the relevant information needed is contained in a
5306: <code class="filename">DESCRIPTION</code> file as part of each R package on
5307: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5308: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5309: creates or updates a package in the canonical form. The resulting
5310: package should be reviewed for correctness.</p>
5311: </div>
5312: <div class="sect2">
5313: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5314: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.184 rillig 5315: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.207 leot 5316: <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 5317: <p>If the TeXlive package name is not known, it may be useful to
5318: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5319: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5320: 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
5321: archive</a>.</p>
5322: <p>If the TeXlive package name is known, download the files from
5323: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5324: archive</a>. For package <code class="filename">foo</code>, you will need
5325: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5326: also have associated documentation packages, so download
5327: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5328: should be placed in the appropriate category directory, which is often
5329: but not always <code class="filename">print</code>. Then run the following
5330: command in the category directory.</p>
5331: <pre class="programlisting">
5332: texlive2pkg foo.tar.xz foo.doc.tar.xz
5333: </pre>
5334: <p>This will create two packages, <code class="filename">tex-foo</code> and
5335: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5336: are correct.</p>
5337: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5338: currently does not include version information in package filenames
5339: and changes their contents periodically when updates occur.
5340: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5341: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5342: main one and the corresponding documentation, upload the distfiles
5343: with the following command in each package directory.</p>
5344: <pre class="programlisting">
5345: make upload-distfiles
5346: </pre>
5347: </div>
5348: </div>
5349: <div class="sect1">
5350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5351: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5352: <div class="sect2">
5353: <div class="titlepage"><div><div><h3 class="title">
5354: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5355: <div class="sect3">
5356: <div class="titlepage"><div><div><h4 class="title">
5357: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5358: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5359: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5360: pkgsrc. As the description says it has to do with the web, the obvious
5361: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5362: <pre class="programlisting">
5363: <code class="prompt">$</code> mkdir www/nvu
5364: <code class="prompt">$</code> cd www/nvu
5365: </pre>
5366: <p>The web site says that the sources are available as a tar file, so
5367: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5368: <pre class="programlisting">
5369: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5370: </pre>
5371: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5372: below the <code class="varname">DISTNAME</code> line, as the package name should
5373: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5374: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5375: <code class="varname">COMMENT</code> fields. Then the package
5376: <code class="filename">Makefile</code> looked like that:</p>
5377: <pre class="programlisting">
5378: # $NetBSD $
5379: #
5380:
5381: DISTNAME= nvu-1.0-sources
5382: PKGNAME= nvu-1.0
5383: CATEGORIES= www
5384: MASTER_SITES= http://cvs.nvu.com/download/
5385: EXTRACT_SUFX= .tar.bz2
5386:
5387: MAINTAINER= rillig@NetBSD.org
5388: HOMEPAGE= http://cvs.nvu.com/
5389: COMMENT= Web Authoring System
5390:
5391: # url2pkg-marker (please do not remove this line.)
5392: .include "../../mk/bsd.pkg.mk"
5393: </pre>
5394: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5395: this is a workaround to prevent CVS expanding to the filename of the
5396: guide.</p>
5397: <p>Then, I quit the editor and watched pkgsrc downloading a large
5398: source archive:</p>
5399: <pre class="programlisting">
5400: url2pkg> Running "make makesum" ...
5401: => Required installed package digest>=20010302: digest-20060826 found
5402: => Fetching nvu-1.0-sources.tar.bz2
5403: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5404: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5405: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5406: url2pkg> Running "make extract" ...
5407: => Required installed package digest>=20010302: digest-20060826 found
5408: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5409: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5410: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5411: ===> Installing dependencies for nvu-1.0
5412: ===> Overriding tools for nvu-1.0
5413: ===> Extracting for nvu-1.0
5414: url2pkg> Adjusting the Makefile.
5415:
5416: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5417:
5418: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5419: </pre>
5420: </div>
5421: <div class="sect3">
5422: <div class="titlepage"><div><div><h4 class="title">
5423: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5424: <p>Now that the package has been extracted, let's see what's inside
5425: it. The package has a <code class="filename">README.txt</code>, but that only
5426: says something about mozilla, so it's probably useless for seeing what
5427: dependencies this package has. But since there is a GNU configure script
5428: in the package, let's hope that it will complain about everything it
5429: needs.</p>
5430: <pre class="programlisting">
5431: <code class="prompt">$</code> bmake
5432: => Required installed package digest>=20010302: digest-20060826 found
5433: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5434: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5435: ===> Patching for nvu-1.0
5436: ===> Creating toolchain wrappers for nvu-1.0
5437: ===> Configuring for nvu-1.0
5438: [...]
5439: configure: error: Perl 5.004 or higher is required.
5440: [...]
5441: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5442: [...]
5443: </pre>
5444: <p>That worked quite well. So I opened the package Makefile in my
5445: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5446: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5447: package have changed now, and since a perl wrapper is automatically
5448: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5449: from scratch.</p>
5450: <pre class="programlisting">
5451: <code class="prompt">$</code> bmake clean
5452: ===> Cleaning for nvu-1.0
5453: <code class="prompt">$</code> bmake
5454: [...]
5455: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5456: GNU Make. You will not be able to build Mozilla without GNU Make.
5457: [...]
5458: </pre>
5459: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5460: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5461: <pre class="programlisting">
5462: [...]
5463: checking for GTK - version >= 1.2.0... no
5464: *** Could not run GTK test program, checking why...
5465: [...]
5466: </pre>
5467: <p>Now to the other dependencies. The first question is: Where is the
5468: GTK package hidden in pkgsrc?</p>
5469: <pre class="programlisting">
5470: <code class="prompt">$</code> echo ../../*/gtk*
5471: [many packages ...]
5472: <code class="prompt">$</code> echo ../../*/gtk
5473: ../../x11/gtk
5474: <code class="prompt">$</code> echo ../../*/gtk2
5475: ../../x11/gtk2
5476: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5477: ../../x11/gtk2/buildlink3.mk
5478: </pre>
5479: <p>The first try was definitely too broad. The second one had exactly
5480: one result, which is very good. But there is one pitfall with GNOME
5481: packages. Before GNOME 2 had been released, there were already many
5482: GNOME 1 packages in pkgsrc. To be able to continue to use these
5483: packages, the GNOME 2 packages were imported as separate packages, and
5484: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5485: whether this was the case here, and indeed it was.</p>
5486: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5487: file, adding the dependency is very easy. I just inserted an
5488: <code class="literal">.include</code> line before the last line of the package
5489: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5490: <pre class="programlisting">
5491: [...]
5492: .include "../../x11/gtk2/buildlink3.mk"
5493: .include "../../mk/bsd.pkg.mk
5494: </pre>
5495: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5496: was:</p>
1.1 dsieger 5497: <pre class="programlisting">
1.184 rillig 5498: [...]
5499: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5500: checking for GTK - version >= 1.2.0... no
5501: *** Could not run GTK test program, checking why...
5502: *** The test program failed to compile or link. See the file config.log for the
5503: *** exact error that occured. This usually means GTK was incorrectly installed
5504: *** or that you have moved GTK since it was installed. In the latter case, you
5505: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5506: configure: error: Test for GTK failed.
5507: [...]
1.111 sevan 5508: </pre>
1.184 rillig 5509: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5510: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5511: told me that this package really wanted to have the GNOME 1 version of
5512: GTK. If the package had looked for GTK2, it would have looked for
5513: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5514: So I changed the <code class="literal">x11/gtk2</code> to
5515: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5516: and tried again.</p>
1.18 snj 5517: <pre class="programlisting">
1.184 rillig 5518: [...]
5519: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5520: In file included from xpidl.c:42:
5521: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5522: In file included from xpidl.c:42:
5523: xpidl.h:132: error: parse error before "IDL_ns"
5524: [...]
1.111 sevan 5525: </pre>
1.184 rillig 5526: <p>The package still does not find all of its dependencies. Now the
5527: question is: Which package provides the
5528: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.18 snj 5529: <pre class="programlisting">
1.184 rillig 5530: <code class="prompt">$</code> echo ../../*/*idl*
5531: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5532: <code class="prompt">$</code> echo ../../*/*IDL*
5533: ../../net/libIDL
1.111 sevan 5534: </pre>
1.184 rillig 5535: <p>Let's take the one from the second try. So I included the
5536: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5537: again. But the error didn't change. After digging through some of the
5538: code, I concluded that the build process of the package was broken and
5539: couldn't have ever worked, but since the Mozilla source tree is quite
5540: large, I didn't want to fix it. So I added the following to the package
5541: <code class="filename">Makefile</code> and tried again:</p>
1.86 wiz 5542: <pre class="programlisting">
1.184 rillig 5543: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5544: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.111 sevan 5545: </pre>
1.184 rillig 5546: <p>The latter line is needed because the package expects the library
5547: <code class="filename">libIDL.so</code>, but only
5548: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5549: wrapper to rewrite that on the fly.</p>
5550: <p>The next problem was related to a recent change of the FreeType
1.207 leot 5551: 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 5552: which patch files were relevant for this issue and copied them to the
5553: <code class="filename">patches</code> directory. Then I retried, fixed the
5554: patches so that they applied cleanly and retried again. This time,
5555: everything worked.</p>
1.86 wiz 5556: </div>
1.184 rillig 5557: <div class="sect3">
5558: <div class="titlepage"><div><div><h4 class="title">
5559: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 5560: <pre class="programlisting">
1.184 rillig 5561: <code class="prompt">$</code> bmake CHECK_FILES=no install
5562: [...]
5563: <code class="prompt">$</code> bmake print-PLIST >PLIST
5564: <code class="prompt">$</code> bmake deinstall
5565: <code class="prompt">$</code> bmake install
1.111 sevan 5566: </pre>
1.184 rillig 5567: </div>
5568: </div>
1.1 dsieger 5569: </div>
5570: </div>
1.41 asau 5571: <div class="chapter">
1.1 dsieger 5572: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 5573: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 5574: <div class="toc">
5575: <p><b>Table of Contents</b></p>
1.100 leot 5576: <dl class="toc">
1.184 rillig 5577: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5578: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5579: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5580: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5581: <dd><dl>
5582: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5583: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5584: <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>
5585: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 5586: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.1 dsieger 5587: </dl></dd>
5588: </dl>
5589: </div>
1.184 rillig 5590: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5591: each of which forms a well-defined part of the pkgsrc system. Using
1.207 leot 5592: 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 5593: like pkgsrc requires some discipline to keep the code correct and
5594: understandable.</p>
5595: <p>The basic ingredients for <code class="filename">Makefile</code>
5596: programming are variables and shell
5597: commands. Among these shell commands may even be more complex ones
1.207 leot 5598: 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 5599: as intended it is necessary to quote all variables correctly when they
5600: are used.</p>
5601: <p>This chapter describes some patterns that appear quite often in
5602: <code class="filename">Makefile</code>s, including the pitfalls that come along
5603: with them.</p>
1.41 asau 5604: <div class="sect1">
1.1 dsieger 5605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5606: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5607: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5608: <p>When you are creating a file as a
5609: target of a rule, always write the data to a temporary file first
5610: and finally rename that file. Otherwise there might occur an error
5611: in the middle of generating the file, and when the user runs
1.207 leot 5612: <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 5613: regenerated properly. Example:</p>
1.1 dsieger 5614: <pre class="programlisting">
1.184 rillig 5615: wrong:
5616: @echo "line 1" > ${.TARGET}
5617: @echo "line 2" >> ${.TARGET}
5618: @false
5619:
5620: correct:
5621: @echo "line 1" > ${.TARGET}.tmp
5622: @echo "line 2" >> ${.TARGET}.tmp
5623: @false
5624: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 5625: </pre>
1.184 rillig 5626: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5627: <code class="filename">wrong</code> will exist, although there was an error
5628: message in the first run. On the other hand, running <span class="command"><strong>make
5629: correct</strong></span> gives an error message twice, as expected.</p>
1.207 leot 5630: <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 5631: <code class="literal">${.TARGET}</code> in case of error, but this only
5632: happens when it is interrupted, for example by pressing
5633: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.207 leot 5634: 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 5635: </li></ul></div>
5636: </div>
5637: <div class="sect1">
5638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5639: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5640: <p><code class="filename">Makefile</code> variables contain strings that
5641: can be processed using the five operators <code class="code">=</code>,
5642: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.207 leot 5643: <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 5644: page.</p>
5645: <p>When a variable's value is parsed from a
5646: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5647: the backslash character <code class="code">\</code> are handled specially. If a
5648: backslash is the last character in a line, that backslash is removed
5649: from the line and the line continues with the next line of the file.</p>
5650: <p>The <code class="code">#</code> character starts a comment that reaches
5651: until the end of the line. To get an actual <code class="code">#</code> character,
5652: such as in a URL, write <code class="code">\#</code> instead.</p>
5653: <p>The evaluation of variables either happens immediately or lazy.
5654: It happens immediately when the variable occurs on the right-hand
5655: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5656: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5657: In the other cases, it is evaluated lazily.</p>
5658: <p>Some of the modifiers split the string into words and then
5659: operate on the words, others operate on the string as a whole. When a
5660: string is split into words, double quotes and single quotes are
1.207 leot 5661: 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 5662: <div class="sect2">
5663: <div class="titlepage"><div><div><h3 class="title">
5664: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5665: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5666: <li class="listitem"><p>All variable names starting with an underscore
5667: are reserved for use by the pkgsrc infrastructure. They shall
5668: not be used by packages.</p></li>
5669: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5670: lowercase variable names for the iteration
5671: variables.</p></li>
5672: <li class="listitem"><p>All list variables should have a plural name,
5673: such as <code class="varname">PKG_OPTIONS</code> or
5674: <code class="varname">DISTFILES</code>.</p></li>
5675: </ul></div>
5676: </div>
5677: </div>
5678: <div class="sect1">
5679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5680: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5681: <div class="sect2">
5682: <div class="titlepage"><div><div><h3 class="title">
5683: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5684: <p>When adding a string that possibly contains whitespace or quotes to
5685: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5686: modifier.</p>
5687: <p>When adding another list to a list (example 2), it must not be
5688: quoted, since its elements are already quoted.</p>
1.1 dsieger 5689: <pre class="programlisting">
1.184 rillig 5690: STRING= foo * bar `date`
5691: LIST= # empty
5692: ANOTHER_LIST= a=b c=d
5693:
5694: LIST+= ${STRING:Q} # 1
5695: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 5696: </pre>
1.184 rillig 5697: </div>
5698: <div class="sect2">
5699: <div class="titlepage"><div><div><h3 class="title">
5700: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5701: <p>Echoing a string containing special characters needs special
5702: work.</p>
1.1 dsieger 5703: <pre class="programlisting">
1.184 rillig 5704: STRING= foo bar < > * `date` $$HOME ' "
5705: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5706:
5707: all:
5708: echo ${STRING} # 1
5709: echo ${STRING:Q} # 2
5710: printf '%s\n' ${STRING:Q}'' # 3
5711: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 5712: </pre>
1.184 rillig 5713: <p>Example 1 leads to a syntax error in the shell, as the characters
5714: are just copied.</p>
5715: <p>Example 2 quotes the string so that the shell interprets it
5716: correctly. But the echo command may additionally interpret strings with a
5717: leading dash or those containing backslashes.</p>
1.207 leot 5718: <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 5719: interprets the format string, but not the next argument. The trailing
5720: single quotes handle the case when the string is empty. In that case, the
5721: :Q modifier would result in an empty string too, which would then be
1.207 leot 5722: 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 5723: but other programs may care.</p>
5724: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5725: need to be quoted because the quoting has already been done
5726: when adding elements to the list.</p>
1.1 dsieger 5727: </div>
1.41 asau 5728: <div class="sect2">
1.1 dsieger 5729: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 5730: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5731: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5732: GNU-style configure script (especially those that call other configure
5733: scripts), it must not have leading or trailing whitespace, since
5734: otherwise the configure script gets confused. To trim leading and
5735: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5736: following example:</p>
1.1 dsieger 5737: <pre class="programlisting">
1.184 rillig 5738: CPPFLAGS= # empty
5739: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5740: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 5741:
1.184 rillig 5742: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 5743:
1.184 rillig 5744: all:
5745: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5746: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5747: </pre>
5748: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5749: trailing whitespace because the <code class="code">+=</code> operator always adds a
5750: space.</p>
5751: </div>
5752: <div class="sect2">
5753: <div class="titlepage"><div><div><h3 class="title">
5754: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5755: <p>When a possibly empty variable is used in a shell program, it may
5756: lead to a syntax error.</p>
5757: <pre class="programlisting">
5758: EGFILES= # empty
1.1 dsieger 5759:
1.184 rillig 5760: install-examples: # produces a syntax error in the shell
5761: for egfile in ${EGFILES}; do \
5762: echo "Installing $$egfile"; \
5763: done
5764: </pre>
5765: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.207 leot 5766: <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 5767: To fix this syntax error, use one of the snippets below.</p>
5768: <pre class="programlisting">
1.229 gutterid 5769: EGFILES= # empty
1.1 dsieger 5770:
1.184 rillig 5771: install-examples:
5772: for egfile in ${EGFILES} ""; do \
5773: [ -n "$$egfile" ] || continue; \
5774: echo "Installing $$egfile"; \
5775: done
5776: </pre>
5777: <p>In this case, an empty string is appended to the iteration list (to
5778: prevent the syntax error) and filtered out later.</p>
5779: <pre class="programlisting">
5780: EGFILES= # empty
1.1 dsieger 5781:
1.184 rillig 5782: install-examples:
5783: .for egfile in ${EGFILES}
5784: echo "Installing ${egfile}"
5785: .endfor
1.1 dsieger 5786: </pre>
1.184 rillig 5787: <p>If one of the filenames contains special characters, it should be
5788: enclosed in single or double quotes.</p>
5789: <p>To have a shell command test whether a make variable is empty, use
5790: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5791: </div>
1.229 gutterid 5792: <div class="sect2">
5793: <div class="titlepage"><div><div><h3 class="title">
5794: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
5795: <p>When a variable can have the values <code class="literal">yes</code> or
5796: <code class="literal">no</code>, use the following pattern to test the variable:</p>
5797: <pre class="programlisting">
5798: .if ${VAR:U:tl} == "yes"
5799: # do something
5800: .endif
5801: </pre>
5802: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
5803: can be undefined. If the variable is guaranteed to be defined, the
5804: <code class="literal">:U</code> can be omitted.</p>
5805: <p>The <code class="literal">:tl</code> modifier converts the variable value to
5806: lowercase, allowing for the values <code class="literal">yes</code>,
5807: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
5808: </div>
1.184 rillig 5809: </div>
5810: </div>
5811: <div class="chapter">
5812: <div class="titlepage"><div><div><h2 class="title">
5813: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5814: <div class="toc">
5815: <p><b>Table of Contents</b></p>
5816: <dl class="toc">
5817: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5818: <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>
5819: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5820: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5821: </dl>
1.1 dsieger 5822: </div>
1.184 rillig 5823: <p>Many packages have the ability to be built to support different
5824: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5825: in pkgsrc that provides generic handling of those options that
5826: determine different ways in which the packages can be built. It's
5827: possible for the user to specify exactly which sets of options will be
5828: built into a package or to allow a set of global default options
5829: apply.</p>
5830: <p>There are two broad classes of behaviors that one might want to
5831: control via options. One is whether some particular feature is
5832: enabled in a program that will be built anyway, often by including or
5833: not including a dependency on some other package. The other is
5834: whether or not an additional program will be built as part of the
5835: package. Generally, it is better to make a split package for such
5836: additional programs instead of using options, because it enables
5837: binary packages to be built which can then be added separately. For
5838: example, the foo package might have minimal dependencies (those
5839: packages without which foo doesn't make sense), and then the foo-gfoo
5840: package might include the GTK frontend program gfoo. This is better
5841: than including a gtk option to foo that adds gfoo, because either that
5842: option is default, in which case binary users can't get foo without
5843: gfoo, or not default, in which case they can't get gfoo. With split
5844: packages, they can install foo without having GTK, and later decide to
5845: install gfoo (pulling in GTK at that time). This is an advantage to
5846: source users too, avoiding the need for rebuilds.</p>
5847: <p>Plugins with widely varying dependencies should usually be split
5848: instead of options.</p>
5849: <p>It is often more work to maintain split packages, especially if
5850: the upstream package does not support this. The decision of split
5851: vs. option should be made based on the likelihood that users will want
5852: or object to the various pieces, the size of the dependencies that are
5853: included, and the amount of work.</p>
5854: <p>A further consideration is licensing. Non-free parts, or parts
5855: that depend on non-free dependencies (especially plugins) should
5856: almost always be split if feasible.</p>
5857: <div class="sect1">
5858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5859: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5860: <p>Global default options are listed in
5861: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5862: that should be built into every package if that option is supported.
5863: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5864: </div>
1.41 asau 5865: <div class="sect1">
1.1 dsieger 5866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5867: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5868: </h2></div></div></div>
5869: <p>The following example shows how
5870: <code class="filename">bsd.options.mk</code> should be used
5871: by the hypothetical ``wibble'' package, either in the package
5872: <code class="filename">Makefile</code>, or in a file,
5873: e.g. <code class="filename">options.mk</code>, that is included by the
5874: main package <code class="filename">Makefile</code>.</p>
1.1 dsieger 5875: <pre class="programlisting">
1.184 rillig 5876: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5877: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5878: PKG_OPTIONS_OPTIONAL_GROUPS= database
5879: PKG_OPTIONS_GROUP.database= mysql pgsql
5880: PKG_SUGGESTED_OPTIONS= wibble-foo
5881: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5882: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5883:
5884: .include "../../mk/bsd.prefs.mk"
5885:
5886: # this package was previously named wibble2
5887: .if defined(PKG_OPTIONS.wibble2)
5888: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5889: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5890: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5891: .endif
5892:
5893: .include "../../mk/bsd.options.mk"
5894:
5895: # Package-specific option-handling
1.1 dsieger 5896:
1.184 rillig 5897: ###
5898: ### FOO support
5899: ###
5900: .if !empty(PKG_OPTIONS:Mwibble-foo)
5901: CONFIGURE_ARGS+= --enable-foo
5902: .endif
1.1 dsieger 5903:
1.184 rillig 5904: ###
5905: ### LDAP support
5906: ###
5907: .if !empty(PKG_OPTIONS:Mldap)
5908: . include "../../databases/openldap-client/buildlink3.mk"
5909: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5910: .endif
1.1 dsieger 5911:
1.184 rillig 5912: ###
5913: ### database support
5914: ###
5915: .if !empty(PKG_OPTIONS:Mmysql)
5916: . include "../../mk/mysql.buildlink3.mk"
5917: .endif
5918: .if !empty(PKG_OPTIONS:Mpgsql)
5919: . include "../../mk/pgsql.buildlink3.mk"
5920: .endif
5921: </pre>
5922: <p>The first section contains the information about which build
5923: options are supported by the package, and any default options settings
5924: if needed.</p>
5925: <div class="orderedlist"><ol class="orderedlist" type="1">
5926: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.207 leot 5927: <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 5928: options. It should be set to
5929: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5930: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5931: at the point where the options are processed.</p></li>
5932: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
5933: build options supported by the package.</p></li>
5934: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
5935: list of names of groups of mutually exclusive options. The options in
5936: each group are listed in
5937: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5938: The most specific setting of any option from the group takes
5939: precedence over all other options in the group. Options from the
5940: groups will be automatically added to
5941: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
5942: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
5943: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5944: packages will fail if no option from the group is
5945: selected.</p></li>
5946: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
5947: of names of sets of options. At least one option from each set must
5948: be selected. The options in each set are listed in
5949: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5950: Options from the sets will be automatically added to
5951: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5952: fail if no option from the set is selected.</p></li>
5953: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
5954: build options which are enabled by default.</p></li>
5955: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
5956: of
5957: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
5958: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
5959: their option counterparts. Pairs should be added with
5960: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
5961: warning will be issued if the user uses a legacy
5962: variable.</p></li>
5963: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
5964: of
5965: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
5966: pairs that map options that have been renamed to their new
5967: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
5968: the listing of global legacy options. A warning will be issued if
5969: the user uses a legacy option.</p></li>
5970: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
5971: options implied by deprecated variables used. This can be used for
5972: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5973: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5974: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
5975: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
5976: a list of warnings about deprecated variables or options used, and
5977: what to use instead.</p></li>
5978: </ol></div>
5979: <p>A package should never modify
5980: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5981: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5982: To suggest a default set of options, use
5983: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5984: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5985: including <code class="filename">bsd.options.mk</code>. If none of
5986: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5987: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5988: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5989: happen with platform-specific options if none of them is supported on
5990: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5991: empty list and the package is otherwise treated as not using the
5992: options framework.</p>
5993: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5994: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5995: build options, properly filtered to remove unsupported and duplicate
5996: options.</p>
5997: <p>The remaining sections contain the logic that is specific to
5998: each option. The correct way to check for an option is to check
5999: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6000: <pre class="programlisting">
6001: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.1 dsieger 6002: </pre>
6003: </div>
1.184 rillig 6004: <div class="sect1">
6005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6006: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
6007: <p>Options that enable similar features in different packages (like
6008: optional support for a library) should use a common name in all
6009: packages that support it (like the name of the library). If another
6010: package already has an option with the same meaning, use the same
6011: name.</p>
6012: <p>Options that enable features specific to one package, where it's
6013: unlikely that another (unrelated) package has the same (or a similar)
6014: optional feature, should use a name prefixed with
6015: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6016: <p>If a group of related packages share an optional feature
6017: specific to that group, prefix it with the name of the
6018: <span class="quote">“<span class="quote">main</span>”</span> package
6019: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6020: <p>For new options, add a line to
6021: <code class="filename">mk/defaults/options.description</code>. Lines have two
6022: fields, separated by tab. The first field is the option name, the
6023: second its description. The description should be a whole sentence
6024: (starting with an uppercase letter and ending with a period) that
6025: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6026: support.</span>”</span> The file is sorted by option names.</p>
6027: </div>
6028: <div class="sect1">
6029: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6030: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
6031: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6032: different dependencies based on the options with which the package was
6033: built. For querying these options, the file
6034: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6035: typical example looks like this:</p>
1.1 dsieger 6036: <pre class="programlisting">
1.184 rillig 6037: pkgbase := libpurple
6038: .include "../../mk/pkg-build-options.mk"
6039:
6040: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6041: ...
6042: .endif
1.117 sevan 6043: </pre>
1.184 rillig 6044: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6045: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6046: options of the libpurple package, which can then be queried like
6047: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6048: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6049: details.</p>
1.1 dsieger 6050: </div>
6051: </div>
1.41 asau 6052: <div class="chapter">
1.1 dsieger 6053: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 6054: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6055: <div class="toc">
6056: <p><b>Table of Contents</b></p>
1.100 leot 6057: <dl class="toc">
1.184 rillig 6058: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
6059: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
6060: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6061: </dl>
6062: </div>
1.184 rillig 6063: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6064: by pkgsrc and also for individual packages to define what commands
6065: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6066: or for later run-time of an installed packaged (such as
6067: <code class="varname">DEPENDS</code>).
6068: If the native system provides an adequate tool, then in many cases, a pkgsrc
6069: package will not be used.</p>
6070: <p>When building a package, the replacement tools are
6071: made available in a directory (as symlinks or wrapper scripts)
6072: that is early in the executable search path. Just like the buildlink
6073: system, this helps with consistent builds.</p>
6074: <p>A tool may be needed to help build a specific package. For example,
6075: perl, GNU make (gmake) or yacc may be needed.</p>
6076: <p>Also a tool may be needed, for example, because the native system's supplied
6077: tool may be inefficient for building a package with pkgsrc.
6078: For example, a package may need GNU awk, bison (instead of
6079: yacc) or a better sed.</p>
6080: <p>The tools used by a package can be listed by running
6081: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6082: <div class="sect1">
1.1 dsieger 6083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6084: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6085: <p>The default set of tools used by pkgsrc is defined in
6086: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6087: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6088: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6089: These can be seen by running:
6090: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6091: <p>If a package needs a specific program to build
6092: then the <code class="varname">USE_TOOLS</code> variable can be used
6093: to define the tools needed.</p>
1.1 dsieger 6094: </div>
1.184 rillig 6095: <div class="sect1">
6096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6097: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6098: <p>In the following examples, the :run means that it is needed at
6099: run-time (and becomes a DEPENDS).
6100: The default is a build dependency which can be set with
6101: :build. (So in this example, it is the same as gmake:build
6102: and pkg-config:build.)</p>
1.1 dsieger 6103: <pre class="programlisting">
1.184 rillig 6104: USE_TOOLS+= gmake perl:run pkg-config
1.1 dsieger 6105: </pre>
1.184 rillig 6106: <p>When using the tools framework, a
6107: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6108: which contains the full path to the appropriate tool. For example,
6109: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6110: on Linux systems.</p>
6111: <p>If you always need a pkgsrc version of the
6112: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6113: </p>
1.1 dsieger 6114: </div>
1.184 rillig 6115: <div class="sect1">
6116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6117: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6118: <p>When improving or porting pkgsrc to a new platform, have a look
6119: at (or create) the corresponding platform specific make file fragment under
6120: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6121: the name of the common tools. For example:</p>
1.1 dsieger 6122: <pre class="programlisting">
1.184 rillig 6123: .if exists(/usr/bin/bzcat)
6124: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6125: .elif exists(/usr/bin/bzip2)
6126: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6127: .endif
6128:
6129: TOOLS_PLATFORM.true?= true # shell builtin
1.1 dsieger 6130: </pre>
6131: </div>
6132: </div>
1.184 rillig 6133: <div class="chapter">
6134: <div class="titlepage"><div><div><h2 class="title">
6135: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6136: <div class="toc">
6137: <p><b>Table of Contents</b></p>
6138: <dl class="toc">
6139: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6140: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6141: <dd><dl>
6142: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6143: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6144: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6145: and
6146: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6147: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6148: </dl></dd>
6149: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
6150: <dd><dl>
6151: <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>
6152: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
6153: </dl></dd>
6154: </dl>
1.1 dsieger 6155: </div>
1.184 rillig 6156: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6157: are seen by a package's configure and build processes. This is implemented
6158: in a two step process:</p>
6159: <div class="orderedlist"><ol class="orderedlist" type="1">
6160: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6161: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6162: of <code class="varname">WRKDIR</code>.</p></li>
6163: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6164: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6165: <code class="option">-L${LOCALBASE}/lib</code> into references to
6166: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6167: native compiler on some operating systems look like GCC, so that
6168: packages that expect GCC won't require modifications to build with
6169: those native compilers.</p></li>
6170: </ol></div>
6171: <p>This normalizes the environment in which a package is built so that the
6172: package may be built consistently despite what other software may be
6173: installed. Please note that the normal system header and library paths,
6174: e.g. <code class="filename">/usr/include</code>,
6175: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6176: designed to insulate the package build from non-system-supplied
6177: software.</p>
1.41 asau 6178: <div class="sect1">
1.1 dsieger 6179: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6180: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6181: <p>The process of converting packages to use the buildlink3
6182: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6183: The things to keep in mind are:</p>
1.23 wiz 6184: <div class="orderedlist"><ol class="orderedlist" type="1">
1.184 rillig 6185: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6186: instead of the actual toolchain. Some packages are tricky,
6187: and the only way to know for sure is the check
6188: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6189: wrappers are being invoked.</p></li>
6190: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6191: the package Makefile, e.g. Java VMs, standalone shells,
6192: etc., because the code to symlink files into
6193: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6194: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6195: </p></li>
6196: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6197: <code class="filename">buildlink3.mk</code> files that you list in a
6198: package's Makefile are added as dependencies for that package.
6199: </p></li>
6200: </ol></div>
6201: <p>If a dependency on a particular package is required for its libraries and
6202: headers, then we replace:</p>
6203: <pre class="programlisting">
6204: DEPENDS+= foo>=1.1.0:../../category/foo
6205: </pre>
6206: <p>with</p>
6207: <pre class="programlisting">
6208: .include "../../category/foo/buildlink3.mk"
6209: </pre>
6210: <p>The buildlink3.mk files usually define the required dependencies.
6211: If you need a newer version of the dependency when using buildlink3.mk
6212: files, then you can define it in your Makefile; for example:</p>
1.1 dsieger 6213: <pre class="programlisting">
1.184 rillig 6214: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6215: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 6216: </pre>
1.184 rillig 6217: <p>There are several <code class="filename">buildlink3.mk</code>
6218: files in <code class="filename">pkgsrc/mk</code>
6219: that handle special package issues:</p>
6220: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6221: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6222: the native or a pkgsrc Berkeley DB implementation based on
6223: the values of <code class="varname">BDB_ACCEPTED</code> and
6224: <code class="varname">BDB_DEFAULT</code>.</p></li>
6225: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6226: comes with neither Curses nor NCurses, this will take care
1.207 leot 6227: 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 6228: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6229: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6230: adding a dependency on Heimdal or MIT-krb5 for packages that
6231: require a Kerberos 5 implementation.</p></li>
6232: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6233: system-provided Motif installation or adds a dependency on
1.207 leot 6234: <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 6235: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6236: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6237: to choose which Motif version will be used.</p></li>
6238: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6239: system-provided GNU readline or editline (libedit) installation,
1.207 leot 6240: 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>,
6241: <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 6242: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6243: If your package really needs GNU readline library, its Makefile
6244: should include <code class="filename">devel/readline/buildlink3.mk</code>
6245: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6246: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6247: variables that may be used by packages that use the
6248: Open Sound System (OSS) API.</p></li>
6249: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6250: any of the Postgres versions in the variable
6251: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6252: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6253: the file for more information.</p></li>
6254: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6255: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.207 leot 6256: 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 6257: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6258: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6259: library.</p></li>
6260: </ul></div>
6261: <p>The comments in those <code class="filename">buildlink3.mk</code>
6262: files provide a more complete
6263: description of how to use them properly.</p>
1.1 dsieger 6264: </div>
1.41 asau 6265: <div class="sect1">
1.1 dsieger 6266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6267: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6268: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6269: included by Makefiles to indicate the need to compile and link
6270: against header files and libraries provided by the package. A
6271: <code class="filename">buildlink3.mk</code> file should always provide
6272: enough information to add the correct type of dependency
6273: relationship and include any other
6274: <code class="filename">buildlink3.mk</code> files that it needs to find
6275: headers and libraries that it needs in turn.</p>
6276: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.207 leot 6277: 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 6278: package is highly recommended. For most packages, the following
6279: command will generate a good starting point for
6280: <code class="filename">buildlink3.mk</code> files:</p>
6281: <pre class="screen">
6282: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6283: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6284: </pre>
1.41 asau 6285: <div class="sect2">
1.1 dsieger 6286: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6287: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6288: <p>The following real-life example
6289: <code class="filename">buildlink3.mk</code> is taken
6290: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.1 dsieger 6291: <pre class="programlisting">
1.184 rillig 6292: BUILDLINK_TREE+= tiff
6293:
6294: .if !defined(TIFF_BUILDLINK3_MK)
6295: TIFF_BUILDLINK3_MK:=
6296:
6297: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6298: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6299: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6300:
6301: .include "../../devel/zlib/buildlink3.mk"
6302: .include "../../graphics/jpeg/buildlink3.mk"
6303: .endif # TIFF_BUILDLINK3_MK
6304:
6305: BUILDLINK_TREE+= -tiff
1.1 dsieger 6306: </pre>
1.184 rillig 6307: <p>The header and footer manipulate
6308: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6309: <code class="filename">buildlink3.mk</code> files and is used to track
6310: the dependency tree.</p>
6311: <p>The main section is protected from multiple inclusion
6312: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6313: added. Several important variables are set in the section:</p>
6314: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6315: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6316: is the dependency version recorded in the installed
1.184 rillig 6317: package; this should always be set using
6318: <span class="command"><strong>+=</strong></span> to ensure that
6319: we're appending to any pre-existing list of values. This
1.185 wiz 6320: variable should be set to the last version of the
1.184 rillig 6321: package that had an backwards-incompatible API change.
6322: </p></li>
6323: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6324: is the location of the <em class="replaceable"><code>pkg</code></em>
6325: pkgsrc directory.</p></li>
6326: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6327: (not shown above) controls whether we use
1.236 gutterid 6328: <code class="varname">BUILD_DEPENDS</code> or
1.184 rillig 6329: <code class="varname">DEPENDS</code> to add the dependency on
6330: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6331: selected by setting
6332: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.236 gutterid 6333: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.184 rillig 6334: used.</p></li>
6335: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6336: and
6337: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6338: (not shown above) are lists of subdirectories of
6339: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6340: to add to the header and library search paths. These
6341: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6342: respectively.</p></li>
6343: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6344: (not shown above) is the list of preprocessor flags to add
6345: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6346: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6347: should be avoided and instead be handled using
6348: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6349: above.</p></li>
6350: </ul></div>
6351: <p>The following variables are all optionally defined within
6352: this second section (protected against multiple inclusion) and
6353: control which package files are symlinked into
6354: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6355: transformed during the symlinking:</p>
6356: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6357: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6358: (not shown above) is a shell glob pattern relative to
6359: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6360: to be symlinked into
6361: <code class="filename">${BUILDLINK_DIR}</code>,
6362: e.g. <code class="filename">include/*.h</code>.</p></li>
6363: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6364: (not shown above) is a shell pipeline that
6365: outputs to stdout a list of files relative to
6366: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6367: The resulting files are to be symlinked
6368: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6369: this takes the <code class="filename">+CONTENTS</code> of a
6370: <em class="replaceable"><code>pkg</code></em> and filters it through
6371: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6372: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6373: (not shown above) is a filter command that filters
6374: <code class="filename">+CONTENTS</code> input into a list of files
6375: relative to
6376: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6377: on stdout. By default,
6378: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6379: outputs the contents of the <code class="filename">include</code>
6380: and <code class="filename">lib</code> directories in the package
6381: <code class="filename">+CONTENTS</code>.</p></li>
6382: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6383: (not shown above) is a list of sed arguments used to
6384: transform the name of the source filename into a
6385: destination filename, e.g. <span class="command"><strong>-e
6386: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6387: </ul></div>
6388: <p>This section can additionally include any
6389: <code class="filename">buildlink3.mk</code> needed for
6390: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6391: Including these <code class="filename">buildlink3.mk</code> files
6392: means that the headers and libraries for these
6393: dependencies are also symlinked into
6394: <code class="filename">${BUILDLINK_DIR}</code>
6395: whenever the <em class="replaceable"><code>pkg</code></em>
6396: <code class="filename">buildlink3.mk</code>
6397: file is included. Dependencies are only added for directly
6398: include <code class="filename">buildlink3.mk</code> files.</p>
6399: <p>When providing a <code class="filename">buildlink3.mk</code> and
6400: including other <code class="filename">buildlink3.mk</code> files in it,
6401: please only add necessary ones, i.e., those whose libraries or
6402: header files are automatically exposed when the package is
6403: use.</p>
6404: <p>In particular, if only an executable
6405: (<code class="filename">bin/foo</code>) is linked against a library, that
6406: library does not need to be propagated in the
6407: <code class="filename">buildlink3.mk</code> file.</p>
6408: <p>The following steps should help you decide if a
6409: <code class="filename">buildlink3.mk</code> file needs to be included:
6410: </p>
6411: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6412: <li class="listitem"><p>Look at the installed header files: What
6413: headers do they include? The packages providing these files
6414: must be buildlinked.</p></li>
6415: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6416: libraries and look against what other libraries they link.
6417: Some of the packages providing these probably need to be
6418: buildlinked; however, it's not automatic, since e.g. GTK on
6419: some systems pulls in the X libraries, so they will show up in
6420: the <code class="filename">ldd</code> output, while on others (like OS
6421: X) it won't. <code class="filename">ldd</code> output can thus only be
6422: used as a hint.</p></li>
6423: </ul></div>
6424: <p>
6425: </p>
6426: </div>
1.41 asau 6427: <div class="sect2">
1.1 dsieger 6428: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6429: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6430: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6431: and
6432: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6433: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.185 wiz 6434: <p>Both variables set lower bounds for a version of this package.
6435: The two variables differ in that one describes source
1.184 rillig 6436: compatibility (API) and the other binary compatibility (ABI).
6437: The difference is that a change in the API breaks compilation of
6438: programs while changes in the ABI stop compiled programs from
6439: running.</p>
1.185 wiz 6440: <p>The
6441: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6442: variable in a <code class="filename">buildlink3.mk</code> should be
6443: changed very rarely. (One possible scenario: If all packages
6444: using this package need a higher version than defined in the
6445: <code class="filename">buildlink3.mk</code>,
1.184 rillig 6446: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6447: could be updated to that higher version.)</p>
6448: <p>On the other hand, changes to
1.184 rillig 6449: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6450: are more common. The variable will need to be updated every
6451: time the major version of one of its shared libraries is changed,
6452: or any other change where a binary built against the previous
6453: version of the package will not run against the new version any
6454: longer.</p>
6455: <p>In such a case, the package's
1.184 rillig 6456: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6457: must be increased to require the new package version. Then the
6458: <code class="varname">PKGREVISION</code> of all packages
6459: <em class="replaceable"><code>foo</code></em> that depend on this package need
6460: to be increased, and if they have
6461: <code class="filename">buildlink3.mk</code> files,
6462: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6463: in their <code class="filename">buildlink3.mk</code> files must be
6464: increased to the new version as well. This is required so that a
6465: package will pull in the versions of the packages that use the
6466: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6467: uniquely identify the packages built against the new ABI. The
1.207 leot 6468: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/revbump/index.html" target="_top"><code class="filename">pkgtools/revbump</code></a> package can
1.185 wiz 6469: help with these updates.</p>
6470: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6471: about dependencies on other packages, including the
6472: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.184 rillig 6473: <p>Please take careful consideration before adjusting
6474: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6475: or
6476: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6477: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6478: cause unneeded package deletions and rebuilds. In many cases,
6479: new versions of packages work just fine with older
6480: dependencies.</p>
1.211 gutterid 6481: <p>Also, it is not needed to set
1.184 rillig 6482: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6483: when it is identical to
1.211 gutterid 6484: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
6485: <p>Note there is also the distinction that users are able to disable
6486: enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
6487: variable, but there is no equivalent option for API dependencies.</p>
1.1 dsieger 6488: </div>
6489: </div>
1.41 asau 6490: <div class="sect1">
1.1 dsieger 6491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6492: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6493: <p>Some packages in pkgsrc install headers and libraries that
6494: coincide with headers and libraries present in the base system.
6495: Aside from a <code class="filename">buildlink3.mk</code> file, these
6496: packages should also include a <code class="filename">builtin.mk</code>
6497: file that includes the necessary checks to decide whether using
6498: the built-in software or the pkgsrc software is
6499: appropriate.</p>
6500: <p>The only requirements of a builtin.mk file for
6501: <em class="replaceable"><code>pkg</code></em> are:</p>
6502: <div class="orderedlist"><ol class="orderedlist" type="1">
6503: <li class="listitem"><p>It should set
6504: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6505: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6506: after it is included.</p></li>
6507: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6508: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6509: which is already set before the
6510: <code class="filename">builtin.mk</code> file is included.</p></li>
6511: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6512: is <span class="emphasis"><em>very</em></span> important and takes careful
6513: attention to <code class="filename">Makefile</code> coding.</p></li>
6514: </ol></div>
6515: <div class="sect2">
6516: <div class="titlepage"><div><div><h3 class="title">
6517: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6518: <p>The following is the recommended template for builtin.mk
6519: files:</p>
1.1 dsieger 6520: <pre class="programlisting">
1.184 rillig 6521: .if !defined(IS_BUILTIN.foo)
6522: #
6523: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6524: # genuinely exists in the system or not.
6525: #
6526: IS_BUILTIN.foo?= no
1.1 dsieger 6527:
1.184 rillig 6528: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6529: # version can be determined.
6530: #
6531: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6532: BUILTIN_PKG.foo?= foo-1.0
6533: . endif
6534: .endif # IS_BUILTIN.foo
1.1 dsieger 6535:
1.184 rillig 6536: .if !defined(USE_BUILTIN.foo)
6537: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6538: . if defined(BUILTIN_PKG.foo)
6539: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6540: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6541: USE_BUILTIN.foo!= \
6542: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6543: && ${ECHO} "yes" || ${ECHO} "no"
6544: . endif
6545: . endfor
6546: . endif
6547: .endif # USE_BUILTIN.foo
1.1 dsieger 6548:
1.184 rillig 6549: CHECK_BUILTIN.foo?= no
6550: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6551: #
6552: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6553: # "yes" or "no".
6554: #
6555: .endif # CHECK_BUILTIN.foo
1.1 dsieger 6556: </pre>
1.184 rillig 6557: <p>The first section sets
6558: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6559: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6560: in the base system. This should not be a base system software
6561: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6562: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6563: included as part of the base system. This variable is only
6564: used internally within the <code class="filename">builtin.mk</code>
6565: file.</p>
6566: <p>The second section sets
6567: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6568: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6569: system if it exists (if
6570: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6571: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6572: within the <code class="filename">builtin.mk</code> file.</p>
6573: <p>The third section sets
6574: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6575: and is <span class="emphasis"><em>required</em></span> in all
6576: <code class="filename">builtin.mk</code> files. The code in this
6577: section must make the determination whether the built-in
6578: software is adequate to satisfy the dependencies listed in
6579: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6580: This is typically done by comparing
6581: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6582: against each of the dependencies in
6583: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6584: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6585: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6586: end of the <code class="filename">builtin.mk</code> file. Note that
6587: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6588: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6589: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6590: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6591: that the built-in version of the software is similar enough to
6592: be used as a replacement.</p>
6593: <p>The last section is guarded by
6594: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6595: and includes code that uses the value of
6596: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6597: set in the previous section. This typically includes, e.g.,
6598: adding additional dependency restrictions and listing additional
6599: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6600: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6601: </div>
6602: <div class="sect2">
6603: <div class="titlepage"><div><div><h3 class="title">
6604: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
6605: <p>When building packages, it's possible to choose whether to set
6606: a global preference for using either the built-in (native)
6607: version or the pkgsrc version of software to satisfy a
6608: dependency. This is controlled by setting
6609: <code class="varname">PREFER_PKGSRC</code> and
6610: <code class="varname">PREFER_NATIVE</code>. These variables take values
6611: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
6612: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
6613: use the pkgsrc versions of software, while
6614: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
6615: built-in versions. Preferences are determined by the most
6616: specific instance of the package in either
6617: <code class="varname">PREFER_PKGSRC</code> or
6618: <code class="varname">PREFER_NATIVE</code>. If a package is specified
6619: in neither or in both variables, then
6620: <code class="varname">PREFER_PKGSRC</code> has precedence over
6621: <code class="varname">PREFER_NATIVE</code>. For example, to require
6622: using pkgsrc versions of software for all but the most basic
6623: bits on a NetBSD system, you can set:</p>
1.1 dsieger 6624: <pre class="programlisting">
1.184 rillig 6625: PREFER_PKGSRC= yes
6626: PREFER_NATIVE= getopt skey tcp_wrappers
6627: </pre>
6628: <p>A package <span class="emphasis"><em>must</em></span> have a
6629: <code class="filename">builtin.mk</code>
6630: file to be listed in <code class="varname">PREFER_NATIVE</code>,
6631: otherwise it is simply ignored in that list.</p>
1.191 bacon 6632: <p><code class="varname">PREFER_PKGSRC</code> and
6633: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
6634: to ensure that the bootstrap process does not use inapropriate
6635: native tools as dependencies for core packages.
6636:
6637: </p>
6638: <pre class="screen">
6639: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
6640: </pre>
6641: <p>
6642:
1.184 rillig 6643: Switching between settings globally at a later date can introduce
6644: complications with dependency resolution. This is caused by packages
1.191 bacon 6645: built with the opposite preference being installed alongside each
6646: other. Hence, any changes to these variables after bootstrap will
6647: necessitate rebuilding all packages depending on one whose preference
6648: has been changed. This is not trivial and should be avoided.</p>
6649: <p>When using pkgsrc on Linux systems, there is high risk of
6650: "leakage", where programs installed by pkgsrc may inadvertently use a
6651: command or library not installed by pkgsrc, e.g. those installed by
6652: yum or apt. Such foreign dependencies may be installed, removed, or
6653: upgraded to a version incompatible with the pkgsrc package at any
6654: time, causing pkgsrc packages to subsequently malfunction. Pkgsrc
6655: cannot prevent this, as it has no control over other package managers.
6656: Another potential problem is that under Redhat Enterprise and related
6657: Linux systems, yum packages are only patched and never upgraded, so
6658: eventually they may become too outdated for use by pkgsrc. Even
6659: intentionally using foreign dependencies, not considered leakage, can
6660: lead to these problems, so it is generally discouraged. In order to
6661: minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
6662: This ensures that pkgsrc is aware of any changes to dependency packages
6663: and can rebuild or upgrade the entire dependency tree as needed. This
6664: default can be overridden by setting --prefer-pkgsrc to "no" or a list of
6665: packages, or by setting --prefer-native to "yes".</p>
1.1 dsieger 6666: </div>
1.7 rillig 6667: </div>
1.1 dsieger 6668: </div>
1.41 asau 6669: <div class="chapter">
1.1 dsieger 6670: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 6671: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.1 dsieger 6672: <div class="toc">
6673: <p><b>Table of Contents</b></p>
1.100 leot 6674: <dl class="toc">
1.184 rillig 6675: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6676: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6677: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
6678: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6679: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6680: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6681: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6682: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6683: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 6684: </dl>
6685: </div>
1.184 rillig 6686: <p>The <code class="filename">PLIST</code> file contains a package's
6687: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6688: the package (relative to the <code class="filename">${PREFIX}</code>
6689: directory it's been installed in) plus some additional statements
1.207 leot 6690: - see the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.184 rillig 6691: This chapter addresses some issues that need attention when
6692: dealing with the <code class="filename">PLIST</code> file (or files, see
6693: below!).</p>
1.41 asau 6694: <div class="sect1">
1.1 dsieger 6695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6696: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6697: <p>Be sure to add a RCS ID line as the first thing in any
6698: <code class="filename">PLIST</code> file you write:</p>
6699: <pre class="programlisting">
6700: @comment $NetBSD $
6701: </pre>
6702: <p>An artificial space has been added between NetBSD and $, this is a
6703: workaround here to prevent CVS expanding to the filename of the guide. When
6704: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6705: </div>
1.41 asau 6706: <div class="sect1">
1.1 dsieger 6707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6708: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6709: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6710: to output a PLIST that matches any new files since the package
6711: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6712: more information on this target.</p>
1.1 dsieger 6713: </div>
1.41 asau 6714: <div class="sect1">
1.1 dsieger 6715: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6716: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6717: </h2></div></div></div>
6718: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6719: of AWK patterns and actions that are used to filter the output of
6720: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6721: scripting you like to it, but be careful with quoting.</p>
6722: <p>For example, to get all files inside the
6723: <code class="filename">libdata/foo</code> directory removed from the
6724: resulting PLIST:</p>
1.1 dsieger 6725: <pre class="programlisting">
1.184 rillig 6726: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 6727: </pre>
1.185 wiz 6728: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6729: evaluated after the file list and directory list are sorted.
6730: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6731: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6732: list and directory list are sorted.</p>
1.184 rillig 6733: </div>
6734: <div class="sect1">
6735: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6736: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6737: <p>A number of variables are substituted automatically in
6738: PLISTs when a package is installed on a system. This includes the
6739: following variables:</p>
6740: <div class="variablelist"><dl class="variablelist">
6741: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6742: <dd>
6743: <p>Some packages like emacs and perl embed information
6744: about which architecture they were built on into the
6745: pathnames where they install their files. To handle this
6746: case, PLIST will be preprocessed before actually used, and
6747: the symbol
6748: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6749: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6750: same is done if the string
6751: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6752: PLIST somewhere - use this on packages that have GNU
6753: autoconf-created configure scripts.</p>
6754: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6755: <h3 class="title">Legacy note</h3>
6756: <p>There used to be a symbol
6757: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6758: was replaced by the output of <span class="command"><strong>uname
6759: -m</strong></span>, but that's no longer supported and has
6760: been removed.</p>
6761: </div>
6762: </dd>
6763: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6764: <dd>
6765: <p>Some packages want to embed the OS name and version
6766: into some paths. To do this, use these variables in the
6767: <code class="filename">PLIST</code>:
6768: </p>
6769: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6770: <li class="listitem"><p><code class="varname">${OPSYS}</code> - output of <span class="quote">“<span class="quote"><span class="command"><strong>uname -s</strong></span></span>”</span></p></li>
6771: <li class="listitem"><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. <span class="quote">“<span class="quote">solaris</span>”</span>)</p></li>
6772: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">“<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</span></p></li>
6773: </ul></div>
6774: </dd>
6775: </dl></div>
6776: <p>For a list of values which are replaced by
6777: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6778: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6779: <code class="varname">PLIST_SUBST</code> should help.</p>
6780: <p>If you want to change other variables not listed above, you
6781: can add variables and their expansions to this variable in the
6782: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="12.5. Optional files">Section 12.5, “Optional files”</a>):</p>
1.1 dsieger 6783: <pre class="programlisting">
1.184 rillig 6784: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 6785: </pre>
1.184 rillig 6786: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6787: in the <code class="filename">PLIST</code> with
6788: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6789: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6790: the common case of conditionally including some
6791: <code class="filename">PLIST</code> entries. It can be done by adding
6792: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6793: setting the corresponding <code class="varname">PLIST.foo</code> variable
6794: to <code class="literal">yes</code> if the entry should be included.
6795: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6796: in the <code class="filename">PLIST</code> with either
6797: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6798: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6799: For example, in <code class="filename">Makefile</code>:</p>
1.66 asau 6800: <pre class="programlisting">
1.184 rillig 6801: PLIST_VARS+= foo
6802: .if <em class="replaceable"><code>condition</code></em>
6803: PLIST.foo= yes
6804: .else
1.66 asau 6805: </pre>
1.184 rillig 6806: <p>And then in <code class="filename">PLIST</code>:</p>
1.1 dsieger 6807: <pre class="programlisting">
1.184 rillig 6808: @comment $NetBSD $
6809: bin/bar
6810: man/man1/bar.1
6811: ${PLIST.foo}bin/foo
6812: ${PLIST.foo}man/man1/foo.1
6813: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 6814: </pre>
1.184 rillig 6815: <p>An artificial space has been added between NetBSD and $, this is a
6816: workaround here to prevent CVS expanding to the filename of the guide. When
1.195 gutterid 6817: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6818: </div>
1.184 rillig 6819: <div class="sect1">
6820: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6821: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6822: <p>Man pages should be installed in compressed form if
6823: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6824: and uncompressed otherwise. To handle this in the
6825: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6826: appended/removed automatically for man pages according to
6827: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6828: or not, see above for details. This modification of the
6829: <code class="filename">PLIST</code> file is done on a copy of it, not
6830: <code class="filename">PLIST</code> itself.</p>
1.1 dsieger 6831: </div>
1.41 asau 6832: <div class="sect1">
1.1 dsieger 6833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6834: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6835: </h2></div></div></div>
6836: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6837: in generating the binary package, set the variable
6838: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.207 leot 6839: The files are later concatenated using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.184 rillig 6840: important. The default for <code class="varname">PLIST_SRC</code> is
6841: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.1 dsieger 6842: </div>
1.41 asau 6843: <div class="sect1">
1.1 dsieger 6844: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6845: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6846: <p>Some packages decide to install a different set of files based on
6847: the operating system being used. These differences can be
6848: automatically handled by using the following files:</p>
6849: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6850: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6851: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6852: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6853: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6854: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6855: </ul></div>
1.1 dsieger 6856: </div>
1.41 asau 6857: <div class="sect1">
1.1 dsieger 6858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6859: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6860: <p>Some packages decide to generate hard-to-guess file names
6861: during installation that are hard to wire down.</p>
6862: <p>In such cases, you can set the
6863: <code class="varname">GENERATE_PLIST</code> variable to shell code
6864: terminated (with a semicolon) that will output PLIST entries which
6865: will be appended to the PLIST</p>
6866: <p>You can find one example in editors/xemacs:</p>
6867: <pre class="programlisting">
6868: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6869: </pre>
6870: <p>which will append something like
6871: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6872: <code class="filename">PLIST</code>.
6873: </p>
1.1 dsieger 6874: </div>
1.41 asau 6875: <div class="sect1">
1.1 dsieger 6876: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6877: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6878: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6879: multiple (and unrelated) packages install files. These
6880: directories were problematic because you had to add special
6881: tricks in the PLIST to conditionally remove them, or have some
6882: centralized package handle them.</p>
6883: <p>In pkgsrc, it is now easy: Each package should create
6884: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6885: will remove any directories left empty after uninstalling a
6886: package.</p>
6887: <p>If a package needs an empty directory to work, create
6888: the directory during installation as usual, and also add an
6889: entry to the PLIST:
6890:
6891: </p>
6892: <pre class="programlisting">
6893: @pkgdir path/to/empty/directory
6894: </pre>
6895: <p>
6896:
6897: or take a look at <code class="varname">MAKE_DIRS</code> and
6898: <code class="varname">OWN_DIRS</code>.
1.1 dsieger 6899: </p>
6900: </div>
1.184 rillig 6901: </div>
6902: <div class="chapter">
6903: <div class="titlepage"><div><div><h2 class="title">
6904: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6905: <div class="toc">
6906: <p><b>Table of Contents</b></p>
6907: <dl class="toc">
6908: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6909: <dd><dl>
6910: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6911: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6912: </dl></dd>
6913: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6914: <dd><dl>
6915: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6916: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.239 dholland 6917: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
6918: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
6919: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 6920: </dl></dd>
6921: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6922: <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>
6923: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6924: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6925: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6926: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6927: <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>
6928: </dl>
6929: </div>
6930: <p>This chapter describes the framework known as
6931: <code class="literal">pkginstall</code>, whose key features are:</p>
6932: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6933: <li class="listitem"><p>Generic installation and manipulation of directories and files
6934: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6935: <li class="listitem"><p>Automatic handling of configuration files during installation,
6936: provided that packages are correctly designed.</p></li>
6937: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6938: <li class="listitem"><p>Registration of system users and groups.</p></li>
6939: <li class="listitem"><p>Registration of system shells.</p></li>
6940: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6941: </ul></div>
6942: <p>The following sections inspect each of the above points in detail.</p>
6943: <p>You may be thinking that many of the things described here could be
6944: easily done with simple code in the package's post-installation target
6945: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6946: as the code in them is only executed when building from source. Machines
6947: using binary packages could not benefit from it at all (as the code itself
6948: could be unavailable). Therefore, the only way to achieve any of the items
6949: described above is by means of the installation scripts, which are
6950: automatically generated by pkginstall.</p>
1.41 asau 6951: <div class="sect1">
1.1 dsieger 6952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6953: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6954: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6955: of files and directories that belong to a package. The names used in it
6956: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6957: which means that it cannot register files outside this directory (absolute
6958: path names are not allowed). Despite this restriction, some packages need
6959: to install files outside this location; e.g., under
6960: <code class="filename">${VARBASE}</code> or
6961: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6962: is to create such files during installation time by using
6963: installation scripts.</p>
6964: <p>The generic installation scripts are shell scripts that can
6965: contain arbitrary code. The list of scripts to execute is taken from
6966: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6967: <code class="filename">INSTALL</code>. A similar variable exists for package
6968: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6969: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6970: commands, so they have the potential to create and manage files
6971: anywhere in the file system.</p>
6972: <p>Using these general installation files is not recommended, but
6973: may be needed in some special cases. One reason for avoiding them is
6974: that the user has to trust the packager that there is no unwanted or
6975: simply erroneous code included in the installation script. Also,
6976: previously there were many similar scripts for the same functionality,
6977: and fixing a common error involved finding and changing all of
6978: them.</p>
6979: <p>The pkginstall framework offers another, standardized way. It
6980: provides generic scripts to abstract the manipulation of such files
6981: and directories based on variables set in the package's
6982: <code class="filename">Makefile</code>. The rest of this section describes
6983: these variables.</p>
6984: <div class="sect2">
6985: <div class="titlepage"><div><div><h3 class="title">
6986: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
6987: <p>The following variables can be set to request the creation of
6988: directories anywhere in the file system:</p>
6989: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6990: <li class="listitem">
6991: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
6992: contain a list of directories that should be created and should attempt
6993: to be destroyed by the installation scripts. The difference between
6994: the two is that the latter prompts the administrator to remove any
6995: directories that may be left after deinstallation (because they were
6996: not empty), while the former does not. Example:</p>
6997: <pre class="programlisting">
6998: MAKE_DIRS+= ${VARBASE}/foo/private
6999: </pre>
7000: </li>
7001: <li class="listitem">
7002: <p><code class="varname">MAKE_DIRS_PERMS</code> and
7003: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
7004: which directories should be created and should attempt to be destroyed
7005: by the installation scripts. Each tuple holds the following values,
7006: separated by spaces: the directory name, its owner, its group and its
7007: numerical mode. For example:</p>
7008: <pre class="programlisting">
7009: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
7010: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
7011: </pre>
7012: <p>The difference between the two is exactly the same as their
7013: non-<code class="varname">PERMS</code> counterparts.</p>
7014: </li>
7015: </ul></div>
1.1 dsieger 7016: </div>
1.184 rillig 7017: <div class="sect2">
7018: <div class="titlepage"><div><div><h3 class="title">
7019: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
7020: <p>Creating non-empty files outside the installation prefix is tricky
7021: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.239 dholland 7022: To overcome this problem, the only solution is to extract the file in a
1.184 rillig 7023: known place (i.e., inside the installation prefix) and copy it to the
7024: appropriate location during installation (done by the installation scripts
1.239 dholland 7025: generated by pkginstall). We will call the former the <span class="emphasis"><em>reference
1.184 rillig 7026: file</em></span> in the following paragraphs, which describe the variables
7027: that can be used to automatically and consistently handle files outside the
7028: installation prefix:</p>
7029: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.239 dholland 7030: <li class="listitem"><p><code class="varname">REQD_FILES</code> is a list of pairs of reference
7031: and target files. At installation time, the reference file is copied
7032: to the target if and only if the latter does not exist. Upon
7033: deinstallation, the reference file is removed provided that it was
7034: not modified by the installation.</p></li>
1.184 rillig 7035: <li class="listitem">
1.239 dholland 7036: <p><code class="varname">REQD_FILES_PERMS</code> contains tuples describing
7037: reference files and targets, including owner, group, and numeric
7038: permissions that should be set. For example:</p>
1.1 dsieger 7039: <pre class="programlisting">
1.184 rillig 7040: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
7041: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 7042: </pre>
1.184 rillig 7043: </li>
1.239 dholland 7044: <li class="listitem"><p><code class="varname">CONF_FILES</code> and
7045: <code class="varname">CONF_FILES_PERMS</code> have the same syntax as
7046: <code class="varname">REQD_FILES</code> and
7047: <code class="varname">REQD_FILES_PERMS</code> respectively. The difference
7048: is that these variables are specifically intended for handling
7049: configuration files, for which additional conventions and
7050: constraints apply. See <a class="xref" href="#conf-files" title="20.2. Configuration files">Section 20.2, “Configuration files”</a> for further
7051: discussion. Note in particular that while handling of
7052: configuration files can be disabled by the user (see <a class="xref" href="#conf-files-disable" title="20.2.5. Disabling handling of configuration files">Section 20.2.5, “Disabling handling of configuration files”</a>), this setting does not affect
7053: <code class="varname">REQD_FILES</code> and
7054: <code class="varname">REQD_FILES_PERMS</code>.</p></li>
1.184 rillig 7055: </ul></div>
1.239 dholland 7056: <p>To install an empty file, one can use these macros and
7057: <code class="filename">/dev/null</code> as the reference file.</p>
1.184 rillig 7058: </div>
1.1 dsieger 7059: </div>
1.41 asau 7060: <div class="sect1">
1.1 dsieger 7061: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7062: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
1.239 dholland 7063: <p>There are two principles that govern the handling of
7064: configuration files in pkgsrc: first, the user's configuration must
7065: not be lost or overwritten by upgrades or reinstallations; and second,
7066: the default configuration should always be available for reference.
7067: To that end, pkgsrc has a framework specifically for handling
7068: configuration files. In general, configuration files are installed
7069: into <code class="filename">${PREFIX}/share/examples</code>, and copied from
7070: there to the pertinent <code class="filename">etc</code> directory as a
7071: separate step and only as needed.</p>
7072: <p>To make this work, there are three things that need to happen,
7073: any of which may require patching. First, the package must be told to
7074: read its configuration from the correct place at runtime; this place
7075: is <code class="filename">${PKG_SYSCONFDIR}</code> (or possibly a subdirectory
7076: of it) which is often but not always
7077: <code class="filename">${PREFIX}/etc</code>. Second, the package must be
7078: taught to install its default configuration files in
7079: <code class="filename">${PREFIX}/share/examples/${PKGBASE}</code>; this is the
7080: point at which patching often becomes required because it is not the
7081: same place as the runtime location. Third, the configuration files
7082: need to be declared in the package makefile; this is the easy part.
7083: </p>
7084: <p>With those elements in place, the right things will happen: the
7085: package install phase and resulting binary package will not touch
7086: <code class="filename">${PKG_SYSCONFDIR}</code>, and the default configuration
7087: will be copied into place by the pkgsrc framework only if not already
7088: present. Similarly, upon deinstall the configuration will not be
7089: removed if it has been modified. (This means that in the case of
7090: reinstallation and upgrades, unmodified configuration files are
7091: updated but modifications are never discarded.)</p>
7092: <p>The following sections describe how to make these things happen
7093: and document other relevant knobs available in the pkgsrc
7094: infrastructure.</p>
1.184 rillig 7095: <div class="sect2">
7096: <div class="titlepage"><div><div><h3 class="title">
7097: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7098: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7099: specifies where configuration files shall be installed. Its contents are
7100: set based upon the following variables:</p>
7101: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7102: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7103: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.239 dholland 7104: be overridden by the user to point to their preferred location (e.g.,
1.184 rillig 7105: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7106: Packages must not use it directly.</p></li>
7107: <li class="listitem">
7108: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7109: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7110: for the package being built shall be installed. The definition of this
7111: variable only makes sense in the package's
7112: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7113: <p>As an example, consider the Apache package,
1.207 leot 7114: <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 7115: configuration files under the
7116: <code class="filename">httpd/</code> subdirectory of
7117: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7118: Makefile.</p>
7119: </li>
7120: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7121: variable that holds this package's configuration directory (if
7122: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7123: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7124: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7125: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7126: directory where the configuration files for the package identified by
7127: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7128: </ul></div>
7129: <p>Based on the above variables, pkginstall determines the value of
7130: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
1.239 dholland 7131: variable that may be used within a package to refer to its configuration
1.184 rillig 7132: directory. The algorithm used to set its value is basically the
7133: following:</p>
7134: <div class="orderedlist"><ol class="orderedlist" type="1">
7135: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7136: its value is used.</p></li>
7137: <li class="listitem"><p>If the previous variable is not defined but
7138: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7139: <code class="filename">Makefile</code>, the resulting value is
7140: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7141: <li class="listitem"><p>Otherwise, it is set to
7142: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7143: </ol></div>
7144: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.239 dholland 7145: automatically added to <code class="filename">OWN_DIRS</code>. This causes it
7146: to be automatically created if needed. See <a class="xref" href="#dirs-outside-prefix" title="20.1.1. Directory manipulation">Section 20.1.1, “Directory manipulation”</a> for further details. This does not apply to
7147: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>; they must be manually
7148: created with <code class="varname">OWN_DIRS</code> or
7149: <code class="varname">MAKE_DIRS</code>.</p>
1.184 rillig 7150: </div>
7151: <div class="sect2">
7152: <div class="titlepage"><div><div><h3 class="title">
7153: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7154: <p>Given that pkgsrc (and users!) expect configuration files to be in a
1.239 dholland 7155: known place, you need to teach each package where to install its files. In
7156: some cases you will have to patch the package Makefiles to achieve it. If
7157: you are lucky, though, it may be as easy as passing an extra flag to the
7158: configuration script. This is the case for packages using GNU
7159: autoconf:</p>
1.1 dsieger 7160: <pre class="programlisting">
1.184 rillig 7161: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 7162: </pre>
1.184 rillig 7163: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
1.239 dholland 7164: for</em></span> its configuration files, not where they will be installed.
7165: Fortunately, there is a different way to specify the latter, as seen
1.240 ! gutterid 7166: in the next section, although the combination is rather confusing at
1.239 dholland 7167: first glance.</p>
1.1 dsieger 7168: </div>
1.184 rillig 7169: <div class="sect2">
7170: <div class="titlepage"><div><div><h3 class="title">
1.239 dholland 7171: <a name="conf-files-patching"></a>20.2.3. Patching installation</h3></div></div></div>
7172: <p>As discussed above, <span class="strong"><strong>packages themselves must not
1.184 rillig 7173: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7174: directly</strong></span>. Bad news is that many software installation scripts
7175: will, out of the box, mess with the contents of that directory. So what is
7176: the correct procedure to fix this issue?</p>
7177: <p>You must teach the package (usually by manually patching it) to
7178: install any configuration files under the examples hierarchy,
7179: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7180: <code class="filename">PLIST</code> registers them and the administrator always
7181: has the original copies available.</p>
1.239 dholland 7182: <p>It turns out that for packages using GNU autoconf it is possible
7183: to create the desired effect by setting <code class="varname">sysconfdir</code>
7184: on the make command line at install time. Consider this example taken
7185: from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/index.html" target="_top"><code class="filename">mail/mutt</code></a>:</p>
7186: <pre class="programlisting">
7187: EGDIR= ${PREFIX}/share/examples/mutt
7188: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
7189: </pre>
7190: <p>Note that the <code class="varname">EGDIR</code> variable, though commonly
7191: used for this purpose, is local to that package and has no meaning
7192: outside it.</p>
7193: </div>
7194: <div class="sect2">
7195: <div class="titlepage"><div><div><h3 class="title">
7196: <a name="conf-files-declare"></a>20.2.4. Declaring configuration files</h3></div></div></div>
1.184 rillig 7197: <p>Once the required configuration files are in place (i.e., under the
1.239 dholland 7198: examples hierarchy), the pkginstall framework can use them as reference copies
1.184 rillig 7199: during the package installation to update what is in
7200: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7201: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.239 dholland 7202: used. Check out <a class="xref" href="#files-outside-prefix" title="20.1.2. File manipulation">Section 20.1.2, “File manipulation”</a> for further
7203: information about their syntax and their purpose. Here is an example,
7204: taken from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/index.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
7205: <pre class="programlisting">
7206: EGDIR= ${PREFIX}/share/examples/mutt
7207: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7208: </pre>
7209: <p>Note that (as in the previous section's example) the
7210: <code class="varname">EGDIR</code> variable is specific to the package and has
7211: no meaning outside it.</p>
7212: <p>For reference, the complete example from Mutt is as follows:</p>
1.1 dsieger 7213: <pre class="programlisting">
1.239 dholland 7214: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
7215: EGDIR= ${PREFIX}/share/examples/mutt
7216: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7217: INSTALLATION_DIRS+= ${EGDIR}
7218: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.1 dsieger 7219: </pre>
7220: </div>
1.184 rillig 7221: <div class="sect2">
7222: <div class="titlepage"><div><div><h3 class="title">
1.239 dholland 7223: <a name="conf-files-disable"></a>20.2.5. Disabling handling of configuration files</h3></div></div></div>
1.184 rillig 7224: <p>The automatic copying of config files can be toggled by setting the
7225: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7226: installation.</p>
1.1 dsieger 7227: </div>
7228: </div>
1.41 asau 7229: <div class="sect1">
1.1 dsieger 7230: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7231: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7232: <p>System startup scripts are special files because they must be
7233: installed in a place known by the underlying OS, usually outside the
7234: 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
7235: can be used. However, pkginstall provides a special mechanism to handle
7236: these files.</p>
7237: <p>In order to provide system startup scripts, the package has
7238: to:</p>
7239: <div class="orderedlist"><ol class="orderedlist" type="1">
7240: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7241: the <code class="literal">.sh</code> suffix appended. Considering the
1.223 nia 7242: <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
7243: has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.184 rillig 7244: <li class="listitem">
7245: <p>Tell pkginstall to handle it, appending the name of the script,
7246: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7247: Continuing the previous example:</p>
7248: <pre class="programlisting">
7249: RCD_SCRIPTS+= cupsd
7250: </pre>
7251: </li>
7252: </ol></div>
7253: <p>Once this is done, pkginstall will do the following steps for each
7254: script in an automated fashion:</p>
7255: <div class="orderedlist"><ol class="orderedlist" type="1">
7256: <li class="listitem"><p>Process the file found in the files directory applying all the
7257: substitutions described in the <code class="filename">FILES_SUBST</code>
7258: variable.</p></li>
7259: <li class="listitem"><p>Copy the script from the files directory to the examples
7260: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.239 dholland 7261: that this reference file must be explicitly registered in the
1.184 rillig 7262: <code class="filename">PLIST</code>.</p></li>
7263: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7264: from the examples hierarchy into the system-wide startup scripts
7265: directory.</p></li>
7266: </ol></div>
7267: <div class="sect2">
7268: <div class="titlepage"><div><div><h3 class="title">
7269: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7270: <p>The automatic copying of config files can be toggled by setting the
7271: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7272: installation. Note that the scripts will be always copied inside the
7273: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7274: matter what the value of this variable is.</p>
1.1 dsieger 7275: </div>
7276: </div>
1.184 rillig 7277: <div class="sect1">
7278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7279: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7280: <p>If a package needs to create special users and/or groups during
7281: installation, it can do so by using the pkginstall framework.</p>
7282: <p>Users can be created by adding entries to the
7283: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7284: syntax:</p>
7285: <pre class="programlisting">
7286: user:group
7287: </pre>
7288: <p>Further specification of user details may be done by setting
7289: per-user variables.
7290: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7291: numeric UID for the user.
7292: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7293: user's description or comment.
7294: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7295: user's home directory, and defaults to
7296: <code class="filename">/nonexistent</code> if not specified.
7297: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7298: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7299: not specified.</p>
7300: <p>Similarly, groups can be created by adding entries to the
7301: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7302: <pre class="programlisting">
7303: group
7304: </pre>
7305: <p>The numeric GID of the group may be set by defining
7306: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7307: <p>If a package needs to create the users and groups at an earlier
7308: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7309: <code class="literal">configure</code>,<code class="literal">build</code>, or
7310: <code class="literal">pre-install</code> to indicate the phase before which the
7311: users and groups are created. In this case, the numeric UIDs and GIDs
7312: of the created users and groups are automatically hardcoded into the
7313: final installation scripts.</p>
1.1 dsieger 7314: </div>
1.41 asau 7315: <div class="sect1">
1.1 dsieger 7316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7317: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7318: <p>Packages that install system shells should register them in the shell
7319: database, <code class="filename">/etc/shells</code>, to make things easier to the
7320: administrator. This must be done from the installation scripts to keep
7321: binary packages working on any system. pkginstall provides an easy way to
7322: accomplish this task.</p>
7323: <p>When a package provides a shell interpreter, it has to set the
7324: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7325: add some hooks to the installation scripts to handle it. Consider the
1.207 leot 7326: 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 7327: <pre class="programlisting">
7328: PKG_SHELL= ${PREFIX}/bin/zsh
7329: </pre>
7330: <div class="sect2">
7331: <div class="titlepage"><div><div><h3 class="title">
7332: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7333: <p>The automatic registration of shell interpreters can be disabled by
7334: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7335: environment variable to <code class="literal">NO</code>.</p>
7336: </div>
1.1 dsieger 7337: </div>
1.41 asau 7338: <div class="sect1">
1.1 dsieger 7339: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7340: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7341: <p>Packages that install X11 fonts should update the database files
7342: that index the fonts within each fonts directory. This can easily be
7343: accomplished within the pkginstall framework.</p>
7344: <p>When a package installs X11 fonts, it must list the directories in
7345: which fonts are installed in the
7346: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7347: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7348: <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
7349: installation scripts to run the appropriate commands to update the fonts
7350: database files within each of those directories. For convenience, if the
7351: directory path is relative, it is taken to be relative to the package's
1.207 leot 7352: 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 7353: <pre class="programlisting">
1.184 rillig 7354: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 7355: </pre>
1.184 rillig 7356: <div class="sect2">
7357: <div class="titlepage"><div><div><h3 class="title">
7358: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7359: <p>The automatic update of fonts databases can be disabled by
7360: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7361: environment variable to <code class="literal">NO</code>.</p>
1.1 dsieger 7362: </div>
7363: </div>
7364: </div>
1.41 asau 7365: <div class="chapter">
1.1 dsieger 7366: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 7367: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 7368: <div class="toc">
7369: <p><b>Table of Contents</b></p>
1.100 leot 7370: <dl class="toc">
1.154 rillig 7371: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 7372: <dd><dl>
1.154 rillig 7373: <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>
7374: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7375: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7376: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7377: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7378: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7379: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7380: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7381: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7382: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7383: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7384: </dl></dd>
7385: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7386: <dd><dl>
7387: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7388: <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>
7389: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7390: </dl></dd>
7391: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7392: <dd><dl>
7393: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7394: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7395: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 7396: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154 rillig 7397: </dl></dd>
7398: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7399: <dd><dl>
7400: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7401: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 7402: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 7403: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
7404: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
7405: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
7406: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 7407: </dl></dd>
7408: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7409: <dd><dl>
7410: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7411: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 7412: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7413: <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>
7414: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 7415: </dl></dd>
7416: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7417: <dd><dl>
7418: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7419: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7420: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7421: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7422: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 7423: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154 rillig 7424: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
7425: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203 nia 7426: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
7427: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
7428: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
7429: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
7430: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
7431: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
7432: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1 dsieger 7433: emulation</a></span></dt>
1.203 nia 7434: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
7435: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1 dsieger 7436: </dl></dd>
1.154 rillig 7437: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7438: </dl>
7439: </div>
1.41 asau 7440: <div class="sect1">
1.1 dsieger 7441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7442: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 7443: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 7444: different platforms. As a result, it is important to ensure,
7445: where possible, that packages in pkgsrc are portable. This
7446: chapter mentions some particular details you should pay
7447: attention to while working on pkgsrc.</p>
1.41 asau 7448: <div class="sect2">
1.1 dsieger 7449: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7450: <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 7451: </h3></div></div></div>
7452: <p>The pkgsrc user can configure pkgsrc by overriding several
7453: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7454: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7455: want to use those variables in the preprocessor directives of
1.207 leot 7456: <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 7457: <code class="literal">.for</code>), you need to include the file
7458: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7459: loads the user preferences.</p>
7460: <p>But note that some variables may not be completely defined
7461: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7462: included, as they may contain references to variables that are
1.108 rillig 7463: not yet defined. In shell commands (the lines in
7464: <code class="filename">Makefile</code> that are indented with a tab) this
7465: is no problem, since variables are only expanded when they are
7466: used. But in the preprocessor directives mentioned above and in
7467: dependency lines (of the form <code class="literal">target:
1.1 dsieger 7468: dependencies</code>) the variables are expanded at load
7469: time.</p>
1.41 asau 7470: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7471: <h3 class="title">Note</h3>
1.108 rillig 7472: <p>To check whether a variable can be used at load time,
7473: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 7474: </div>
7475: </div>
1.41 asau 7476: <div class="sect2">
1.1 dsieger 7477: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7478: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 7479: <p>Occasionally, packages require interaction from the user,
7480: and this can be in a number of ways:</p>
1.41 asau 7481: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7482: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7483: interaction such as entering username/password or accepting a
7484: license on a web page.</p></li>
1.23 wiz 7485: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7486: passwords.</p></li>
1.23 wiz 7487: <li class="listitem"><p>help to configure the package before it is built</p></li>
7488: <li class="listitem"><p>help during the build process</p></li>
7489: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7490: </ul></div>
1.108 rillig 7491: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7492: variable to define which stages need interaction. This should be
7493: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 7494: <pre class="programlisting">
7495: INTERACTIVE_STAGE= configure install
1.111 sevan 7496: </pre>
1.1 dsieger 7497: <p>The user can then decide to skip this package by setting the
1.108 rillig 7498: <code class="varname">BATCH</code> variable. Packages that require interaction
7499: are also excluded from bulk builds.</p>
1.1 dsieger 7500: </div>
1.41 asau 7501: <div class="sect2">
1.1 dsieger 7502: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7503: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 7504: <p>Authors of software can choose the licence under which software
7505: can be copied. The Free Software Foundation has declared some
7506: licenses "Free", and the Open Source Initiative has a definition of
7507: "Open Source".</p>
7508: <p>By default, pkgsrc allows packages with Free or Open Source
7509: licenses to be built. To allow packages with other licenses to be
7510: built as well, the pkgsrc user needs to add these licenses to the
7511: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7512: that this variable only affects which packages may be
7513: <span class="emphasis"><em>built</em></span>, while the license terms often also
7514: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 7515: <p>One might want to only install packages with a BSD license,
1.108 rillig 7516: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 7517: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 7518: user can override the default by setting the
7519: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 7520: of "+=". The licenses accepted by default are defined in the
7521: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7522: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7523: <p>The license tag mechanism is intended to address
7524: copyright-related issues surrounding building, installing and
7525: using a package, and not to address redistribution issues (see
7526: <code class="varname">RESTRICTED</code> and
1.111 sevan 7527: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7528: Packages with redistribution restrictions should set these
7529: tags.</p>
1.1 dsieger 7530: <p>Denoting that a package may be copied according to a
7531: particular license is done by placing the license in
7532: <code class="filename">pkgsrc/licenses</code> and setting the
7533: <code class="varname">LICENSE</code> variable to a string identifying the
1.207 leot 7534: 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 7535: <pre class="programlisting">
7536: LICENSE= xv-license
1.111 sevan 7537: </pre>
1.1 dsieger 7538: <p>When trying to build, the user will get a notice that the
7539: package is covered by a license which has not been placed in the
7540: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7541: <pre class="programlisting">
7542: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7543: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7544: ===> To view the license, enter "/usr/bin/make show-license".
7545: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7546: ===> ACCEPTABLE_LICENSES+=xv-license
7547: *** Error code 1
1.111 sevan 7548: </pre>
1.10 hubertf 7549: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7550: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7551: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7552: convey to pkgsrc that it should not in the future fail because of
7553: that license:</p>
7554: <pre class="programlisting">
7555: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7556: </pre>
7557: <p>The use of <code class="varname">LICENSE=shareware</code>,
7558: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7559: is deprecated because it does not crisply refer to a particular
7560: license text. Another problem with such usage is that it does not
7561: enable a user to tell pkgsrc to proceed for a single package
7562: without also telling pkgsrc to proceed for all packages with that
7563: tag.</p>
7564: <div class="sect3">
7565: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7566: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7567: <p>When adding a package with a new license, the following steps
7568: are required:</p>
7569: <div class="orderedlist"><ol class="orderedlist" type="1">
7570: <li class="listitem">
1.169 rillig 7571: <p>Check whether the license qualifies as Free or Open Source by
7572: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7573: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111 sevan 7574: Open Source Initiative</a>. If this is the case, the filename in
7575: <code class="filename">pkgsrc/licenses/</code> does not need the
7576: <code class="filename">-license</code> suffix, and the license name should be
7577: added to:</p>
1.48 rodent 7578: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7579: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7580: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7581: <li class="listitem"><p>default_acceptable_licenses in
7582: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48 rodent 7583: </ul></div>
7584: </li>
1.169 rillig 7585: <li class="listitem"><p>The license text should be added to
7586: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7587: licenses can be seen in this directory.</p></li>
1.48 rodent 7588: </ol></div>
1.111 sevan 7589: </div>
7590: <div class="sect3">
7591: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7592: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7593: <p>When the license changes (in a way other than formatting),
1.111 sevan 7594: make sure that the new license has a different name (e.g.,
1.1 dsieger 7595: append the version number if it exists, or the date). Just
7596: because a user told pkgsrc to build programs under a previous
7597: version of a license does not mean that pkgsrc should build
7598: programs under the new licenses. The higher-level point is that
7599: pkgsrc does not evaluate licenses for reasonableness; the only
7600: test is a mechanistic test of whether a particular text has been
1.111 sevan 7601: approved by either of two bodies (FSF or OSI).</p>
7602: </div>
1.1 dsieger 7603: </div>
1.41 asau 7604: <div class="sect2">
1.1 dsieger 7605: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7606: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7607: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7608: By declaring the restrictions, package tools can
1.1 dsieger 7609: automatically refrain from e.g. placing binary packages on FTP
7610: sites.</p>
1.111 sevan 7611: <p>There are four possible restrictions, which are
1.1 dsieger 7612: the cross product of sources (distfiles) and binaries not being
7613: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7614: language in any license, and because non-Free licenses tend to be
7615: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7616: CD-ROM.
7617:
7618: "FTP" means making the source or binary file available over the
7619: Internet at no charge.
7620:
7621: "CD-ROM" means making the source or binary available on some kind of
7622: media, together with other source and binary packages, which is sold
7623: for a distribution charge.
1.1 dsieger 7624: </p>
7625: <p>In order to encode these restrictions, the package system
7626: defines five make variables that can be set to note these
7627: restrictions:</p>
1.41 asau 7628: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7629: <li class="listitem">
1.1 dsieger 7630: <p><code class="varname">RESTRICTED</code></p>
7631: <p>This variable should be set whenever a restriction
7632: exists (regardless of its kind). Set this variable to a
7633: string containing the reason for the restriction. It should
7634: be understood that those wanting to understand the restriction
7635: will have to read the license, and perhaps seek advice of
7636: counsel.</p>
7637: </li>
1.23 wiz 7638: <li class="listitem">
1.1 dsieger 7639: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7640: <p>Binaries may not be placed on CD-ROM containing other
7641: binary packages, for which a distribution charge may be made.
7642: In this case, set this variable to
7643: <code class="varname">${RESTRICTED}</code>.</p>
7644: </li>
1.23 wiz 7645: <li class="listitem">
1.1 dsieger 7646: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7647: <p>Binaries may not made available on the Internet without
7648: charge. In this case, set this variable to
7649: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7650: binary packages will not be included on ftp.NetBSD.org.</p>
7651: </li>
1.23 wiz 7652: <li class="listitem">
1.1 dsieger 7653: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7654: <p>Distfiles may not be placed on CD-ROM, together with
7655: other distfiles, for which a fee may be charged. In this
7656: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7657: </p>
7658: </li>
1.23 wiz 7659: <li class="listitem">
1.1 dsieger 7660: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7661: <p>Distfiles may not made available via FTP at no charge.
7662: In this case, set this variable to
7663: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7664: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7665: </li>
7666: </ul></div>
1.111 sevan 7667: <p>Please note that packages will be removed from pkgsrc when the
7668: distfiles are not distributable and cannot be obtained for a period
7669: of one full quarter branch. Packages with manual/interactive fetch
7670: must have a maintainer and it is his/her responsibility to ensure
7671: this.</p>
1.1 dsieger 7672: </div>
1.41 asau 7673: <div class="sect2">
1.1 dsieger 7674: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7675: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.175 gutterid 7676: <p>Your package may depend on some other package being present,
7677: and there are various ways of expressing this dependency.
7678: pkgsrc supports the <code class="varname">DEPENDS</code>,
7679: <code class="varname">BUILD_DEPENDS</code>,
7680: <code class="varname">TOOL_DEPENDS</code>, and
7681: <code class="varname">TEST_DEPENDS</code> definitions, the
1.1 dsieger 7682: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7683: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7684: to handle dependencies, and which uses the variables named above.
1.184 rillig 7685: 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 7686: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7687: definition registers that pre-requisite in the binary package so it
7688: will be pulled in when the binary package is later installed, whilst
7689: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7690: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7691: dependency that is only needed for building or testing the resulting
1.184 rillig 7692: 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 7693: <p>This means that if you only need a package present whilst
1.175 gutterid 7694: you are building or testing, it should be noted as a
7695: <code class="varname">TOOL_DEPENDS</code>,
7696: <code class="varname">BUILD_DEPENDS</code>, or
7697: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.156 leot 7698: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7699: packages, i.e. packages for the architecture where the package
7700: is built;
7701: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.175 gutterid 7702: packages, i.e., packages for the architecture for which the package
1.156 leot 7703: is built.</p>
1.175 gutterid 7704: <p>The format for a <code class="varname">DEPENDS</code>,
7705: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7706: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.1 dsieger 7707: <pre class="programlisting">
7708: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7709: </pre>
1.23 wiz 7710: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7711: may include any of the wildcard version numbers recognized by
1.207 leot 7712: <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 7713: <div class="orderedlist"><ol class="orderedlist" type="1">
7714: <li class="listitem">
1.1 dsieger 7715: <p>If your package needs another package's binaries or
1.54 wiz 7716: libraries to build and run, and if that package has a
1.1 dsieger 7717: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7718: <pre class="programlisting">
7719: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7720: </pre>
1.1 dsieger 7721: </li>
1.23 wiz 7722: <li class="listitem">
1.54 wiz 7723: <p>If your package needs another package's binaries or
7724: libraries only for building, and if that package has a
7725: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7726: <pre class="programlisting">
7727: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7728: </pre>
1.54 wiz 7729: <p>but set
7730: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7731: to make it a build dependency only. This case is rather
7732: rare.</p>
7733: </li>
7734: <li class="listitem">
1.25 spz 7735: <p>If your package needs binaries from another package to build,
1.156 leot 7736: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7737: <pre class="programlisting">
1.156 leot 7738: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7739: </pre>
1.1 dsieger 7740: </li>
1.156 leot 7741: <li class="listitem"><p>If your package needs static libraries to link against, header
7742: files to include, etc. from another package to build,
7743: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7744: <li class="listitem"><p>If your package needs a library with which to link and
7745: there is no <code class="filename">buildlink3.mk</code> file
7746: available, create one. Using
7747: <code class="varname">DEPENDS</code> won't be sufficient because the
7748: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7749: <li class="listitem">
1.25 spz 7750: <p>If your package needs some executable to be able to run
7751: correctly and if there's no
7752: <code class="filename">buildlink3.mk</code> file, this is specified
7753: using the <code class="varname">DEPENDS</code> variable. The
1.207 leot 7754: <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 7755: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7756: when it runs, and that is specified:</p>
1.1 dsieger 7757: <pre class="programlisting">
1.129 wiz 7758: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7759: </pre>
1.25 spz 7760: </li>
1.175 gutterid 7761: <li class="listitem"><p>If your package includes a test suite that has extra
7762: dependencies only required for this purpose (frequently this
7763: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7764: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.25 spz 7765: <li class="listitem">
7766: <p>You can use wildcards in package dependencies. Note that
7767: such wildcard dependencies are retained when creating binary
7768: packages. The dependency is checked when installing the binary
7769: package and any package which matches the pattern will be
7770: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7771: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7772: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7773: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7774: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7775: <p>Wildcards can also be used to specify that a package
7776: will only build against a certain minimum version of a
7777: pre-requisite:</p>
7778: <pre class="programlisting">
1.25 spz 7779: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7780: </pre>
1.25 spz 7781: <p>This means that the package will build using version 6.0
7782: of ImageMagick or newer. Such a dependency may be warranted
7783: if, for example, the command line options of an executable
7784: have changed.</p>
7785: <p>If you need to depend on minimum versions of libraries,
1.183 wiz 7786: set
7787: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7788: to the appropriate pattern before including its
7789: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7790: <pre class="programlisting">
7791: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7792: .include "../../graphics/jpeg/buildlink3.mk"
7793: </pre>
1.1 dsieger 7794: <p>For security fixes, please update the package
1.154 rillig 7795: 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 7796: information.</p>
7797: </li>
7798: </ol></div>
7799: <p>If your package needs files from another package to build,
7800: add the relevant distribution files to
7801: <code class="varname">DISTFILES</code>, so they will be extracted
1.207 leot 7802: 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 7803: (It relies on the jpeg sources being present in source form
7804: during the build.)</p>
7805: </div>
1.41 asau 7806: <div class="sect2">
1.1 dsieger 7807: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7808: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.226 gutterid 7809: <p>Your package may conflict with other packages users might
7810: already have installed on their system, e.g., if your package
1.1 dsieger 7811: installs the same set of files as another package in the pkgsrc
1.227 wiz 7812: tree.</p>
1.207 leot 7813: <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>
7814: 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 7815: install the same shared library, thus you set in
7816: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7817: <pre class="programlisting">
7818: CONFLICTS= Xaw-Xpm-[0-9]*
1.238 wiz 7819: </pre>
1.142 leot 7820: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7821: <pre class="programlisting">
7822: CONFLICTS= libXaw3d-[0-9]*
1.238 wiz 7823: </pre>
1.207 leot 7824: <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 7825: that conflict with existing packages and abort. However, in many
7826: situations this is too late in the process. Binary package managers
7827: will not know about the conflict until they attempt to install the
7828: package after already downloading it and all its dependencies.
7829: Users may also waste time building a package and its dependencies
7830: only to find out at the end that it conflicts with another package
7831: they have installed.</p>
7832: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7833: should be added in all cases where it is known that packages conflict
7834: with each other. These <code class="varname">CONFLICTS</code> entries are
1.207 leot 7835: 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 7836: managers to inform users that packages cannot be installed onto
7837: the target system.</p>
1.1 dsieger 7838: </div>
1.41 asau 7839: <div class="sect2">
1.1 dsieger 7840: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7841: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7842: <p>There are several reasons why a package might be
7843: instructed to not build under certain circumstances. If the
7844: package builds and runs on most platforms, the exceptions
1.83 dholland 7845: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7846: the package builds and runs on a small handful of platforms,
7847: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7848: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7849: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7850: (OS-version-platform) that can use glob-style
7851: wildcards.</p>
7852: <p>If a package is not appropriate for some platforms (as
1.114 maya 7853: opposed to merely broken), a different set of variables should be
1.83 dholland 7854: used as this affects failure reporting and statistics.
7855: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7856: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7857: the package is appropriate for only a small handful of platforms
7858: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7859: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7860: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7861: (OS-version-platform) that can use glob-style
7862: wildcards.</p>
7863: <p>Some packages are tightly bound to a specific version of an
1.207 leot 7864: 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 7865: backwards compatible with other versions of the OS, and should be
7866: uploaded to a version specific directory on the FTP server. Mark
7867: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7868: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7869: the package system internals, but may be used in the
7870: future.</p>
7871: <p>If the package should be skipped (for example, because it
7872: provides functionality already provided by the system), set
7873: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7874: the package should fail because some preconditions are not met,
7875: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7876: message.</p>
7877: </div>
1.41 asau 7878: <div class="sect2">
1.1 dsieger 7879: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7880: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7881: <p>To ensure that a package may not be deleted, once it has been
7882: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7883: be set in the package Makefile. This will be carried into any
7884: binary package that is made from this pkgsrc entry. A
1.23 wiz 7885: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.207 leot 7886: 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 7887: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7888: </div>
1.41 asau 7889: <div class="sect2">
1.1 dsieger 7890: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7891: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7892: <p>When a vulnerability is found, this should be noted in
1.205 wiz 7893: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>.
7894: Entries in that file consist of three parts:</p>
7895: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7896: <li class="listitem"><p>package version pattern</p></li>
7897: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
7898: <li class="listitem"><p>URL providing additional information about the issue</p></li>
7899: </ul></div>
7900: <p>For the package version pattern please always use `<' to
7901: mark an upper bound (not `<='!). This will avoid possible
7902: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
7903: related to security fixes. Lower bounds can be added too, using
7904: '>' or '>='. For example,
1.206 wiz 7905: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.205 wiz 7906: versions 1.0 (included) to 1.2 (excluded) of
7907: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
7908: issue.</p>
7909: <p>Entries should always be added at the bottom of the file.</p>
7910: <p>When fixing packages, please modify the upper bound of the
7911: corresponding entry. To continue the previous example, if a fix
7912: was backported to version 1.1nb2, change the previous pattern to
1.206 wiz 7913: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.205 wiz 7914: <p>To locally test a package version pattern against a
7915: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
7916: pmatch</strong></span> command.</p>
7917: <p>The URL should be as permanent as possible and provide as
7918: much information about the issue as possible. CVE entries are
7919: preferred.</p>
7920: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.31 wiz 7921: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7922: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7923: <code class="varname">PKGREVISION</code> should be increased (this is of
7924: course not necessary if the problem is fixed by using a newer
7925: release of the software), and the pattern in the
7926: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7927: <p>Also, if the fix should be applied to the stable pkgsrc
7928: branch, be sure to submit a pullup request!</p>
7929: <p>Binary packages already on ftp.NetBSD.org will be handled
7930: semi-automatically by a weekly cron job.</p>
1.205 wiz 7931: <p>In case a security issue is disputed, please contact
7932: pkgsrc-security@NetBSD.org.</p>
1.1 dsieger 7933: </div>
1.41 asau 7934: <div class="sect2">
1.1 dsieger 7935: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7936: <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 7937: <p>When making fixes to an existing package it can be useful
7938: to change the version number in <code class="varname">PKGNAME</code>. To
7939: avoid conflicting with future versions by the original author, a
1.23 wiz 7940: <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 7941: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7942: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7943: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7944: <pre class="programlisting">
7945: DISTNAME= foo-17.42
7946: PKGREVISION= 9
1.111 sevan 7947: </pre>
1.1 dsieger 7948: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7949: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7950: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7951: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7952: <code class="varname">PKGNAME_NOREV</code>.</p>
7953: <p>When a new release of the package is released, the
7954: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7955: minor release of the above package, things should be like:</p>
7956: <pre class="programlisting">
7957: DISTNAME= foo-17.43
1.111 sevan 7958: </pre>
1.1 dsieger 7959: <p><code class="varname">PKGREVISION</code> should be incremented for any
7960: non-trivial change in the resulting binary package. Without a
7961: <code class="varname">PKGREVISION</code> bump, someone with the previous
7962: version installed has no way of knowing that their package is out
7963: of date. Thus, changes without increasing
7964: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7965: trivial that no reasonable person would want to upgrade", and this
7966: is the rough test for when increasing
7967: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7968: changes that do not merit increasing
7969: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7970: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7971: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169 rillig 7972: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7973: comments in Makefile.</p></li>
7974: <li class="listitem"><p>Changing build variables if the resulting binary
7975: package is the same.</p></li>
7976: <li class="listitem"><p>Changing
7977: <code class="filename">DESCR</code>.</p></li>
7978: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7979: default options don't change.</p></li>
1.1 dsieger 7980: </ul></div>
7981: <p>Examples of changes that do merit an increase to
7982: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7983: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7984: <li class="listitem"><p>Security fixes</p></li>
7985: <li class="listitem"><p>Changes or additions to a patch
7986: file</p></li>
7987: <li class="listitem"><p>Changes to the
7988: <code class="filename">PLIST</code></p></li>
7989: <li class="listitem"><p>A dependency is changed or
7990: renamed.</p></li>
1.1 dsieger 7991: </ul></div>
7992: <p>PKGREVISION must also be incremented when dependencies have ABI
7993: changes.</p>
7994: </div>
1.41 asau 7995: <div class="sect2">
1.1 dsieger 7996: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7997: <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 7998: <p>When you want to replace the same text in multiple files, or
7999: multiple times in the same file, it is cumbersome to maintain a patch
8000: file for this. This is where the SUBST framework steps in. It provides an
8001: easy-to-use interface for replacing text in files. It just needs the
8002: following information:</p>
8003: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8004: <li class="listitem"><p>In which phase of the package build cycle should the
8005: replacement happen?</p></li>
8006: <li class="listitem"><p>In which files should the replacement
1.172 rillig 8007: happen?</p></li>
1.180 rillig 8008: <li class="listitem"><p>Which text should be replaced with
8009: what?</p></li>
1.172 rillig 8010: </ul></div>
8011: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.180 rillig 8012: variables. A minimal example is:</p>
8013: <pre class="programlisting">
8014: SUBST_CLASSES+= paths
8015: SUBST_STAGE.paths= pre-configure
8016: SUBST_FILES.paths= src/*.c
8017: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
8018: </pre>
8019: <p>Translated into English, it means: In the pre-configure stage (that
8020: is, after applying the patches from the patches/ directory and before
8021: running the configure script and the portability check), replace the text
8022: <code class="literal">/usr/local</code> with the content of the variable
8023: <code class="varname">PREFIX</code>.</p>
8024: <p>Each SUBST block starts by appending an identifier to
8025: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
8026: identifier can be chosen freely by the package. If there should ever be
8027: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
8028: early, so don't worry about name collisions.</p>
8029: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
8030: SUBST block are parameterized using this identifier. In the remainder of
8031: this section, these parameterized variables are written as
8032: <code class="varname">SUBST_STAGE.*</code>.</p>
8033: <pre class="programlisting">
8034: SUBST_CLASSES+= paths
8035: SUBST_STAGE.paths= pre-configure
8036: SUBST_MESSAGE.paths= Fixing absolute paths.
8037: SUBST_FILES.paths= src/*.c
8038: SUBST_FILES.paths+= scripts/*.sh
8039: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
8040: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8041: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
8042: </pre>
8043: <p>To get a complete picture about the SUBST substitutions, run
8044: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
8045: expected, run pkglint on the package, which detects several typical
8046: mistakes surrounding the SUBST blocks. For any questions that might
8047: remain after this, have a look at
8048: <code class="filename">mk/subst.mk</code>.</p>
8049: <div class="sect3">
8050: <div class="titlepage"><div><div><h4 class="title">
8051: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
8052: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
8053: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
8054: <code class="literal">pre-configure</code> is used most often, by far. The most
8055: popular stages are, in chronological order:</p>
8056: <div class="variablelist"><dl class="variablelist">
8057: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
8058: <dd>
8059: <p>The substitutions are applied immediately after the
8060: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
8061: package will leave no traces of the original files.</p>
8062: <p>When the substitution applies to files for which there is also a
8063: patch in the <code class="filename">patches/</code> directory, this means that the
8064: patches will be computed based on the result of the substitution. When
8065: these patches are sent to the upstream maintainer later, to be fixed in
8066: the upstream package, these patches may no longer match what the upstream
8067: author is used to. Because of this, <code class="literal">pre-configure</code> is
8068: often a better choice.</p>
8069: </dd>
8070: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
8071: <dd>
8072: <p>The substitutions are applied after the patches from the
8073: <code class="filename">patches/</code> directory. This makes it possible to run
8074: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.207 leot 8075: 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 8076: <p>When updating the patches, it is helpful to explicitly separate the
8077: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
8078: configure</strong></span>, and to only edit the patches between these commands.
8079: Otherwise the substitutions from the SUBST block will end up in the patch
8080: file. When this happens in really obvious ways, pkglint will complain
8081: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
8082: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
8083: can only detect these really obvious
8084: cases.</p>
8085: </dd>
8086: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
8087: <dd><p>This stage should only be used if the package defines a
8088: <code class="literal">pre-configure</code> action itself, and the substitution must
8089: happen after that. Typical examples are packages that use the
8090: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
8091: script from
8092: <code class="filename">configure.ac</code>.</p></dd>
8093: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
8094: <dd><p>This stage is used to fix up any mistakes by the
8095: configure stage.</p></dd>
8096: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
8097: <dd><p>This stage should only be used for substitutions that are
8098: clearly related to building the package, not for fixing the
8099: configuration. Substitutions for pathnames (such as replacing
8100: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
8101: user names (such as replacing <code class="literal">@MY_USER@</code> with the
8102: actual username) belong in pre-configure or post-configure
8103: instead.</p></dd>
8104: <dt><span class="term"><code class="literal">post-build</code></span></dt>
8105: <dd>
8106: <p>Just as with pre-build, this stage should only be used
8107: for substitutions that are clearly related to building the package, not
8108: for fixing the configuration. Substitutions for pathnames (such as
8109: replacing <code class="filename">/usr/local</code> with
8110: <code class="literal">${PREFIX}</code>) or user names (such as replacing
8111: <code class="literal">@MY_USER@</code> with the actual username) belong in
8112: pre-configure or post-configure instead.</p>
8113: <p>A typical use is to update pkg-config files to include the rpath
8114: compiler options.</p>
8115: </dd>
8116: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8117: <dd><p>In general, the install phase should be as simple as
8118: possible. As with the pre-build and post-build stages, it should not be
8119: used to fix pathnames or user names, these belong in pre-configure
8120: instead. There are only few legitimate use cases for applying
8121: substitutions in this stage.</p></dd>
8122: </dl></div>
8123: </div>
8124: <div class="sect3">
8125: <div class="titlepage"><div><div><h4 class="title">
1.181 rillig 8126: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.180 rillig 8127: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8128: filename patterns. These patterns are relative to
8129: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8130: A typical example is:</p>
8131: <pre class="programlisting">
8132: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8133: </pre>
8134: <p>The above patterns, especially the last, are quite broad. The SUBST
8135: implementation checks that each filename pattern that is mentioned here
8136: has an effect. For example, if none of the
8137: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8138: and substituted, that filename pattern is redundant and should be left
1.181 rillig 8139: out. By default, the SUBST framework will complain with an error message.
8140: If the text to be substituted occurs in some of the files from a single
8141: pattern, but not in all of them, that is totally ok, and the SUBST
1.180 rillig 8142: framework will only print an INFO message for those files.</p>
8143: <p>If there is a good reason for having redundant filename patterns,
1.181 rillig 8144: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.180 rillig 8145: <p>Another popular way of choosing the files for the substitutions is
8146: via a shell command, like this:</p>
8147: <pre class="programlisting">
1.181 rillig 8148: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 8149: SUBST_FILES.path= ${C_FILES_CMD:sh}
8150: </pre>
8151: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8152: freely chosen and independent of the SUBST framework.</p>
8153: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8154: lists each file individually. Thereby chances are higher that there are
8155: filename patterns in which no substitution happens. Since the SUBST
8156: framework cannot know whether the filename patterns in
8157: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8158: Makefile (where any redundant filename pattern would be suspicious) or
8159: been generated by a shell command (in which redundant filename patterns
8160: are more likely and to be expected), it will complain about these
8161: redundant filename patterns. Therefore, SUBST blocks that use a shell
8162: command to generate the list of filename patterns often need to set
8163: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8164: </div>
8165: <div class="sect3">
8166: <div class="titlepage"><div><div><h4 class="title">
8167: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8168: <p>In most cases, the substitutions are given using one or more
1.207 leot 8169: <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 8170: <pre class="programlisting">
8171: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8172: </pre>
8173: <p>Each of the sed commands needs to be preceded by the
8174: <code class="literal">-e</code> option and should be specified on a line of its
8175: own, to avoid hiding short sed commands at the end of a line.</p>
8176: <p>Since the sed commands often contain shell metacharacters as the
8177: separator (the <code class="literal">|</code> in the above example), it is common
8178: to enclose them in single quotes.</p>
8179: <p>A common substitution is to replace placeholders of the form
8180: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8181: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8182: <pre class="programlisting">
8183: SUBST_VARS.path= PREFIX
8184: </pre>
8185: <p>This type of substitutions is typically done by the GNU configure
1.181 rillig 8186: scripts during the do-configure stage, but in some cases these need to be
8187: overridden. The same pattern is also used when a package defines patches
8188: that replace previously hard-coded paths like
8189: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8190: placeholder first, which then gets substituted by the actual
8191: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8192: cases, it works equally well to just use the SUBST framework to directly
8193: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8194: thereby omitting the intermediate patch file.</p>
1.180 rillig 8195: <p>If the above is not flexible enough, it is possible to not use sed
8196: at all for the substitution but to specify an entirely different command,
8197: like this:</p>
1.1 dsieger 8198: <pre class="programlisting">
1.180 rillig 8199: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8200: </pre>
8201: <p>This is used for the few remaining packages in which the
8202: distributed files use Windows-style line endings that need to be
8203: converted to UNIX-style line endings.</p>
8204: </div>
8205: <div class="sect3">
8206: <div class="titlepage"><div><div><h4 class="title">
8207: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8208: <p>When a SUBST block is applied during a package build, a message is
8209: logged. The default message is fine for most purposes but can be
8210: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8211: message.</p>
8212: </div>
1.1 dsieger 8213: </div>
8214: </div>
1.41 asau 8215: <div class="sect1">
1.1 dsieger 8216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8217: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 8218: <div class="sect2">
1.1 dsieger 8219: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8220: <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 8221: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8222: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8223: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8224: with the name of each file to download as an argument, expecting
8225: it to output the URL of the directory from which to download
1.207 leot 8226: 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 8227: example of this usage.</p>
8228: <p>If the download can't be automated, because the user must
8229: submit personal information to apply for a password, or must pay
8230: for the source, or whatever, you can set
8231: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8232: displayed to the user before aborting the build. Example:</p>
8233: <pre class="programlisting">
8234: FETCH_MESSAGE= "Please download the files"
8235: FETCH_MESSAGE+= " "${DISTFILES:Q}
8236: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 8237: </pre>
1.1 dsieger 8238: </div>
1.41 asau 8239: <div class="sect2">
1.1 dsieger 8240: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8241: <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 8242: <p>Sometimes authors of a software package make some
8243: modifications after the software was released, and they put up a
8244: new distfile without changing the package's version number. If a
8245: package is already in pkgsrc at that time, the checksum will
8246: no longer match. The contents of the new distfile should be
8247: compared against the old one before changing anything, to make
8248: sure the distfile was really updated on purpose, and that
8249: no trojan horse or so crept in.
8250: Please mention that the distfiles were compared and what was found
1.53 rodent 8251: in your commit message.</p>
1.109 wiz 8252: <p>Then, the correct way to work around this is to set
8253: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8254: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8255: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8256: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 8257: <code class="varname">PATCHFILES</code> for this package will be put in that
1.154 rillig 8258: 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 8259: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 8260: including the <code class="filename">nbX</code> suffix) or a date stamp can
8261: be appended, like
8262: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169 rillig 8263: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8264: name does not contain a version and the distfile is apt to change. In
8265: cases where the likelihood of this is very small,
8266: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8267: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8268: distfile name changes, even if a package is being moved or
8269: renamed.</p>
1.53 rodent 8270: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8271: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8272: path in the filenames.
1.53 rodent 8273: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8274: Furthermore, a mail to the package's authors seems appropriate
8275: telling them that changing distfiles after releases without
8276: changing the file names is not good practice.</p>
8277: </div>
1.88 tnn 8278: <div class="sect2">
8279: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8280: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169 rillig 8281: <p>Helper methods exist for packages hosted on github.com which
8282: will often have distfile names that clash with other packages, for
8283: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8284: from below:</p>
1.88 tnn 8285: <div class="sect3">
8286: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8287: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169 rillig 8288: <p>If your distfile URL looks similar to
1.189 bacon 8289: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.169 rillig 8290: then you are packaging a tagged release.</p>
1.88 tnn 8291: <pre class="programlisting">
1.189 bacon 8292: DISTNAME= example-1.0
1.90 tnn 8293: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8294: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8295: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 8296: EXTRACT_SUFX= .zip
8297: </pre>
1.230 gutterid 8298: <p>Here, DISTNAME combined with use of GITHUB_TAG leads the
8299: file fetching infrastructure to save the resulting file locally as
8300: <code class="literal">example-1.0.zip</code>.</p>
1.88 tnn 8301: </div>
8302: <div class="sect3">
8303: <div class="titlepage"><div><div><h4 class="title">
1.189 bacon 8304: <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>
8305: <p>If your distfile looks similar to
8306: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8307: release, then set the package version to 0.0.0.N, where N is the number
8308: of commits to the repository, and set GITHUB_TAG to the commit hash.
8309: This will (almost) ensure that the first tagged release will have a
8310: version greater than this one so that package upgrades will function
8311: properly.</p>
8312: <pre class="programlisting">
8313: DISTNAME= example-0.0.0.347
8314: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8315: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8316: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8317: </pre>
8318: </div>
8319: <div class="sect3">
8320: <div class="titlepage"><div><div><h4 class="title">
8321: <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>
8322: <p>If your distfile looks similar to
8323: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8324: then include the last release version and the commit count since that
8325: release in the package version and set GITHUB_TAG to the commit hash.
8326: The latest release and commit count are shown in the output of
8327: "git describe --tags":
8328: </p>
8329: <pre class="screen">
8330: # git clone https://github.com/username/example
8331: # cd example
8332: # git describe --tags
8333: 1.2.3-5-g988881a
8334: </pre>
1.88 tnn 8335: <pre class="programlisting">
1.189 bacon 8336: DISTNAME= example-1.2.3.5
8337: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8338: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8339: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 8340: </pre>
1.88 tnn 8341: </div>
8342: <div class="sect3">
8343: <div class="titlepage"><div><div><h4 class="title">
1.189 bacon 8344: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.169 rillig 8345: <p>If your distfile URL looks similar to
1.189 bacon 8346: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.169 rillig 8347: then you are packaging a release.</p>
1.88 tnn 8348: <pre class="programlisting">
8349: DISTNAME= offensive-1.6
1.90 tnn 8350: PKGNAME= ${DISTNAME:S/offensive/proper/}
8351: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8352: GITHUB_PROJECT= example
1.90 tnn 8353: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8354: EXTRACT_SUFX= .zip
1.111 sevan 8355: </pre>
1.88 tnn 8356: </div>
8357: </div>
1.1 dsieger 8358: </div>
1.41 asau 8359: <div class="sect1">
1.1 dsieger 8360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8361: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8362: <div class="sect2">
1.1 dsieger 8363: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8364: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8365: <p>pkgsrc supports many different machines, with different
8366: object formats like a.out and ELF, and varying abilities to do
8367: shared library and dynamic loading at all. To accompany this,
8368: varying commands and options have to be passed to the
8369: compiler, linker, etc. to get the Right Thing, which can be
8370: pretty annoying especially if you don't have all the machines
8371: at your hand to test things. The
1.207 leot 8372: <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 8373: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8374: both static and dynamic libraries from a set of source files,
8375: thus being platform-independent.</p>
8376: <p>Here's how to use libtool in a package in seven simple
8377: steps:</p>
1.23 wiz 8378: <div class="orderedlist"><ol class="orderedlist" type="1">
8379: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8380: Makefile.</p></li>
1.23 wiz 8381: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8382: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8383: add it to the definition of <code class="varname">CC</code>, if only
8384: libraries are being built in a given Makefile. This one command
8385: will build both PIC and non-PIC library objects, so you need not
8386: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8387: <li class="listitem">
1.1 dsieger 8388: <p>For the linking of the library, remove any
1.23 wiz 8389: <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
8390: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8391: <pre class="programlisting">
8392: ${LIBTOOL} --mode=link \
8393: ${CC} -o ${.TARGET:.a=.la} \
8394: ${OBJS:.o=.lo} \
8395: -rpath ${PREFIX}/lib \
8396: -version-info major:minor
1.111 sevan 8397: </pre>
1.1 dsieger 8398: <p>Note that the library is changed to have a
8399: <code class="filename">.la</code> extension, and the objects are
8400: changed to have a <code class="filename">.lo</code>
8401: extension. Change <code class="varname">OBJS</code> as
8402: necessary. This automatically creates all of the
8403: <code class="filename">.a</code>,
8404: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8405: necessary) in the build directory. Be sure to include
1.23 wiz 8406: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8407: minor are zero, as libtool will otherwise strip off the
8408: shared library version.</p>
8409: <p>From the libtool manual:</p>
8410: <pre class="programlisting">
8411: So, libtool library versions are described by three integers:
8412:
8413: CURRENT
8414: The most recent interface number that this library implements.
8415:
8416: REVISION
8417: The implementation number of the CURRENT interface.
8418:
8419: AGE
8420: The difference between the newest and oldest interfaces that
8421: this library implements. In other words, the library implements
8422: all the interface numbers in the range from number `CURRENT -
8423: AGE' to `CURRENT'.
8424:
8425: If two libraries have identical CURRENT and AGE numbers, then the
8426: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 8427: </pre>
1.23 wiz 8428: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8429: different results for a.out and ELF (excluding symlinks)
8430: in only one case. An ELF library of the form
1.23 wiz 8431: <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 8432: will have a symlink of
1.23 wiz 8433: <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 8434: on an a.out platform. This is handled
8435: automatically.</p>
1.23 wiz 8436: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8437: directory of the library being built.</p>
8438: <p>In the <code class="filename">PLIST</code>, include only the
8439: <code class="filename">.la</code> file, the other files will be
8440: added automatically.</p>
8441: </li>
1.23 wiz 8442: <li class="listitem">
1.1 dsieger 8443: <p>When linking shared object (<code class="filename">.so</code>)
1.207 leot 8444: 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 8445: shared libraries, use <span class="quote">“<span class="quote">-module
8446: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8447: tacked on.</p>
8448: <p>The <code class="filename">PLIST</code> file gets the
8449: <code class="filename">foo.so</code> entry.</p>
8450: </li>
1.23 wiz 8451: <li class="listitem">
1.1 dsieger 8452: <p>When linking programs that depend on these libraries
8453: <span class="emphasis"><em>before</em></span> they are installed, preface
1.207 leot 8454: 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 8455: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8456: libraries (static or shared), but please be aware that
8457: libtool will not allow you to specify a relative path in
1.23 wiz 8458: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8459: expects you to change that argument to be the
8460: <code class="filename">.la</code> file. e.g.</p>
8461: <pre class="programlisting">
8462: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 8463: </pre>
1.1 dsieger 8464: <p>should be changed to:</p>
8465: <pre class="programlisting">
8466: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 8467: </pre>
1.1 dsieger 8468: <p>and it will do the right thing with the libraries.</p>
8469: </li>
1.23 wiz 8470: <li class="listitem">
1.207 leot 8471: <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>
8472: 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 8473: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8474: <code class="filename">.la</code>. e.g.</p>
8475: <pre class="programlisting">
1.22 jakllsch 8476: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 8477: </pre>
1.1 dsieger 8478: <p>This will install the static <code class="filename">.a</code>,
8479: shared library, any needed symlinks, and run
1.207 leot 8480: <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 8481: </li>
1.23 wiz 8482: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8483: the <code class="filename">.la</code>
8484: file (this is a change from previous behaviour).</p></li>
8485: </ol></div>
8486: </div>
1.41 asau 8487: <div class="sect2">
1.1 dsieger 8488: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8489: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8490: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8491: package Makefile. This will override the package's own libtool
8492: in most cases. For older libtool using packages, libtool is
8493: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8494: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8495: configure; find work*/ -name libtool</strong></span>.</p>
8496: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8497: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8498: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8499: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8500: package's libtool script(s), set it as appropriate.</p>
8501: <p>If you do not need <code class="filename">*.a</code> static
8502: libraries built and installed, then use
8503: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8504: <p>If your package makes use of the platform-independent library
8505: for loading dynamic shared objects, that comes with libtool
8506: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8507: <p>Some packages use libtool incorrectly so that the package
8508: may not work or build in some circumstances. Some of the more
8509: common errors are:</p>
1.41 asau 8510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8511: <li class="listitem">
1.1 dsieger 8512: <p>The inclusion of a shared object (-module) as a dependent library in an
8513: executable or library. This in itself isn't a problem if one of two things
8514: has been done:</p>
1.23 wiz 8515: <div class="orderedlist"><ol class="orderedlist" type="1">
8516: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8517: <code class="filename">libfoo.la</code>, not
8518: <code class="filename">foo.la</code></p></li>
1.23 wiz 8519: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8520: </ol></div>
8521: </li>
1.23 wiz 8522: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8523: The function lt_dlinit() should be called and the macro
8524: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8525: executables.</p></li>
8526: </ul></div>
8527: </div>
1.41 asau 8528: <div class="sect2">
1.1 dsieger 8529: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8530: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8531: <p>If a package needs GNU autoconf or automake to be executed
1.223 nia 8532: to regenerate the
8533: <code class="filename">configure</code>
8534: script and <code class="filename">Makefile.in</code> makefile
8535: templates from <code class="filename">configure.ac</code> and
8536: <code class="filename">Makefile.am</code>,
8537: then they should be executed in a pre-configure target:</p>
1.1 dsieger 8538: <pre class="programlisting">
1.223 nia 8539: USE_TOOLS+= autoconf automake autoreconf
8540: GNU_CONFIGURE= yes
1.1 dsieger 8541: ...
8542:
8543: pre-configure:
1.223 nia 8544: set -e; cd ${WRKSRC} && autoreconf -fi
1.1 dsieger 8545: ...
1.111 sevan 8546: </pre>
1.223 nia 8547: <p>Packages which use GNU Automake will sometimes
8548: require GNU Make (<code class="literal">gmake</code> in
8549: <code class="varname">USE_TOOLS</code>),
8550: but not always. Note that autoreconf
8551: only needs to be executed if <code class="filename">configure.ac</code>
8552: or Makefiles are modified, or <code class="filename">configure</code>
8553: is not present.</p>
1.1 dsieger 8554: <p>There are times when the configure process makes
8555: additional changes to the generated files, which then causes
8556: the build process to try to re-execute the automake sequence.
8557: This is prevented by touching various files in the configure
8558: stage. If this causes problems with your package you can set
8559: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8560: Makefile.</p>
8561: </div>
1.223 nia 8562: <div class="sect2">
8563: <div class="titlepage"><div><div><h3 class="title">
8564: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
8565: <p>Packages using Meson to configure need to include:
8566:
8567: </p>
8568: <pre class="programlisting">
8569: .include "../../devel/meson/build.mk"
8570: </pre>
8571: <p>In nearly all cases (any program with dependencies),
8572: pkg-config needs to be added to
8573: <code class="varname">USE_TOOLS</code>. If the package installs
8574: translation files for non-English languages, also
8575: add msgfmt and xgettext:
8576:
8577: </p>
8578: <pre class="programlisting">
8579: USE_TOOLS+= pkg-config msgfmt xgettext
8580: </pre>
8581: <p>If any options need to be passed to Meson, use
8582: <code class="varname">MESON_ARGS</code> instead of
8583: <code class="varname">CONFIGURE_ARGS</code>:
8584:
8585: </p>
8586: <pre class="programlisting">
8587: MESON_ARGS+= -Dx11=false
8588: </pre>
8589: </div>
1.1 dsieger 8590: </div>
1.41 asau 8591: <div class="sect1">
1.1 dsieger 8592: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8593: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41 asau 8594: <div class="sect2">
1.1 dsieger 8595: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8596: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.223 nia 8597: <p>Compilers for the C and C++ languages comes with
1.1 dsieger 8598: the NetBSD base system. By default, pkgsrc assumes that a package
8599: is written in C and will hide all other compilers (via the wrapper
1.184 rillig 8600: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8601: <p>To declare which language's compiler a package needs, set
8602: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.212 wiz 8603: currently are:
1.238 wiz 8604: </p>
1.212 wiz 8605: <pre class="programlisting">
1.238 wiz 8606: c99, c++, c++03, gnu++03, c++0x, gnu++0x, c++11, gnu++11,
8607: c++14, gnu++14, c++17, gnu++17, c++20, gnu++20, fortran,
8608: fortran77, java, objc, obj-c++, and ada.
8609: </pre>
1.212 wiz 8610: <p>
8611: (and any combination). The default is
1.23 wiz 8612: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8613: written in C++, usually need a C compiler for the configure
8614: phase.</p>
1.223 nia 8615: <p>To express a general requirement on a specific C or C++
8616: version, normally only <code class="varname">GCC_REQD</code> needs to be set.
8617: For example, GCC 7 includes support for C++17, so if the package uses
8618: C++17 it should specify:
8619:
1.238 wiz 8620: </p>
1.223 nia 8621: <pre class="programlisting">
1.238 wiz 8622: GCC_REQD+= 7
8623: </pre>
1.223 nia 8624: <p>Language variants like <code class="literal">c++11</code> for
8625: <code class="varname">USE_LANGUAGES</code> should only be specified
8626: if the package does not explicitly set <code class="literal">-std=...</code>
8627: when compiling (i.e. the package assumes the compiler defaults to
8628: C++11 or some other standard). This is usually a bug in the
8629: upstream build system.</p>
8630: <p>GCC version 5 includes support for C++14, while GCC 4.7 includes
8631: more-or-less complete support for C++11. For more information, consult
8632: <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 8633: </div>
1.41 asau 8634: <div class="sect2">
1.1 dsieger 8635: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8636: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 8637: <p>If a program is written in Java, use the Java framework in
8638: pkgsrc. The package must include
8639: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8640: provides the following variables:</p>
1.41 asau 8641: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8642: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8643: dependency on the JDK is added. If
1.23 wiz 8644: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8645: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8646: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8647: JDK.</p></li>
1.23 wiz 8648: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8649: a package needs a Java2 implementation. The supported values
1.23 wiz 8650: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8651: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8652: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8653: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8654: above. This variable is not set by default.</p></li>
1.24 wiz 8655: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8656: automatically set to the runtime location of the used Java
8657: implementation dependency. It may be used to set
8658: <code class="varname">JAVA_HOME</code> to a good value if the program
8659: needs this variable to be defined.
8660: </p></li>
1.1 dsieger 8661: </ul></div>
8662: </div>
1.41 asau 8663: <div class="sect2">
1.1 dsieger 8664: <div class="titlepage"><div><div><h3 class="title">
1.205 wiz 8665: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
8666: <p>If a program is written in Go and has any dependencies on
8667: other Go modules, have the package include
8668: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8669: <div class="orderedlist"><ol class="orderedlist" type="1">
8670: <li class="listitem"><p>Generate a list of those dependencies with
8671: <span class="command"><strong>make clean && make patch && make show-go-modules >
8672: go-modules.mk</strong></span>.</p></li>
1.223 nia 8673: <li class="listitem"><p>Prepend
8674: <code class="literal">.include "go-modules.mk"</code> to any other
8675: <code class="literal">.include</code>s.</p></li>
8676: <li class="listitem"><p>Incorporate these modules in
8677: <code class="filename">distinfo</code> with <span class="command"><strong>make
8678: makesum</strong></span>.</p></li>
8679: </ol></div>
8680: </div>
8681: <div class="sect2">
8682: <div class="titlepage"><div><div><h3 class="title">
8683: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
8684: <p>If a program is written in Rust and uses Cargo to build,
8685: have the package include
8686: <code class="filename">../../lang/rust/cargo.mk</code>.</p>
8687: <div class="orderedlist"><ol class="orderedlist" type="1">
8688: <li class="listitem"><p>Generate a list of those dependencies with
8689: <span class="command"><strong>make CARGO_ARGS="build --release" build &&
8690: make print-cargo-depends > cargo-depends.mk</strong></span>.</p></li>
8691: <li class="listitem"><p>Prepend
8692: <code class="literal">.include "cargo-depends.mk"</code> to any other
8693: <code class="literal">.include</code>s.</p></li>
1.205 wiz 8694: <li class="listitem"><p>Incorporate these modules in
8695: <code class="filename">distinfo</code> with <span class="command"><strong>make
8696: makesum</strong></span>.</p></li>
8697: </ol></div>
8698: </div>
8699: <div class="sect2">
8700: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8701: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.203 nia 8702: <p>If your package contains interpreted Perl scripts, add
1.23 wiz 8703: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8704: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8705: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8706: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8707: that you want adjusted. Every occurrence of
8708: <code class="filename">*/bin/perl</code> in a she-bang line will be
1.210 gutterid 8709: replaced with the full path to the Perl executable.</p>
8710: <p>If a particular version of Perl is needed, set the
1.1 dsieger 8711: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8712: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.203 nia 8713: <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 8714: about handling Perl modules.</p>
8715: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
8716: for the language now known as Raku.</p>
1.1 dsieger 8717: </div>
1.41 asau 8718: <div class="sect2">
1.1 dsieger 8719: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8720: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 8721: <p><code class="varname">REPLACE_SH</code>,
8722: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8723: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.225 gutterid 8724: she-bangs in files. Please use the appropriate one, preferring
8725: <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.74 wiz 8726: Each should contain a list of scripts, relative to
8727: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8728: occurrence of the matching shell in a she-bang line will be
8729: replaced with the full path to the shell executable.
1.40 wiz 8730: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8731: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8732: </div>
1.41 asau 8733: <div class="sect2">
1.40 wiz 8734: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8735: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.210 gutterid 8736: <p>There are further similar REPLACE variables available, e.g.,
8737: <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
8738: and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.211 gutterid 8739: noted above, have their actions defined centrally in
1.210 gutterid 8740: <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.211 gutterid 8741: languages define the actions of these variables within their own
8742: dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
8743: actioned in <code class="filename">lang/php/phpversion.mk</code>, and
8744: <code class="varname">REPLACE_PYTHON</code> is actioned in
1.210 gutterid 8745: <code class="filename">lang/python/application.mk</code>. For other languages,
8746: consult the mk files found within their specific directories (the
1.216 gutterid 8747: naming convention varies), or check the list found in
8748: <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.210 gutterid 8749: <p>Currently, special handling for other languages varies
1.1 dsieger 8750: in pkgsrc. If a compiler package provides a
8751: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8752: just add a (build) dependency on the appropriate compiler
8753: package.</p>
8754: </div>
8755: </div>
1.41 asau 8756: <div class="sect1">
1.1 dsieger 8757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8758: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8759: <p>The most common failures when building a package are that
8760: some platforms do not provide certain header files, functions or
8761: libraries, or they provide the functions in a library that the
8762: original package author didn't know. To work around this, you
8763: can rewrite the source code in most cases so that it does not
8764: use the missing functions or provides a replacement function.</p>
1.41 asau 8765: <div class="sect2">
1.1 dsieger 8766: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8767: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8768: <p>If a package already comes with a GNU configure script, the
8769: preferred way to fix the build failure is to change the
8770: configure script, not the code. In the other cases, you can
8771: utilize the C preprocessor, which defines certain macros
8772: depending on the operating system and hardware architecture it
8773: compiles for. These macros can be queried using for example
8774: <code class="varname">#if defined(__i386)</code>. Almost every operating
8775: system, hardware architecture and compiler has its own macro.
8776: For example, if the macros <code class="varname">__GNUC__</code>,
8777: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8778: are all defined, you know that you are using NetBSD on an i386
8779: compatible CPU, and your compiler is GCC.</p>
8780: <p>The list of the following macros for hardware and
8781: operating system depends on the compiler that is used. For
8782: example, if you want to conditionally compile code on Solaris,
8783: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8784: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8785: <div class="sect3">
1.1 dsieger 8786: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8787: <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 8788: <p>To distinguish between specific NetBSD versions,
8789: you should use the following code.</p>
8790: <pre class="programlisting">
8791: #ifdef __NetBSD__
8792: #include <sys/param.h>
8793: #if __NetBSD_Prereq__(9,99,17)
8794: /* use a newer feature */
8795: #else
8796: /* older code */
8797: #endif
8798: #endif
8799:
8800: #ifndef _WIN32
8801: /* Unix-like specific code */
8802: #endif
8803: </pre>
1.1 dsieger 8804: <p>To distinguish between 4.4 BSD-derived systems and the
8805: rest of the world, you should use the following code.</p>
8806: <pre class="programlisting">
8807: #include <sys/param.h>
8808: #if (defined(BSD) && BSD >= 199306)
8809: /* BSD-specific code goes here */
8810: #else
8811: /* non-BSD-specific code goes here */
8812: #endif
8813: </pre>
1.223 nia 8814: <p>You can also test for the following macros:</p>
1.1 dsieger 8815: <pre class="programlisting">
1.45 obache 8816: Cygwin __CYGWIN__
8817: DragonFly __DragonFly__
1.1 dsieger 8818: FreeBSD __FreeBSD__
1.45 obache 8819: Haiku __HAIKU__
1.1 dsieger 8820: Interix __INTERIX
8821: IRIX __sgi (TODO: get a definite source for this)
1.223 nia 8822: Linux __linux
1.83 dholland 8823: Mac OS X __APPLE__
1.45 obache 8824: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8825: Minix3 __minix
1.1 dsieger 8826: NetBSD __NetBSD__
8827: OpenBSD __OpenBSD__
8828: Solaris sun, __sun
8829: </pre>
8830: </div>
1.41 asau 8831: <div class="sect3">
1.1 dsieger 8832: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8833: <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 8834: <pre class="programlisting">
8835: i386 i386, __i386, __i386__
1.223 nia 8836: x86-64 __amd64__, __x86_64__
8837: ARM __arm__
1.1 dsieger 8838: MIPS __mips
8839: SPARC sparc, __sparc
1.223 nia 8840: PowerPC __powerpc
1.1 dsieger 8841: </pre>
8842: </div>
1.41 asau 8843: <div class="sect3">
1.1 dsieger 8844: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8845: <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 8846: <pre class="programlisting">
8847: GCC __GNUC__ (major version), __GNUC_MINOR__
8848: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8849: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8850: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8851: </pre>
8852: </div>
8853: </div>
1.41 asau 8854: <div class="sect2">
1.1 dsieger 8855: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8856: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8857: <p>Some source files trigger bugs in the compiler, based on
8858: combinations of compiler version and architecture and almost
8859: always relation to optimisation being enabled. Common symptoms
8860: are gcc internal errors or never finishing compiling a
8861: file.</p>
8862: <p>Typically, a workaround involves testing the
8863: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8864: optimisation for that combination of file,
1.87 tnn 8865: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8866: <p>This used to be a big problem in the past, but is rarely
8867: needed now as compiler technology has matured. If you still need
8868: to add a compiler specific workaround, please do so in the file
8869: <code class="filename">hacks.mk</code> and describe the symptom and
8870: compiler version as detailed as possible.</p>
1.1 dsieger 8871: </div>
1.41 asau 8872: <div class="sect2">
1.1 dsieger 8873: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8874: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8875: <p>Compilation sometimes fails with an error message like this:</p>
8876: <pre class="programlisting">
8877: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8878: fatal error: pango/pango.h: No such file or directory
8879: </pre>
8880: <p>The proper way to fix this problem depends on the type of the
8881: header, which is described in the following sections.</p>
8882: <div class="sect3">
8883: <div class="titlepage"><div><div><h4 class="title">
8884: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8885: <p>If the header name looks like it comes from a different package,
8886: that other package should be included via the buildlink3
8887: framework.</p>
8888: <p>First, look whether the header is somewhere in the buildlink3
8889: directory below <code class="varname">WRKDIR</code>. In the above case of
8890: the missing Pango header:</p>
8891: <pre class="programlisting">
8892: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8893: </pre>
8894: <p>In the case of Pango, the output is:</p>
8895: <pre class="programlisting">
8896: work/.buildlink/include/pango-1.0/pango/pango.h
8897: </pre>
8898: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8899: in the <code class="filename">.buildlink</code> directory, it would have been
8900: found automatically. There is an extra <code class="filename">pango-1.0</code>
8901: path component though, which means that the compiler command line must
8902: contain an option of the form
8903: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8904: most cases this option is generated by the configure script, which can be examined using:</p>
8905: <pre class="programlisting">
8906: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8907: -I/usr/pkg/include/pango-1.0
8908: -I/usr/pkg/include/pango-1.0
8909: -I/usr/pkg/include/pango-1.0
8910: -I/usr/pkg/include/pango-1.0
8911: -I/usr/pkg/include/pango-1.0
8912: </pre>
8913: <p>This looks good. These options are transformed by the buildlink
8914: wrapper to refer to the correct path inside
8915: <code class="filename">work/.buildlink</code>.</p>
8916: <p>Since the compilation fails though, examine the compiler command
8917: lines in <code class="filename">work/.work.log</code> to see whether the
8918: <code class="literal">-I</code> option is included in the particular command
8919: line.</p>
8920: <p>To further analyze the situation, run <span class="command"><strong>bmake
8921: build-env</strong></span>, which sets up an interactive, realistic environment
8922: including all the pkgsrc wrapper commands and environment variables. From
8923: there, try to compile some simple example programs that use the
8924: header.</p>
8925: </div>
8926: <div class="sect3">
8927: <div class="titlepage"><div><div><h4 class="title">
8928: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8929: <p>If the name of the header seems to come from the package itself,
8930: and if the build is run with parallel jobs, the package may have some
8931: undeclared dependencies between the <code class="filename">.c</code> and the
8932: <code class="filename">.h</code> files, and a C file is compiled before its
8933: required header is generated.</p>
8934: <p>To see whether the build runs with parallel jobs, run
8935: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8936: like this:</p>
8937: <pre class="programlisting">
8938: usr MAKE_JOBS= 7
8939: pkg MAKE_JOBS_SAFE # undefined
8940: def _MAKE_JOBS_N= 7
8941: </pre>
8942: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8943: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8944: package could have disabled parallel builds by setting
8945: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8946: in this case it hasn't.</p>
8947: <p>To see whether the build failure is caused by parallel builds,
8948: first save the exact error message and a bit of context, maybe you need
8949: it later for reporting a bug. Next, run:</p>
8950: <pre class="programlisting">
8951: MAKE_JOBS_SAFE=no bmake clean build
8952: </pre>
8953: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8954: report</a> against the pkgsrc package, including the exact error
8955: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8956: </div>
1.173 rillig 8957: <div class="sect3">
8958: <div class="titlepage"><div><div><h4 class="title">
8959: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
8960: <p>Pkgsrc does not work reliably if any of
8961: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
8962: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
8963: bootstrap program prevents installing pkgsrc in symlink-based
8964: directories. Existing pkgsrc installations are not checked for symlinks
8965: though.</p>
8966: <p>The "No such file or directory" error messages are a typical
8967: symptom of symlinks, and it's quite difficult to find out that this is
8968: the actual cause.</p>
8969: </div>
8970: <div class="sect3">
8971: <div class="titlepage"><div><div><h4 class="title">
8972: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
8973: <p>When building a hierarchy of packages, it may happen that one
8974: package is built and then pkgsrc is updated. This situation can provoke
8975: various hard to diagnose build errors. To clean up the situation:</p>
8976: <pre class="programlisting">
1.223 nia 8977: <code class="prompt">$</code> (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.173 rillig 8978: </pre>
1.223 nia 8979: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
8980: prevent running this command in the wrong directory.)</p>
1.173 rillig 8981: <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
8982: that directory as well.</p>
8983: </div>
8984: <div class="sect3">
8985: <div class="titlepage"><div><div><h4 class="title">
8986: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
8987: <p>On platforms other than BSD, third-party packages are installed in
8988: <code class="filename">/usr/include</code>, together with the base system. This
8989: means that pkgsrc cannot distinguish between headers provided by the base
8990: system (which it needs) and headers from third-party packages (which are
8991: often included in pkgsrc as well). This can lead to subtle version
8992: mismatches.</p>
8993: <p>In pkgsrc installations that have been active for several years, it
8994: may happen that some files are manually deleted. To exclude this unlikely
8995: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
8996: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
8997: check/fix dependencies.</p>
8998: <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>
8999: for contact information. Be prepared to describe what you have tried so
9000: far and what any error messages were.</p>
9001: </div>
1.172 rillig 9002: </div>
9003: <div class="sect2">
9004: <div class="titlepage"><div><div><h3 class="title">
9005: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 9006: </h3></div></div></div>
1.1 dsieger 9007: <p>This error message often means that a package did not
9008: link to a shared library it needs. The following functions are
9009: known to cause this error message over and over.</p>
9010: <div class="informaltable">
1.106 tnn 9011: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 9012: <colgroup>
9013: <col>
9014: <col>
9015: <col>
9016: </colgroup>
9017: <thead><tr>
9018: <th>Function</th>
9019: <th>Library</th>
9020: <th>Affected platforms</th>
9021: </tr></thead>
9022: <tbody>
9023: <tr>
9024: <td>accept, bind, connect</td>
9025: <td>-lsocket</td>
9026: <td>Solaris</td>
9027: </tr>
9028: <tr>
9029: <td>crypt</td>
9030: <td>-lcrypt</td>
9031: <td>DragonFly, NetBSD</td>
9032: </tr>
9033: <tr>
9034: <td>dlopen, dlsym</td>
9035: <td>-ldl</td>
9036: <td>Linux</td>
9037: </tr>
9038: <tr>
9039: <td>gethost*</td>
9040: <td>-lnsl</td>
9041: <td>Solaris</td>
9042: </tr>
9043: <tr>
9044: <td>inet_aton</td>
9045: <td>-lresolv</td>
9046: <td>Solaris</td>
9047: </tr>
9048: <tr>
9049: <td>nanosleep, sem_*, timer_*</td>
9050: <td>-lrt</td>
9051: <td>Solaris</td>
9052: </tr>
9053: <tr>
9054: <td>openpty</td>
9055: <td>-lutil</td>
9056: <td>Linux</td>
9057: </tr>
9058: </tbody>
9059: </table>
9060: </div>
1.223 nia 9061: <p>To fix these linker errors, it is often sufficient to add
1.1 dsieger 9062: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
9063: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.223 nia 9064: <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.1 dsieger 9065: bmake</strong></span>.</p>
1.41 asau 9066: <div class="sect3">
1.1 dsieger 9067: <div class="titlepage"><div><div><h4 class="title">
1.223 nia 9068: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.1 dsieger 9069: <p>When you are using the SunPro compiler, there is another
9070: possibility. That compiler cannot handle the following code:</p>
9071: <pre class="programlisting">
9072: extern int extern_func(int);
9073:
9074: static inline int
9075: inline_func(int x)
9076: {
9077: return extern_func(x);
9078: }
9079:
9080: int main(void)
9081: {
9082: return 0;
9083: }
9084: </pre>
9085: <p>It generates the code for <code class="function">inline_func</code> even if
9086: that function is never used. This code then refers to
9087: <code class="function">extern_func</code>, which can usually not be resolved. To
9088: solve this problem you can try to tell the package to disable inlining
9089: of functions.</p>
9090: </div>
1.228 gutterid 9091: <div class="sect3">
9092: <div class="titlepage"><div><div><h4 class="title">
9093: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
9094: <p>When building for older machine architectures (e.g., i386, PowerPC),
9095: builds may fail because the package expects modern 64-bit atomic functions
9096: which the underlying hardware either doesn't support, or will only support
9097: with specific compiler flags. This is generally handled via inclusion of
9098: mk/atomic64.mk.</p>
9099: </div>
1.1 dsieger 9100: </div>
1.41 asau 9101: <div class="sect2">
1.1 dsieger 9102: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 9103: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1 dsieger 9104: <p>Sometimes packages fail to build because the compiler runs
9105: into an operating system specific soft limit. With the
9106: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.223 nia 9107: to unlimit the resources. The allowed values are any combination of
9108: <span class="quote">“<span class="quote">cputime</span>”</span>,
9109: <span class="quote">“<span class="quote">datasize</span>”</span>,
9110: <span class="quote">“<span class="quote">memorysize</span>”</span>,
9111: <span class="quote">“<span class="quote">stacksize</span>”</span> and
9112: <span class="quote">“<span class="quote">virtualsize</span>”</span>.
1.1 dsieger 9113: Setting this variable is similar to running the shell builtin
1.10 hubertf 9114: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 9115: segment size or maximum stack size of a process, respectively, to
9116: their hard limits.</p>
9117: </div>
9118: </div>
1.41 asau 9119: <div class="sect1">
1.1 dsieger 9120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9121: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 9122: <div class="sect2">
1.1 dsieger 9123: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9124: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 9125: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 9126: with some operating systems cannot create more than one
9127: directory at a time. As such, you should call
9128: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
9129: <pre class="programlisting">
9130: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
9131: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 9132: </pre>
1.223 nia 9133: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
9134: directly, you can also append <span class="quote">“<span class="quote"><code class="literal">dir1
9135: dir2</code></span>”</span> to the <code class="varname">INSTALLATION_DIRS</code>
9136: variable, which will automatically do the right thing.</p>
1.1 dsieger 9137: </div>
1.41 asau 9138: <div class="sect2">
1.1 dsieger 9139: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9140: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 9141: <p>In general, documentation should be installed into
9142: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.223 nia 9143: <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.1 dsieger 9144: includes the version number of the package).</p>
9145: <p>Many modern packages using GNU autoconf allow to set the
9146: directory where HTML documentation is installed with the
1.223 nia 9147: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag is
9148: needed because otherwise the documentation ends up in
9149: <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
9150: pkgsrc, the HTML documentation should go into the package-specific
9151: directory, just like any other documentation.</p>
1.1 dsieger 9152: <p>An exception to the above is that library API documentation
1.207 leot 9153: 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 9154: browsers (devhelp) should be left at their default location, which
9155: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
9156: documentation can be recognized from files ending in
9157: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
9158: (It is also acceptable to install such files in
9159: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
9160: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
9161: <code class="filename">.devhelp*</code> file must be directly in that
9162: directory then, no additional subdirectory level is allowed in
9163: this case. This is usually achieved by using
1.23 wiz 9164: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 9165: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
9166: though.)</p>
9167: </div>
1.41 asau 9168: <div class="sect2">
1.1 dsieger 9169: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9170: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 9171: <p>Certain packages, most of them in the games category, install
9172: a score file that allows all users on the system to record their
9173: highscores. In order for this to work, the binaries need to be
9174: installed setgid and the score files owned by the appropriate
1.35 wiz 9175: group and/or owner (traditionally the "games" user/group). Set
9176: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 9177: following variables, documented in more detail in
9178: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 9179: behaviour: <code class="varname">GAMEDATAMODE</code>,
9180: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 9181: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
9182: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
9183: <code class="varname">GAMEDATA_PERMS</code> and
9184: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
9185: <p>An example that illustrates some of the variables described above is
9186: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
9187: used to properly set directory permissions of the directory where the
9188: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
9189: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
9190: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
9191: binary:</p>
9192: <pre class="programlisting">
1.112 rillig 9193: USE_GAMESGROUP= yes
1.100 leot 9194:
1.112 rillig 9195: BUILD_DEFS+= VARBASE
1.100 leot 9196:
1.112 rillig 9197: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
9198: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
9199: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 9200: </pre>
1.100 leot 9201: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
9202: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
9203: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
9204: needed to be accessed by setgid games and
9205: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 9206: <p>A package should therefore never hard code file ownership or
1.100 leot 9207: access permissions but rely on <code class="varname">*_PERMS</code> as described above
9208: or alternatively on <code class="varname">INSTALL_GAME</code>,
9209: <code class="varname">INSTALL_GAME_DATA</code> and
9210: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 9211: </div>
1.41 asau 9212: <div class="sect2">
1.1 dsieger 9213: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9214: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 9215: <p><code class="varname">DESTDIR</code> support means that a package
9216: installs into a staging directory, not the final location of the
9217: files. Then a binary package is created which can be used for
9218: installation as usual. There are two ways: Either the package must
1.23 wiz 9219: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9220: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 9221: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9222: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 9223: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
9224: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 9225: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9226: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 9227: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9228: the inclusion.</p></li>
1.23 wiz 9229: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 9230: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 9231: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 9232: automatically. Many manual rules and pre/post-install often are
9233: incorrect; fix them.</p></li>
1.23 wiz 9234: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 9235: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 9236: <li class="listitem"><p>In general, packages should support
1.4 rillig 9237: <code class="varname">UNPRIVILEGED</code> to be able to use
9238: DESTDIR.</p></li>
9239: </ul></div>
9240: </div>
1.41 asau 9241: <div class="sect2">
1.4 rillig 9242: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9243: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 9244: <p>Your package may also contain scripts with hardcoded paths to
1.203 nia 9245: other interpreters besides (or as well as) Perl. To correct the
1.1 dsieger 9246: full pathname to the script interpreter, you need to set the
9247: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 9248: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 9249: <pre class="programlisting">
9250: REPLACE_INTERPRETER+= tcl
9251: REPLACE.tcl.old= .*/bin/tclsh
9252: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9253: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9254: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 9255: </pre>
1.1 dsieger 9256: </div>
1.41 asau 9257: <div class="sect2">
1.1 dsieger 9258: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9259: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.1 dsieger 9260: <p>Makefiles of packages providing perl5 modules should include
9261: the Makefile fragment
9262: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 9263: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 9264: configuration for such modules as well as various hooks to tune
9265: this configuration. See comments in this file for
9266: details.</p>
9267: <p>Perl5 modules will install into different places depending
9268: on the version of perl used during the build process. To
9269: address this, pkgsrc will append lines to the
9270: <code class="filename">PLIST</code> corresponding to the files listed in
9271: the installed <code class="filename">.packlist</code> file generated by
9272: most perl5 modules. This is invoked by defining
9273: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 9274: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9275: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9276: e.g.:</p>
1.1 dsieger 9277: <pre class="programlisting">
1.47 wiz 9278: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 9279: </pre>
1.47 wiz 9280: <p>The perl5 config variables
9281: <code class="varname">installarchlib</code>,
9282: <code class="varname">installscript</code>,
9283: <code class="varname">installvendorbin</code>,
9284: <code class="varname">installvendorscript</code>,
9285: <code class="varname">installvendorarch</code>,
9286: <code class="varname">installvendorlib</code>,
9287: <code class="varname">installvendorman1dir</code>, and
9288: <code class="varname">installvendorman3dir</code> represent those
9289: locations in which components of perl5 modules may be installed,
9290: provided as variable with uppercase and prefixed with
9291: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9292: and may be used by perl5 packages that don't have a packlist.
9293: These variables are also substituted for in the
9294: <code class="filename">PLIST</code> as uppercase prefixed with
9295: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 9296: </div>
1.41 asau 9297: <div class="sect2">
1.1 dsieger 9298: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9299: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 9300: <p>Some packages install info files or use the
1.23 wiz 9301: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 9302: commands. <code class="varname">INFO_FILES</code> should be defined in
9303: the package Makefile so that <code class="filename">INSTALL</code> and
9304: <code class="filename">DEINSTALL</code> scripts will be generated to
9305: handle registration of the info files in the Info directory
1.23 wiz 9306: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 9307: files registration is either provided by the system, or by a
9308: special purpose package automatically added as dependency if
9309: needed.</p>
9310: <p><code class="varname">PKGINFODIR</code> is the directory under
9311: <code class="filename">${PREFIX}</code> where info files are primarily
9312: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 9313: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 9314: <p>The info files for the package should be listed in the
9315: package <code class="filename">PLIST</code>; however any split info files
9316: need not be listed.</p>
1.23 wiz 9317: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9318: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 9319: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 9320: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 9321: should be noted with the <code class="varname">TEXINFO_REQD</code>
9322: variable in the package <code class="filename">Makefile</code>. By
9323: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 9324: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 9325: does not match the required minimum, a build dependency on the
1.207 leot 9326: <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 9327: be added automatically.</p>
9328: <p>The build and installation process of the software provided
9329: by the package should not use the
1.10 hubertf 9330: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 9331: info files is the task of the package
9332: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 9333: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 9334: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 9335: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9336: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 9337: in <code class="varname">PATH</code>.</p>
1.10 hubertf 9338: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 9339: no effect except the logging of a message. The script overriding
1.10 hubertf 9340: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 9341: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 9342: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 9343: </div>
1.41 asau 9344: <div class="sect2">
1.1 dsieger 9345: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9346: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9347: <p>All packages that install manual pages should install them
9348: into the same directory, so that there is one common place to look
9349: for them. In pkgsrc, this place is
9350: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9351: should be used in packages. The default for
9352: <code class="varname">PKGMANDIR</code> is
1.23 wiz 9353: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9354: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 9355: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9356: <h3 class="title">Note</h3>
9357: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9358: is far from complete.</p>
9359: </div>
9360: <p>The <code class="filename">PLIST</code> files can just use
9361: <code class="filename">man/</code> as the top level directory for the man
9362: page file entries, and the pkgsrc framework will convert as
9363: needed. In all other places, the correct
9364: <code class="varname">PKGMANDIR</code> must be used.</p>
9365: <p>Packages that are
9366: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 9367: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 9368: <code class="filename">./configure</code>
9369: --mandir switch to set where the man pages should be installed.
9370: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9371: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9372: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9373: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 9374: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 9375: Or if the <code class="filename">./configure</code> script uses
9376: a non-standard use of --mandir, you can set
9377: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.184 rillig 9378: <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 9379: information on installation of compressed manual pages.</p>
9380: </div>
1.41 asau 9381: <div class="sect2">
1.1 dsieger 9382: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9383: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9384: <p>If a package installs font files, you will need to rebuild
9385: the fonts database in the directory where they get installed at
9386: installation and deinstallation time. This can be automatically
9387: done by using the pkginstall framework.</p>
9388: <p>You can list the directories where fonts are installed in the
9389: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9390: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 9391: <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 9392: Also make sure that the database file
9393: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9394: <p>Note that you should not create new directories for fonts;
9395: instead use the standard ones to avoid that the user needs to
9396: manually configure his X server to find them.</p>
9397: </div>
1.41 asau 9398: <div class="sect2">
1.1 dsieger 9399: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9400: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9401: <p>If a package installs SGML or XML data files that need to be
9402: registered in system-wide catalogs (like DTDs, sub-catalogs,
9403: etc.), you need to take some extra steps:</p>
1.23 wiz 9404: <div class="orderedlist"><ol class="orderedlist" type="1">
9405: <li class="listitem"><p>Include
1.1 dsieger 9406: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9407: your <code class="filename">Makefile</code>, which takes care of
9408: registering those files in system-wide catalogs at
9409: installation and deinstallation time.</p></li>
1.23 wiz 9410: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9411: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9412: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9413: any XML catalogs installed by the package.</p></li>
1.23 wiz 9414: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9415: to be added to the SGML catalog. These come in groups of
9416: three strings; see xmlcatmgr(1) for more information
9417: (specifically, arguments recognized by the 'add' action).
9418: Note that you will normally not use this variable.</p></li>
1.23 wiz 9419: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9420: to be added to the XML catalog. These come in groups of three
9421: strings; see xmlcatmgr(1) for more information (specifically,
9422: arguments recognized by the 'add' action). Note that you will
9423: normally not use this variable.</p></li>
9424: </ol></div>
9425: </div>
1.41 asau 9426: <div class="sect2">
1.1 dsieger 9427: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9428: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9429: <p>If a package provides extensions to the MIME database by
9430: installing <code class="filename">.xml</code> files inside
9431: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9432: need to take some extra steps to ensure that the database is kept
9433: consistent with respect to these new files:</p>
1.23 wiz 9434: <div class="orderedlist"><ol class="orderedlist" type="1">
9435: <li class="listitem"><p>Include
1.1 dsieger 9436: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9437: (avoid using the <code class="filename">buildlink3.mk</code> file from
9438: this same directory, which is reserved for inclusion from
9439: other <code class="filename">buildlink3.mk</code> files). It takes
9440: care of rebuilding the MIME database at installation and
9441: deinstallation time, and disallows any access to it directly
9442: from the package.</p></li>
1.23 wiz 9443: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9444: <code class="filename">share/mime</code> directory,
9445: <span class="emphasis"><em>except</em></span> for files saved under
9446: <code class="filename">share/mime/packages</code>. The former are
9447: handled automatically by
9448: the update-mime-database program, but the latter are
9449: package-dependent and must be removed by the package that
9450: installed them in the first place.</p></li>
1.23 wiz 9451: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9452: from the PLIST. They will be handled by the shared-mime-info
9453: package.</p></li>
9454: </ol></div>
9455: </div>
1.41 asau 9456: <div class="sect2">
1.1 dsieger 9457: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9458: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.1 dsieger 9459: <p>If a package uses intltool during its build, add
9460: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9461: which forces it to use the intltool package provided by pkgsrc,
9462: instead of the one bundled with the distribution file.</p>
9463: <p>This tracks intltool's build-time dependencies and uses the
9464: latest available version; this way, the package benefits of any
9465: bug fixes that may have appeared since it was released.</p>
9466: </div>
1.41 asau 9467: <div class="sect2">
1.1 dsieger 9468: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9469: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9470: <p>If a package contains a rc.d script, it won't be copied into
9471: the startup directory by default, but you can enable it, by adding
9472: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9473: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9474: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9475: it will automatically remove the scripts when the package is
9476: deinstalled.</p>
9477: </div>
1.41 asau 9478: <div class="sect2">
1.1 dsieger 9479: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9480: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9481: <p>If a package installs TeX packages into the texmf tree,
9482: the <code class="filename">ls-R</code> database of the tree needs to be
9483: updated.</p>
1.41 asau 9484: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9485: <h3 class="title">Note</h3>
1.22 jakllsch 9486: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9487: packages should install files
1.22 jakllsch 9488: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9489: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9490: </div>
1.23 wiz 9491: <div class="orderedlist"><ol class="orderedlist" type="1">
9492: <li class="listitem"><p>Include
1.22 jakllsch 9493: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9494: takes care of rebuilding the <code class="filename">ls-R</code>
9495: database at installation and deinstallation time.</p></li>
1.23 wiz 9496: <li class="listitem">
1.1 dsieger 9497: <p>If your package installs files into a texmf
9498: tree other than the one
1.22 jakllsch 9499: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9500: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9501: trees that need database update.</p>
9502: <p>If your package also installs font map files that need
1.10 hubertf 9503: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9504: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9505: set <code class="varname">TEX_MAP_FILES</code> and/or
9506: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9507: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9508: be run automatically at installation/deinstallation to
9509: enable/disable font map files for TeX output
9510: drivers.</p>
9511: </li>
1.23 wiz 9512: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9513: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9514: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9515: </ol></div>
9516: </div>
1.41 asau 9517: <div class="sect2">
1.1 dsieger 9518: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9519: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.1 dsieger 9520: emulation</h3></div></div></div>
9521: <p>There are some packages that provide libraries and
9522: executables for running binaries from a one operating system
9523: on a different one (if the latter supports it). One example
9524: is running Linux binaries on NetBSD.</p>
1.207 leot 9525: <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 9526: helps in extracting and packaging Linux rpm packages.</p>
9527: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9528: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9529: if all libraries for each installed executable can be found by
9530: the dynamic linker. Since the standard dynamic linker is run,
9531: this fails for emulation packages, because the libraries used
9532: by the emulation are not in the standard directories.</p>
9533: </div>
1.184 rillig 9534: <div class="sect2">
9535: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9536: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.184 rillig 9537: <p>If a package installs images under the
9538: <code class="filename">share/icons/hicolor</code> and/or updates the
9539: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9540: database, you need to take some extra steps to make sure that the
9541: shared theme directory is handled appropriately and that the cache
9542: database is rebuilt:</p>
9543: <div class="orderedlist"><ol class="orderedlist" type="1">
9544: <li class="listitem"><p>Include
9545: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9546: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9547: entry that refers to the theme cache.</p></li>
9548: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9549: directories from the <code class="filename">share/icons/hicolor</code>
9550: hierarchy because they will be handled automatically.</p></li>
9551: </ol></div>
9552: <p>The best way to verify that the PLIST is correct with
9553: respect to the last two points is to regenerate it using
9554: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9555: </div>
9556: <div class="sect2">
9557: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9558: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.184 rillig 9559: <p>If a package installs <code class="filename">.desktop</code> files
9560: under <code class="filename">share/applications</code> and these include
9561: MIME information (MimeType key), you need to take extra steps to
9562: ensure that they are registered into the MIME database:</p>
9563: <div class="orderedlist"><ol class="orderedlist" type="1">
9564: <li class="listitem"><p>Include
9565: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9566: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9567: <code class="filename">share/applications/mimeinfo.cache</code> file.
9568: It will be handled automatically.</p></li>
9569: </ol></div>
9570: <p>The best way to verify that the PLIST is correct with
9571: respect to the last point is to regenerate it using <span class="command"><strong>make
9572: print-PLIST</strong></span>.</p>
9573: </div>
9574: </div>
9575: <div class="sect1">
9576: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9577: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9578: <p>In some cases one does not have the time to solve a problem
9579: immediately. In this case, one can plainly mark a package as broken. For
9580: this, one just sets the variable <code class="varname">BROKEN</code> to the
9581: reason why the package is broken (similar to the
9582: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9583: the package will immediately be shown this message, and the build
9584: will not be even tried.</p>
9585: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9586: intervals.</p>
9587: </div>
9588: </div>
9589: <div class="chapter">
9590: <div class="titlepage"><div><div><h2 class="title">
9591: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9592: <div class="toc">
9593: <p><b>Table of Contents</b></p>
9594: <dl class="toc">
9595: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9596: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9597: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9598: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9599: </dl>
9600: </div>
9601: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9602: site</a>:</p>
9603: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9604: environment, an intuitive and attractive desktop for users, and the
9605: GNOME development platform, an extensive framework for building
9606: applications that integrate into the rest of the desktop.</p></blockquote></div>
9607: <p>pkgsrc provides a seamless way to automatically build and install
9608: a complete GNOME environment <span class="emphasis"><em>under many different
9609: platforms</em></span>. We can say with confidence that pkgsrc is one of
9610: the most advanced build and packaging systems for GNOME due to its
9611: included technologies buildlink3, the wrappers and tools framework and
9612: automatic configuration file management. Lots of efforts are put into
9613: achieving a completely clean deinstallation of installed software
9614: components.</p>
9615: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9616: the above also means that great efforts are put into making GNOME work
1.201 cirnatda 9617: under this operating system.</p>
1.184 rillig 9618: <p>This chapter is aimed at pkgsrc developers and other people
9619: interested in helping our GNOME porting and packaging efforts. It
9620: provides instructions on how to manage the existing packages and some
9621: important information regarding their internals.</p>
9622: <div class="sect1">
9623: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9624: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9625: <p>pkgsrc includes three GNOME-related meta packages:</p>
9626: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 9627: <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 9628: the core GNOME desktop environment. It only includes the necessary
9629: bits to get it to boot correctly, although it may lack important
9630: functionality for daily operation. The idea behind this package is
9631: to let end users build their own configurations on top of this one,
9632: first installing this meta package to achieve a functional setup and
9633: then adding individual applications.</p></li>
1.207 leot 9634: <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 9635: complete installation of the GNOME platform and desktop as defined
9636: by the GNOME project; this is based on the components distributed in
9637: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9638: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9639: official FTP server. Developer-only tools found in those
9640: directories are not installed unless required by some other
9641: component to work properly. Similarly, packages from the bindings
9642: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9643: in unless required as a dependency for an end-user component. This
1.207 leot 9644: 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>
9645: <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 9646: Installs all the tools required to build a GNOME component when
9647: fetched from the CVS repository. These are required to let the
9648: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9649: </ul></div>
9650: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9651: sorted in a way that eases updates: a package may depend on other
9652: packages listed before it but not on any listed after it. It is very
9653: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9654: change it to alphabetical sorting!</em></span></p>
9655: </div>
9656: <div class="sect1">
9657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9658: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9659: <p>Almost all GNOME applications are written in C and use a common
9660: set of tools as their build system. Things get different with the new
9661: bindings to other languages (such as Python), but the following will
9662: give you a general idea on the minimum required tools:</p>
9663: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9664: <li class="listitem">
9665: <p>Almost all GNOME applications use the GNU Autotools as their
9666: build system. As a general rule you will need to tell this to your
9667: package:</p>
9668: <pre class="programlisting">
1.223 nia 9669: GNU_CONFIGURE= yes
9670: USE_LIBTOOL= yes
9671: USE_TOOLS+= gmake
1.184 rillig 9672: </pre>
9673: </li>
9674: <li class="listitem">
9675: <p>If the package uses pkg-config to detect dependencies, add this
9676: tool to the list of required utilities:</p>
9677: <pre class="programlisting">
1.223 nia 9678: USE_TOOLS+= pkg-config
1.184 rillig 9679: </pre>
1.207 leot 9680: <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 9681: the end of the build process to ensure that you did not miss to
9682: specify any dependency in your package and that the version
9683: requirements are all correct.</p>
9684: </li>
9685: <li class="listitem"><p>If the package uses intltool, be sure to add
9686: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9687: to handle dependencies and to force the package to use the latest
9688: available version.</p></li>
9689: <li class="listitem">
9690: <p>If the package uses gtk-doc (a documentation generation
9691: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9692: tool is rather big and the distfile should come with pregenerated
9693: documentation anyway; if it does not, it is a bug that you ought to
9694: report. For such packages you should disable gtk-doc (unless it is
9695: the default):</p>
9696: <pre class="programlisting">
1.223 nia 9697: CONFIGURE_ARGS+= --disable-gtk-doc
1.184 rillig 9698: </pre>
9699: <p>The default location of installed HTML files
9700: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9701: and should not be changed unless the package insists on installing
9702: them somewhere else. Otherwise programs as
9703: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9704: do that with an entry similar to:</p>
9705: <pre class="programlisting">
1.223 nia 9706: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.184 rillig 9707: </pre>
9708: </li>
9709: </ul></div>
9710: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9711: files under the installation prefix to maintain databases. In this
9712: context, shared means that those exact same directories and files are
9713: used among several different packages, leading to conflicts in the
9714: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9715: handle the most common cases, so you have to forget about using
9716: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9717: omitting shared files from them. If you find yourself doing those,
9718: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9719: <p>The following table lists the common situations that result in
9720: using shared directories or files. For each of them, the appropriate
9721: solution is given. After applying the solution be sure to
9722: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9723: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9724: <div class="table">
9725: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9726: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9727: <colgroup>
9728: <col>
9729: <col>
9730: </colgroup>
9731: <thead><tr>
9732: <th>If the package...</th>
9733: <th>Then...</th>
9734: </tr></thead>
9735: <tbody>
9736: <tr>
9737: <td>Installs icons under the
9738: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9739: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.203 nia 9740: <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 9741: </tr>
9742: <tr>
9743: <td>Installs files under
9744: <code class="filename">share/mime/packages</code>.</td>
1.203 nia 9745: <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 9746: </tr>
9747: <tr>
9748: <td>Installs <code class="filename">.desktop</code> files under
9749: <code class="filename">share/applications</code> and these include MIME
9750: information.</td>
1.203 nia 9751: <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 9752: </tr>
9753: </tbody>
9754: </table></div>
1.1 dsieger 9755: </div>
1.184 rillig 9756: <br class="table-break">
1.1 dsieger 9757: </div>
1.41 asau 9758: <div class="sect1">
1.1 dsieger 9759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 9760: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9761: <p>When seeing GNOME as a whole, there are two kinds of
9762: updates:</p>
9763: <div class="variablelist"><dl class="variablelist">
9764: <dt><span class="term">Major update</span></dt>
9765: <dd>
9766: <p>Given that there is still a very long way for GNOME 3 (if it
9767: ever appears), we consider a major update one that goes from a
9768: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9769: where <code class="literal">Y</code> is even and greater than
9770: <code class="literal">X</code>. These are hard to achieve because they
9771: introduce lots of changes in the components' code and almost all
9772: GNOME distfiles are updated to newer versions. Some of them can
9773: even break API and ABI compatibility with the previous major
9774: version series. As a result, the update needs to be done all at
9775: once to minimize breakage.</p>
9776: <p>A major update typically consists of around 80 package
9777: updates and the addition of some new ones.</p>
9778: </dd>
9779: <dt><span class="term">Minor update</span></dt>
9780: <dd>
9781: <p>We consider a minor update one that goes from a
9782: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9783: one where <code class="literal">Y</code> is greater than
9784: <code class="literal">X</code>. These are easy to achieve because they do
9785: not update all GNOME components, can be done in an incremental way
9786: and do not break API nor ABI compatibility.</p>
9787: <p>A minor update typically consists of around 50 package
9788: updates, although the numbers here may vary a lot.</p>
9789: </dd>
9790: </dl></div>
9791: <p>In order to update the GNOME components in pkgsrc to a new stable
9792: release (either major or minor), the following steps should be
9793: followed:</p>
9794: <div class="orderedlist"><ol class="orderedlist" type="1">
1.23 wiz 9795: <li class="listitem">
1.184 rillig 9796: <p>Get a list of all the tarballs that form the new release by
9797: using the following commands. These will leave the full list of the
9798: components' distfiles into the <code class="filename">list.txt</code>
9799: file:</p>
9800: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9801: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9802: awk '{ print $9 }' >list.txt</code></strong>
9803: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9804: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9805: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.1 dsieger 9806: </li>
1.184 rillig 9807: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9808: bump their version to the release you are updating them to. The
9809: three meta packages should be always consistent with versioning.
9810: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9811: in them.</p></li>
1.23 wiz 9812: <li class="listitem">
1.184 rillig 9813: <p>For each meta package, update all its
9814: <code class="varname">DEPENDS</code> lines to match the latest versions as
9815: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9816: newer version (even if found in the FTP) because the meta packages
9817: are supposed to list the exact versions that form a specific GNOME
9818: release. Exceptions are permitted here if a newer version solves a
9819: serious issue in the overall desktop experience; these typically
9820: come in the form of a revision bump in pkgsrc, not in newer versions
9821: from the developers.</p>
9822: <p>Packages not listed in the <code class="filename">list.txt</code> file
9823: should be updated to the latest version available (if found in
9824: pkgsrc). This is the case, for example, of the dependencies on the
1.207 leot 9825: 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 9826: </li>
1.23 wiz 9827: <li class="listitem">
1.184 rillig 9828: <p>Generate a patch from the modified meta packages and extract the
9829: list of "new" lines. This will provide you an outline on what
9830: packages need to be updated in pkgsrc and in what order:</p>
9831: <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 9832: </li>
1.184 rillig 9833: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9834: installed packages and start over from scratch at this point.</p></li>
9835: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9836: of <code class="filename">todo.txt</code> and update the packages listed in
9837: it in order. For major desktop updates none of these should be
9838: committed until the entire set is completed because there are chances
9839: of breaking not-yet-updated packages.</p></li>
9840: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9841: the tree one by one with appropriate log messages. At the end,
9842: commit the three meta package updates and all the corresponding
9843: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9844: <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>
9845: </ol></div>
9846: </div>
9847: <div class="sect1">
9848: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9849: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9850: <p>GNOME is a very big component in pkgsrc which approaches 100
9851: packages. Please, it is very important that you always, always,
9852: <span class="strong"><strong>always</strong></span> feed back any portability
9853: 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
9854: their attention on portability issues and to ensure that future versions
9855: can be built out-of-the box on NetBSD. The less custom patches in
9856: pkgsrc, the easier further updates are. Those developers in charge of
9857: issuing major GNOME updates will be grateful if you do that.</p>
1.200 cirnatda 9858: <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
9859: GitLab</a>. Not all components use these to track bugs, but most
1.184 rillig 9860: of them do. Do not be short on your reports: always provide detailed
9861: explanations of the current failure, how it can be improved to achieve
1.200 cirnatda 9862: maximum portability and, if at all possible, provide a patch against the
9863: main Git branch. The more verbose you are, the higher chances of your
9864: patch being accepted.</p>
1.184 rillig 9865: <p>Also, please avoid using preprocessor magic to fix portability
9866: issues. While the FreeBSD GNOME people are doing a great job in porting
9867: GNOME to their operating system, the official GNOME sources are now
9868: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9869: and similar macros. This hurts portability. Please see our patching
9870: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9871: details.</p>
9872: </div>
1.1 dsieger 9873: </div>
1.41 asau 9874: <div class="chapter">
1.1 dsieger 9875: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9876: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9877: <div class="toc">
9878: <p><b>Table of Contents</b></p>
1.100 leot 9879: <dl class="toc">
1.154 rillig 9880: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9881: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9882: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9883: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9884: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9885: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9886: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9887: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9888: </dl>
9889: </div>
1.41 asau 9890: <div class="sect1">
1.1 dsieger 9891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9892: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9893: <p>Our policy is that we accept binaries only from pkgsrc
9894: developers to guarantee that the packages don't contain any
9895: trojan horses etc. This is not to annoy anyone but rather to
9896: protect our users! You're still free to put up your home-made
9897: binary packages and tell the world where to get them. NetBSD
9898: developers doing bulk builds and wanting to upload them please
1.154 rillig 9899: 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 9900: builds)</i></a>.</p>
1.1 dsieger 9901: </div>
1.41 asau 9902: <div class="sect1">
1.1 dsieger 9903: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9904: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.218 nia 9905: <p>Firstly, you can import new packages into
9906: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
9907: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
9908: for details.</p>
9909: <p>Next, check that your package is complete, compiles and
1.184 rillig 9910: 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 9911: 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>
9912: tool and fix any errors that appear.</p>
9913: <p>Finally, send a report to the pkgsrc bug tracking system,
1.207 leot 9914: 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 9915: that, go to the web page
1.174 leot 9916: <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 9917: which contains some instructions and a link to a form where you
9918: can submit packages. The
1.207 leot 9919: <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 9920: also available as a substitute for either of the above two tools.
9921: </p>
1.1 dsieger 9922: <p>In the form of the problem report, the category should be
1.23 wiz 9923: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9924: and version number, and the description field should contain a
9925: short description of your package (contents of the COMMENT
1.218 nia 9926: variable or DESCR file are OK).</p>
1.1 dsieger 9927: </div>
1.41 asau 9928: <div class="sect1">
1.1 dsieger 9929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9930: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9931: <p>Please note all package additions, updates, moves, and
9932: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9933: important to keep this file up to date and conforming to the
9934: existing format, because it will be used by scripts to
1.174 leot 9935: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9936: sites. Additionally, check the
9937: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9938: for the package you updated or removed, in case it was mentioned
9939: there.</p>
9940: <p>When the <code class="varname">PKGREVISION</code> of a package is
9941: bumped, the change should appear in
9942: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9943: related or otherwise relevant. Mass bumps that result from a
9944: dependency being updated should not be mentioned. In all other
9945: cases it's the developer's decision.</p>
9946: <p>There is a make target that helps in creating proper
1.10 hubertf 9947: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9948: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9949: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9950: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9951: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9952: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9953: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9954: For new packages, or package moves or removals, set the
9955: <code class="varname">CTYPE</code> variable on the command line to "Added",
9956: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9957: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9958: not the same as your NetBSD login name. The target also automatically
9959: removes possibly existing entries for the package in the
9960: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 9961: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 9962: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9963: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9964: makes the cvs commands use the main repository.
9965: </p>
1.1 dsieger 9966: </div>
1.41 asau 9967: <div class="sect1">
1.1 dsieger 9968: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9969: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 9970: <p>For several years, there have been mirrors of pkgsrc in
9971: fossil, git, and hg. Standard practise when using these tools is to
9972: make the first line of a commit message function as a summary that
9973: can be read without the rest, such as is commonly done with "git log
9974: --oneline". For this reason, we have the following guidelines for
9975: pkgsrc commit messages:</p>
9976: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9977: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 9978: big picture in 65 characters or less. When a commit is for one
1.130 wiz 9979: package, include the name of the package. For updates, include the
9980: version to which it is updated.</p></li>
9981: <li class="listitem"><p>Leave the next line empty.</p></li>
9982: <li class="listitem"><p>Then come the details for the commit (changes in that
9983: package, reason for a change) and any relevant PRs. Wrap this
9984: section.</p></li>
9985: </ul></div>
9986: <p>Here is an example:
1.238 wiz 9987: </p>
1.130 wiz 9988: <pre class="programlisting">
1.238 wiz 9989: libxslt: update to 1.0.30
1.130 wiz 9990:
1.238 wiz 9991: Changes since 1.0.29:
9992: ...
9993: </pre>
1.130 wiz 9994: <p>
9995: </p>
9996: <p>Here is another example:
1.238 wiz 9997: </p>
1.130 wiz 9998: <pre class="programlisting">
1.238 wiz 9999: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.130 wiz 10000:
1.238 wiz 10001: (rationale)
10002: </pre>
1.130 wiz 10003: <p>
10004: </p>
10005: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
10006: allowed on the pkgsrc repository to change commit messages.</p>
10007: </div>
10008: <div class="sect1">
10009: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10010: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 10011: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 10012: access to the pkgsrc repository.</p>
10013: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
10014: Start by adding the directory and then files in the directory. Don't
10015: forget to add the new package to the category's
10016: <code class="filename">Makefile</code>. Make sure you don't forget any files;
10017: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
10018: <pre class="programlisting">
10019: <code class="prompt">$</code> cd .../pkgsrc/category
10020: <code class="prompt">$</code> cvs add pkgname
10021: <code class="prompt">$</code> cd pkgname
10022: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
10023: <code class="prompt">$</code> cvs add patches/p*
10024: <code class="prompt">$</code> cvs status | less
1.34 wiz 10025: <code class="prompt">$</code> cvs commit
1.33 wiz 10026: <code class="prompt">$</code> cd ..
1.236 gutterid 10027: <code class="prompt">$</code> vi Makefile # add SUBDIR+=pkgname line
1.34 wiz 10028: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 10029: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 10030: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 10031: </pre>
1.1 dsieger 10032: <p>The commit message of the initial import should include part of the
10033: <code class="filename">DESCR</code> file, so people reading the mailing lists know
10034: what the package is/does.</p>
1.33 wiz 10035: <p>Also mention the new package in
10036: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
10037: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
10038: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 10039: </div>
1.41 asau 10040: <div class="sect1">
1.1 dsieger 10041: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10042: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 10043: <p>Please always put a concise, appropriate and relevant summary of the
10044: changes between old and new versions into the commit log when updating
10045: a package. There are various reasons for this:</p>
1.41 asau 10046: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10047: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 10048: or its information may be overwritten by newer information.</p></li>
1.23 wiz 10049: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 10050: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 10051: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 10052: repository is very useful for people who read the pkgsrc-changes mailing
10053: list, so that they can make tactical decisions about when to upgrade
10054: the package.</p></li>
10055: </ul></div>
10056: <p>Please also recognize that, just because a new version of a package
10057: has been released, it should not automatically be upgraded in the CVS
10058: repository. We prefer to be conservative in the packages that are
10059: included in pkgsrc - development or beta packages are not really the
10060: best thing for most places in which pkgsrc is used. Please use your
10061: judgement about what should go into pkgsrc, and bear in mind that
10062: stability is to be preferred above new and possibly untested features.</p>
10063: </div>
1.41 asau 10064: <div class="sect1">
1.1 dsieger 10065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10066: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 10067: <p>Renaming packages is not recommended.</p>
1.175 gutterid 10068: <p>When renaming packages, be sure to fix any references to the old name
1.20 snj 10069: in other Makefiles, options, buildlink files, etc.</p>
1.167 leot 10070: <p>
1.175 gutterid 10071: Also, when renaming a package, please add
1.167 leot 10072: the package name and version pattern(s) of the previous package
10073: to <code class="varname">SUPERSEDES</code>.
1.20 snj 10074: This may be repeated for multiple renames.
10075: The new package would be an exact replacement.
1.167 leot 10076: Example:
1.20 snj 10077: </p>
1.167 leot 10078: <pre class="programlisting">
10079: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
10080: SUPERSEDES+= optcomp-[0-9]*
10081: </pre>
1.23 wiz 10082: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 10083: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
10084: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
10085: not be an exact replacement but is a suggestion for the replaced
10086: functionality.</p>
10087: </div>
1.41 asau 10088: <div class="sect1">
1.20 snj 10089: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10090: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 10091: <p>It is preferred that packages are not renamed or moved, but if needed
10092: please follow these steps.
10093: </p>
1.23 wiz 10094: <div class="orderedlist"><ol class="orderedlist" type="1">
10095: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
10096: <li class="listitem">
1.1 dsieger 10097: <p>Remove all CVS dirs.</p>
10098: <p>Alternatively to the first two steps you can also do:</p>
10099: <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>
10100: <p>and use that for further work.</p>
10101: </li>
1.23 wiz 10102: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
10103: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
10104: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
10105: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 10106: <code class="varname">PREV_PKGPATH</code> to the previous category/package
10107: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
10108: for doing an update using pkgsrc building; for example, it can
1.207 leot 10109: 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 10110: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
10111: new <code class="varname">PKGPATH</code> for that moved package. Note that
10112: it may have multiple matches, so the tool should also check on the
10113: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
10114: probably has no value unless <code class="varname">SUPERSEDES</code> is not
10115: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.237 gutterid 10116: <li class="listitem"><p><span class="command"><strong>cvs add</strong></span> the modified package in the new
1.1 dsieger 10117: place.</p></li>
1.23 wiz 10118: <li class="listitem">
1.1 dsieger 10119: <p>Check if any package depends on it:
10120: </p>
10121: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
10122: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
10123: </li>
1.23 wiz 10124: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
10125: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
10126: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
10127: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
10128: <li class="listitem">
1.1 dsieger 10129: <p>Commit the changed and removed files:</p>
10130: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
10131: <p>(and any packages from step 5, of course).</p>
10132: </li>
10133: </ol></div>
10134: </div>
10135: </div>
1.41 asau 10136: <div class="chapter">
1.1 dsieger 10137: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 10138: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 10139: <p>This section contains the answers to questions that may
10140: arise when you are writing a package. If you don't find your
10141: question answered here, first have a look in the other chapters,
10142: and if you still don't have the answer, ask on the
10143: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 10144: <div class="qandaset">
1.174 leot 10145: <a name="devfaq.qandaset"></a><dl>
1.154 rillig 10146: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 10147: MAKEFLAGS, .MAKEFLAGS and
10148: MAKE_FLAGS?</a>
10149: </dt>
1.154 rillig 10150: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 10151: MAKE, GMAKE and
10152: MAKE_PROGRAM?</a>
10153: </dt>
1.154 rillig 10154: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 10155: CC, PKG_CC and
10156: PKGSRC_COMPILER?</a>
10157: </dt>
1.223 nia 10158: <dt>24.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 10159: VARNAME=BUILDLINK_PREFIX.foo
10160: say it's empty?</a>
10161: </dt>
1.223 nia 10162: <dt>24.5. <a href="#devfaq.master_sites">What does
1.1 dsieger 10163: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
10164: don't understand the := inside
10165: it.</a>
10166: </dt>
1.223 nia 10167: <dt>24.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 10168: developers?</a>
10169: </dt>
1.223 nia 10170: <dt>24.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 10171: documentation?</a>
10172: </dt>
1.223 nia 10173: <dt>24.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.174 leot 10174: What shall I do?</a>
1.1 dsieger 10175: </dt>
10176: </dl>
1.41 asau 10177: <table border="0" style="width: 100%;">
10178: <colgroup>
1.1 dsieger 10179: <col align="left" width="1%">
1.23 wiz 10180: <col>
1.41 asau 10181: </colgroup>
1.1 dsieger 10182: <tbody>
1.41 asau 10183: <tr class="question">
1.1 dsieger 10184: <td align="left" valign="top">
1.174 leot 10185: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.1 dsieger 10186: </td>
10187: <td align="left" valign="top"><p>What is the difference between
10188: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10189: <code class="varname">MAKE_FLAGS</code>?</p></td>
10190: </tr>
10191: <tr class="answer">
10192: <td align="left" valign="top"></td>
1.223 nia 10193: <td align="left" valign="top">
10194: <p><code class="varname">MAKEFLAGS</code> are the flags passed
10195: 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>
10196: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
10197: passed to the <code class="varname">MAKE_PROGRAM</code> when building the
10198: package.</p>
10199: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
10200: <span class="command"><strong>bmake</strong></span> and should not be used by
10201: packages.</p>
10202: </td>
1.1 dsieger 10203: </tr>
1.41 asau 10204: <tr class="question">
1.1 dsieger 10205: <td align="left" valign="top">
1.174 leot 10206: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.1 dsieger 10207: </td>
10208: <td align="left" valign="top"><p>What is the difference between
10209: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10210: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10211: </tr>
10212: <tr class="answer">
10213: <td align="left" valign="top"></td>
1.223 nia 10214: <td align="left" valign="top">
10215: <p><code class="varname">MAKE</code> is the path to the
1.207 leot 10216: <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 10217: infrastructure.</p>
10218: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
10219: need to say <code class="varname">USE_TOOLS+=gmake</code> to use
10220: that.</p>
10221: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
10222: program that is used for building the package.</p>
10223: </td>
1.1 dsieger 10224: </tr>
1.41 asau 10225: <tr class="question">
1.1 dsieger 10226: <td align="left" valign="top">
1.174 leot 10227: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.1 dsieger 10228: </td>
10229: <td align="left" valign="top"><p>What is the difference between
10230: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10231: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10232: </tr>
10233: <tr class="answer">
10234: <td align="left" valign="top"></td>
10235: <td align="left" valign="top">
1.223 nia 10236: <p><code class="varname">CC</code> is the path to the real C
10237: compiler, which can be configured by the pkgsrc user.</p>
10238: <p><code class="varname">PKG_CC</code> is the path to the compiler
10239: wrapper.</p>
10240: <p><code class="varname">PKGSRC_COMPILER</code> is
10241: <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
10242: compiler that should be used. See
10243: <code class="filename">mk/compiler.mk</code> for more information about
10244: the latter variable.</p>
1.1 dsieger 10245: </td>
10246: </tr>
1.41 asau 10247: <tr class="question">
1.1 dsieger 10248: <td align="left" valign="top">
1.223 nia 10249: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.4.</b></p>
1.1 dsieger 10250: </td>
1.10 hubertf 10251: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 10252: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10253: say it's empty?</p></td>
10254: </tr>
10255: <tr class="answer">
10256: <td align="left" valign="top"></td>
10257: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 10258: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10259: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 10260: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 10261: command.</p></td>
10262: </tr>
1.41 asau 10263: <tr class="question">
1.1 dsieger 10264: <td align="left" valign="top">
1.223 nia 10265: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.5.</b></p>
1.1 dsieger 10266: </td>
10267: <td align="left" valign="top"><p>What does
1.108 rillig 10268: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10269: don't understand the <code class="code">:=</code> inside
1.1 dsieger 10270: it.</p></td>
10271: </tr>
10272: <tr class="answer">
10273: <td align="left" valign="top"></td>
1.223 nia 10274: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
10275: assignment operator, even though it may look like one.
1.1 dsieger 10276: Instead, it is a degenerate form of
1.108 rillig 10277: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.207 leot 10278: 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 10279: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 10280: case of <code class="varname">MASTER_SITE_*</code>,
10281: <em class="replaceable"><code>old_string</code></em> is the empty string and
10282: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 10283: <code class="code">package/</code>. That's where the
10284: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 10285: together.</p></td>
10286: </tr>
1.41 asau 10287: <tr class="question">
1.1 dsieger 10288: <td align="left" valign="top">
1.223 nia 10289: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.6.</b></p>
1.1 dsieger 10290: </td>
10291: <td align="left" valign="top"><p>Which mailing lists are there for package
10292: developers?</p></td>
10293: </tr>
10294: <tr class="answer">
10295: <td align="left" valign="top"></td>
1.41 asau 10296: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.174 leot 10297: <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 10298: <dd><p>This is a list for technical discussions related
10299: to pkgsrc development, e.g. soliciting feedback for changes to
10300: pkgsrc infrastructure, proposed new features, questions related
10301: to porting pkgsrc to a new platform, advice for maintaining a
10302: package, patches that affect many packages, help requests moved
10303: from pkgsrc-users when an infrastructure bug is found,
10304: etc.</p></dd>
1.174 leot 10305: <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 10306: <dd><p>All bug reports in category "pkg" sent with
1.207 leot 10307: <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 10308: directly; use one of the other mailing
10309: lists.</p></dd>
10310: </dl></div></td>
10311: </tr>
1.41 asau 10312: <tr class="question">
1.1 dsieger 10313: <td align="left" valign="top">
1.223 nia 10314: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.7.</b></p>
1.1 dsieger 10315: </td>
10316: <td align="left" valign="top"><p>Where is the pkgsrc
10317: documentation?</p></td>
10318: </tr>
10319: <tr class="answer">
10320: <td align="left" valign="top"></td>
10321: <td align="left" valign="top">
10322: <p>There are many places where you can find
10323: documentation about pkgsrc:</p>
1.41 asau 10324: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10325: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 10326: of chapters that explain large parts of pkgsrc, but some
10327: chapters tend to be outdated. Which ones they are is hard to
10328: say.</p></li>
1.174 leot 10329: <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 10330: about certain features, announcements of new parts of the pkgsrc
10331: infrastructure and sometimes even announcements that a certain
10332: feature has been marked as obsolete. The benefit here is that
10333: each message has a date appended to it.</p></li>
1.23 wiz 10334: <li class="listitem"><p>Many of the files in the
1.1 dsieger 10335: <code class="filename">mk/</code> directory start with a comment that
10336: describes the purpose of the file and how it can be used by the
10337: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 10338: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 10339: help</strong></span>.</p></li>
1.23 wiz 10340: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 10341: information, but they tend to be highly abbreviated, especially
10342: for actions that occur often. Some contain a detailed
10343: description of what has changed, but they are geared towards the
10344: other pkgsrc developers, not towards an average pkgsrc user.
10345: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10346: don't know what has been before, these messages may not be worth
10347: too much to you.</p></li>
1.23 wiz 10348: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10349: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 10350: mind of the developer who wrote the code. To get this
1.10 hubertf 10351: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 10352: to see who has written it and ask on the
10353: <code class="literal">tech-pkg</code> mailing list, so that others can
10354: find your questions later (see above). To be sure that the
10355: developer in charge reads the mail, you may CC him or
10356: her.</p></li>
10357: </ul></div>
1.184 rillig 10358: </td>
10359: </tr>
10360: <tr class="question">
10361: <td align="left" valign="top">
1.223 nia 10362: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.8.</b></p>
1.184 rillig 10363: </td>
1.223 nia 10364: <td align="left" valign="top"><p>I have a little time to kill.
1.184 rillig 10365: What shall I do?</p></td>
10366: </tr>
10367: <tr class="answer">
10368: <td align="left" valign="top"></td>
10369: <td align="left" valign="top">
10370: <p>This is not really an FAQ yet, but here's the answer
10371: anyway.</p>
1.41 asau 10372: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 10373: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.207 leot 10374: <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 10375: will tell you about newer versions of installed packages that are
10376: available, but not yet updated in pkgsrc.</p></li>
10377: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10378: — it contains a list of suggested new packages and a list of
10379: cleanups and enhancements for pkgsrc that would be nice to
10380: have.</p></li>
10381: <li class="listitem"><p>Review packages for which review was requested on
10382: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10383: mailing list.</p></li>
1.1 dsieger 10384: </ul></div>
1.184 rillig 10385: </td>
1.1 dsieger 10386: </tr>
10387: </tbody>
1.184 rillig 10388: </table>
1.1 dsieger 10389: </div>
10390: </div>
10391: </div>
1.41 asau 10392: <div class="part">
1.1 dsieger 10393: <div class="titlepage"><div><div><h1 class="title">
10394: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10395: <div class="partintro">
1.1 dsieger 10396: <div></div>
10397: <p>This part of the guide deals with everything
10398: from the infrastructure that is behind the interfaces described
10399: in the developer's guide. A casual package maintainer should not
10400: need anything from this part.</p>
10401: <div class="toc">
10402: <p><b>Table of Contents</b></p>
1.100 leot 10403: <dl class="toc">
1.184 rillig 10404: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10405: <dd><dl>
1.184 rillig 10406: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10407: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10408: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10409: <dd><dl>
1.184 rillig 10410: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10411: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10412: </dl></dd>
1.184 rillig 10413: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10414: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10415: <dd><dl>
1.184 rillig 10416: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10417: <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 10418: </dl></dd>
1.184 rillig 10419: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10420: <dd><dl>
1.184 rillig 10421: <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>
10422: <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 10423: </dl></dd>
10424: </dl></dd>
1.184 rillig 10425: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 10426: <dd><dl>
1.184 rillig 10427: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10428: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10429: <dd><dl>
1.184 rillig 10430: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10431: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10432: </dl></dd>
10433: </dl></dd>
1.184 rillig 10434: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10435: <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 10436: </dl>
10437: </div>
10438: </div>
1.41 asau 10439: <div class="chapter">
1.1 dsieger 10440: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10441: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10442: <div class="toc">
10443: <p><b>Table of Contents</b></p>
1.100 leot 10444: <dl class="toc">
1.184 rillig 10445: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10446: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10447: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10448: <dd><dl>
1.184 rillig 10449: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10450: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10451: </dl></dd>
1.184 rillig 10452: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10453: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10454: <dd><dl>
1.184 rillig 10455: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10456: <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 10457: </dl></dd>
1.184 rillig 10458: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10459: <dd><dl>
1.184 rillig 10460: <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>
10461: <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 10462: </dl></dd>
10463: </dl>
10464: </div>
10465: <p>The pkgsrc infrastructure consists of many small Makefile
10466: fragments. Each such fragment needs a properly specified
10467: interface. This chapter explains how such an interface looks
10468: like.</p>
1.41 asau 10469: <div class="sect1">
1.1 dsieger 10470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10471: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10472: <p>Whenever a variable is defined in the pkgsrc
10473: infrastructure, the location and the way of definition provide
10474: much information about the intended use of that variable.
10475: Additionally, more documentation may be found in a header
10476: comment or in this pkgsrc guide.</p>
10477: <p>A special file is
10478: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10479: variables that are intended to be user-defined. They are either
10480: defined using the <code class="literal">?=</code> operator or they are
10481: left undefined because defining them to anything would
1.23 wiz 10482: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10483: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10484: file.</p>
10485: <p>Outside this file, the following conventions apply:
10486: Variables that are defined using the <code class="literal">?=</code>
10487: operator may be overridden by a package.</p>
10488: <p>Variables that are defined using the <code class="literal">=</code>
10489: operator may be used read-only at run-time.</p>
10490: <p>Variables whose name starts with an underscore must not be
10491: accessed outside the pkgsrc infrastructure at all. They may
10492: change without further notice.</p>
1.41 asau 10493: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10494: <h3 class="title">Note</h3>
10495: <p>These conventions are currently not applied
10496: consistently to the complete pkgsrc
10497: infrastructure.</p>
10498: </div>
10499: </div>
1.41 asau 10500: <div class="sect1">
1.1 dsieger 10501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10502: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10503: <p>All variables that contain lists of things should default
10504: to being empty. Two examples that do not follow this rule are
10505: <code class="varname">USE_LANGUAGES</code> and
10506: <code class="varname">DISTFILES</code>. These variables cannot simply be
10507: modified using the <code class="literal">+=</code> operator in package
10508: <code class="filename">Makefile</code>s (or other files included by
10509: them), since there is no guarantee whether the variable is
10510: already set or not, and what its value is. In the case of
1.23 wiz 10511: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10512: the default value and just define it as in the following
10513: example.</p>
10514: <pre class="programlisting">
10515: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10516: </pre>
10517: <p>Because of the selection of this default value, the same
10518: value appears in many package Makefiles. Similarly for
10519: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10520: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10521: doesn't stand out. Nevertheless it is mentioned in many
10522: files.</p>
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.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.41 asau 10527: <div class="sect2">
1.1 dsieger 10528: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10529: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.1 dsieger 10530: <p>Variable evaluation takes place either at load time or at
10531: runtime, depending on the context in which they occur. The
10532: contexts where variables are evaluated at load time are:</p>
1.41 asau 10533: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10534: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10535: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10536: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10537: <code class="literal">.for</code>,</p></li>
1.23 wiz 10538: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10539: </ul></div>
10540: <p>A special exception are references to the iteration
10541: variables of <code class="literal">.for</code> loops, which are expanded
10542: inline, no matter in which context they appear.</p>
10543: <p>As the values of variables may change during load time,
10544: care must be taken not to evaluate them by accident. Typical
10545: examples for variables that should not be evaluated at load time
10546: are <code class="varname">DEPENDS</code> and
10547: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10548: clear, here is an example:</p>
10549: <pre class="programlisting">
10550: CONFIGURE_ARGS= # none
10551: CFLAGS= -O
10552: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10553:
10554: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10555:
10556: CFLAGS+= -Wall
1.111 sevan 10557: </pre>
1.1 dsieger 10558: <p>This code shows how the use of the <code class="literal">:=</code>
10559: operator can quickly lead to unexpected results. The first
10560: paragraph is fairly common code. The second paragraph evaluates
10561: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10562: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10563: <code class="literal">-Wall</code> is appended to the
10564: <code class="varname">CFLAGS</code>, but this addition will not appear in
10565: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10566: paragraphs from above typically occur in completely unrelated
10567: files.</p>
10568: </div>
1.41 asau 10569: <div class="sect2">
1.1 dsieger 10570: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10571: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10572: <p>After all the files have been loaded, the values of the
10573: variables cannot be changed anymore. Variables that are used in
10574: the shell commands are expanded at this point.</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.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10580: <p>There are many ways in which the definition and use of a
1.108 rillig 10581: variable can be restricted in order to detect bugs and violations
10582: of the (mostly unwritten) policies. A package can be checked with
10583: <code class="literal">pkglint -Wall</code> to see whether it meets these
10584: rules.</p>
1.1 dsieger 10585: </div>
1.41 asau 10586: <div class="sect1">
1.1 dsieger 10587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10588: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10589: <p>Most of the <code class="filename">.mk</code> files fall into one
10590: of the following classes. Cases where a file falls into more
10591: than one class should be avoided as it often leads to subtle
10592: bugs.</p>
1.41 asau 10593: <div class="sect2">
1.1 dsieger 10594: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10595: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10596: <p>In a traditional imperative programming language some of
10597: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10598: procedures. They take some input parameters and—after
10599: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10600: variables in <code class="filename">Makefile</code>s have global scope
10601: care must be taken not to use parameter names that have already
10602: another meaning. For example, <code class="varname">PKGNAME</code> is a
10603: bad choice for a parameter name.</p>
10604: <p>Procedures are completely evaluated at preprocessing time.
10605: That is, when calling a procedure all input parameters must be
10606: completely resolvable. For example,
10607: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10608: parameter since it is very likely that further text will be
10609: added after calling the procedure, which would effectively apply
10610: the procedure to only a part of the variable. Also, references
1.108 rillig 10611: to other variables will be modified after calling the
1.1 dsieger 10612: procedure.</p>
10613: <p>A procedure can declare its output parameters either as
10614: suitable for use in preprocessing directives or as only
10615: available at runtime. The latter alternative is for variables
10616: that contain references to other runtime variables.</p>
10617: <p>Procedures shall be written such that it is possible to
10618: call the procedure more than once. That is, the file must not
10619: contain multiple-inclusion guards.</p>
10620: <p>Examples for procedures are
10621: <code class="filename">mk/bsd.options.mk</code> and
10622: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10623: that the parameters are evaluated at load time, they should be
10624: assigned using the <code class="literal">:=</code> operator, which should
10625: be used only for this purpose.</p>
10626: </div>
1.41 asau 10627: <div class="sect2">
1.1 dsieger 10628: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10629: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10630: <p>Action files take some input parameters and may define
10631: runtime variables. They shall not define loadtime variables.
10632: There are action files that are included implicitly by the
10633: pkgsrc infrastructure, while other must be included
10634: explicitly.</p>
10635: <p>An example for action files is
10636: <code class="filename">mk/subst.mk</code>.</p>
10637: </div>
10638: </div>
1.41 asau 10639: <div class="sect1">
1.1 dsieger 10640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10641: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10642: <p>Package <code class="filename">Makefile</code>s usually consist of
10643: a set of variable definitions, and include the file
10644: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10645: Before that, they may also include various other
10646: <code class="filename">*.mk</code> files if they need to query the
10647: availability of certain features like the type of compiler or
10648: the X11 implementation. Due to the heavy use of preprocessor
10649: directives like <code class="literal">.if</code> and
10650: <code class="literal">.for</code>, the order in which the files are loaded
10651: matters.</p>
10652: <p>This section describes at which point the various files
10653: are loaded and gives reasons for that order.</p>
1.41 asau 10654: <div class="sect2">
1.1 dsieger 10655: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10656: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10657: </h3></div></div></div>
10658: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10659: is to define some essential variables like
10660: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10661: <code class="varname">MACHINE_ARCH</code>.</p>
10662: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10663: 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 10664: After that, those variables
1.1 dsieger 10665: that have not been overridden by the user are loaded from
10666: <code class="filename">mk/defaults/mk.conf</code>.</p>
10667: <p>After the user settings, the system settings and platform
10668: settings are loaded, which may override the user
10669: settings.</p>
10670: <p>Then, the tool definitions are loaded. The tool wrappers
10671: are not yet in effect. This only happens when building a
10672: package, so the proper variables must be used instead of the
10673: direct tool names.</p>
10674: <p>As the last steps, some essential variables from the
10675: wrapper and the package system flavor are loaded, as well as the
10676: variables that have been cached in earlier phases of a package
10677: build.</p>
10678: </div>
1.41 asau 10679: <div class="sect2">
1.1 dsieger 10680: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10681: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10682: </h3></div></div></div>
10683: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10684: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10685: loaded, which fill default values for those variables that have
10686: not been defined by the package. These variables may later
10687: be used even in unrelated files.</p>
10688: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10689: provides the target <code class="literal">error-check</code> that is added
10690: as a special dependency to all other targets that use
10691: <code class="varname">DELAYED_ERROR_MSG</code> or
10692: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10693: <p>Then, the package-specific hacks from
10694: <code class="filename">hacks.mk</code> are included.</p>
10695: <p>Then, various other files follow. Most of them don't have
10696: any dependencies on what they need to have included before or
10697: after them, though some do.</p>
10698: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10699: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10700: restricts the use of these variables to all the files that have
10701: been included before. Appearances in later files will be
10702: silently ignored.</p>
10703: <p>Then, the files for the main targets are included, in the
10704: order of later execution, though the actual order should not
10705: matter.</p>
10706: <p>At last, some more files are included that don't set any
10707: interesting variables but rather just define make targets to be
10708: executed.</p>
10709: </div>
10710: </div>
10711: </div>
1.41 asau 10712: <div class="chapter">
1.1 dsieger 10713: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10714: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.1 dsieger 10715: <div class="toc">
10716: <p><b>Table of Contents</b></p>
1.100 leot 10717: <dl class="toc">
1.184 rillig 10718: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10719: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10720: <dd><dl>
1.184 rillig 10721: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10722: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10723: </dl></dd>
10724: </dl>
10725: </div>
10726: <p>The pkgsrc infrastructure consists of a large codebase,
10727: and there are many corners where every little bit of a file is
10728: well thought out, making pkgsrc likely to fail as soon as
10729: anything is changed near those parts. To prevent most changes
10730: from breaking anything, a suite of regression tests should go
10731: along with every important part of the pkgsrc infrastructure.
10732: This chapter describes how regression tests work in pkgsrc and
10733: how you can add new tests.</p>
1.41 asau 10734: <div class="sect1">
1.1 dsieger 10735: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10736: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.207 leot 10737: <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 10738: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10739: can simply run that command, which will run all tests in the
1.168 rillig 10740: <code class="filename">regress/</code> directory.</p>
1.1 dsieger 10741: </div>
1.41 asau 10742: <div class="sect1">
1.1 dsieger 10743: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10744: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.168 rillig 10745: <p>Every directory in the <code class="filename">regress/</code>
10746: directory that contains a file called <code class="filename">spec</code>
1.1 dsieger 10747: is considered a regression test. This file is a shell program
1.10 hubertf 10748: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10749: The following functions can be overridden to suit your
10750: needs.</p>
1.41 asau 10751: <div class="sect2">
1.1 dsieger 10752: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10753: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 10754: <p>These functions do not take any parameters. Although they
10755: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.174 leot 10756: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108 rillig 10757: question</a> for details.</p>
1.41 asau 10758: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10759: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 10760: <dd><p>This function prepares the environment for the
10761: test. By default it does nothing.</p></dd>
1.108 rillig 10762: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10763: <dd>
10764: <p>This function runs the actual test. By default,
1.1 dsieger 10765: it calls <code class="varname">TEST_MAKE</code> with the arguments
10766: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10767: error messages into the file
1.108 rillig 10768: <code class="varname">TEST_OUTFILE</code>.</p>
10769: <p>When defining this function, make sure that all output that
10770: needs to be checked is written to the correct output file.
10771: Example:</p>
10772: <pre class="programlisting">
10773: do_test() {
1.112 rillig 10774: echo "Example output"
1.108 rillig 10775: } 1>$TEST_OUTFILE 2>&1
10776: </pre>
10777: </dd>
10778: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10779: <dd>
10780: <p>This function is run after the test and is
1.1 dsieger 10781: typically used to compare the actual output from the one that is
10782: expected. It can make use of the various helper functions from
1.108 rillig 10783: the next section. Example:</p>
10784: <pre class="programlisting">
10785: check_result() {
1.112 rillig 10786: exit_status 0
10787: output_require "Example"
10788: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10789: output_prohibit "no such file or directory"
1.168 rillig 10790: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 10791: }
10792: </pre>
10793: </dd>
10794: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 10795: <dd><p>This function cleans everything up after the
10796: test has been run. By default it does nothing.</p></dd>
10797: </dl></div>
10798: </div>
1.41 asau 10799: <div class="sect2">
1.1 dsieger 10800: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10801: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.41 asau 10802: <div class="variablelist"><dl class="variablelist">
1.168 rillig 10803: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10804: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108 rillig 10805: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 10806: <dd><p>This function compares the exitcode of the
1.108 rillig 10807: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 10808: If they differ, the test will fail.</p></dd>
1.108 rillig 10809: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10810: <dd>
10811: <p>This function checks for each of its parameters
10812: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 10813: extended regular expression. If it does not, the test will
1.108 rillig 10814: fail. Example:</p>
10815: <pre class="programlisting">
10816: output_require "looks fine"
10817: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10818: </pre>
10819: </dd>
1.177 leot 10820: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.1 dsieger 10821: <dd><p>This function checks for each of its parameters
1.10 hubertf 10822: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10823: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10824: If any of the regular expressions matches, the test will
10825: fail.</p></dd>
10826: </dl></div>
10827: </div>
10828: </div>
10829: </div>
1.41 asau 10830: <div class="chapter">
1.1 dsieger 10831: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10832: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10833: <div class="toc">
10834: <p><b>Table of Contents</b></p>
1.184 rillig 10835: <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 10836: </div>
10837: <p>The pkgsrc system has already been ported to many
10838: operating systems, hardware architectures and compilers. This
10839: chapter explains the necessary steps to make pkgsrc even more
10840: portable.</p>
1.41 asau 10841: <div class="sect1">
1.1 dsieger 10842: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10843: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10844: <p>To port pkgsrc to a new operating system (called
10845: <code class="literal">MyOS</code> in this example), you need to touch the
10846: following files:</p>
1.41 asau 10847: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10848: <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>
10849: <dd><p>This file contains some basic definitions, for
10850: example the name of the C
10851: compiler.</p></dd>
10852: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10853: <dd><p>Insert code that defines the variables
10854: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.212 wiz 10855: <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.1 dsieger 10856: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10857: <code class="varname">APPEND_ELF</code>, and the other variables that
10858: appear in this file.</p></dd>
10859: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10860: <dd><p>This file contains the platform-specific
10861: definitions that are used by pkgsrc. Start by copying one of the
10862: other files and edit it to your
10863: needs.</p></dd>
10864: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10865: <dd><p>This file defines the paths to all the tools
10866: that are needed by one or the other package in pkgsrc, as well
10867: as by pkgsrc itself. Find out where these tools are on your
10868: platform and add them.</p></dd>
10869: </dl></div>
10870: <p>Now, you should be able to build some basic packages, like
1.207 leot 10871: <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 10872: </div>
10873: </div>
10874: </div>
1.41 asau 10875: <div class="appendix">
10876: <div class="titlepage"><div><div><h1 class="title">
10877: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10878: <div class="toc">
10879: <p><b>Table of Contents</b></p>
1.100 leot 10880: <dl class="toc">
1.1 dsieger 10881: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10882: <dd><dl>
10883: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10884: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10885: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 10886: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 10887: </dl></dd>
10888: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10889: </dl>
10890: </div>
10891: <p>We checked to find a piece of software that wasn't in the packages
10892: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10893: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10894: present in the tree is beyond us, but it's useful for the purposes of
10895: this exercise.</p>
1.41 asau 10896: <div class="sect1">
1.1 dsieger 10897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10898: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10899: <div class="sect2">
1.1 dsieger 10900: <div class="titlepage"><div><div><h3 class="title">
10901: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10902: <pre class="programlisting">
10903: # $NetBSD$
10904: #
10905:
10906: DISTNAME= bison-1.25
10907: CATEGORIES= devel
1.171 rillig 10908: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 10909:
1.29 dholland 10910: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 10911: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 10912: COMMENT= GNU yacc clone
10913:
10914: GNU_CONFIGURE= yes
1.46 wiz 10915: INFO_FILES= yes
1.1 dsieger 10916:
10917: .include "../../mk/bsd.pkg.mk"
10918: </pre>
10919: </div>
1.41 asau 10920: <div class="sect2">
1.1 dsieger 10921: <div class="titlepage"><div><div><h3 class="title">
10922: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10923: <pre class="programlisting">
10924: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.207 leot 10925: 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 10926: of the NetBSD source tree is beyond me.
10927: </pre>
10928: </div>
1.41 asau 10929: <div class="sect2">
1.1 dsieger 10930: <div class="titlepage"><div><div><h3 class="title">
10931: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10932: <pre class="programlisting">
10933: @comment $NetBSD$
10934: bin/bison
10935: man/man1/bison.1.gz
10936: share/bison.simple
10937: share/bison.hairy
10938: </pre>
10939: </div>
1.41 asau 10940: <div class="sect2">
1.1 dsieger 10941: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 10942: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1 dsieger 10943: <p>The NetBSD package system comes with
1.207 leot 10944: <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 10945: which helps to check the contents of these
10946: files. After installation it is quite easy to use, just change to the
1.171 rillig 10947: directory of the package you wish to examine and run
1.10 hubertf 10948: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10949: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171 rillig 10950: ERROR: Makefile: Each package must define its LICENSE.
10951: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10952: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10953: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10954: 1 error, 2 warnings and 1 note found.
10955: (Run "pkglint -e" to show explanations.)
10956: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 10957: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1 dsieger 10958: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170 rillig 10959: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1 dsieger 10960: -Wall</strong></span> for a very thorough check.</p>
10961: </div>
10962: </div>
1.41 asau 10963: <div class="sect1">
1.1 dsieger 10964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10965: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10966: <p>Create the directory where the package lives,
10967: plus any auxiliary directories:</p>
10968: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10969: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10970: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10971: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10972: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.184 rillig 10973: <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 10974: then continue with fetching the distfile:</p>
10975: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10976: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10977: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10978: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10979: ftp: Error retrieving file: 500 Internal error
10980:
10981: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10982: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10983: ftp: Error retrieving file: 500 Internal error
10984:
10985: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10986: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10987: Successfully retrieved file.</pre>
10988: <p>Generate the checksum of the distfile into
10989: <code class="filename">distinfo</code>:</p>
10990: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10991: <p>Now compile:</p>
10992: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10993: >> Checksum OK for bison-1.25.tar.gz.
10994: ===> Extracting for bison-1.25
10995: ===> Patching for bison-1.25
10996: ===> Ignoring empty patch directory
10997: ===> Configuring for bison-1.25
10998: creating cache ./config.cache
10999: checking for gcc... cc
11000: checking whether we are using GNU C... yes
11001: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
11002: checking how to run the C preprocessor... cc -E
11003: checking for minix/config.h... no
11004: checking for POSIXized ISC... no
11005: checking whether cross-compiling... no
11006: checking for ANSI C header files... yes
11007: checking for string.h... yes
11008: checking for stdlib.h... yes
11009: checking for memory.h... yes
11010: checking for working const... yes
11011: checking for working alloca.h... no
11012: checking for alloca... yes
11013: checking for strerror... yes
11014: updating cache ./config.cache
11015: creating ./config.status
11016: creating Makefile
11017: ===> Building for bison-1.25
11018: 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
11019: 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
11020: 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
11021: 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
11022: 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
11023: 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
11024: 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
11025: 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
11026: 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
11027: 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
11028: 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
11029: 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
11030: 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
11031: 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
11032: 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
11033: 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
11034: 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
11035: 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
11036: 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
11037: 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
11038: 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
11039: 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
11040: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
11041: rm -f bison.s1
11042: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
11043: <p>Everything seems OK, so install the files:</p>
11044: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11045: >> Checksum OK for bison-1.25.tar.gz.
11046: ===> Installing for bison-1.25
11047: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
11048: rm -f /usr/pkg/bin/bison
11049: cd /usr/pkg/share; rm -f bison.simple bison.hairy
11050: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
11051: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
11052: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
11053: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
11054: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
11055: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
11056: ===> Registering installation for bison-1.25</pre>
11057: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 11058: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 11059: binary package, do this now:</p>
11060: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11061: >> Checksum OK for bison-1.25.tar.gz.
11062: ===> Building package for bison-1.25
11063: Creating package bison-1.25.tgz
11064: Registering depends:.
11065: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
11066: <p>Now that you don't need the source and object files
11067: any more, clean up:</p>
11068: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
11069: ===> Cleaning for bison-1.25</pre>
11070: </div>
11071: </div>
1.41 asau 11072: <div class="appendix">
11073: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 11074: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.1 dsieger 11075: <div class="toc">
11076: <p><b>Table of Contents</b></p>
1.100 leot 11077: <dl class="toc">
1.207 leot 11078: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
11079: <dd><dl>
11080: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
11081: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
11082: </dl></dd>
11083: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
11084: <dd><dl>
11085: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
11086: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
11087: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
11088: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
11089: </dl></dd>
11090: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
11091: <dd><dl>
11092: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
11093: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
11094: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
11095: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
11096: </dl></dd>
1.1 dsieger 11097: </dl>
11098: </div>
1.207 leot 11099: <p>
11100: A number of mechanisms are available in pkgsrc to improve the security of the
11101: resulting system. This page describes the mechanisms, and gives hints
11102: about detecting and fixing problems.
11103: </p>
11104: <p>
11105: Mechanisms can be enabled individually in
11106: <code class="filename">mk.conf</code>, and are
11107: individually described below.
11108: </p>
11109: <p>
11110: Typically, a feature will cause some programs to fail to build or work
11111: when first enabled. This can be due to latent problems in the
11112: program, and can be due to other reasons. After enough testing to
11113: have confidence that user problems will be quite rare, individual
11114: mechanisms will be enabled by default.
11115: </p>
11116: <p>
11117: For each mechanism, see the Caveats section below for an explanation
11118: of what might go wrong at compile time and at run time, and how to
11119: notice and address these problems.
11120: </p>
1.41 asau 11121: <div class="sect1">
1.1 dsieger 11122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11123: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
11124: <div class="sect2">
11125: <div class="titlepage"><div><div><h3 class="title">
11126: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
11127: <div class="sect3">
11128: <div class="titlepage"><div><div><h4 class="title">
11129: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
11130: <p>
11131: This allows substitute wrappers to be used for some commonly used
11132: library functions that do not have built-in bounds checking - but
11133: could in some cases.
11134: </p>
11135: <p>
11136: Two mitigation levels are available:
11137: </p>
11138: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11139: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
11140: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
11141: </ul></div>
11142: <p>
11143: "strong" has been enabled by default since pkgsrc-2017Q3.
11144: </p>
11145: </div>
11146: <div class="sect3">
11147: <div class="titlepage"><div><div><h4 class="title">
11148: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
11149: <p>
11150: This enables a stack-smashing protection mitigation. It is done by adding a
11151: guard variable to functions with vulnerable objects. The guards are initialized
11152: when a function is entered and then checked when the function exits. The guard
11153: check will fail and the program forcibly exited if the variable was modified in
11154: the meantime. This can happen in case of buffer overflows or memory corruption,
11155: and therefore exposing these bugs.
11156: </p>
11157: <p>
11158: Different mitigation levels are available:
11159: </p>
11160: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11161: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
11162: by the compiler;</p></li>
11163: <li class="listitem"><p>"all", which will protect every function;</p></li>
11164: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
11165: two settings above.</p></li>
11166: </ul></div>
11167: <p>
11168: This mitigation is supported by both GCC and clang. It may be supported in
11169: additional compilers, possibly under a different name. It is particularly useful
11170: for unsafe programming languages, such as C/C++.
11171: </p>
11172: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11173: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
11174: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
11175: </ul></div>
11176: <p>More details can be found here:</p>
11177: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11178: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
11179: </p></li></ul></div>
11180: </div>
11181: <div class="sect3">
11182: <div class="titlepage"><div><div><h4 class="title">
11183: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
11184: <p>
11185: This requests the creation of PIE (Position Independent Executables) for all
11186: executables. The PIE mechanism is normally used for shared libraries, so that
11187: they can be loaded at differing addresses at runtime. PIE itself does not have
11188: useful security properties; however, it is necessary to fully leverage some,
11189: such as ASLR. Some operating systems support Address Space Layout Randomization
11190: (ASLR), which causes different addresses to be used each time a program is run.
11191: This makes it more difficult for an attacker to guess addresses and thus makes
11192: exploits harder to construct. With PIE, ASLR can really be applied to the entire
11193: program, instead of the stack and heap only.
11194: </p>
11195: <p>
11196: PIE executables will only be built for toolchains that are known to support PIE.
11197: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
11198: </p>
11199: <p>
11200: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
11201: </p>
1.1 dsieger 11202: </div>
1.210 gutterid 11203: <div class="sect3">
11204: <div class="titlepage"><div><div><h4 class="title">
1.219 nia 11205: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.207 leot 11206: <p>
11207: This also makes the exploitation of some security vulnerabilities more
11208: difficult in some cases.
11209: </p>
11210: <p>Two different mitigation levels are available:</p>
11211: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11212: <li class="listitem"><p>
1.219 nia 11213: partial (the default): the ELF sections are reordered so that internal data sections
1.207 leot 11214: precede the program's own data sections, and non-PLT GOT is read-only;
11215: </p></li>
11216: <li class="listitem"><p>
11217: full: in addition to partial RELRO, every relocation is performed immediately
1.218 nia 11218: when starting the program, allowing the entire GOT to be read-only. This
11219: can greatly slow down startup of large programs.
1.207 leot 11220: </p></li>
11221: </ul></div>
11222: <p>
11223: This is currently supported by GCC. Many software distributions now enable this
1.220 nia 11224: feature by default, at the "partial" level.
1.207 leot 11225: </p>
11226: <p>
11227: More details can be found here:
11228: </p>
11229: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11230: <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>
11231: </p></li></ul></div>
1.1 dsieger 11232: </div>
1.219 nia 11233: </div>
11234: <div class="sect2">
11235: <div class="titlepage"><div><div><h3 class="title">
11236: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
11237: <div class="sect3">
11238: <div class="titlepage"><div><div><h4 class="title">
11239: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
11240: <p>
11241: With this option, pkgsrc will try to build packages reproducibly. This allows
11242: packages built from the same tree and with the same options, to produce
11243: identical results bit by bit. This option should be combined with ASLR and
11244: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
11245: attackers attempting to exploit security vulnerabilities.
11246: </p>
11247: <p>
11248: More details can be found here:
11249: </p>
11250: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11251: <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>
11252: </p></li></ul></div>
11253: <p>
11254: More work likely needs to be done before pkgsrc is fully reproducible.
11255: </p>
11256: </div>
1.207 leot 11257: <div class="sect3">
11258: <div class="titlepage"><div><div><h4 class="title">
1.219 nia 11259: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.207 leot 11260: <p>
11261: This uses <code class="literal">-fstack-check</code> with GCC for
11262: another stack protection mitigation.
11263: </p>
11264: <p>
11265: It asks the compiler to generate code verifying that it does not corrupt the
11266: stack. According to GCC's manual page, this is really only useful for
11267: multi-threaded programs.
11268: </p>
1.1 dsieger 11269: </div>
11270: </div>
11271: </div>
1.41 asau 11272: <div class="sect1">
1.1 dsieger 11273: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11274: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
11275: <div class="sect2">
11276: <div class="titlepage"><div><div><h3 class="title">
11277: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
11278: <div class="sect3">
11279: <div class="titlepage"><div><div><h4 class="title">
11280: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
11281: <p>
11282: A number of packages may fail to build with this option enabled. The
11283: failures are often related to the absence of the <code class="literal">-fPIC</code>
11284: compilation flag when building libraries or executables (or ideally
11285: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
11286: <code class="varname">CFLAGS</code> already, but requires the package to
11287: actually support it.
11288: </p>
11289: <div class="sect4">
11290: <div class="titlepage"><div><div><h5 class="title">
11291: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
11292: <p>
11293: These instructions are meant as a reference only; they likely need to be adapted
11294: for many packages individually.
11295: </p>
11296: <p>
11297: For packages using <code class="filename">Makefiles</code>:
11298: </p>
11299: <pre class="programlisting">
11300: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
11301: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
11302: </pre>
11303: <p>
11304: For packages using <code class="filename">Imakefiles</code>:
11305: </p>
11306: <pre class="programlisting">
11307: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
11308: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
11309: </pre>
11310: </div>
11311: </div>
11312: <div class="sect3">
11313: <div class="titlepage"><div><div><h4 class="title">
11314: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
11315: <p>
11316: Some programs may fail to run, or crash at random times once built as PIE. Two
11317: scenarios are essentially possible. This is nearly always due to a bug in
11318: the program being exposed due to ASLR.
11319: </p>
11320: </div>
11321: <div class="sect3">
11322: <div class="titlepage"><div><div><h4 class="title">
11323: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
11324: <p>
11325: Ideally, packages should be fixed for compatibility with MKPIE.
11326: However, in some cases this is very difficult, due to complex build systems,
11327: packages using non-standard toolchains, or programming languages with odd
11328: bootstrapping mechanisms.
11329: </p>
11330: <p>
11331: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
11332: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
11333: <code class="filename">bsd.prefs.mk</code> is included.
11334: </p>
11335: </div>
11336: </div>
11337: <div class="sect2">
11338: <div class="titlepage"><div><div><h3 class="title">
11339: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
11340: <div class="sect3">
11341: <div class="titlepage"><div><div><h4 class="title">
11342: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
11343: <p>
11344: This feature makes use of pre-processing directives to look for hardened,
11345: alternative implementations of essential library calls. Some programs may fail
11346: to build as a result; this usually happens for those trying too hard to be
11347: portable, or otherwise abusing definitions in the standard library.
11348: </p>
11349: </div>
11350: <div class="sect3">
11351: <div class="titlepage"><div><div><h4 class="title">
11352: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
11353: <p>
11354: This feature may cause some programs to crash, usually indicating an
11355: actual bug in the program. The fix will typically involve patching the
11356: original program's source code.
11357: </p>
11358: </div>
11359: <div class="sect3">
11360: <div class="titlepage"><div><div><h4 class="title">
11361: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
11362: <p>
11363: At least in the case of GCC, FORTIFY will only be applied if optimization is
11364: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
11365: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
11366: optimization level. This cannot easily be applied globally, as some packages
11367: may require specific optimization levels.
11368: </p>
11369: </div>
11370: <div class="sect3">
11371: <div class="titlepage"><div><div><h4 class="title">
11372: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
11373: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11374: <h3 class="title">Note</h3>
11375: <p>FORTIFY should not be disabled to work around runtime crashes in
11376: the program! This is a very bad idea and will expose you to security
11377: vulnerabilities.
11378: </p>
11379: </div>
11380: <p>
11381: To disable FORTIFY on a per-package basis, set the following
11382: in the package's <code class="filename">Makefile</code>
11383: before <code class="filename">bsd.prefs.mk</code> is included:
11384: </p>
11385: <pre class="programlisting">
11386: FORTIFY_SUPPORTED= no
11387: </pre>
11388: </div>
11389: </div>
11390: <div class="sect2">
11391: <div class="titlepage"><div><div><h3 class="title">
11392: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
11393: <div class="sect3">
11394: <div class="titlepage"><div><div><h4 class="title">
11395: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
11396: <p>
11397: For better protection, full RELRO requires every symbol to be resolved when the
11398: program starts, rather than simply when required at run-time. This will have
11399: more impact on programs using a lot of symbols, or linked to libraries exposing
11400: a lot of symbols. Therefore, daemons or programs otherwise running in
11401: background are affected only when started. Programs loading plug-ins at
11402: run-time are affected when loading the plug-ins.
11403: </p>
11404: <p>
11405: The impact is not expected to be noticeable on modern hardware, except in some
11406: cases for big programs.
11407: </p>
11408: </div>
11409: <div class="sect3">
11410: <div class="titlepage"><div><div><h4 class="title">
11411: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
11412: <p>
11413: Some programs handle plug-ins and dependencies in a way that conflicts with
11414: RELRO: for instance, with an initialization routine listing any other plug-in
11415: required. With full RELRO, the missing symbols are resolved before the
11416: initialization routine can run, and the dynamic loader will not be able to find
11417: them directly and abort as a result. Unfortunately, this is how Xorg loads its
11418: drivers. Partial RELRO can be applied instead in this case.
11419: </p>
11420: </div>
11421: <div class="sect3">
11422: <div class="titlepage"><div><div><h4 class="title">
11423: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
11424: <p>
11425: To disable RELRO on a per-package basis, set the following
11426: in the package's <code class="filename">Makefile</code>
11427: before <code class="filename">bsd.prefs.mk</code> is included:
11428: </p>
11429: <pre class="programlisting">
11430: RELRO_SUPPORTED= no
11431: </pre>
1.209 nia 11432: <p>
11433: It is also possible to at most enable partial RELRO, by
11434: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
11435: </p>
1.207 leot 11436: </div>
11437: </div>
11438: <div class="sect2">
11439: <div class="titlepage"><div><div><h3 class="title">
11440: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
11441: <div class="sect3">
11442: <div class="titlepage"><div><div><h4 class="title">
11443: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
11444: <p>
11445: The stack-smashing protection provided by this option does not work for some
11446: programs. The most common situation in which this happens is when the program
11447: allocates variables on the stack, with the size determined at run-time.
11448: </p>
11449: </div>
11450: <div class="sect3">
11451: <div class="titlepage"><div><div><h4 class="title">
11452: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
11453: <p>
11454: Again, this feature may cause some programs to crash via a
11455: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
11456: </p>
11457: <p>
11458: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
11459: messages are sent and - by default -
11460: appended to <code class="filename">/var/log/messages</code>, e.g.:
11461: </p>
11462: <pre class="programlisting">
11463: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
11464: </pre>
11465: <p>
11466: (where <code class="literal">hostname</code> is the hostname(1) and
11467: <code class="literal">program</code> is the basename(1) of the program crashed).
11468: </p>
11469: <p>
11470: Patching the original program is then required.
11471: </p>
11472: <p>
11473: Rebuilding the package via:
11474: </p>
11475: <pre class="programlisting">
11476: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
11477: </pre>
11478: <p>
11479: and inspecting the backtrace of the coredump via the debugger
11480: should point out the problematic call by inspecting the frame
11481: calling the _chk() (SSP) function.
11482: </p>
11483: </div>
11484: <div class="sect3">
11485: <div class="titlepage"><div><div><h4 class="title">
11486: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
11487: <p>
11488: The compiler emits extra code when using this feature: a check for buffer
11489: overflows is performed when entering and exiting functions, requiring an extra
11490: variable on the stack. The level of protection can otherwise be adjusted to
11491: affect only those functions considered more sensitive by the compiler (with
11492: -fstack-protector instead of -fstack-protector-all).
11493: </p>
11494: <p>
11495: The impact is not expected to be noticeable on modern hardware. However,
11496: programs with a hard requirement to run at the fastest possible speed should
11497: avoid using this feature, or using libraries built with this feature.
11498: </p>
11499: </div>
11500: <div class="sect3">
11501: <div class="titlepage"><div><div><h4 class="title">
11502: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
11503: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11504: <h3 class="title">Note</h3>
11505: <p>SSP should not be disabled to work around runtime crashes in
11506: the program! This is a very bad idea and will expose you to security
11507: vulnerabilities.</p>
11508: </div>
11509: <p>
11510: To disable SSP on a per-package basis, set the following
11511: in the package's <code class="filename">Makefile</code>
11512: before <code class="filename">bsd.prefs.mk</code> is included:
11513: </p>
11514: <pre class="programlisting">
11515: SSP_SUPPORTED= no
11516: </pre>
11517: </div>
11518: </div>
11519: </div>
11520: <div class="sect1">
11521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11522: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
11523: <p>
11524: The illusion of security is worse than having no security at all. This section
11525: lists a number of ways to ensure the security features requested are actually
11526: effective.
11527: </p>
11528: <p>
11529: These instructions were obtained and tested on a system derived from NetBSD 7
11530: (amd64). YMMV.
11531: </p>
11532: <div class="sect2">
11533: <div class="titlepage"><div><div><h3 class="title">
11534: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
11535: <p>
11536: The ELF executable type in use changes for binaries built as PIE; without:
11537: </p>
11538: <pre class="programlisting">
11539: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
11540: /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
11541: </pre>
11542: <p>as opposed to the following binary, built as PIE:</p>
11543: <pre class="programlisting">
11544: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
11545: /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
11546: </pre>
11547: <p>
11548: The latter result is then what is expected.
11549: </p>
11550: </div>
11551: <div class="sect2">
11552: <div class="titlepage"><div><div><h3 class="title">
11553: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
11554: <p>
11555: The following command should list a section called RELRO:
11556: </p>
11557: <pre class="programlisting">
11558: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
11559:
11560: /path/to/bin/ary: file format elf64-x86-64
11561:
11562: Program Header:
11563: [...]
11564: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
11565: </pre>
11566: <p>
11567: This check is now performed automatically if
11568: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
11569: </p>
11570: </div>
11571: <div class="sect2">
11572: <div class="titlepage"><div><div><h3 class="title">
11573: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
11574: <p>
11575: The dynamic loader will apply RELRO immediately when detecting the presence of
11576: the <code class="varname">BIND_NOW</code> flag:
11577: </p>
11578: <pre class="programlisting">
11579: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
11580:
11581: /path/to/bin/ary: file format elf64-x86-64
11582:
11583: Dynamic Section:
11584: [...]
11585: BIND_NOW 0x0000000000000000
11586: </pre>
11587: <p>
11588: This has to be combined with partial RELRO (see above) to be fully efficient.
11589: </p>
11590: <p>
11591: This check is now performed automatically (where supported) if
11592: <code class="varname">PKG_DEVELOPER</code> is set.
11593: </p>
11594: </div>
11595: <div class="sect2">
11596: <div class="titlepage"><div><div><h3 class="title">
11597: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.208 nia 11598: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11599: <h3 class="title">Note</h3>
11600: <p>
11601: Checking for SSP using this method only works where the operating system
11602: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
11603: on recent NetBSD/FreeBSD/Linux versions.
11604: </p>
11605: </div>
1.207 leot 11606: <p>
11607: Building objects, binaries and libraries with SSP will affect the presence of
11608: additional symbols in the resulting file:
11609: </p>
11610: <pre class="programlisting">
11611: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
11612: [...]
11613: U __stack_chk_fail
11614: 0000000000600ea0 B __stack_chk_guard
11615: </pre>
11616: <p>
11617: This is an indicator that the program was indeed built with support for SSP.
11618: </p>
11619: <p>
11620: This check is now performed automatically (where supported) if
11621: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
11622: </p>
11623: </div>
11624: </div>
11625: </div>
11626: <div class="appendix">
11627: <div class="titlepage"><div><div><h1 class="title">
11628: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
11629: <div class="toc">
11630: <p><b>Table of Contents</b></p>
11631: <dl class="toc">
11632: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
11633: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
11634: </dl>
11635: </div>
11636: <div class="sect1">
11637: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11638: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
11639: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11640: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11641: => figlet221.tar.gz doesn't seem to exist on this system.
11642: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11643: => [172219 bytes]
11644: Connected to ftp.plig.net.
11645: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11646: 331 Guest login ok, send your complete e-mail address as password.
11647: 230-You are user #5 of 500 simultaneous users allowed.
11648: 230-
11649: 230- ___ _ _ _
11650: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11651: 230- | _| _| . |_| . | | | . |_| . | _| . |
11652: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11653: 230- |_| |_| |___| |___|
11654: 230-
11655: 230-** Welcome to ftp.plig.org **
11656: 230-
11657: 230-Please note that all transfers from this FTP site are logged. If you
11658: 230-do not like this, please disconnect now.
11659: 230-
11660: 230-This archive is available via
11661: 230-
11662: 230-HTTP: http://ftp.plig.org/
11663: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11664: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11665: 230-
11666: 230-Please email comments, bug reports and requests for packages to be
11667: 230-mirrored to ftp-admin@plig.org.
11668: 230-
11669: 230-
11670: 230 Logged in anonymously.
11671: Remote system type is UNIX.
11672: Using binary mode to transfer files.
11673: 200 Type okay.
11674: 250 "/pub" is new cwd.
11675: 250-"/pub/figlet" is new cwd.
11676: 250-
11677: 250-Welcome to the figlet archive at ftp.figlet.org
11678: 250-
11679: 250- ftp://ftp.figlet.org/pub/figlet/
11680: 250-
11681: 250-The official FIGlet web page is:
11682: 250- http://www.figlet.org/
11683: 250-
11684: 250-If you have questions, please mailto:info@figlet.org. If you want to
11685: 250-contribute a font or something else, you can email us.
11686: 250
11687: 250 "/pub/figlet/program" is new cwd.
11688: 250 "/pub/figlet/program/unix" is new cwd.
11689: local: figlet221.tar.gz remote: figlet221.tar.gz
11690: 502 Unimplemented command.
11691: 227 Entering Passive Mode (195,40,6,41,246,104)
11692: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11693: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11694: 226 Transfer completed.
11695: 172219 bytes received in 00:02 (75.99 KB/s)
11696: 221 Goodbye.
11697: => Checksum OK for figlet221.tar.gz.
11698: ===> Extracting for figlet-2.2.1nb2
11699: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11700: ===> Patching for figlet-2.2.1nb2
11701: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11702: ===> Overriding tools for figlet-2.2.1nb2
11703: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11704: ===> Configuring for figlet-2.2.1nb2
11705: ===> Building for figlet-2.2.1nb2
11706: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11707: chmod a+x figlet
11708: gcc -O2 -o chkfont chkfont.c
11709: => Unwrapping files-to-be-installed.
11710: <code class="prompt">#</code>
11711: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11712: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11713: ===> Installing for figlet-2.2.1nb2
11714: install -d -o root -g wheel -m 755 /usr/pkg/bin
11715: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11716: mkdir -p /usr/pkg/share/figlet
11717: cp figlet /usr/pkg/bin
11718: cp chkfont /usr/pkg/bin
11719: chmod 555 figlist showfigfonts
11720: cp figlist /usr/pkg/bin
11721: cp showfigfonts /usr/pkg/bin
11722: cp fonts/*.flf /usr/pkg/share/figlet
11723: cp fonts/*.flc /usr/pkg/share/figlet
11724: cp figlet.6 /usr/pkg/man/man6
11725: ===> Registering installation for figlet-2.2.1nb2
11726: <code class="prompt">#</code></pre>
11727: </div>
11728: <div class="sect1">
11729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11730: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
11731: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11732: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11733: ===> Packaging figlet-2.2.1nb2
11734: ===> Building binary package for figlet-2.2.1nb2
11735: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11736: Using SrcDir value of /usr/pkg
11737: Registering depends:.
11738: <code class="prompt">#</code></pre>
11739: </div>
11740: </div>
11741: <div class="appendix">
11742: <div class="titlepage"><div><div><h1 class="title">
11743: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
11744: <div class="toc">
11745: <p><b>Table of Contents</b></p>
11746: <dl class="toc">
11747: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11748: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11749: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11750: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11751: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
11752: <code class="filename">stable</code>,
11753: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11754: source packages</a></span></dt>
11755: </dl>
11756: </div>
11757: <p>As in other big projects, the directory layout of pkgsrc
11758: is quite complex for newbies. This chapter explains where you
11759: find things on the FTP server. The base directory on
11760: <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>.
11761: On other servers it may be different, but inside this directory,
11762: everything should look the same, no matter on which server you
11763: are. This directory contains some subdirectories, which are
11764: explained below.</p>
11765: <div class="sect1">
11766: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11767: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
11768: <p>The directory <code class="filename">distfiles</code> contains lots
11769: of archive files from all pkgsrc packages, which are mirrored
11770: here. The subdirectories are called after their package names
11771: and are used when the distributed files have names that don't
11772: explicitly contain a version number or are otherwise too generic
11773: (for example <code class="filename">release.tar.gz</code>).</p>
11774: </div>
11775: <div class="sect1">
11776: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11777: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
11778: <p>This directory contains things that individual pkgsrc
11779: developers find worth publishing.</p>
11780: </div>
11781: <div class="sect1">
11782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11783: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
11784: <p>This directory contains binary packages for the various
11785: platforms that are supported by pkgsrc.
11786: 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>
11787: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11788: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
11789: operating system for which the packages have been built. The
11790: name is taken from the output of the <span class="command"><strong>uname</strong></span>
11791: command, so it may differ from the one you are used to
11792: hear.</p></li>
11793: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
11794: architecture of the platform for which the packages have been
11795: built. It also includes the <code class="varname">ABI</code> (Application
11796: Binary Interface) for platforms that have several of
11797: them.</p></li>
11798: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
11799: the operating system. For version numbers that change often (for
11800: example NetBSD-current), the often-changing part should be
11801: replaced with an <code class="literal">x</code>, for example
11802: <code class="literal">4.99.x</code>.</p></li>
11803: <li class="listitem"><p><code class="varname">TAG</code> is either
11804: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11805: for a stable branch, or <code class="literal">head</code> for packages
11806: built from the HEAD branch. The latter should only be used when
11807: the packages are updated on a regular basis. Otherwise the date
11808: from checking out pkgsrc should be appended, for example
11809: <code class="literal">head_20071015</code>.</p></li>
11810: </ul></div>
11811: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11812: can quickly click through the directories on the
11813: server and find the best binary packages for their machines. Since they
11814: usually know the operating system and the hardware architecture, OPSYS
11815: and ARCH are placed first. After these choices, they can select the
11816: best combination of OSVERSION and TAG together, since it is usually the
11817: case that packages stay compatible between different version of the
11818: operating system.</p>
11819: <p>In each of these directories, there is a
11820: whole binary packages collection for a specific platform. It has a directory called
11821: <code class="filename">All</code> which contains all binary packages.
11822: Besides that, there are various category directories that
11823: contain symbolic links to the real binary packages.</p>
11824: </div>
11825: <div class="sect1">
11826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11827: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 11828: <p>Here are the reports from bulk builds, for those who want
11829: to fix packages that didn't build on some of the platforms. The
1.207 leot 11830: 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 11831: </div>
1.41 asau 11832: <div class="sect1">
1.8 rillig 11833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11834: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.148 leot 11835: <code class="filename">stable</code>,
1.22 jakllsch 11836: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 11837: source packages</h2></div></div></div>
1.23 wiz 11838: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 11839: that is the files that define how to create binary packages from
11840: source archives.</p>
1.149 leot 11841: <p>Each of the <code class="filename">current</code>,
11842: <code class="filename">stable</code> and
11843: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11844: directories share the same structure. They each contain a
11845: <code class="filename">pkgsrc</code> directory and
11846: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 11847: <p>The directory <code class="filename">pkgsrc</code> contains a
11848: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 11849: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11850: as the directory, ready to be downloaded as a whole.</p>
11851: <p>The <code class="filename">current</code> directory contains files
11852: related to the HEAD branch of the CVS repository.
11853: In this directory there is an additional file called
11854: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11855: all pkgsrc <code class="filename">README</code>s with information about
11856: categories and packages.
11857: </p>
11858: <p>The <code class="filename">stable</code> directory is a symlink to
11859: the latest
11860: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11861: </p>
11862: <p>The
11863: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11864: directories contain files related to the
11865: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11866: stable branch of the CVS repository. In these directories there is
11867: an additional file called
11868: <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 11869: which contains the state of pkgsrc when it was branched.</p>
11870: </div>
11871: </div>
1.41 asau 11872: <div class="appendix">
11873: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 11874: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.154 rillig 11875: <p>
11876: The following list contains all help topics that are available
11877: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11878: </p>
1.156 leot 11879: <table border="0" summary="Simple list" class="simplelist">
11880: <tr>
11881: <td>#!</td>
11882: <td>-lintl</td>
11883: </tr>
11884: <tr>
1.205 wiz 11885: <td>32bit</td>
1.156 leot 11886: <td>64bit</td>
1.205 wiz 11887: </tr>
11888: <tr>
1.156 leot 11889: <td>ABI</td>
1.205 wiz 11890: <td>ACCEPTABLE_LICENSES</td>
1.156 leot 11891: </tr>
11892: <tr>
11893: <td>ACROREAD_FONTPATH</td>
1.205 wiz 11894: <td>ADDITIONAL</td>
1.156 leot 11895: </tr>
11896: <tr>
11897: <td>AFAIK</td>
1.205 wiz 11898: <td>AIX</td>
1.156 leot 11899: </tr>
11900: <tr>
11901: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.205 wiz 11902: <td>ALL_ENV</td>
1.156 leot 11903: </tr>
11904: <tr>
1.200 cirnatda 11905: <td>ALTERNATIVES_SRC</td>
1.239 dholland 11906: <td>AMANDA_TMP</td>
1.238 wiz 11907: </tr>
11908: <tr>
11909: <td>AMANDA_USER</td>
1.239 dholland 11910: <td>AMANDA_VAR</td>
1.233 wiz 11911: </tr>
11912: <tr>
1.238 wiz 11913: <td>APACHE_GROUP</td>
1.239 dholland 11914: <td>APACHE_MODULE_NAME</td>
1.227 wiz 11915: </tr>
11916: <tr>
1.238 wiz 11917: <td>APACHE_MODULE_SRC</td>
1.239 dholland 11918: <td>APACHE_MODULE_SRCDIR</td>
1.223 nia 11919: </tr>
11920: <tr>
1.238 wiz 11921: <td>APACHE_PKG_PREFIX</td>
1.239 dholland 11922: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.217 rillig 11923: </tr>
11924: <tr>
1.238 wiz 11925: <td>APACHE_SUEXEC_DOCROOT</td>
1.239 dholland 11926: <td>APACHE_USER</td>
1.214 leot 11927: </tr>
11928: <tr>
1.238 wiz 11929: <td>APPEND_ABI</td>
1.239 dholland 11930: <td>APPEND_ELF</td>
1.212 wiz 11931: </tr>
11932: <tr>
1.238 wiz 11933: <td>ARLA_CACHE</td>
1.239 dholland 11934: <td>AUDIT_PACKAGES_FLAGS</td>
1.197 leot 11935: </tr>
11936: <tr>
1.238 wiz 11937: <td>AUTOCONF_REQD</td>
1.239 dholland 11938: <td>AUTOMAKE_OVERRIDE</td>
1.177 leot 11939: </tr>
11940: <tr>
1.238 wiz 11941: <td>AUTOMAKE_REQD</td>
1.239 dholland 11942: <td>AUTO_MKDIRS</td>
1.161 leot 11943: </tr>
11944: <tr>
1.238 wiz 11945: <td>BDB185_DEFAULT</td>
1.239 dholland 11946: <td>BDBBASE</td>
1.159 rillig 11947: </tr>
11948: <tr>
1.238 wiz 11949: <td>BDB_ACCEPTED</td>
1.239 dholland 11950: <td>BDB_DEFAULT</td>
1.156 leot 11951: </tr>
11952: <tr>
1.238 wiz 11953: <td>BDB_LIBS</td>
1.239 dholland 11954: <td>BDB_TYPE</td>
1.156 leot 11955: </tr>
11956: <tr>
1.238 wiz 11957: <td>BINCIMAP_GROUP</td>
1.239 dholland 11958: <td>BINCIMAP_USER</td>
1.156 leot 11959: </tr>
11960: <tr>
1.238 wiz 11961: <td>BIND_DIR</td>
1.239 dholland 11962: <td>BIND_GROUP</td>
1.156 leot 11963: </tr>
11964: <tr>
1.238 wiz 11965: <td>BIND_USER</td>
1.239 dholland 11966: <td>BINOWN</td>
1.156 leot 11967: </tr>
11968: <tr>
1.238 wiz 11969: <td>BINPKG_SITES</td>
1.239 dholland 11970: <td>BIN_INSTALL_FLAGS</td>
1.156 leot 11971: </tr>
11972: <tr>
1.238 wiz 11973: <td>BISON_PKGDATADIR</td>
1.239 dholland 11974: <td>BLAS</td>
1.156 leot 11975: </tr>
11976: <tr>
1.238 wiz 11977: <td>BLAS_ACCEPTED</td>
1.239 dholland 11978: <td>BLAS_C_INTERFACE</td>
1.156 leot 11979: </tr>
11980: <tr>
1.238 wiz 11981: <td>BLAS_INCLUDES</td>
1.239 dholland 11982: <td>BLAS_INDEX64</td>
1.156 leot 11983: </tr>
11984: <tr>
1.238 wiz 11985: <td>BLAS_LIBS</td>
1.239 dholland 11986: <td>BLAS_PC</td>
1.156 leot 11987: </tr>
11988: <tr>
1.238 wiz 11989: <td>BLAS_TYPE</td>
1.239 dholland 11990: <td>BOOTSTRAP_DEPENDS</td>
1.198 leot 11991: </tr>
11992: <tr>
1.238 wiz 11993: <td>BROKEN</td>
1.239 dholland 11994: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.229 gutterid 11995: </tr>
11996: <tr>
1.238 wiz 11997: <td>BROKEN_ON_PLATFORM</td>
1.239 dholland 11998: <td>BSDSRCDIR</td>
1.156 leot 11999: </tr>
12000: <tr>
1.238 wiz 12001: <td>BSDXSRCDIR</td>
1.239 dholland 12002: <td>BSD_MAKE_ENV</td>
1.156 leot 12003: </tr>
12004: <tr>
1.238 wiz 12005: <td>BUILDLINK_AUTO_DIRS</td>
1.239 dholland 12006: <td>BUILDLINK_AUTO_VARS</td>
1.189 bacon 12007: </tr>
12008: <tr>
1.238 wiz 12009: <td>BUILDLINK_CFLAGS</td>
1.239 dholland 12010: <td>BUILDLINK_CONTENTS_FILTER</td>
1.205 wiz 12011: </tr>
12012: <tr>
1.238 wiz 12013: <td>BUILDLINK_CPPFLAGS</td>
1.229 gutterid 12014: <td>BUILDLINK_FILES</td>
1.156 leot 12015: </tr>
12016: <tr>
1.216 gutterid 12017: <td>BUILDLINK_FILES_CMD</td>
1.229 gutterid 12018: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.205 wiz 12019: </tr>
12020: <tr>
1.216 gutterid 12021: <td>BUILDLINK_LDFLAGS</td>
1.229 gutterid 12022: <td>BUILDLINK_LIBS</td>
1.156 leot 12023: </tr>
12024: <tr>
1.216 gutterid 12025: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.229 gutterid 12026: <td>BUILDLINK_PKGNAME</td>
1.156 leot 12027: </tr>
12028: <tr>
1.216 gutterid 12029: <td>BUILDLINK_PREFIX</td>
1.229 gutterid 12030: <td>BUILDLINK_RPATHDIRS</td>
1.156 leot 12031: </tr>
12032: <tr>
1.216 gutterid 12033: <td>BUILDLINK_TREE</td>
1.229 gutterid 12034: <td>BUILD_DEFS</td>
1.156 leot 12035: </tr>
12036: <tr>
1.216 gutterid 12037: <td>BUILD_DEFS_EFFECTS</td>
1.229 gutterid 12038: <td>BUILD_DEPENDS</td>
1.156 leot 12039: </tr>
12040: <tr>
1.216 gutterid 12041: <td>BUILD_DIRS</td>
1.229 gutterid 12042: <td>BUILD_ENV_SHELL</td>
1.156 leot 12043: </tr>
12044: <tr>
1.216 gutterid 12045: <td>BUILD_MAKE_CMD</td>
1.229 gutterid 12046: <td>BUILD_MAKE_FLAGS</td>
1.156 leot 12047: </tr>
12048: <tr>
1.216 gutterid 12049: <td>BUILD_TARGET</td>
1.229 gutterid 12050: <td>BUILTIN_FIND_FILES</td>
1.156 leot 12051: </tr>
12052: <tr>
1.216 gutterid 12053: <td>BUILTIN_FIND_FILES_VAR</td>
1.229 gutterid 12054: <td>BUILTIN_FIND_GREP</td>
1.156 leot 12055: </tr>
12056: <tr>
1.216 gutterid 12057: <td>BUILTIN_FIND_HEADERS</td>
1.229 gutterid 12058: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.156 leot 12059: </tr>
12060: <tr>
1.216 gutterid 12061: <td>BUILTIN_FIND_PKGCONFIG</td>
1.229 gutterid 12062: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.156 leot 12063: </tr>
12064: <tr>
1.216 gutterid 12065: <td>BUILTIN_PKG</td>
1.229 gutterid 12066: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.195 gutterid 12067: </tr>
12068: <tr>
1.216 gutterid 12069: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.229 gutterid 12070: <td>BUILTIN_VERSION_SCRIPT</td>
1.156 leot 12071: </tr>
12072: <tr>
1.216 gutterid 12073: <td>BUILTIN_X11_TYPE</td>
1.229 gutterid 12074: <td>BUILTIN_X11_VERSION</td>
1.156 leot 12075: </tr>
12076: <tr>
1.216 gutterid 12077: <td>CACTI_GROUP</td>
1.229 gutterid 12078: <td>CACTI_USER</td>
1.156 leot 12079: </tr>
12080: <tr>
1.216 gutterid 12081: <td>CANNA_GROUP</td>
1.229 gutterid 12082: <td>CANNA_USER</td>
1.156 leot 12083: </tr>
12084: <tr>
1.216 gutterid 12085: <td>CAT</td>
1.229 gutterid 12086: <td>CBLAS_LIBS</td>
1.156 leot 12087: </tr>
12088: <tr>
1.229 gutterid 12089: <td>CBLAS_PC</td>
1.216 gutterid 12090: <td>CCACHE_BASE</td>
1.156 leot 12091: </tr>
12092: <tr>
1.189 bacon 12093: <td>CCACHE_DIR</td>
1.216 gutterid 12094: <td>CCACHE_LOGFILE</td>
1.156 leot 12095: </tr>
12096: <tr>
1.189 bacon 12097: <td>CC_VERSION</td>
1.216 gutterid 12098: <td>CC_VERSION_STRING</td>
1.156 leot 12099: </tr>
12100: <tr>
1.189 bacon 12101: <td>CDRECORD_CONF</td>
1.216 gutterid 12102: <td>CDROM_PKG_URL_DIR</td>
1.156 leot 12103: </tr>
12104: <tr>
1.189 bacon 12105: <td>CDROM_PKG_URL_HOST</td>
1.226 gutterid 12106: <td>CHANGES</td>
1.223 nia 12107: </tr>
12108: <tr>
1.226 gutterid 12109: <td>CHECK_COMPILER</td>
1.239 dholland 12110: <td>CHECK_FAKEHOME</td>
1.238 wiz 12111: </tr>
12112: <tr>
12113: <td>CHECK_FILES</td>
1.239 dholland 12114: <td>CHECK_FILES_SKIP</td>
1.233 wiz 12115: </tr>
12116: <tr>
1.238 wiz 12117: <td>CHECK_FILES_STRICT</td>
1.239 dholland 12118: <td>CHECK_HEADERS</td>
1.227 wiz 12119: </tr>
12120: <tr>
1.238 wiz 12121: <td>CHECK_HEADERS_SKIP</td>
1.239 dholland 12122: <td>CHECK_INTERPRETER</td>
1.217 rillig 12123: </tr>
12124: <tr>
1.238 wiz 12125: <td>CHECK_INTERPRETER_SKIP</td>
1.239 dholland 12126: <td>CHECK_PERMS</td>
1.214 leot 12127: </tr>
12128: <tr>
1.238 wiz 12129: <td>CHECK_PERMS_AUTOFIX</td>
1.239 dholland 12130: <td>CHECK_PERMS_SKIP</td>
1.212 wiz 12131: </tr>
12132: <tr>
1.238 wiz 12133: <td>CHECK_PIE</td>
1.239 dholland 12134: <td>CHECK_PIE_SKIP</td>
1.205 wiz 12135: </tr>
12136: <tr>
1.238 wiz 12137: <td>CHECK_PIE_SUPPORTED</td>
1.239 dholland 12138: <td>CHECK_PORTABILITY</td>
1.197 leot 12139: </tr>
12140: <tr>
1.238 wiz 12141: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.239 dholland 12142: <td>CHECK_PORTABILITY_SKIP</td>
1.177 leot 12143: </tr>
12144: <tr>
1.238 wiz 12145: <td>CHECK_RELRO</td>
1.239 dholland 12146: <td>CHECK_RELRO_SKIP</td>
1.161 leot 12147: </tr>
12148: <tr>
1.238 wiz 12149: <td>CHECK_RELRO_SUPPORTED</td>
1.239 dholland 12150: <td>CHECK_SHLIBS</td>
1.216 gutterid 12151: </tr>
12152: <tr>
1.238 wiz 12153: <td>CHECK_SHLIBS_SKIP</td>
1.239 dholland 12154: <td>CHECK_SHLIBS_SUPPORTED</td>
1.159 rillig 12155: </tr>
12156: <tr>
1.238 wiz 12157: <td>CHECK_SHLIBS_TOXIC</td>
1.239 dholland 12158: <td>CHECK_SSP</td>
1.156 leot 12159: </tr>
12160: <tr>
1.238 wiz 12161: <td>CHECK_SSP_SKIP</td>
1.239 dholland 12162: <td>CHECK_SSP_SUPPORTED</td>
1.156 leot 12163: </tr>
12164: <tr>
1.238 wiz 12165: <td>CHECK_STRIPPED</td>
1.239 dholland 12166: <td>CHECK_STRIPPED_SKIP</td>
1.156 leot 12167: </tr>
12168: <tr>
1.238 wiz 12169: <td>CHECK_WRKREF</td>
1.239 dholland 12170: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.156 leot 12171: </tr>
12172: <tr>
1.238 wiz 12173: <td>CHECK_WRKREF_SKIP</td>
1.239 dholland 12174: <td>CLAMAV_DBDIR</td>
1.156 leot 12175: </tr>
12176: <tr>
1.238 wiz 12177: <td>CLAMAV_GROUP</td>
1.239 dholland 12178: <td>CLAMAV_USER</td>
1.156 leot 12179: </tr>
12180: <tr>
1.238 wiz 12181: <td>CLANGBASE</td>
1.239 dholland 12182: <td>CLEANDEPENDS</td>
1.156 leot 12183: </tr>
12184: <tr>
1.238 wiz 12185: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.239 dholland 12186: <td>CMAKE_INSTALL_NAME_DIR</td>
1.156 leot 12187: </tr>
12188: <tr>
1.238 wiz 12189: <td>CMAKE_INSTALL_PREFIX</td>
1.239 dholland 12190: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.156 leot 12191: </tr>
12192: <tr>
1.238 wiz 12193: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.239 dholland 12194: <td>CMAKE_PREFIX_PATH</td>
1.156 leot 12195: </tr>
12196: <tr>
1.238 wiz 12197: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.191 bacon 12198: <td>COMPILER_RPATH_FLAG</td>
1.156 leot 12199: </tr>
12200: <tr>
1.226 gutterid 12201: <td>COMPILER_USE_SYMLINKS</td>
1.191 bacon 12202: <td>CONFIGURE_ARGS</td>
1.156 leot 12203: </tr>
12204: <tr>
1.226 gutterid 12205: <td>CONFIGURE_DIRS</td>
1.191 bacon 12206: <td>CONFIGURE_ENV</td>
1.156 leot 12207: </tr>
12208: <tr>
1.226 gutterid 12209: <td>CONFIGURE_ENV_SHELL</td>
1.191 bacon 12210: <td>CONFIGURE_HAS_INFODIR</td>
1.156 leot 12211: </tr>
12212: <tr>
1.226 gutterid 12213: <td>CONFIGURE_HAS_MANDIR</td>
1.191 bacon 12214: <td>CONFIGURE_SCRIPT</td>
1.156 leot 12215: </tr>
12216: <tr>
1.226 gutterid 12217: <td>CONFIG_SHELL</td>
1.191 bacon 12218: <td>CONFIG_SHELL_FLAGS</td>
1.156 leot 12219: </tr>
12220: <tr>
1.226 gutterid 12221: <td>CONF_FILES</td>
1.191 bacon 12222: <td>CONF_FILES_MODE</td>
1.156 leot 12223: </tr>
12224: <tr>
1.226 gutterid 12225: <td>CONF_FILES_PERMS</td>
1.191 bacon 12226: <td>CONSERVER_DEFAULTHOST</td>
1.156 leot 12227: </tr>
12228: <tr>
1.226 gutterid 12229: <td>CONSERVER_DEFAULTPORT</td>
1.191 bacon 12230: <td>CP</td>
1.156 leot 12231: </tr>
12232: <tr>
1.232 gutterid 12233: <td>CPE</td>
12234: <td>CPE_EDITION</td>
12235: </tr>
12236: <tr>
12237: <td>CPE_LANG</td>
12238: <td>CPE_OTHER</td>
12239: </tr>
12240: <tr>
12241: <td>CPE_PART</td>
12242: <td>CPE_PRODUCT</td>
12243: </tr>
12244: <tr>
12245: <td>CPE_SW_EDITION</td>
12246: <td>CPE_TARGET_HW</td>
12247: </tr>
12248: <tr>
12249: <td>CPE_TARGET_SW</td>
12250: <td>CPE_UPDATE</td>
12251: </tr>
12252: <tr>
12253: <td>CPE_URI</td>
12254: <td>CPE_VENDOR</td>
12255: </tr>
12256: <tr>
12257: <td>CPE_VERSION</td>
1.226 gutterid 12258: <td>CPP</td>
1.156 leot 12259: </tr>
12260: <tr>
1.232 gutterid 12261: <td>CPP_PRECOMP_FLAGS</td>
1.226 gutterid 12262: <td>CREATE_WRKDIR_SYMLINK</td>
1.156 leot 12263: </tr>
12264: <tr>
1.232 gutterid 12265: <td>CROSSBASE</td>
1.226 gutterid 12266: <td>CTFCONVERT</td>
1.156 leot 12267: </tr>
12268: <tr>
1.232 gutterid 12269: <td>CTF_FILES_SKIP</td>
1.226 gutterid 12270: <td>CTF_SUPPORTED</td>
1.156 leot 12271: </tr>
12272: <tr>
1.232 gutterid 12273: <td>CTYPE</td>
1.226 gutterid 12274: <td>CUPS_GROUP</td>
1.156 leot 12275: </tr>
12276: <tr>
1.232 gutterid 12277: <td>CUPS_SYSTEM_GROUPS</td>
1.226 gutterid 12278: <td>CUPS_USER</td>
1.177 leot 12279: </tr>
12280: <tr>
1.232 gutterid 12281: <td>CURSES_DEFAULT</td>
1.226 gutterid 12282: <td>CURSES_TYPE</td>
1.227 wiz 12283: </tr>
12284: <tr>
1.232 gutterid 12285: <td>CXX</td>
1.239 dholland 12286: <td>CYRUS_GROUP</td>
1.238 wiz 12287: </tr>
12288: <tr>
12289: <td>CYRUS_IDLE</td>
1.239 dholland 12290: <td>CYRUS_USER</td>
1.233 wiz 12291: </tr>
12292: <tr>
1.238 wiz 12293: <td>DAEMONTOOLS_GROUP</td>
1.239 dholland 12294: <td>DAEMONTOOLS_LOG_USER</td>
1.217 rillig 12295: </tr>
12296: <tr>
1.238 wiz 12297: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.239 dholland 12298: <td>DARWIN_REQUIRES_FILTER</td>
1.214 leot 12299: </tr>
12300: <tr>
1.238 wiz 12301: <td>DBUS_GROUP</td>
1.239 dholland 12302: <td>DBUS_USER</td>
1.212 wiz 12303: </tr>
12304: <tr>
1.238 wiz 12305: <td>DEFANG_GROUP</td>
1.239 dholland 12306: <td>DEFANG_USER</td>
1.205 wiz 12307: </tr>
12308: <tr>
1.238 wiz 12309: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.239 dholland 12310: <td>DEFAULT_DISTFILES</td>
1.197 leot 12311: </tr>
12312: <tr>
1.238 wiz 12313: <td>DEFAULT_IRC_SERVER</td>
1.239 dholland 12314: <td>DEFAULT_SERIAL_DEVICE</td>
1.159 rillig 12315: </tr>
12316: <tr>
1.238 wiz 12317: <td>DEF_UMASK</td>
1.239 dholland 12318: <td>DEINSTALLDEPENDS</td>
1.156 leot 12319: </tr>
12320: <tr>
1.238 wiz 12321: <td>DEINSTALL_SRC</td>
1.239 dholland 12322: <td>DEINSTALL_TEMPLATES</td>
1.156 leot 12323: </tr>
12324: <tr>
1.238 wiz 12325: <td>DELAYED_ERROR_MSG</td>
1.239 dholland 12326: <td>DELAYED_WARNING_MSG</td>
1.195 gutterid 12327: </tr>
12328: <tr>
1.238 wiz 12329: <td>DEPENDS</td>
1.239 dholland 12330: <td>DEPENDS_TARGET</td>
1.156 leot 12331: </tr>
12332: <tr>
1.238 wiz 12333: <td>DEPENDS_TYPE</td>
1.239 dholland 12334: <td>DESTDIR</td>
1.156 leot 12335: </tr>
12336: <tr>
1.238 wiz 12337: <td>DESTDIR_VARNAME</td>
1.239 dholland 12338: <td>DIALER_GROUP</td>
1.156 leot 12339: </tr>
12340: <tr>
1.238 wiz 12341: <td>DIGEST_REQD</td>
1.239 dholland 12342: <td>DISTDIR</td>
1.156 leot 12343: </tr>
12344: <tr>
1.238 wiz 12345: <td>DISTFILES</td>
1.239 dholland 12346: <td>DISTINFO_FILE</td>
1.156 leot 12347: </tr>
12348: <tr>
1.238 wiz 12349: <td>DISTNAME</td>
1.239 dholland 12350: <td>DIST_PATH</td>
1.156 leot 12351: </tr>
12352: <tr>
1.238 wiz 12353: <td>DIST_SUBDIR</td>
1.239 dholland 12354: <td>DJBDNS_AXFR_USER</td>
1.156 leot 12355: </tr>
12356: <tr>
1.238 wiz 12357: <td>DJBDNS_CACHE_USER</td>
1.239 dholland 12358: <td>DJBDNS_DJBDNS_GROUP</td>
1.156 leot 12359: </tr>
12360: <tr>
1.238 wiz 12361: <td>DJBDNS_LOG_USER</td>
1.239 dholland 12362: <td>DJBDNS_RBL_USER</td>
1.156 leot 12363: </tr>
12364: <tr>
1.238 wiz 12365: <td>DJBDNS_TINY_USER</td>
1.239 dholland 12366: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.156 leot 12367: </tr>
12368: <tr>
1.238 wiz 12369: <td>DL_AUTO_VARS</td>
1.239 dholland 12370: <td>DL_CFLAGS</td>
1.156 leot 12371: </tr>
12372: <tr>
1.238 wiz 12373: <td>DL_LDFLAGS</td>
1.239 dholland 12374: <td>DL_LIBS</td>
1.156 leot 12375: </tr>
12376: <tr>
1.238 wiz 12377: <td>DNS</td>
1.239 dholland 12378: <td>DOCOWN</td>
1.156 leot 12379: </tr>
12380: <tr>
1.238 wiz 12381: <td>DOWNLOADED_DISTFILE</td>
1.239 dholland 12382: <td>DQCACHE_GROUP</td>
1.156 leot 12383: </tr>
12384: <tr>
1.238 wiz 12385: <td>DQCACHE_USER</td>
1.239 dholland 12386: <td>DT_LAYOUT</td>
1.156 leot 12387: </tr>
12388: <tr>
1.238 wiz 12389: <td>DYNAMIC_SITES_CMD</td>
1.239 dholland 12390: <td>DYNAMIC_SITES_SCRIPT</td>
1.156 leot 12391: </tr>
12392: <tr>
1.238 wiz 12393: <td>ECHO</td>
1.239 dholland 12394: <td>ECHO_N</td>
1.218 nia 12395: </tr>
12396: <tr>
1.238 wiz 12397: <td>ELK_GUI</td>
1.239 dholland 12398: <td>EMACS_TYPE</td>
1.156 leot 12399: </tr>
12400: <tr>
1.238 wiz 12401: <td>EMULDIR</td>
1.239 dholland 12402: <td>EMULSUBDIR</td>
1.156 leot 12403: </tr>
12404: <tr>
1.238 wiz 12405: <td>EMULSUBDIRSLASH</td>
1.239 dholland 12406: <td>EMUL_ARCH</td>
1.156 leot 12407: </tr>
12408: <tr>
1.238 wiz 12409: <td>EMUL_DISTRO</td>
1.239 dholland 12410: <td>EMUL_EXEC_FMT</td>
1.156 leot 12411: </tr>
12412: <tr>
1.238 wiz 12413: <td>EMUL_IS_NATIVE</td>
1.239 dholland 12414: <td>EMUL_MODULES</td>
1.156 leot 12415: </tr>
12416: <tr>
1.238 wiz 12417: <td>EMUL_OPSYS</td>
1.239 dholland 12418: <td>EMUL_PKG_FMT</td>
1.156 leot 12419: </tr>
12420: <tr>
1.238 wiz 12421: <td>EMUL_PLATFORM</td>
1.239 dholland 12422: <td>EMUL_PLATFORMS</td>
1.156 leot 12423: </tr>
12424: <tr>
1.238 wiz 12425: <td>EMUL_PREFER</td>
1.239 dholland 12426: <td>EMUL_REQD</td>
1.156 leot 12427: </tr>
12428: <tr>
1.238 wiz 12429: <td>EMUL_TYPE</td>
1.239 dholland 12430: <td>ERROR_MSG</td>
1.156 leot 12431: </tr>
12432: <tr>
1.238 wiz 12433: <td>EXIM_GROUP</td>
1.239 dholland 12434: <td>EXIM_USER</td>
1.156 leot 12435: </tr>
12436: <tr>
1.238 wiz 12437: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.239 dholland 12438: <td>EXTRACTOR</td>
1.156 leot 12439: </tr>
12440: <tr>
1.238 wiz 12441: <td>EXTRACT_CMD</td>
1.239 dholland 12442: <td>EXTRACT_CMD_DEFAULT</td>
1.156 leot 12443: </tr>
12444: <tr>
1.238 wiz 12445: <td>EXTRACT_DIR</td>
1.239 dholland 12446: <td>EXTRACT_ELEMENTS</td>
1.156 leot 12447: </tr>
12448: <tr>
1.238 wiz 12449: <td>EXTRACT_ENV</td>
1.239 dholland 12450: <td>EXTRACT_ONLY</td>
1.223 nia 12451: </tr>
12452: <tr>
1.238 wiz 12453: <td>EXTRACT_OPTS</td>
1.239 dholland 12454: <td>EXTRACT_SUFX</td>
1.156 leot 12455: </tr>
12456: <tr>
1.238 wiz 12457: <td>EXTRACT_USING</td>
1.239 dholland 12458: <td>FAIL</td>
1.156 leot 12459: </tr>
12460: <tr>
1.238 wiz 12461: <td>FAILOVER_FETCH</td>
1.239 dholland 12462: <td>FAIL_MSG</td>
1.156 leot 12463: </tr>
12464: <tr>
1.238 wiz 12465: <td>FAKE_NCURSES</td>
1.239 dholland 12466: <td>FAM</td>
1.156 leot 12467: </tr>
12468: <tr>
1.238 wiz 12469: <td>FAM_ACCEPTED</td>
1.239 dholland 12470: <td>FAM_DEFAULT</td>
1.156 leot 12471: </tr>
12472: <tr>
1.238 wiz 12473: <td>FAM_SERVER</td>
1.239 dholland 12474: <td>FCPATH</td>
1.156 leot 12475: </tr>
12476: <tr>
1.238 wiz 12477: <td>FEATURE_CPPFLAGS</td>
1.239 dholland 12478: <td>FEATURE_LDFLAGS</td>
1.156 leot 12479: </tr>
12480: <tr>
1.238 wiz 12481: <td>FEATURE_LIBS</td>
1.239 dholland 12482: <td>FETCH_AFTER_ARGS</td>
1.156 leot 12483: </tr>
12484: <tr>
1.238 wiz 12485: <td>FETCH_BEFORE_ARGS</td>
1.239 dholland 12486: <td>FETCH_CMD</td>
1.156 leot 12487: </tr>
12488: <tr>
1.238 wiz 12489: <td>FETCH_OUTPUT_ARGS</td>
1.239 dholland 12490: <td>FETCH_PROXY</td>
1.177 leot 12491: </tr>
12492: <tr>
1.238 wiz 12493: <td>FETCH_RESUME_ARGS</td>
1.239 dholland 12494: <td>FETCH_TIMEOUT</td>
1.156 leot 12495: </tr>
12496: <tr>
1.238 wiz 12497: <td>FETCH_USE_IPV4_ONLY</td>
1.239 dholland 12498: <td>FETCH_USING</td>
1.156 leot 12499: </tr>
12500: <tr>
1.238 wiz 12501: <td>FILES_SUBST</td>
1.239 dholland 12502: <td>FILES_SUBST_SED</td>
1.156 leot 12503: </tr>
12504: <tr>
1.238 wiz 12505: <td>FIX_SYSTEM_HEADERS</td>
1.226 gutterid 12506: <td>FONTS_DIRS</td>
1.177 leot 12507: </tr>
12508: <tr>
1.232 gutterid 12509: <td>FONTS_VERBOSE</td>
1.226 gutterid 12510: <td>FOO_HACKS_MK</td>
1.156 leot 12511: </tr>
12512: <tr>
1.232 gutterid 12513: <td>FOX_USE_XUNICODE</td>
1.226 gutterid 12514: <td>FREEWNN_GROUP</td>
1.156 leot 12515: </tr>
12516: <tr>
1.232 gutterid 12517: <td>FREEWNN_USER</td>
1.226 gutterid 12518: <td>FTP_PKG_URL_DIR</td>
1.156 leot 12519: </tr>
12520: <tr>
1.232 gutterid 12521: <td>FTP_PKG_URL_HOST</td>
1.226 gutterid 12522: <td>GAMEDATAMODE</td>
1.156 leot 12523: </tr>
12524: <tr>
1.232 gutterid 12525: <td>GAMEDATA_PERMS</td>
1.226 gutterid 12526: <td>GAMEDIRMODE</td>
1.156 leot 12527: </tr>
12528: <tr>
1.232 gutterid 12529: <td>GAMEDIR_PERMS</td>
1.226 gutterid 12530: <td>GAMEGRP</td>
1.156 leot 12531: </tr>
12532: <tr>
1.232 gutterid 12533: <td>GAMEMODE</td>
1.226 gutterid 12534: <td>GAMEOWN</td>
1.156 leot 12535: </tr>
12536: <tr>
1.232 gutterid 12537: <td>GAMES_GROUP</td>
1.226 gutterid 12538: <td>GAMES_USER</td>
1.156 leot 12539: </tr>
12540: <tr>
1.232 gutterid 12541: <td>GCC</td>
1.226 gutterid 12542: <td>GCCBASE</td>
1.156 leot 12543: </tr>
12544: <tr>
1.232 gutterid 12545: <td>GCC_REQD</td>
1.226 gutterid 12546: <td>GCC_VERSION_SUFFIX</td>
1.156 leot 12547: </tr>
12548: <tr>
1.232 gutterid 12549: <td>GEM_BUILD</td>
1.226 gutterid 12550: <td>GEM_CLEANBUILD</td>
1.156 leot 12551: </tr>
12552: <tr>
1.232 gutterid 12553: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.226 gutterid 12554: <td>GEM_DOCDIR</td>
1.177 leot 12555: </tr>
12556: <tr>
1.232 gutterid 12557: <td>GEM_EXTSDIR</td>
1.226 gutterid 12558: <td>GEM_HOME</td>
1.156 leot 12559: </tr>
12560: <tr>
1.232 gutterid 12561: <td>GEM_KEEPBUILD</td>
1.226 gutterid 12562: <td>GEM_LIBDIR</td>
1.156 leot 12563: </tr>
12564: <tr>
1.232 gutterid 12565: <td>GEM_NAME</td>
1.226 gutterid 12566: <td>GEM_PATH</td>
1.198 leot 12567: </tr>
12568: <tr>
1.232 gutterid 12569: <td>GEM_PLUGINSDIR</td>
1.226 gutterid 12570: <td>GEM_SPECFILE</td>
1.156 leot 12571: </tr>
12572: <tr>
1.232 gutterid 12573: <td>GENERATE_PLIST</td>
1.226 gutterid 12574: <td>GHC</td>
1.156 leot 12575: </tr>
12576: <tr>
1.232 gutterid 12577: <td>GHOSTSCRIPT_REQD</td>
1.226 gutterid 12578: <td>GITHUB_PROJECT</td>
1.177 leot 12579: </tr>
12580: <tr>
1.232 gutterid 12581: <td>GITHUB_RELEASE</td>
1.226 gutterid 12582: <td>GITHUB_SUBMODULES</td>
1.159 rillig 12583: </tr>
12584: <tr>
1.232 gutterid 12585: <td>GITHUB_TAG</td>
1.226 gutterid 12586: <td>GITHUB_TYPE</td>
1.223 nia 12587: </tr>
12588: <tr>
1.232 gutterid 12589: <td>GITLAB_PROJECT</td>
1.226 gutterid 12590: <td>GITLAB_RELEASE</td>
1.223 nia 12591: </tr>
12592: <tr>
1.232 gutterid 12593: <td>GITLAB_SUBMODULES</td>
1.226 gutterid 12594: <td>GITLAB_TAG</td>
1.223 nia 12595: </tr>
12596: <tr>
1.232 gutterid 12597: <td>GITLAB_TYPE</td>
1.239 dholland 12598: <td>GNU</td>
1.233 wiz 12599: </tr>
12600: <tr>
1.232 gutterid 12601: <td>GNU_CONFIGURE</td>
1.239 dholland 12602: <td>GNU_CONFIGURE_INFODIR</td>
1.156 leot 12603: </tr>
12604: <tr>
1.232 gutterid 12605: <td>GNU_CONFIGURE_MANDIR</td>
1.239 dholland 12606: <td>GNU_CONFIGURE_QUIET</td>
1.156 leot 12607: </tr>
12608: <tr>
1.232 gutterid 12609: <td>GNU_CONFIGURE_STRICT</td>
1.239 dholland 12610: <td>GODEP_REDIRECTS</td>
1.156 leot 12611: </tr>
12612: <tr>
1.232 gutterid 12613: <td>GO_BUILD_PATTERN</td>
1.239 dholland 12614: <td>GO_DEPS</td>
1.238 wiz 12615: </tr>
12616: <tr>
12617: <td>GO_DIST_BASE</td>
1.239 dholland 12618: <td>GO_EXTRA_MOD_DIRS</td>
1.156 leot 12619: </tr>
12620: <tr>
1.238 wiz 12621: <td>GO_MODULE_FILES</td>
1.239 dholland 12622: <td>GO_SRCPATH</td>
1.156 leot 12623: </tr>
12624: <tr>
1.238 wiz 12625: <td>GROUP_SPECIFIC_PKGS</td>
1.239 dholland 12626: <td>GRUB_NETWORK_CARDS</td>
1.156 leot 12627: </tr>
12628: <tr>
1.238 wiz 12629: <td>GRUB_PRESET_COMMAND</td>
1.239 dholland 12630: <td>GRUB_SCAN_ARGS</td>
1.156 leot 12631: </tr>
12632: <tr>
1.238 wiz 12633: <td>GZIP</td>
1.233 wiz 12634: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.217 rillig 12635: </tr>
12636: <tr>
1.232 gutterid 12637: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.222 gutterid 12638: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.226 gutterid 12639: </tr>
12640: <tr>
1.232 gutterid 12641: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.236 gutterid 12642: <td>HASKELL_ENABLE_TESTS</td>
1.220 nia 12643: </tr>
12644: <tr>
1.236 gutterid 12645: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.232 gutterid 12646: <td>HASKELL_PKG_NAME</td>
1.229 gutterid 12647: </tr>
12648: <tr>
1.236 gutterid 12649: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
1.226 gutterid 12650: <td>HEADER_TEMPLATES</td>
1.214 leot 12651: </tr>
12652: <tr>
1.232 gutterid 12653: <td>HOMEPAGE</td>
1.239 dholland 12654: <td>HOST_PKGTOOLS_ARGS</td>
1.233 wiz 12655: </tr>
12656: <tr>
12657: <td>HOST_SPECIFIC_PKGS</td>
1.239 dholland 12658: <td>HOWL_GROUP</td>
1.227 wiz 12659: </tr>
12660: <tr>
1.233 wiz 12661: <td>HOWL_USER</td>
1.239 dholland 12662: <td>ICCBASE</td>
1.223 nia 12663: </tr>
12664: <tr>
1.233 wiz 12665: <td>ICECAST_CHROOTDIR</td>
1.239 dholland 12666: <td>ICON_THEMES</td>
1.156 leot 12667: </tr>
12668: <tr>
1.233 wiz 12669: <td>IDOBASE</td>
1.239 dholland 12670: <td>IGNORE_CCACHE</td>
1.156 leot 12671: </tr>
12672: <tr>
1.233 wiz 12673: <td>IGNORE_INFO_DIRS</td>
1.239 dholland 12674: <td>IGNORE_INTERACTIVE_FETCH</td>
1.191 bacon 12675: </tr>
12676: <tr>
1.233 wiz 12677: <td>IMAKE</td>
1.239 dholland 12678: <td>IMAKEOPTS</td>
1.156 leot 12679: </tr>
12680: <tr>
1.233 wiz 12681: <td>IMAKE_MAKE</td>
1.239 dholland 12682: <td>IMAKE_MANINSTALL</td>
1.156 leot 12683: </tr>
12684: <tr>
1.233 wiz 12685: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.239 dholland 12686: <td>IMDICTDIR</td>
1.156 leot 12687: </tr>
12688: <tr>
1.233 wiz 12689: <td>INCOMPAT_CURSES</td>
1.239 dholland 12690: <td>INFO_DIR</td>
1.156 leot 12691: </tr>
12692: <tr>
1.233 wiz 12693: <td>INFO_FILES</td>
1.240 ! gutterid 12694: <td>INFO_MSG</td>
1.156 leot 12695: </tr>
12696: <tr>
1.236 gutterid 12697: <td>INIT_SYSTEM</td>
1.240 ! gutterid 12698: <td>INN_DATA_DIR</td>
1.156 leot 12699: </tr>
12700: <tr>
1.236 gutterid 12701: <td>INN_GROUP</td>
1.240 ! gutterid 12702: <td>INN_USER</td>
1.156 leot 12703: </tr>
12704: <tr>
1.236 gutterid 12705: <td>INSTALLATION_DIRS</td>
1.240 ! gutterid 12706: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.156 leot 12707: </tr>
12708: <tr>
1.236 gutterid 12709: <td>INSTALL_ENV</td>
1.240 ! gutterid 12710: <td>INSTALL_SH_OVERRIDE</td>
1.156 leot 12711: </tr>
12712: <tr>
1.236 gutterid 12713: <td>INSTALL_SRC</td>
1.240 ! gutterid 12714: <td>INSTALL_TEMPLATES</td>
1.172 rillig 12715: </tr>
12716: <tr>
1.236 gutterid 12717: <td>INSTALL_UNSTRIPPED</td>
1.240 ! gutterid 12718: <td>IRCD_HYBRID_IRC_GROUP</td>
1.156 leot 12719: </tr>
12720: <tr>
1.236 gutterid 12721: <td>IRCD_HYBRID_IRC_USER</td>
1.240 ! gutterid 12722: <td>IRCD_HYBRID_MAXCONN</td>
1.156 leot 12723: </tr>
12724: <tr>
1.236 gutterid 12725: <td>IRCD_HYBRID_NICLEN</td>
1.240 ! gutterid 12726: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.156 leot 12727: </tr>
12728: <tr>
1.236 gutterid 12729: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.240 ! gutterid 12730: <td>IRCD_HYBRID_TOPICLEN</td>
1.156 leot 12731: </tr>
12732: <tr>
1.236 gutterid 12733: <td>IRIX</td>
1.240 ! gutterid 12734: <td>IRRD_USE_PGP</td>
1.156 leot 12735: </tr>
12736: <tr>
1.236 gutterid 12737: <td>JABBERD_GROUP</td>
1.240 ! gutterid 12738: <td>JABBERD_LOGDIR</td>
1.156 leot 12739: </tr>
12740: <tr>
1.236 gutterid 12741: <td>JABBERD_PIDDIR</td>
1.240 ! gutterid 12742: <td>JABBERD_SPOOLDIR</td>
1.156 leot 12743: </tr>
12744: <tr>
1.232 gutterid 12745: <td>JABBERD_USER</td>
1.240 ! gutterid 12746: <td>JAVA_BINPREFIX</td>
1.156 leot 12747: </tr>
12748: <tr>
1.236 gutterid 12749: <td>JAVA_CLASSPATH</td>
1.240 ! gutterid 12750: <td>JAVA_HOME</td>
1.233 wiz 12751: </tr>
12752: <tr>
1.236 gutterid 12753: <td>JAVA_LD_LIBRARY_PATH</td>
1.240 ! gutterid 12754: <td>JAVA_NAME</td>
1.156 leot 12755: </tr>
12756: <tr>
1.236 gutterid 12757: <td>JAVA_UNLIMIT</td>
1.240 ! gutterid 12758: <td>JAVA_WRAPPERS</td>
1.227 wiz 12759: </tr>
12760: <tr>
1.236 gutterid 12761: <td>JPEG_ACCEPTED</td>
1.240 ! gutterid 12762: <td>JPEG_DEFAULT</td>
1.177 leot 12763: </tr>
12764: <tr>
1.236 gutterid 12765: <td>KERBEROS</td>
1.240 ! gutterid 12766: <td>KERMIT_SUID_UUCP</td>
1.156 leot 12767: </tr>
12768: <tr>
1.236 gutterid 12769: <td>KJS_USE_PCRE</td>
1.240 ! gutterid 12770: <td>KNEWS_DOMAIN_FILE</td>
1.217 rillig 12771: </tr>
12772: <tr>
1.232 gutterid 12773: <td>KNEWS_DOMAIN_NAME</td>
1.240 ! gutterid 12774: <td>KRB5_ACCEPTED</td>
1.156 leot 12775: </tr>
12776: <tr>
1.232 gutterid 12777: <td>KRB5_DEFAULT</td>
1.240 ! gutterid 12778: <td>LANGUAGES</td>
1.156 leot 12779: </tr>
12780: <tr>
1.232 gutterid 12781: <td>LAPACKE_LIBS</td>
1.240 ! gutterid 12782: <td>LAPACKE_PC</td>
1.156 leot 12783: </tr>
12784: <tr>
1.232 gutterid 12785: <td>LAPACK_LIBS</td>
1.240 ! gutterid 12786: <td>LAPACK_PC</td>
1.156 leot 12787: </tr>
12788: <tr>
1.232 gutterid 12789: <td>LATEX2HTML_ICONPATH</td>
1.240 ! gutterid 12790: <td>LDCONFIG_ADD_CMD</td>
1.156 leot 12791: </tr>
12792: <tr>
1.232 gutterid 12793: <td>LDCONFIG_REMOVE_CMD</td>
1.240 ! gutterid 12794: <td>LDD</td>
1.177 leot 12795: </tr>
12796: <tr>
1.232 gutterid 12797: <td>LEAFNODE_DATA_DIR</td>
1.240 ! gutterid 12798: <td>LEAFNODE_GROUP</td>
1.156 leot 12799: </tr>
12800: <tr>
1.232 gutterid 12801: <td>LEAFNODE_USER</td>
1.240 ! gutterid 12802: <td>LIBDVDCSS_HOMEPAGE</td>
1.156 leot 12803: </tr>
12804: <tr>
1.232 gutterid 12805: <td>LIBDVDCSS_MASTER_SITES</td>
1.240 ! gutterid 12806: <td>LIBRSVG_TYPE</td>
1.156 leot 12807: </tr>
12808: <tr>
1.232 gutterid 12809: <td>LIBTOOL</td>
1.240 ! gutterid 12810: <td>LIBTOOLIZE_PLIST</td>
1.156 leot 12811: </tr>
12812: <tr>
1.232 gutterid 12813: <td>LIBTOOL_M4_OVERRIDE</td>
1.240 ! gutterid 12814: <td>LIBUSB_TYPE</td>
1.205 wiz 12815: </tr>
12816: <tr>
1.232 gutterid 12817: <td>LICENSE</td>
1.240 ! gutterid 12818: <td>LINKER_RPATH_FLAG</td>
1.157 leot 12819: </tr>
12820: <tr>
1.232 gutterid 12821: <td>LINK_RPATH_FLAG</td>
1.240 ! gutterid 12822: <td>LINUX_LOCALES</td>
1.156 leot 12823: </tr>
12824: <tr>
1.239 dholland 12825: <td>LOCALBASE</td>
1.240 ! gutterid 12826: <td>LOCALBASE_LOCKTYPE</td>
1.238 wiz 12827: </tr>
12828: <tr>
1.239 dholland 12829: <td>LOCALPATCHES</td>
1.240 ! gutterid 12830: <td>LOVE_DATA</td>
1.223 nia 12831: </tr>
12832: <tr>
1.239 dholland 12833: <td>LOVE_GAME</td>
1.240 ! gutterid 12834: <td>LOVE_VERSION</td>
1.177 leot 12835: </tr>
12836: <tr>
1.239 dholland 12837: <td>LP32PLATFORMS</td>
1.240 ! gutterid 12838: <td>LP64PLATFORMS</td>
1.214 leot 12839: </tr>
12840: <tr>
1.239 dholland 12841: <td>LUA_BUSTED_ARGS</td>
1.240 ! gutterid 12842: <td>LUA_CDIR</td>
1.197 leot 12843: </tr>
12844: <tr>
1.239 dholland 12845: <td>LUA_COMPILER</td>
1.240 ! gutterid 12846: <td>LUA_DOCDIR</td>
1.156 leot 12847: </tr>
12848: <tr>
1.239 dholland 12849: <td>LUA_EXAMPLESDIR</td>
1.240 ! gutterid 12850: <td>LUA_INCDIR</td>
1.156 leot 12851: </tr>
12852: <tr>
1.239 dholland 12853: <td>LUA_INTERPRETER</td>
1.240 ! gutterid 12854: <td>LUA_LDIR</td>
1.221 nia 12855: </tr>
12856: <tr>
1.239 dholland 12857: <td>LUA_LINKER_MAGIC</td>
1.240 ! gutterid 12858: <td>LUA_PKGPREFIX</td>
1.218 nia 12859: </tr>
12860: <tr>
1.239 dholland 12861: <td>LUA_SELF_CONFLICT</td>
1.240 ! gutterid 12862: <td>LUA_USE_BUSTED</td>
1.218 nia 12863: </tr>
12864: <tr>
1.239 dholland 12865: <td>LUA_VERSIONS_ACCEPTED</td>
1.240 ! gutterid 12866: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.218 nia 12867: </tr>
12868: <tr>
1.239 dholland 12869: <td>LUA_VERSION_DEFAULT</td>
1.240 ! gutterid 12870: <td>LUA_VERSION_REQD</td>
1.218 nia 12871: </tr>
12872: <tr>
1.239 dholland 12873: <td>Lua</td>
1.240 ! gutterid 12874: <td>MACHINE_PLATFORM</td>
1.218 nia 12875: </tr>
12876: <tr>
1.239 dholland 12877: <td>MAILAGENT_DOMAIN</td>
1.240 ! gutterid 12878: <td>MAILAGENT_EMAIL</td>
1.218 nia 12879: </tr>
12880: <tr>
1.239 dholland 12881: <td>MAILAGENT_FQDN</td>
1.240 ! gutterid 12882: <td>MAILAGENT_ORGANIZATION</td>
1.218 nia 12883: </tr>
12884: <tr>
1.232 gutterid 12885: <td>MAJORDOMO_HOMEDIR</td>
1.240 ! gutterid 12886: <td>MAKEINFO_ARGS</td>
1.205 wiz 12887: </tr>
12888: <tr>
1.236 gutterid 12889: <td>MAKE_DIRS</td>
1.240 ! gutterid 12890: <td>MAKE_DIRS_PERMS</td>
1.233 wiz 12891: </tr>
12892: <tr>
1.236 gutterid 12893: <td>MAKE_ENV</td>
1.240 ! gutterid 12894: <td>MAKE_FILE</td>
1.227 wiz 12895: </tr>
12896: <tr>
1.236 gutterid 12897: <td>MAKE_FLAGS</td>
1.240 ! gutterid 12898: <td>MAKE_JOBS</td>
1.156 leot 12899: </tr>
12900: <tr>
1.236 gutterid 12901: <td>MAKE_JOBS_SAFE</td>
1.240 ! gutterid 12902: <td>MAKE_PROGRAM</td>
1.212 wiz 12903: </tr>
12904: <tr>
1.236 gutterid 12905: <td>MANCOMPRESSED_IF_MANZ</td>
1.240 ! gutterid 12906: <td>MANINSTALL</td>
1.156 leot 12907: </tr>
12908: <tr>
1.236 gutterid 12909: <td>MANZ</td>
1.240 ! gutterid 12910: <td>MASTER_SITES</td>
1.156 leot 12911: </tr>
12912: <tr>
1.236 gutterid 12913: <td>MASTER_SITE_BACKUP</td>
1.240 ! gutterid 12914: <td>MASTER_SITE_LOCAL</td>
1.156 leot 12915: </tr>
12916: <tr>
1.236 gutterid 12917: <td>MASTER_SITE_MOZILLA</td>
1.240 ! gutterid 12918: <td>MASTER_SITE_OVERRIDE</td>
1.156 leot 12919: </tr>
12920: <tr>
1.236 gutterid 12921: <td>MASTER_SITE_PERL_CPAN</td>
1.240 ! gutterid 12922: <td>MASTER_SORT</td>
1.189 bacon 12923: </tr>
12924: <tr>
1.236 gutterid 12925: <td>MASTER_SORT_RANDOM</td>
1.240 ! gutterid 12926: <td>MASTER_SORT_REGEX</td>
1.156 leot 12927: </tr>
12928: <tr>
1.236 gutterid 12929: <td>MECAB_CHARSET</td>
1.240 ! gutterid 12930: <td>MEDIATOMB_GROUP</td>
1.156 leot 12931: </tr>
12932: <tr>
1.236 gutterid 12933: <td>MEDIATOMB_USER</td>
1.240 ! gutterid 12934: <td>MIPSPROBASE</td>
1.156 leot 12935: </tr>
12936: <tr>
1.236 gutterid 12937: <td>MIREDO_GROUP</td>
1.240 ! gutterid 12938: <td>MIREDO_USER</td>
1.156 leot 12939: </tr>
12940: <tr>
1.236 gutterid 12941: <td>MISSING_FEATURES</td>
1.240 ! gutterid 12942: <td>MKDIR</td>
1.156 leot 12943: </tr>
12944: <tr>
1.236 gutterid 12945: <td>MKPIE_SUPPORTED</td>
1.240 ! gutterid 12946: <td>MLDONKEY_GROUP</td>
1.156 leot 12947: </tr>
12948: <tr>
1.236 gutterid 12949: <td>MLDONKEY_HOME</td>
1.240 ! gutterid 12950: <td>MLDONKEY_USER</td>
1.156 leot 12951: </tr>
12952: <tr>
1.236 gutterid 12953: <td>MONOTONE_GROUP</td>
1.240 ! gutterid 12954: <td>MONOTONE_USER</td>
1.156 leot 12955: </tr>
12956: <tr>
1.236 gutterid 12957: <td>MOTIFBASE</td>
1.240 ! gutterid 12958: <td>MOTIF_TYPE</td>
1.156 leot 12959: </tr>
12960: <tr>
1.236 gutterid 12961: <td>MOTIF_TYPE_DEFAULT</td>
1.240 ! gutterid 12962: <td>MPI_TYPE</td>
1.207 leot 12963: </tr>
12964: <tr>
1.236 gutterid 12965: <td>MSGFMT_STRIP_MSGCTXT</td>
1.240 ! gutterid 12966: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.156 leot 12967: </tr>
12968: <tr>
1.232 gutterid 12969: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.240 ! gutterid 12970: <td>MV</td>
1.156 leot 12971: </tr>
12972: <tr>
1.239 dholland 12973: <td>MYSQL_CHARSET</td>
1.240 ! gutterid 12974: <td>MYSQL_DATADIR</td>
1.238 wiz 12975: </tr>
12976: <tr>
1.239 dholland 12977: <td>MYSQL_EXTRA_CHARSET</td>
1.240 ! gutterid 12978: <td>MYSQL_GROUP</td>
1.223 nia 12979: </tr>
12980: <tr>
1.239 dholland 12981: <td>MYSQL_USER</td>
1.240 ! gutterid 12982: <td>MYSQL_VERSION</td>
1.214 leot 12983: </tr>
12984: <tr>
1.239 dholland 12985: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.240 ! gutterid 12986: <td>MYSQL_VERSIONS_ALL</td>
1.197 leot 12987: </tr>
12988: <tr>
1.239 dholland 12989: <td>MYSQL_VERSION_DEFAULT</td>
1.240 ! gutterid 12990: <td>NAGIOSCMD_GROUP</td>
1.205 wiz 12991: </tr>
12992: <tr>
1.239 dholland 12993: <td>NAGIOSDIR</td>
1.240 ! gutterid 12994: <td>NAGIOS_GROUP</td>
1.156 leot 12995: </tr>
12996: <tr>
1.239 dholland 12997: <td>NAGIOS_USER</td>
1.240 ! gutterid 12998: <td>NATIVE_APPEND_ABI</td>
1.156 leot 12999: </tr>
13000: <tr>
1.239 dholland 13001: <td>NATIVE_APPEND_ELF</td>
1.240 ! gutterid 13002: <td>NATIVE_EXEC_FMT</td>
1.156 leot 13003: </tr>
13004: <tr>
1.239 dholland 13005: <td>NATIVE_MACHINE_PLATFORM</td>
1.240 ! gutterid 13006: <td>NATIVE_OBJECT_FMT</td>
1.156 leot 13007: </tr>
13008: <tr>
1.239 dholland 13009: <td>NBPAX_PROGRAM_PREFIX</td>
1.240 ! gutterid 13010: <td>NETBSD_LOGIN_NAME</td>
1.195 gutterid 13011: </tr>
13012: <tr>
1.239 dholland 13013: <td>NMH_EDITOR</td>
1.240 ! gutterid 13014: <td>NMH_MTA</td>
1.156 leot 13015: </tr>
13016: <tr>
1.239 dholland 13017: <td>NMH_PAGER</td>
1.240 ! gutterid 13018: <td>NODE_VERSIONS_ACCEPTED</td>
1.156 leot 13019: </tr>
13020: <tr>
1.239 dholland 13021: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.240 ! gutterid 13022: <td>NODE_VERSION_DEFAULT</td>
1.156 leot 13023: </tr>
13024: <tr>
1.239 dholland 13025: <td>NODE_VERSION_REQD</td>
1.240 ! gutterid 13026: <td>NOLOGIN</td>
1.156 leot 13027: </tr>
13028: <tr>
1.239 dholland 13029: <td>NOTE</td>
1.240 ! gutterid 13030: <td>NOT_FOR_PLATFORM</td>
1.156 leot 13031: </tr>
13032: <tr>
1.239 dholland 13033: <td>NOT_PAX_ASLR_SAFE</td>
1.240 ! gutterid 13034: <td>NOT_PAX_MPROTECT_SAFE</td>
1.229 gutterid 13035: </tr>
13036: <tr>
1.239 dholland 13037: <td>NO_BUILD</td>
1.240 ! gutterid 13038: <td>NO_CHECKSUM</td>
1.218 nia 13039: </tr>
13040: <tr>
1.239 dholland 13041: <td>NO_CONFIGURE</td>
1.240 ! gutterid 13042: <td>NO_SKIP</td>
1.218 nia 13043: </tr>
13044: <tr>
1.239 dholland 13045: <td>NS_PREFERRED</td>
1.240 ! gutterid 13046: <td>NULLMAILER_GROUP</td>
1.156 leot 13047: </tr>
13048: <tr>
1.239 dholland 13049: <td>NULLMAILER_USER</td>
1.240 ! gutterid 13050: <td>OBJHOSTNAME</td>
1.178 rillig 13051: </tr>
13052: <tr>
1.239 dholland 13053: <td>OBJMACHINE</td>
1.240 ! gutterid 13054: <td>OCAML_FINDLIB_DIRS</td>
1.156 leot 13055: </tr>
13056: <tr>
1.239 dholland 13057: <td>OCAML_FINDLIB_REGISTER</td>
1.240 ! gutterid 13058: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.156 leot 13059: </tr>
13060: <tr>
1.239 dholland 13061: <td>OCAML_SITELIBDIR</td>
1.240 ! gutterid 13062: <td>OMF</td>
1.156 leot 13063: </tr>
13064: <tr>
1.239 dholland 13065: <td>ONLY_FOR_COMPILER</td>
1.240 ! gutterid 13066: <td>ONLY_FOR_PLATFORM</td>
1.156 leot 13067: </tr>
13068: <tr>
1.239 dholland 13069: <td>OPENSSH_CHROOT</td>
1.240 ! gutterid 13070: <td>OPENSSH_GROUP</td>
1.156 leot 13071: </tr>
13072: <tr>
1.239 dholland 13073: <td>OPENSSH_USER</td>
1.240 ! gutterid 13074: <td>OPSYS</td>
1.156 leot 13075: </tr>
13076: <tr>
1.239 dholland 13077: <td>OPSYS_EMULDIR</td>
1.240 ! gutterid 13078: <td>OPSYS_VERSION</td>
1.156 leot 13079: </tr>
13080: <tr>
1.239 dholland 13081: <td>OS</td>
1.240 ! gutterid 13082: <td>OSS_TYPE</td>
1.156 leot 13083: </tr>
13084: <tr>
1.239 dholland 13085: <td>OSX</td>
1.240 ! gutterid 13086: <td>OSX_TOLERATE_SDK_SKEW</td>
1.156 leot 13087: </tr>
13088: <tr>
1.239 dholland 13089: <td>OS_VARIANT</td>
1.240 ! gutterid 13090: <td>OS_VERSION</td>
1.238 wiz 13091: </tr>
13092: <tr>
1.239 dholland 13093: <td>OTF_FONTS_DIR</td>
1.240 ! gutterid 13094: <td>OVERRIDE_DIRDEPTH</td>
1.156 leot 13095: </tr>
13096: <tr>
1.239 dholland 13097: <td>OVERRIDE_GEMSPEC</td>
1.240 ! gutterid 13098: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.156 leot 13099: </tr>
13100: <tr>
1.229 gutterid 13101: <td>OWN_DIRS</td>
1.240 ! gutterid 13102: <td>OWN_DIRS_PERMS</td>
1.233 wiz 13103: </tr>
13104: <tr>
13105: <td>P4GROUP</td>
1.240 ! gutterid 13106: <td>P4PORT</td>
1.214 leot 13107: </tr>
13108: <tr>
1.233 wiz 13109: <td>P4ROOT</td>
1.240 ! gutterid 13110: <td>P4USER</td>
1.227 wiz 13111: </tr>
13112: <tr>
1.233 wiz 13113: <td>PACKAGES</td>
1.240 ! gutterid 13114: <td>PALMOS_DEFAULT_SDK</td>
1.205 wiz 13115: </tr>
13116: <tr>
1.233 wiz 13117: <td>PAMBASE</td>
1.240 ! gutterid 13118: <td>PAM_DEFAULT</td>
1.161 leot 13119: </tr>
13120: <tr>
1.233 wiz 13121: <td>PAPERSIZE</td>
1.240 ! gutterid 13122: <td>PASSIVE_FETCH</td>
1.156 leot 13123: </tr>
13124: <tr>
1.233 wiz 13125: <td>PATCHDIR</td>
1.240 ! gutterid 13126: <td>PATCHFILES</td>
1.156 leot 13127: </tr>
13128: <tr>
1.233 wiz 13129: <td>PATCH_ARGS</td>
1.240 ! gutterid 13130: <td>PATCH_DEBUG</td>
1.156 leot 13131: </tr>
13132: <tr>
1.233 wiz 13133: <td>PATCH_DIST_ARGS</td>
1.240 ! gutterid 13134: <td>PATCH_DIST_CAT</td>
1.156 leot 13135: </tr>
13136: <tr>
1.233 wiz 13137: <td>PATCH_DIST_STRIP</td>
1.240 ! gutterid 13138: <td>PATCH_FUZZ_FACTOR</td>
1.156 leot 13139: </tr>
13140: <tr>
1.233 wiz 13141: <td>PATCH_STRIP</td>
1.240 ! gutterid 13142: <td>PATH</td>
1.209 nia 13143: </tr>
13144: <tr>
1.233 wiz 13145: <td>PCCBASE</td>
1.240 ! gutterid 13146: <td>PEAR_CMD</td>
1.156 leot 13147: </tr>
13148: <tr>
1.229 gutterid 13149: <td>PEAR_LIB</td>
1.240 ! gutterid 13150: <td>PEAR_PACKAGE_XML</td>
1.227 wiz 13151: </tr>
13152: <tr>
1.229 gutterid 13153: <td>PERL5</td>
1.240 ! gutterid 13154: <td>PERL5_CONFIGURE</td>
1.156 leot 13155: </tr>
13156: <tr>
1.229 gutterid 13157: <td>PERL5_CONFIGURE_DIRS</td>
1.240 ! gutterid 13158: <td>PERL5_LDFLAGS</td>
1.217 rillig 13159: </tr>
13160: <tr>
1.229 gutterid 13161: <td>PERL5_LICENSE</td>
1.240 ! gutterid 13162: <td>PERL5_MODULE_TYPE</td>
1.205 wiz 13163: </tr>
13164: <tr>
1.229 gutterid 13165: <td>PERL5_PACKLIST</td>
1.240 ! gutterid 13166: <td>PERL5_PACKLIST_DIR</td>
1.177 leot 13167: </tr>
13168: <tr>
1.229 gutterid 13169: <td>PERL5_PERLBASE</td>
1.240 ! gutterid 13170: <td>PERL5_SITEBASE</td>
1.161 leot 13171: </tr>
13172: <tr>
1.229 gutterid 13173: <td>PERL5_USE_PACKLIST</td>
1.240 ! gutterid 13174: <td>PERL5_VENDORBASE</td>
1.161 leot 13175: </tr>
13176: <tr>
1.229 gutterid 13177: <td>PFCTL</td>
1.240 ! gutterid 13178: <td>PFVAR_H</td>
1.156 leot 13179: </tr>
13180: <tr>
1.229 gutterid 13181: <td>PF_VERSION</td>
1.240 ! gutterid 13182: <td>PGGROUP</td>
1.156 leot 13183: </tr>
13184: <tr>
1.229 gutterid 13185: <td>PGHOME</td>
1.240 ! gutterid 13186: <td>PGPKGSRCDIR</td>
1.156 leot 13187: </tr>
13188: <tr>
1.229 gutterid 13189: <td>PGSQL_TYPE</td>
1.240 ! gutterid 13190: <td>PGSQL_VERSION</td>
1.156 leot 13191: </tr>
13192: <tr>
1.229 gutterid 13193: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.240 ! gutterid 13194: <td>PGSQL_VERSION_DEFAULT</td>
1.156 leot 13195: </tr>
13196: <tr>
1.229 gutterid 13197: <td>PGUSER</td>
1.240 ! gutterid 13198: <td>PG_LIB_EXT</td>
1.156 leot 13199: </tr>
13200: <tr>
1.229 gutterid 13201: <td>PHP</td>
1.240 ! gutterid 13202: <td>PHPCOMMON_MK</td>
1.156 leot 13203: </tr>
13204: <tr>
1.229 gutterid 13205: <td>PHPPKGSRCDIR</td>
1.240 ! gutterid 13206: <td>PHP_BASE_VERS</td>
1.156 leot 13207: </tr>
13208: <tr>
1.229 gutterid 13209: <td>PHP_CHECK_INSTALLED</td>
1.240 ! gutterid 13210: <td>PHP_EXTENSION_DIR</td>
1.156 leot 13211: </tr>
13212: <tr>
1.229 gutterid 13213: <td>PHP_INITIAL_TEENY</td>
1.240 ! gutterid 13214: <td>PHP_PKG_PREFIX</td>
1.156 leot 13215: </tr>
13216: <tr>
1.229 gutterid 13217: <td>PHP_VERSION</td>
1.240 ! gutterid 13218: <td>PHP_VERSIONS_ACCEPTED</td>
1.156 leot 13219: </tr>
13220: <tr>
1.229 gutterid 13221: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.240 ! gutterid 13222: <td>PHP_VERSION_DEFAULT</td>
1.156 leot 13223: </tr>
13224: <tr>
1.229 gutterid 13225: <td>PHP_VERSION_REQD</td>
1.240 ! gutterid 13226: <td>PILRC_USE_GTK</td>
1.156 leot 13227: </tr>
13228: <tr>
1.229 gutterid 13229: <td>PKGCONFIG_BASE</td>
1.240 ! gutterid 13230: <td>PKGCONFIG_FILE</td>
1.156 leot 13231: </tr>
13232: <tr>
1.229 gutterid 13233: <td>PKGCONFIG_OVERRIDE</td>
1.240 ! gutterid 13234: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.156 leot 13235: </tr>
13236: <tr>
1.229 gutterid 13237: <td>PKGDIR</td>
1.240 ! gutterid 13238: <td>PKGGNUDIR</td>
1.156 leot 13239: </tr>
13240: <tr>
1.229 gutterid 13241: <td>PKGINFODIR</td>
1.240 ! gutterid 13242: <td>PKGLOCALEDIR</td>
1.156 leot 13243: </tr>
13244: <tr>
1.229 gutterid 13245: <td>PKGMANDIR</td>
1.240 ! gutterid 13246: <td>PKGNAME</td>
1.156 leot 13247: </tr>
13248: <tr>
1.229 gutterid 13249: <td>PKGNAME_REQD</td>
1.240 ! gutterid 13250: <td>PKGPATH</td>
1.156 leot 13251: </tr>
13252: <tr>
1.229 gutterid 13253: <td>PKGREVISION</td>
1.240 ! gutterid 13254: <td>PKGSRC_BLAS_TYPES</td>
1.156 leot 13255: </tr>
13256: <tr>
1.229 gutterid 13257: <td>PKGSRC_CHANGES</td>
1.240 ! gutterid 13258: <td>PKGSRC_COMPILER</td>
1.156 leot 13259: </tr>
13260: <tr>
1.229 gutterid 13261: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.240 ! gutterid 13262: <td>PKGSRC_LOCKTYPE</td>
1.156 leot 13263: </tr>
13264: <tr>
1.229 gutterid 13265: <td>PKGSRC_MAKE_ENV</td>
1.240 ! gutterid 13266: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.156 leot 13267: </tr>
13268: <tr>
1.229 gutterid 13269: <td>PKGSRC_MKPIE</td>
1.240 ! gutterid 13270: <td>PKGSRC_MKREPRO</td>
1.156 leot 13271: </tr>
13272: <tr>
1.229 gutterid 13273: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.240 ! gutterid 13274: <td>PKGSRC_RUN_TEST</td>
1.177 leot 13275: </tr>
13276: <tr>
1.229 gutterid 13277: <td>PKGSRC_SETENV</td>
1.240 ! gutterid 13278: <td>PKGSRC_SLEEPSECS</td>
1.156 leot 13279: </tr>
13280: <tr>
1.229 gutterid 13281: <td>PKGSRC_TODO</td>
1.240 ! gutterid 13282: <td>PKGSRC_USE_CTF</td>
1.159 rillig 13283: </tr>
13284: <tr>
1.229 gutterid 13285: <td>PKGSRC_USE_FORTIFY</td>
1.240 ! gutterid 13286: <td>PKGSRC_USE_MKTOOLS</td>
1.156 leot 13287: </tr>
13288: <tr>
1.229 gutterid 13289: <td>PKGSRC_USE_RELRO</td>
1.240 ! gutterid 13290: <td>PKGSRC_USE_SSP</td>
1.156 leot 13291: </tr>
13292: <tr>
1.229 gutterid 13293: <td>PKGSRC_USE_STACK_CHECK</td>
1.240 ! gutterid 13294: <td>PKGTASKS_DATAFILE</td>
1.156 leot 13295: </tr>
13296: <tr>
1.229 gutterid 13297: <td>PKGTOOLS_ARGS</td>
1.240 ! gutterid 13298: <td>PKGTOOLS_ENV</td>
1.156 leot 13299: </tr>
13300: <tr>
1.229 gutterid 13301: <td>PKG_ALTERNATIVES</td>
1.240 ! gutterid 13302: <td>PKG_APACHE</td>
1.156 leot 13303: </tr>
13304: <tr>
1.229 gutterid 13305: <td>PKG_APACHE_ACCEPTED</td>
1.240 ! gutterid 13306: <td>PKG_APACHE_DEFAULT</td>
1.156 leot 13307: </tr>
13308: <tr>
1.229 gutterid 13309: <td>PKG_BEST_EXISTS</td>
1.240 ! gutterid 13310: <td>PKG_BUILD_OPTIONS</td>
1.156 leot 13311: </tr>
13312: <tr>
1.229 gutterid 13313: <td>PKG_COMPRESSION</td>
1.240 ! gutterid 13314: <td>PKG_CONFIG</td>
1.156 leot 13315: </tr>
13316: <tr>
1.229 gutterid 13317: <td>PKG_CONFIG_PERMS</td>
1.240 ! gutterid 13318: <td>PKG_CREATE_USERGROUP</td>
1.156 leot 13319: </tr>
13320: <tr>
1.229 gutterid 13321: <td>PKG_DB_TMPDIR</td>
1.240 ! gutterid 13322: <td>PKG_DEBUG_LEVEL</td>
1.156 leot 13323: </tr>
13324: <tr>
1.229 gutterid 13325: <td>PKG_DEFAULT_OPTIONS</td>
1.240 ! gutterid 13326: <td>PKG_DESTDIR_SUPPORT</td>
1.156 leot 13327: </tr>
13328: <tr>
1.229 gutterid 13329: <td>PKG_DEVELOPER</td>
1.240 ! gutterid 13330: <td>PKG_DISABLED_OPTIONS</td>
1.156 leot 13331: </tr>
13332: <tr>
1.229 gutterid 13333: <td>PKG_FATAL_ERRORS</td>
1.240 ! gutterid 13334: <td>PKG_FC</td>
1.233 wiz 13335: </tr>
13336: <tr>
13337: <td>PKG_FILELIST_CMD</td>
1.240 ! gutterid 13338: <td>PKG_GECOS</td>
1.156 leot 13339: </tr>
13340: <tr>
1.233 wiz 13341: <td>PKG_GID</td>
1.240 ! gutterid 13342: <td>PKG_GROUPS</td>
1.156 leot 13343: </tr>
13344: <tr>
1.233 wiz 13345: <td>PKG_GROUPS_VARS</td>
1.240 ! gutterid 13346: <td>PKG_HOME</td>
1.156 leot 13347: </tr>
13348: <tr>
1.233 wiz 13349: <td>PKG_INIT_SCRIPTS</td>
1.240 ! gutterid 13350: <td>PKG_JAVA_HOME</td>
1.156 leot 13351: </tr>
13352: <tr>
1.233 wiz 13353: <td>PKG_JVM</td>
1.240 ! gutterid 13354: <td>PKG_JVMS_ACCEPTED</td>
1.156 leot 13355: </tr>
13356: <tr>
1.233 wiz 13357: <td>PKG_JVM_DEFAULT</td>
1.240 ! gutterid 13358: <td>PKG_LEGACY_OPTIONS</td>
1.156 leot 13359: </tr>
13360: <tr>
1.233 wiz 13361: <td>PKG_LIBTOOL</td>
1.240 ! gutterid 13362: <td>PKG_MKSYMLINKS</td>
1.156 leot 13363: </tr>
13364: <tr>
1.233 wiz 13365: <td>PKG_OPTIONS</td>
1.240 ! gutterid 13366: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.156 leot 13367: </tr>
13368: <tr>
1.233 wiz 13369: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.240 ! gutterid 13370: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.156 leot 13371: </tr>
13372: <tr>
1.233 wiz 13373: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.240 ! gutterid 13374: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.226 gutterid 13375: </tr>
13376: <tr>
1.233 wiz 13377: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.240 ! gutterid 13378: <td>PKG_OPTIONS_VAR</td>
1.156 leot 13379: </tr>
13380: <tr>
1.233 wiz 13381: <td>PKG_PHP</td>
1.240 ! gutterid 13382: <td>PKG_PHP_MAJOR_VERS</td>
1.156 leot 13383: </tr>
13384: <tr>
1.233 wiz 13385: <td>PKG_PHP_VERSION</td>
1.240 ! gutterid 13386: <td>PKG_RCD_SCRIPTS</td>
1.156 leot 13387: </tr>
13388: <tr>
1.233 wiz 13389: <td>PKG_REFCOUNT_DBDIR</td>
1.240 ! gutterid 13390: <td>PKG_REGISTER_SHELLS</td>
1.156 leot 13391: </tr>
13392: <tr>
1.233 wiz 13393: <td>PKG_RESUME_TRANSFERS</td>
1.240 ! gutterid 13394: <td>PKG_SHELL</td>
1.156 leot 13395: </tr>
13396: <tr>
1.233 wiz 13397: <td>PKG_SUGGESTED_OPTIONS</td>
1.240 ! gutterid 13398: <td>PKG_SUPPORTED_OPTIONS</td>
1.156 leot 13399: </tr>
13400: <tr>
1.233 wiz 13401: <td>PKG_SYSCONFBASE</td>
1.240 ! gutterid 13402: <td>PKG_SYSCONFBASEDIR</td>
1.156 leot 13403: </tr>
13404: <tr>
1.233 wiz 13405: <td>PKG_SYSCONFDIR</td>
1.240 ! gutterid 13406: <td>PKG_SYSCONFDIR_PERMS</td>
1.156 leot 13407: </tr>
13408: <tr>
1.233 wiz 13409: <td>PKG_SYSCONFSUBDIR</td>
1.240 ! gutterid 13410: <td>PKG_SYSCONFVAR</td>
1.156 leot 13411: </tr>
13412: <tr>
1.233 wiz 13413: <td>PKG_TOOLS_BIN</td>
1.240 ! gutterid 13414: <td>PKG_UID</td>
1.156 leot 13415: </tr>
13416: <tr>
1.233 wiz 13417: <td>PKG_UPDATE_FONTS_DB</td>
1.240 ! gutterid 13418: <td>PKG_USERS</td>
1.156 leot 13419: </tr>
13420: <tr>
1.233 wiz 13421: <td>PKG_USERS_VARS</td>
1.240 ! gutterid 13422: <td>PKG_VERBOSE</td>
1.156 leot 13423: </tr>
13424: <tr>
1.233 wiz 13425: <td>PLEASE</td>
1.240 ! gutterid 13426: <td>PLIST</td>
1.156 leot 13427: </tr>
13428: <tr>
1.233 wiz 13429: <td>PLIST_AWK</td>
1.240 ! gutterid 13430: <td>PLIST_AWK_ENV</td>
1.156 leot 13431: </tr>
13432: <tr>
1.233 wiz 13433: <td>PLIST_SRC</td>
1.240 ! gutterid 13434: <td>PLIST_SUBST</td>
1.156 leot 13435: </tr>
13436: <tr>
1.233 wiz 13437: <td>PLIST_TYPE</td>
1.240 ! gutterid 13438: <td>PLIST_VARS</td>
1.156 leot 13439: </tr>
13440: <tr>
1.233 wiz 13441: <td>POPTOP_USE_MPPE</td>
1.240 ! gutterid 13442: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.156 leot 13443: </tr>
13444: <tr>
1.233 wiz 13445: <td>POST_FETCH_HOOK</td>
1.240 ! gutterid 13446: <td>PREFER</td>
1.156 leot 13447: </tr>
13448: <tr>
1.233 wiz 13449: <td>PREFER_NATIVE</td>
1.240 ! gutterid 13450: <td>PREFER_NATIVE_PTHREADS</td>
1.156 leot 13451: </tr>
13452: <tr>
1.233 wiz 13453: <td>PREFER_PKGSRC</td>
1.240 ! gutterid 13454: <td>PREFIX</td>
1.156 leot 13455: </tr>
13456: <tr>
1.233 wiz 13457: <td>PREPEND_PATH</td>
1.240 ! gutterid 13458: <td>PRE_ROOT_CMD</td>
1.156 leot 13459: </tr>
13460: <tr>
1.233 wiz 13461: <td>PRIVILEGED_STAGES</td>
1.240 ! gutterid 13462: <td>PS</td>
1.156 leot 13463: </tr>
13464: <tr>
1.233 wiz 13465: <td>PTHREAD_AUTO_VARS</td>
1.240 ! gutterid 13466: <td>PTHREAD_CFLAGS</td>
1.156 leot 13467: </tr>
13468: <tr>
1.233 wiz 13469: <td>PTHREAD_LDFLAGS</td>
1.240 ! gutterid 13470: <td>PTHREAD_LIBS</td>
1.156 leot 13471: </tr>
13472: <tr>
1.233 wiz 13473: <td>PTHREAD_OPTS</td>
1.240 ! gutterid 13474: <td>PTHREAD_TYPE</td>
1.156 leot 13475: </tr>
13476: <tr>
1.233 wiz 13477: <td>PVM_SSH</td>
1.240 ! gutterid 13478: <td>PYPKGPREFIX</td>
1.156 leot 13479: </tr>
13480: <tr>
1.233 wiz 13481: <td>PYTHON_FOR_BUILD_ONLY</td>
1.240 ! gutterid 13482: <td>PYTHON_SELF_CONFLICT</td>
1.156 leot 13483: </tr>
13484: <tr>
1.237 gutterid 13485: <td>PYTHON_VERSION</td>
1.240 ! gutterid 13486: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.156 leot 13487: </tr>
13488: <tr>
1.232 gutterid 13489: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.240 ! gutterid 13490: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.156 leot 13491: </tr>
13492: <tr>
1.232 gutterid 13493: <td>PYTHON_VERSION_DEFAULT</td>
1.240 ! gutterid 13494: <td>PYTHON_VERSION_REQD</td>
1.156 leot 13495: </tr>
13496: <tr>
1.232 gutterid 13497: <td>PYVERSSUFFIX</td>
1.240 ! gutterid 13498: <td>QMAILDIR</td>
1.156 leot 13499: </tr>
13500: <tr>
1.232 gutterid 13501: <td>QMAIL_ALIAS_USER</td>
1.240 ! gutterid 13502: <td>QMAIL_DAEMON_USER</td>
1.156 leot 13503: </tr>
13504: <tr>
1.232 gutterid 13505: <td>QMAIL_LOG_USER</td>
1.240 ! gutterid 13506: <td>QMAIL_NOFILES_GROUP</td>
1.156 leot 13507: </tr>
13508: <tr>
1.232 gutterid 13509: <td>QMAIL_PASSWD_USER</td>
1.240 ! gutterid 13510: <td>QMAIL_QMAIL_GROUP</td>
1.156 leot 13511: </tr>
13512: <tr>
1.232 gutterid 13513: <td>QMAIL_QUEUE_DIR</td>
1.240 ! gutterid 13514: <td>QMAIL_QUEUE_EXTRA</td>
1.156 leot 13515: </tr>
13516: <tr>
1.232 gutterid 13517: <td>QMAIL_QUEUE_USER</td>
1.240 ! gutterid 13518: <td>QMAIL_REMOTE_USER</td>
1.156 leot 13519: </tr>
13520: <tr>
1.232 gutterid 13521: <td>QMAIL_ROOT_USER</td>
1.240 ! gutterid 13522: <td>QMAIL_SEND_USER</td>
1.156 leot 13523: </tr>
13524: <tr>
1.232 gutterid 13525: <td>QORE_LATEST_MODULE_API</td>
1.240 ! gutterid 13526: <td>QORE_MODULE_API</td>
1.156 leot 13527: </tr>
13528: <tr>
1.232 gutterid 13529: <td>QORE_MODULE_DIR</td>
1.240 ! gutterid 13530: <td>QORE_USER_MODULE_DIR</td>
1.156 leot 13531: </tr>
13532: <tr>
1.232 gutterid 13533: <td>QORE_VERSION</td>
1.240 ! gutterid 13534: <td>QPOPPER_FAC</td>
1.156 leot 13535: </tr>
13536: <tr>
1.232 gutterid 13537: <td>QPOPPER_SPOOL_DIR</td>
1.240 ! gutterid 13538: <td>QPOPPER_USER</td>
1.156 leot 13539: </tr>
13540: <tr>
1.232 gutterid 13541: <td>RAKE_NAME</td>
1.240 ! gutterid 13542: <td>RASMOL_DEPTH</td>
1.233 wiz 13543: </tr>
13544: <tr>
1.232 gutterid 13545: <td>RCD_SCRIPTS</td>
1.240 ! gutterid 13546: <td>RCD_SCRIPTS_DIR</td>
1.218 nia 13547: </tr>
13548: <tr>
1.232 gutterid 13549: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.240 ! gutterid 13550: <td>RCD_SCRIPTS_MODE</td>
1.227 wiz 13551: </tr>
13552: <tr>
1.232 gutterid 13553: <td>RCD_SCRIPTS_SHELL</td>
1.240 ! gutterid 13554: <td>RCD_SCRIPT_SRC</td>
1.156 leot 13555: </tr>
13556: <tr>
1.239 dholland 13557: <td>RDOC</td>
1.238 wiz 13558: <td>READLINE_DEFAULT</td>
1.214 leot 13559: </tr>
13560: <tr>
1.232 gutterid 13561: <td>READLINE_TYPE</td>
1.238 wiz 13562: <td>REAL_ROOT_GROUP</td>
1.205 wiz 13563: </tr>
13564: <tr>
1.232 gutterid 13565: <td>REAL_ROOT_USER</td>
1.238 wiz 13566: <td>RECURSIVE_MAKE</td>
1.223 nia 13567: </tr>
13568: <tr>
1.232 gutterid 13569: <td>RELAY_CTRL_DIR</td>
1.238 wiz 13570: <td>RELRO_SUPPORTED</td>
1.177 leot 13571: </tr>
13572: <tr>
1.232 gutterid 13573: <td>REPLACE_AWK</td>
1.238 wiz 13574: <td>REPLACE_BASH</td>
1.214 leot 13575: </tr>
13576: <tr>
1.232 gutterid 13577: <td>REPLACE_CSH</td>
1.238 wiz 13578: <td>REPLACE_KSH</td>
1.212 wiz 13579: </tr>
13580: <tr>
1.232 gutterid 13581: <td>REPLACE_LUA</td>
1.238 wiz 13582: <td>REPLACE_NODEJS</td>
1.156 leot 13583: </tr>
13584: <tr>
1.232 gutterid 13585: <td>REPLACE_OCTAVE</td>
1.238 wiz 13586: <td>REPLACE_PERL</td>
1.205 wiz 13587: </tr>
13588: <tr>
1.232 gutterid 13589: <td>REPLACE_PERL6</td>
1.238 wiz 13590: <td>REPLACE_PHP</td>
1.197 leot 13591: </tr>
13592: <tr>
1.232 gutterid 13593: <td>REPLACE_PYTHON</td>
1.238 wiz 13594: <td>REPLACE_QORE</td>
1.156 leot 13595: </tr>
13596: <tr>
1.232 gutterid 13597: <td>REPLACE_R</td>
1.238 wiz 13598: <td>REPLACE_RUBY</td>
1.218 nia 13599: </tr>
13600: <tr>
1.232 gutterid 13601: <td>REPLACE_RUBY_DIRS</td>
1.238 wiz 13602: <td>REPLACE_RUBY_PAT</td>
1.161 leot 13603: </tr>
13604: <tr>
1.232 gutterid 13605: <td>REPLACE_SH</td>
1.238 wiz 13606: <td>REPLACE_TEXLUA</td>
1.216 gutterid 13607: </tr>
13608: <tr>
1.232 gutterid 13609: <td>REPLACE_WISH</td>
1.238 wiz 13610: <td>REQD_DIRS</td>
1.156 leot 13611: </tr>
13612: <tr>
1.232 gutterid 13613: <td>REQD_DIRS_PERMS</td>
1.238 wiz 13614: <td>REQD_FILES</td>
1.218 nia 13615: </tr>
13616: <tr>
1.232 gutterid 13617: <td>REQD_FILES_MODE</td>
1.238 wiz 13618: <td>REQD_FILES_PERMS</td>
1.156 leot 13619: </tr>
13620: <tr>
1.232 gutterid 13621: <td>RESOLV_AUTO_VARS</td>
1.238 wiz 13622: <td>RESOLV_LDFLAGS</td>
1.156 leot 13623: </tr>
13624: <tr>
1.232 gutterid 13625: <td>RESOLV_LIBS</td>
1.238 wiz 13626: <td>RM</td>
13627: </tr>
13628: <tr>
1.232 gutterid 13629: <td>ROOT_CMD</td>
1.238 wiz 13630: <td>ROOT_GROUP</td>
1.156 leot 13631: </tr>
13632: <tr>
1.232 gutterid 13633: <td>ROOT_USER</td>
1.238 wiz 13634: <td>RPCGEN</td>
1.156 leot 13635: </tr>
13636: <tr>
1.232 gutterid 13637: <td>RPM</td>
1.238 wiz 13638: <td>RPM2PKG_PLIST</td>
1.205 wiz 13639: </tr>
13640: <tr>
1.232 gutterid 13641: <td>RPM2PKG_PREFIX</td>
1.238 wiz 13642: <td>RPM2PKG_STAGE</td>
1.217 rillig 13643: </tr>
13644: <tr>
1.232 gutterid 13645: <td>RPM2PKG_STRIP</td>
1.238 wiz 13646: <td>RPM2PKG_SUBPREFIX</td>
1.214 leot 13647: </tr>
13648: <tr>
1.232 gutterid 13649: <td>RPMFILES</td>
1.238 wiz 13650: <td>RPMIGNOREPATH</td>
1.212 wiz 13651: </tr>
13652: <tr>
1.232 gutterid 13653: <td>RPM_DB_PREFIX</td>
1.238 wiz 13654: <td>RSSH_CVS_PATH</td>
1.156 leot 13655: </tr>
13656: <tr>
1.232 gutterid 13657: <td>RSSH_RDIST_PATH</td>
1.238 wiz 13658: <td>RSSH_RSYNC_PATH</td>
1.197 leot 13659: </tr>
13660: <tr>
1.232 gutterid 13661: <td>RSSH_SCP_PATH</td>
1.238 wiz 13662: <td>RSSH_SFTP_SERVER_PATH</td>
1.156 leot 13663: </tr>
13664: <tr>
1.232 gutterid 13665: <td>RUBY</td>
1.238 wiz 13666: <td>RUBYGEM</td>
1.156 leot 13667: </tr>
13668: <tr>
1.232 gutterid 13669: <td>RUBYGEM_MANPAGES</td>
1.238 wiz 13670: <td>RUBYGEM_NAME</td>
1.156 leot 13671: </tr>
13672: <tr>
1.232 gutterid 13673: <td>RUBYGEM_OPTIONS</td>
1.238 wiz 13674: <td>RUBYGEM_USE_MANPAGES</td>
1.231 jnemeth 13675: </tr>
13676: <tr>
1.232 gutterid 13677: <td>RUBYGEM_VERBOSE</td>
1.238 wiz 13678: <td>RUBY_ABI_VERSION</td>
1.156 leot 13679: </tr>
13680: <tr>
1.232 gutterid 13681: <td>RUBY_ARCH</td>
1.238 wiz 13682: <td>RUBY_ARCHINC</td>
1.156 leot 13683: </tr>
13684: <tr>
1.232 gutterid 13685: <td>RUBY_ARCHLIB</td>
1.238 wiz 13686: <td>RUBY_BASE</td>
1.156 leot 13687: </tr>
13688: <tr>
1.232 gutterid 13689: <td>RUBY_BASERIDIR</td>
1.238 wiz 13690: <td>RUBY_BUILD_DOCUMENT</td>
1.156 leot 13691: </tr>
13692: <tr>
1.232 gutterid 13693: <td>RUBY_DLEXT</td>
1.238 wiz 13694: <td>RUBY_DOC</td>
1.156 leot 13695: </tr>
13696: <tr>
1.232 gutterid 13697: <td>RUBY_DYNAMIC_DIRS</td>
1.238 wiz 13698: <td>RUBY_EG</td>
1.156 leot 13699: </tr>
13700: <tr>
1.232 gutterid 13701: <td>RUBY_ENCODING_ARG</td>
1.238 wiz 13702: <td>RUBY_EXTCONF</td>
1.156 leot 13703: </tr>
13704: <tr>
1.232 gutterid 13705: <td>RUBY_EXTCONF_CHECK</td>
1.238 wiz 13706: <td>RUBY_EXTCONF_DEBUG</td>
1.198 leot 13707: </tr>
13708: <tr>
1.232 gutterid 13709: <td>RUBY_EXTCONF_MAKEFILE</td>
1.238 wiz 13710: <td>RUBY_GEM_ARCH</td>
1.156 leot 13711: </tr>
13712: <tr>
1.232 gutterid 13713: <td>RUBY_GEM_BASE</td>
1.238 wiz 13714: <td>RUBY_INC</td>
1.156 leot 13715: </tr>
13716: <tr>
1.232 gutterid 13717: <td>RUBY_LIB</td>
1.238 wiz 13718: <td>RUBY_LIB_BASE</td>
1.156 leot 13719: </tr>
13720: <tr>
1.232 gutterid 13721: <td>RUBY_NAME</td>
1.238 wiz 13722: <td>RUBY_NOVERSION</td>
1.156 leot 13723: </tr>
13724: <tr>
1.232 gutterid 13725: <td>RUBY_PKGPREFIX</td>
1.238 wiz 13726: <td>RUBY_RAILS</td>
1.223 nia 13727: </tr>
13728: <tr>
1.232 gutterid 13729: <td>RUBY_RAILS52_VERSION</td>
1.238 wiz 13730: <td>RUBY_RAILS60_VERSION</td>
1.156 leot 13731: </tr>
13732: <tr>
1.232 gutterid 13733: <td>RUBY_RAILS61_VERSION</td>
1.238 wiz 13734: <td>RUBY_RAILS70_VERSION</td>
1.156 leot 13735: </tr>
13736: <tr>
1.232 gutterid 13737: <td>RUBY_RAILS_ACCEPTED</td>
1.238 wiz 13738: <td>RUBY_RAILS_DEFAULT</td>
1.156 leot 13739: </tr>
13740: <tr>
1.232 gutterid 13741: <td>RUBY_RAILS_REQD</td>
1.238 wiz 13742: <td>RUBY_RAILS_STRICT_DEP</td>
1.156 leot 13743: </tr>
13744: <tr>
1.232 gutterid 13745: <td>RUBY_RIDIR</td>
1.238 wiz 13746: <td>RUBY_SETUP</td>
1.156 leot 13747: </tr>
13748: <tr>
1.232 gutterid 13749: <td>RUBY_SHLIB</td>
1.238 wiz 13750: <td>RUBY_SHLIBALIAS</td>
1.156 leot 13751: </tr>
13752: <tr>
1.232 gutterid 13753: <td>RUBY_SHLIBVER</td>
1.238 wiz 13754: <td>RUBY_SIMPLE_INSTALL</td>
1.156 leot 13755: </tr>
13756: <tr>
1.232 gutterid 13757: <td>RUBY_SITEARCHLIB</td>
1.238 wiz 13758: <td>RUBY_SITELIB</td>
1.156 leot 13759: </tr>
13760: <tr>
1.232 gutterid 13761: <td>RUBY_SITELIB_BASE</td>
1.238 wiz 13762: <td>RUBY_SITERIDIR</td>
1.156 leot 13763: </tr>
13764: <tr>
1.232 gutterid 13765: <td>RUBY_SLEXT</td>
1.238 wiz 13766: <td>RUBY_SRCDIR</td>
1.174 leot 13767: </tr>
13768: <tr>
1.232 gutterid 13769: <td>RUBY_STATICLIB</td>
1.238 wiz 13770: <td>RUBY_SUFFIX</td>
1.156 leot 13771: </tr>
13772: <tr>
1.232 gutterid 13773: <td>RUBY_SYSRIDIR</td>
1.238 wiz 13774: <td>RUBY_USE_PTHREAD</td>
1.156 leot 13775: </tr>
13776: <tr>
1.232 gutterid 13777: <td>RUBY_VENDORARCHLIB</td>
1.238 wiz 13778: <td>RUBY_VENDORLIB</td>
1.156 leot 13779: </tr>
13780: <tr>
1.232 gutterid 13781: <td>RUBY_VENDORLIB_BASE</td>
1.238 wiz 13782: <td>RUBY_VER</td>
1.156 leot 13783: </tr>
13784: <tr>
1.232 gutterid 13785: <td>RUBY_VERSION</td>
1.238 wiz 13786: <td>RUBY_VERSIONS_ACCEPTED</td>
1.156 leot 13787: </tr>
13788: <tr>
1.232 gutterid 13789: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.238 wiz 13790: <td>RUBY_VERSION_DEFAULT</td>
1.156 leot 13791: </tr>
13792: <tr>
1.232 gutterid 13793: <td>RUBY_VERSION_REQD</td>
1.238 wiz 13794: <td>RUBY_VER_DIR</td>
1.156 leot 13795: </tr>
13796: <tr>
1.232 gutterid 13797: <td>RUN</td>
1.238 wiz 13798: <td>RUN_LDCONFIG</td>
1.156 leot 13799: </tr>
13800: <tr>
1.232 gutterid 13801: <td>RUST_TYPE</td>
1.238 wiz 13802: <td>SCO</td>
1.156 leot 13803: </tr>
13804: <tr>
1.232 gutterid 13805: <td>SCREWS_GROUP</td>
1.238 wiz 13806: <td>SCREWS_USER</td>
1.156 leot 13807: </tr>
13808: <tr>
1.232 gutterid 13809: <td>SCRIPTS_ENV</td>
1.238 wiz 13810: <td>SCROLLKEEPER_DATADIR</td>
1.156 leot 13811: </tr>
13812: <tr>
1.232 gutterid 13813: <td>SCROLLKEEPER_REBUILDDB</td>
1.238 wiz 13814: <td>SCROLLKEEPER_UPDATEDB</td>
1.156 leot 13815: </tr>
13816: <tr>
1.232 gutterid 13817: <td>SDIST_PAWD</td>
1.238 wiz 13818: <td>SDL12_TYPE</td>
1.156 leot 13819: </tr>
13820: <tr>
1.232 gutterid 13821: <td>SERIAL_DEVICES</td>
1.238 wiz 13822: <td>SETGIDGAME</td>
1.156 leot 13823: </tr>
13824: <tr>
1.232 gutterid 13825: <td>SETGID_GAMES_PERMS</td>
1.238 wiz 13826: <td>SETUID_ROOT_PERMS</td>
1.156 leot 13827: </tr>
13828: <tr>
1.232 gutterid 13829: <td>SH</td>
1.238 wiz 13830: <td>SHLIB</td>
1.233 wiz 13831: </tr>
13832: <tr>
1.232 gutterid 13833: <td>SIGN_PACKAGES</td>
1.239 dholland 13834: <td>SILC_CLIENT_WITH_PERL</td>
1.156 leot 13835: </tr>
13836: <tr>
1.232 gutterid 13837: <td>SITE_SPECIFIC_PKGS</td>
1.239 dholland 13838: <td>SKIP_DEPENDS</td>
1.227 wiz 13839: </tr>
13840: <tr>
1.232 gutterid 13841: <td>SMF_INSTANCES</td>
1.239 dholland 13842: <td>SMF_MANIFEST</td>
1.156 leot 13843: </tr>
13844: <tr>
1.232 gutterid 13845: <td>SMF_METHODS</td>
1.239 dholland 13846: <td>SMF_METHOD_SHELL</td>
1.156 leot 13847: </tr>
13848: <tr>
1.232 gutterid 13849: <td>SMF_METHOD_SRC</td>
1.239 dholland 13850: <td>SMF_NAME</td>
1.177 leot 13851: </tr>
13852: <tr>
1.232 gutterid 13853: <td>SMF_PREFIX</td>
1.239 dholland 13854: <td>SMF_SRCDIR</td>
1.156 leot 13855: </tr>
13856: <tr>
1.232 gutterid 13857: <td>SNIPROXY_GROUP</td>
1.239 dholland 13858: <td>SNIPROXY_USER</td>
1.217 rillig 13859: </tr>
13860: <tr>
1.232 gutterid 13861: <td>SOURCE_BUFFSIZE</td>
1.239 dholland 13862: <td>SPECIAL_PERMS</td>
1.156 leot 13863: </tr>
13864: <tr>
1.232 gutterid 13865: <td>SPECIFIC_PKGS</td>
1.239 dholland 13866: <td>SSH_SUID</td>
1.159 rillig 13867: </tr>
13868: <tr>
1.232 gutterid 13869: <td>SSP_SUPPORTED</td>
1.239 dholland 13870: <td>SSYNC_PAWD</td>
1.156 leot 13871: </tr>
13872: <tr>
1.232 gutterid 13873: <td>STEP_MSG</td>
1.239 dholland 13874: <td>STRIP</td>
1.156 leot 13875: </tr>
13876: <tr>
1.232 gutterid 13877: <td>STRIP_DBG</td>
1.239 dholland 13878: <td>STRIP_DEBUG</td>
1.156 leot 13879: </tr>
13880: <tr>
1.232 gutterid 13881: <td>STRIP_DEBUG_SUPPORTED</td>
1.239 dholland 13882: <td>STRIP_FILES_SKIP</td>
1.156 leot 13883: </tr>
13884: <tr>
1.232 gutterid 13885: <td>SU</td>
1.239 dholland 13886: <td>SUBDIR</td>
1.156 leot 13887: </tr>
13888: <tr>
1.232 gutterid 13889: <td>SUBST</td>
1.239 dholland 13890: <td>SUBST_CLASSES</td>
1.156 leot 13891: </tr>
13892: <tr>
1.232 gutterid 13893: <td>SUBST_FILES</td>
1.239 dholland 13894: <td>SUBST_FILTER_CMD</td>
1.156 leot 13895: </tr>
13896: <tr>
1.232 gutterid 13897: <td>SUBST_MESSAGE</td>
1.239 dholland 13898: <td>SUBST_NOOP_OK</td>
1.156 leot 13899: </tr>
13900: <tr>
1.232 gutterid 13901: <td>SUBST_SED</td>
1.239 dholland 13902: <td>SUBST_SHOW_DIFF</td>
1.156 leot 13903: </tr>
13904: <tr>
1.232 gutterid 13905: <td>SUBST_SKIP_TEXT_CHECK</td>
1.239 dholland 13906: <td>SUBST_STAGE</td>
1.156 leot 13907: </tr>
13908: <tr>
1.232 gutterid 13909: <td>SUBST_VARS</td>
1.239 dholland 13910: <td>SUNWSPROBASE</td>
1.156 leot 13911: </tr>
13912: <tr>
1.232 gutterid 13913: <td>SUSE_PREFER</td>
1.237 gutterid 13914: <td>SU_CMD</td>
1.238 wiz 13915: </tr>
13916: <tr>
1.232 gutterid 13917: <td>SYSCONFBASE</td>
1.239 dholland 13918: <td>TARGET_ARCH</td>
1.156 leot 13919: </tr>
13920: <tr>
1.232 gutterid 13921: <td>TBL</td>
1.239 dholland 13922: <td>TERMCAP_TYPE</td>
1.227 wiz 13923: </tr>
13924: <tr>
1.232 gutterid 13925: <td>TERMINFO_DEFAULT</td>
1.239 dholland 13926: <td>TERMINFO_TYPE</td>
1.156 leot 13927: </tr>
13928: <tr>
1.232 gutterid 13929: <td>TEST</td>
1.239 dholland 13930: <td>TEST_DEPENDS</td>
1.217 rillig 13931: </tr>
13932: <tr>
1.232 gutterid 13933: <td>TEST_DIRS</td>
1.239 dholland 13934: <td>TEST_ENV</td>
1.212 wiz 13935: </tr>
13936: <tr>
1.232 gutterid 13937: <td>TEST_ENV_SHELL</td>
1.239 dholland 13938: <td>TEST_MAKE_CMD</td>
1.217 rillig 13939: </tr>
13940: <tr>
1.232 gutterid 13941: <td>TEST_MAKE_FLAGS</td>
1.239 dholland 13942: <td>TEST_TARGET</td>
1.205 wiz 13943: </tr>
13944: <tr>
1.232 gutterid 13945: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.239 dholland 13946: <td>TEXLIVE_REV</td>
1.189 bacon 13947: </tr>
13948: <tr>
1.232 gutterid 13949: <td>TEXLIVE_UNVERSIONED</td>
1.239 dholland 13950: <td>TEXMFSITE</td>
1.161 leot 13951: </tr>
13952: <tr>
1.232 gutterid 13953: <td>TEX_FORMATS</td>
1.239 dholland 13954: <td>TEX_HYPHEN_DAT</td>
1.159 rillig 13955: </tr>
13956: <tr>
1.232 gutterid 13957: <td>TEX_HYPHEN_DEF</td>
1.239 dholland 13958: <td>TEX_TEXMF_DIRS</td>
1.156 leot 13959: </tr>
13960: <tr>
1.232 gutterid 13961: <td>THTTPD_LOG_FACILITY</td>
1.239 dholland 13962: <td>TINYDYN_USER</td>
1.156 leot 13963: </tr>
13964: <tr>
1.232 gutterid 13965: <td>TLSWRAPPER_CHROOT</td>
1.239 dholland 13966: <td>TO</td>
1.156 leot 13967: </tr>
13968: <tr>
1.232 gutterid 13969: <td>TOOLS_ALIASES</td>
1.239 dholland 13970: <td>TOOLS_ALWAYS_WRAP</td>
1.156 leot 13971: </tr>
13972: <tr>
1.232 gutterid 13973: <td>TOOLS_ARGS</td>
1.239 dholland 13974: <td>TOOLS_BROKEN</td>
1.156 leot 13975: </tr>
13976: <tr>
1.232 gutterid 13977: <td>TOOLS_CMD</td>
1.239 dholland 13978: <td>TOOLS_CMDLINE_SED</td>
1.156 leot 13979: </tr>
13980: <tr>
1.232 gutterid 13981: <td>TOOLS_CREATE</td>
1.239 dholland 13982: <td>TOOLS_CROSS_DESTDIR</td>
1.156 leot 13983: </tr>
13984: <tr>
1.232 gutterid 13985: <td>TOOLS_DIR</td>
1.239 dholland 13986: <td>TOOLS_FAIL</td>
1.156 leot 13987: </tr>
13988: <tr>
1.232 gutterid 13989: <td>TOOLS_GNU_MISSING</td>
1.239 dholland 13990: <td>TOOLS_LDCONFIG</td>
1.156 leot 13991: </tr>
13992: <tr>
1.232 gutterid 13993: <td>TOOLS_NOOP</td>
1.239 dholland 13994: <td>TOOLS_PATH</td>
1.156 leot 13995: </tr>
13996: <tr>
1.232 gutterid 13997: <td>TOOLS_SCRIPT</td>
1.239 dholland 13998: <td>TOOLS_USE_CROSS_COMPILE</td>
1.156 leot 13999: </tr>
14000: <tr>
1.232 gutterid 14001: <td>TOOL_DEPENDS</td>
1.237 gutterid 14002: <td>TTF_FONTS_DIR</td>
1.238 wiz 14003: </tr>
14004: <tr>
1.232 gutterid 14005: <td>TYPE</td>
1.238 wiz 14006: <td>UAC_REQD_EXECS</td>
1.156 leot 14007: </tr>
14008: <tr>
1.232 gutterid 14009: <td>UCSPI_SSL_GROUP</td>
1.238 wiz 14010: <td>UCSPI_SSL_USER</td>
1.223 nia 14011: </tr>
14012: <tr>
1.232 gutterid 14013: <td>UNLIMIT_RESOURCES</td>
1.238 wiz 14014: <td>UNPRIVILEGED</td>
1.156 leot 14015: </tr>
14016: <tr>
1.232 gutterid 14017: <td>UNPRIVILEGED_GROUP</td>
1.238 wiz 14018: <td>UNPRIVILEGED_GROUPS</td>
1.212 wiz 14019: </tr>
14020: <tr>
1.236 gutterid 14021: <td>UNPRIVILEGED_USER</td>
1.238 wiz 14022: <td>UNWRAP_FILES</td>
1.156 leot 14023: </tr>
14024: <tr>
1.236 gutterid 14025: <td>UNWRAP_PATTERNS</td>
1.238 wiz 14026: <td>UPDATE_GEMSPEC</td>
1.156 leot 14027: </tr>
14028: <tr>
1.236 gutterid 14029: <td>UPDATE_TARGET</td>
1.238 wiz 14030: <td>URI</td>
1.156 leot 14031: </tr>
14032: <tr>
1.236 gutterid 14033: <td>USERGROUP_PHASE</td>
1.238 wiz 14034: <td>USERPPP_GROUP</td>
1.156 leot 14035: </tr>
14036: <tr>
1.236 gutterid 14037: <td>USER_SPECIFIC_PKGS</td>
1.238 wiz 14038: <td>USE_ABI_DEPENDS</td>
1.156 leot 14039: </tr>
14040: <tr>
1.236 gutterid 14041: <td>USE_APR</td>
1.238 wiz 14042: <td>USE_BSD_MAKEFILE</td>
1.156 leot 14043: </tr>
14044: <tr>
1.236 gutterid 14045: <td>USE_BUILTIN</td>
1.238 wiz 14046: <td>USE_CROSS_COMPILE</td>
1.156 leot 14047: </tr>
14048: <tr>
1.236 gutterid 14049: <td>USE_CURSES</td>
1.238 wiz 14050: <td>USE_CWRAPPERS</td>
1.156 leot 14051: </tr>
14052: <tr>
1.236 gutterid 14053: <td>USE_DB185</td>
1.238 wiz 14054: <td>USE_FEATURES</td>
1.156 leot 14055: </tr>
14056: <tr>
1.236 gutterid 14057: <td>USE_GAMESGROUP</td>
1.238 wiz 14058: <td>USE_GCC_RUNTIME</td>
1.205 wiz 14059: </tr>
14060: <tr>
1.236 gutterid 14061: <td>USE_IMAKE</td>
1.238 wiz 14062: <td>USE_JAVA</td>
1.156 leot 14063: </tr>
14064: <tr>
1.236 gutterid 14065: <td>USE_JAVA2</td>
1.238 wiz 14066: <td>USE_LANGUAGES</td>
1.156 leot 14067: </tr>
14068: <tr>
1.236 gutterid 14069: <td>USE_LIBTOOL</td>
1.238 wiz 14070: <td>USE_NATIVE_GCC</td>
1.156 leot 14071: </tr>
14072: <tr>
1.236 gutterid 14073: <td>USE_NETBSD_REPO</td>
1.238 wiz 14074: <td>USE_PKGSRC_GCC</td>
1.156 leot 14075: </tr>
14076: <tr>
1.236 gutterid 14077: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.238 wiz 14078: <td>USE_PKGTASKS</td>
1.156 leot 14079: </tr>
14080: <tr>
1.236 gutterid 14081: <td>USE_PKG_ADMIN_DIGEST</td>
1.238 wiz 14082: <td>USE_RUBY_EXTCONF</td>
1.156 leot 14083: </tr>
14084: <tr>
1.236 gutterid 14085: <td>USE_RUBY_INSTALL</td>
1.238 wiz 14086: <td>USE_RUBY_SETUP</td>
1.156 leot 14087: </tr>
14088: <tr>
1.236 gutterid 14089: <td>USE_RUBY_SETUP_PKG</td>
1.238 wiz 14090: <td>USE_TOOLS</td>
1.156 leot 14091: </tr>
14092: <tr>
1.236 gutterid 14093: <td>UUCP_GROUP</td>
1.238 wiz 14094: <td>UUCP_USER</td>
1.156 leot 14095: </tr>
14096: <tr>
1.236 gutterid 14097: <td>VARBASE</td>
1.238 wiz 14098: <td>VARNAME</td>
1.156 leot 14099: </tr>
14100: <tr>
1.236 gutterid 14101: <td>VIM_EXTRA_OPTS</td>
1.238 wiz 14102: <td>WARNING_MSG</td>
1.156 leot 14103: </tr>
14104: <tr>
1.236 gutterid 14105: <td>WCALC_CGIDIR</td>
1.238 wiz 14106: <td>WCALC_CGIPATH</td>
1.156 leot 14107: </tr>
14108: <tr>
1.236 gutterid 14109: <td>WCALC_HTMLDIR</td>
1.238 wiz 14110: <td>WCALC_HTMLPATH</td>
1.156 leot 14111: </tr>
14112: <tr>
1.236 gutterid 14113: <td>WDM_MANAGERS</td>
1.238 wiz 14114: <td>WRAPPER_CC</td>
1.156 leot 14115: </tr>
14116: <tr>
1.236 gutterid 14117: <td>WRAPPER_REORDER_CMDS</td>
1.238 wiz 14118: <td>WRKDIR</td>
1.156 leot 14119: </tr>
14120: <tr>
1.236 gutterid 14121: <td>WRKDIR_BASENAME</td>
1.238 wiz 14122: <td>WRKDIR_LOCKTYPE</td>
1.156 leot 14123: </tr>
14124: <tr>
1.236 gutterid 14125: <td>WRKLOG</td>
1.238 wiz 14126: <td>WRKOBJDIR</td>
1.156 leot 14127: </tr>
14128: <tr>
1.236 gutterid 14129: <td>WRKSRC</td>
1.238 wiz 14130: <td>X10_PORT</td>
1.156 leot 14131: </tr>
14132: <tr>
1.236 gutterid 14133: <td>X11</td>
1.238 wiz 14134: <td>X11BASE</td>
1.156 leot 14135: </tr>
14136: <tr>
1.236 gutterid 14137: <td>X11_PKGSRCDIR</td>
1.238 wiz 14138: <td>X11_TYPE</td>
1.189 bacon 14139: </tr>
14140: <tr>
1.236 gutterid 14141: <td>X509_CERTIFICATE</td>
1.238 wiz 14142: <td>X509_KEY</td>
1.156 leot 14143: </tr>
14144: <tr>
1.236 gutterid 14145: <td>XAW_TYPE</td>
1.238 wiz 14146: <td>XLOCK_DEFAULT_MODE</td>
1.156 leot 14147: </tr>
14148: <tr>
1.236 gutterid 14149: <td>XMKMF</td>
1.238 wiz 14150: <td>XMKMF_FLAGS</td>
1.156 leot 14151: </tr>
14152: <tr>
1.236 gutterid 14153: <td>XXX</td>
1.239 dholland 14154: <td>YES</td>
1.233 wiz 14155: </tr>
14156: <tr>
1.232 gutterid 14157: <td>ZSH_STATIC</td>
1.239 dholland 14158: <td>__stdc__</td>
1.156 leot 14159: </tr>
14160: <tr>
1.232 gutterid 14161: <td>_vargroups</td>
1.239 dholland 14162: <td>accept</td>
1.227 wiz 14163: </tr>
14164: <tr>
1.232 gutterid 14165: <td>acquire-localbase-lock</td>
1.239 dholland 14166: <td>acquire-lock</td>
1.156 leot 14167: </tr>
14168: <tr>
1.232 gutterid 14169: <td>add</td>
1.239 dholland 14170: <td>added</td>
1.159 rillig 14171: </tr>
14172: <tr>
1.232 gutterid 14173: <td>administrator</td>
1.239 dholland 14174: <td>alloca</td>
1.217 rillig 14175: </tr>
14176: <tr>
1.232 gutterid 14177: <td>alternatives</td>
1.239 dholland 14178: <td>aslr</td>
1.156 leot 14179: </tr>
14180: <tr>
1.232 gutterid 14181: <td>asprintf</td>
1.239 dholland 14182: <td>atlas</td>
1.201 cirnatda 14183: </tr>
14184: <tr>
1.232 gutterid 14185: <td>autoconf</td>
1.239 dholland 14186: <td>automake</td>
1.174 leot 14187: </tr>
14188: <tr>
1.232 gutterid 14189: <td>autoreconf</td>
1.239 dholland 14190: <td>awk</td>
1.156 leot 14191: </tr>
14192: <tr>
1.232 gutterid 14193: <td>bash</td>
1.239 dholland 14194: <td>big-endian</td>
1.156 leot 14195: </tr>
14196: <tr>
1.232 gutterid 14197: <td>bin-install</td>
1.239 dholland 14198: <td>bind</td>
1.174 leot 14199: </tr>
14200: <tr>
1.232 gutterid 14201: <td>binpkg-list</td>
1.239 dholland 14202: <td>blas</td>
1.156 leot 14203: </tr>
14204: <tr>
1.232 gutterid 14205: <td>bootstrap-depends</td>
1.239 dholland 14206: <td>broken</td>
1.161 leot 14207: </tr>
14208: <tr>
1.232 gutterid 14209: <td>broken_on_platform</td>
1.239 dholland 14210: <td>bsd</td>
1.156 leot 14211: </tr>
14212: <tr>
1.232 gutterid 14213: <td>bsd.prog.mk</td>
1.239 dholland 14214: <td>build</td>
1.156 leot 14215: </tr>
14216: <tr>
1.232 gutterid 14217: <td>build-env</td>
1.239 dholland 14218: <td>buildlink-directories</td>
1.156 leot 14219: </tr>
14220: <tr>
1.232 gutterid 14221: <td>buildlink-oss-soundcard-h</td>
1.239 dholland 14222: <td>c</td>
1.177 leot 14223: </tr>
14224: <tr>
1.232 gutterid 14225: <td>c++</td>
1.239 dholland 14226: <td>ccache</td>
1.159 rillig 14227: </tr>
14228: <tr>
1.232 gutterid 14229: <td>cce</td>
1.239 dholland 14230: <td>cdefs</td>
1.156 leot 14231: </tr>
14232: <tr>
1.232 gutterid 14233: <td>ceil</td>
1.239 dholland 14234: <td>changes</td>
1.174 leot 14235: </tr>
14236: <tr>
1.232 gutterid 14237: <td>changes-entry</td>
1.239 dholland 14238: <td>changes-entry-noupdate</td>
1.156 leot 14239: </tr>
14240: <tr>
1.232 gutterid 14241: <td>check</td>
1.239 dholland 14242: <td>check-clean</td>
1.156 leot 14243: </tr>
14244: <tr>
1.232 gutterid 14245: <td>check-files</td>
1.239 dholland 14246: <td>check-files-clean</td>
1.156 leot 14247: </tr>
14248: <tr>
1.232 gutterid 14249: <td>check-vulnerable</td>
1.239 dholland 14250: <td>checksum</td>
1.156 leot 14251: </tr>
14252: <tr>
1.232 gutterid 14253: <td>checksum-phase</td>
1.239 dholland 14254: <td>clean</td>
1.174 leot 14255: </tr>
14256: <tr>
1.232 gutterid 14257: <td>clean-depends</td>
1.239 dholland 14258: <td>cleandir</td>
1.156 leot 14259: </tr>
14260: <tr>
1.232 gutterid 14261: <td>commit</td>
1.239 dholland 14262: <td>commit-changes-entry</td>
1.156 leot 14263: </tr>
14264: <tr>
1.232 gutterid 14265: <td>compact</td>
1.239 dholland 14266: <td>compiler</td>
1.156 leot 14267: </tr>
14268: <tr>
1.232 gutterid 14269: <td>conf</td>
1.239 dholland 14270: <td>config.guess</td>
1.156 leot 14271: </tr>
14272: <tr>
1.232 gutterid 14273: <td>config.sub</td>
1.239 dholland 14274: <td>configuration</td>
1.156 leot 14275: </tr>
14276: <tr>
1.232 gutterid 14277: <td>configure</td>
1.239 dholland 14278: <td>configure-env</td>
1.156 leot 14279: </tr>
14280: <tr>
1.232 gutterid 14281: <td>configure-help</td>
1.239 dholland 14282: <td>configure_args</td>
1.156 leot 14283: </tr>
14284: <tr>
1.232 gutterid 14285: <td>connect</td>
1.239 dholland 14286: <td>cos</td>
1.156 leot 14287: </tr>
14288: <tr>
1.232 gutterid 14289: <td>cpe</td>
1.239 dholland 14290: <td>cputime</td>
1.156 leot 14291: </tr>
14292: <tr>
1.229 gutterid 14293: <td>create-usergroup</td>
1.239 dholland 14294: <td>csh</td>
1.156 leot 14295: </tr>
14296: <tr>
1.229 gutterid 14297: <td>ctf</td>
1.237 gutterid 14298: <td>debug</td>
1.238 wiz 14299: </tr>
14300: <tr>
1.229 gutterid 14301: <td>declaration</td>
1.238 wiz 14302: <td>declare</td>
1.223 nia 14303: </tr>
14304: <tr>
1.229 gutterid 14305: <td>defined</td>
1.238 wiz 14306: <td>depend</td>
1.174 leot 14307: </tr>
14308: <tr>
1.229 gutterid 14309: <td>dependencies</td>
1.238 wiz 14310: <td>depends</td>
1.214 leot 14311: </tr>
14312: <tr>
1.229 gutterid 14313: <td>depends-checksum</td>
1.238 wiz 14314: <td>depends-fetch</td>
1.205 wiz 14315: </tr>
14316: <tr>
1.229 gutterid 14317: <td>deps</td>
1.238 wiz 14318: <td>describe</td>
1.161 leot 14319: </tr>
14320: <tr>
1.229 gutterid 14321: <td>destdir</td>
1.238 wiz 14322: <td>disable</td>
1.197 leot 14323: </tr>
14324: <tr>
1.229 gutterid 14325: <td>distclean</td>
1.238 wiz 14326: <td>distinfo</td>
1.156 leot 14327: </tr>
14328: <tr>
1.229 gutterid 14329: <td>dl</td>
1.238 wiz 14330: <td>dlopen</td>
1.156 leot 14331: </tr>
14332: <tr>
1.229 gutterid 14333: <td>do-buildlink</td>
1.238 wiz 14334: <td>do-clean</td>
1.156 leot 14335: </tr>
14336: <tr>
1.229 gutterid 14337: <td>do-configure</td>
1.238 wiz 14338: <td>do-configure-post-hook</td>
1.156 leot 14339: </tr>
14340: <tr>
1.229 gutterid 14341: <td>do-extract</td>
1.238 wiz 14342: <td>do-fetch</td>
1.156 leot 14343: </tr>
14344: <tr>
1.229 gutterid 14345: <td>do-install</td>
1.238 wiz 14346: <td>emul</td>
1.162 rillig 14347: </tr>
14348: <tr>
1.229 gutterid 14349: <td>emul-distinfo</td>
1.238 wiz 14350: <td>emul-fetch</td>
1.156 leot 14351: </tr>
14352: <tr>
1.229 gutterid 14353: <td>emulation</td>
1.238 wiz 14354: <td>emulator</td>
1.217 rillig 14355: </tr>
14356: <tr>
1.229 gutterid 14357: <td>enable</td>
1.238 wiz 14358: <td>endian</td>
1.233 wiz 14359: </tr>
14360: <tr>
1.229 gutterid 14361: <td>enomem</td>
1.239 dholland 14362: <td>ensurepip</td>
1.156 leot 14363: </tr>
14364: <tr>
1.229 gutterid 14365: <td>err</td>
1.239 dholland 14366: <td>errx</td>
1.227 wiz 14367: </tr>
14368: <tr>
1.229 gutterid 14369: <td>etc</td>
1.239 dholland 14370: <td>exp</td>
1.214 leot 14371: </tr>
14372: <tr>
1.229 gutterid 14373: <td>extract-rpm</td>
1.239 dholland 14374: <td>fabs</td>
1.156 leot 14375: </tr>
14376: <tr>
1.229 gutterid 14377: <td>feature</td>
1.239 dholland 14378: <td>features</td>
1.205 wiz 14379: </tr>
14380: <tr>
1.229 gutterid 14381: <td>fetch</td>
1.239 dholland 14382: <td>fetch-list</td>
1.197 leot 14383: </tr>
14384: <tr>
1.229 gutterid 14385: <td>follows</td>
1.239 dholland 14386: <td>forbids</td>
1.156 leot 14387: </tr>
14388: <tr>
1.229 gutterid 14389: <td>form</td>
1.239 dholland 14390: <td>format</td>
1.156 leot 14391: </tr>
14392: <tr>
1.229 gutterid 14393: <td>fortify</td>
1.237 gutterid 14394: <td>fortify_source</td>
1.238 wiz 14395: </tr>
14396: <tr>
1.229 gutterid 14397: <td>friend</td>
1.238 wiz 14398: <td>fts</td>
1.217 rillig 14399: </tr>
14400: <tr>
1.229 gutterid 14401: <td>fts_close</td>
1.238 wiz 14402: <td>fts_open</td>
1.223 nia 14403: </tr>
14404: <tr>
1.229 gutterid 14405: <td>fts_read</td>
1.238 wiz 14406: <td>fts_set</td>
1.156 leot 14407: </tr>
14408: <tr>
1.229 gutterid 14409: <td>gcc</td>
1.238 wiz 14410: <td>gethostbyaddr</td>
1.156 leot 14411: </tr>
14412: <tr>
1.229 gutterid 14413: <td>gethostbyname</td>
1.238 wiz 14414: <td>gethostbyname2</td>
1.156 leot 14415: </tr>
14416: <tr>
1.229 gutterid 14417: <td>getopt_long</td>
1.238 wiz 14418: <td>getprogname</td>
1.156 leot 14419: </tr>
14420: <tr>
1.229 gutterid 14421: <td>getservbyname</td>
1.238 wiz 14422: <td>getservbyport</td>
1.174 leot 14423: </tr>
14424: <tr>
1.229 gutterid 14425: <td>getservent</td>
1.238 wiz 14426: <td>gettext</td>
1.233 wiz 14427: </tr>
14428: <tr>
1.229 gutterid 14429: <td>github</td>
1.239 dholland 14430: <td>gitlab</td>
1.174 leot 14431: </tr>
14432: <tr>
1.229 gutterid 14433: <td>glob</td>
1.239 dholland 14434: <td>gnu</td>
1.227 wiz 14435: </tr>
14436: <tr>
1.229 gutterid 14437: <td>gnu_configure_strict</td>
1.239 dholland 14438: <td>go</td>
1.223 nia 14439: </tr>
14440: <tr>
1.229 gutterid 14441: <td>go-deps</td>
1.239 dholland 14442: <td>golang</td>
1.217 rillig 14443: </tr>
14444: <tr>
1.229 gutterid 14445: <td>guess-license</td>
1.239 dholland 14446: <td>hashbang</td>
1.156 leot 14447: </tr>
14448: <tr>
1.229 gutterid 14449: <td>heimdal</td>
1.237 gutterid 14450: <td>help</td>
1.238 wiz 14451: </tr>
14452: <tr>
1.229 gutterid 14453: <td>imake</td>
1.238 wiz 14454: <td>increment</td>
1.156 leot 14455: </tr>
14456: <tr>
1.229 gutterid 14457: <td>indirect</td>
1.238 wiz 14458: <td>inet_aton</td>
1.214 leot 14459: </tr>
14460: <tr>
1.229 gutterid 14461: <td>interp</td>
1.238 wiz 14462: <td>interpreter</td>
1.156 leot 14463: </tr>
14464: <tr>
1.229 gutterid 14465: <td>intl</td>
1.238 wiz 14466: <td>ip4</td>
1.205 wiz 14467: </tr>
14468: <tr>
1.229 gutterid 14469: <td>ip6</td>
1.238 wiz 14470: <td>ipv4</td>
1.197 leot 14471: </tr>
14472: <tr>
1.229 gutterid 14473: <td>ipv6</td>
1.238 wiz 14474: <td>iso</td>
1.161 leot 14475: </tr>
14476: <tr>
1.229 gutterid 14477: <td>kerberos</td>
1.238 wiz 14478: <td>krb</td>
1.156 leot 14479: </tr>
14480: <tr>
1.229 gutterid 14481: <td>krb5</td>
1.238 wiz 14482: <td>ksh</td>
1.156 leot 14483: </tr>
14484: <tr>
1.229 gutterid 14485: <td>lapack</td>
1.238 wiz 14486: <td>latex</td>
1.156 leot 14487: </tr>
14488: <tr>
1.229 gutterid 14489: <td>libintl_bindtextdomain</td>
1.238 wiz 14490: <td>libintl_gettext</td>
1.189 bacon 14491: </tr>
14492: <tr>
1.229 gutterid 14493: <td>libintl_textdomain</td>
1.238 wiz 14494: <td>libnbcompat</td>
1.189 bacon 14495: </tr>
14496: <tr>
1.229 gutterid 14497: <td>libs</td>
1.238 wiz 14498: <td>libtool</td>
1.156 leot 14499: </tr>
14500: <tr>
1.229 gutterid 14501: <td>licence</td>
1.238 wiz 14502: <td>license</td>
1.177 leot 14503: </tr>
14504: <tr>
1.229 gutterid 14505: <td>lintl</td>
1.238 wiz 14506: <td>little-endian</td>
1.156 leot 14507: </tr>
14508: <tr>
1.229 gutterid 14509: <td>lock</td>
1.238 wiz 14510: <td>locking</td>
1.174 leot 14511: </tr>
14512: <tr>
1.229 gutterid 14513: <td>lua</td>
1.238 wiz 14514: <td>lvalue</td>
1.159 rillig 14515: </tr>
14516: <tr>
1.229 gutterid 14517: <td>make</td>
1.238 wiz 14518: <td>makesum</td>
1.156 leot 14519: </tr>
14520: <tr>
1.229 gutterid 14521: <td>memory</td>
1.239 dholland 14522: <td>meta</td>
1.233 wiz 14523: </tr>
14524: <tr>
1.229 gutterid 14525: <td>meta-package</td>
1.239 dholland 14526: <td>meta_package</td>
1.227 wiz 14527: </tr>
14528: <tr>
1.229 gutterid 14529: <td>mit-krb5</td>
1.239 dholland 14530: <td>mk.conf</td>
1.156 leot 14531: </tr>
14532: <tr>
1.229 gutterid 14533: <td>mkl</td>
1.239 dholland 14534: <td>mount</td>
1.156 leot 14535: </tr>
14536: <tr>
1.229 gutterid 14537: <td>move</td>
1.239 dholland 14538: <td>moved</td>
1.177 leot 14539: </tr>
14540: <tr>
1.229 gutterid 14541: <td>mprotect</td>
1.239 dholland 14542: <td>mremap</td>
1.159 rillig 14543: </tr>
14544: <tr>
1.229 gutterid 14545: <td>nb</td>
1.239 dholland 14546: <td>nbcompat</td>
1.226 gutterid 14547: </tr>
14548: <tr>
1.229 gutterid 14549: <td>netlib</td>
1.239 dholland 14550: <td>node</td>
1.156 leot 14551: </tr>
14552: <tr>
1.229 gutterid 14553: <td>node.js</td>
1.239 dholland 14554: <td>nodejs</td>
1.156 leot 14555: </tr>
14556: <tr>
1.229 gutterid 14557: <td>obstack</td>
1.239 dholland 14558: <td>obstack_ptr_grow</td>
1.218 nia 14559: </tr>
14560: <tr>
1.229 gutterid 14561: <td>occurs</td>
1.239 dholland 14562: <td>only</td>
1.218 nia 14563: </tr>
14564: <tr>
1.229 gutterid 14565: <td>openblas</td>
1.239 dholland 14566: <td>options</td>
1.205 wiz 14567: </tr>
14568: <tr>
1.229 gutterid 14569: <td>options.mk</td>
1.239 dholland 14570: <td>order</td>
1.156 leot 14571: </tr>
14572: <tr>
1.229 gutterid 14573: <td>override</td>
1.239 dholland 14574: <td>override-intltool</td>
1.161 leot 14575: </tr>
14576: <tr>
1.229 gutterid 14577: <td>override-message-intltool</td>
1.239 dholland 14578: <td>package</td>
1.156 leot 14579: </tr>
14580: <tr>
1.229 gutterid 14581: <td>parallel</td>
1.239 dholland 14582: <td>path</td>
1.156 leot 14583: </tr>
14584: <tr>
1.229 gutterid 14585: <td>pax</td>
1.239 dholland 14586: <td>paxctl</td>
1.156 leot 14587: </tr>
14588: <tr>
1.229 gutterid 14589: <td>pbulk-index</td>
1.239 dholland 14590: <td>pc</td>
1.156 leot 14591: </tr>
14592: <tr>
1.229 gutterid 14593: <td>perl</td>
1.239 dholland 14594: <td>perl5</td>
1.156 leot 14595: </tr>
14596: <tr>
1.229 gutterid 14597: <td>perms</td>
1.239 dholland 14598: <td>php</td>
1.156 leot 14599: </tr>
14600: <tr>
1.229 gutterid 14601: <td>pkg-build-options</td>
1.239 dholland 14602: <td>pkg-config</td>
1.156 leot 14603: </tr>
14604: <tr>
1.229 gutterid 14605: <td>pkg_build_options</td>
1.239 dholland 14606: <td>platform</td>
1.156 leot 14607: </tr>
14608: <tr>
1.229 gutterid 14609: <td>plist</td>
1.239 dholland 14610: <td>post-extract</td>
1.156 leot 14611: </tr>
14612: <tr>
1.229 gutterid 14613: <td>post-fetch</td>
1.239 dholland 14614: <td>post-wrapper</td>
1.156 leot 14615: </tr>
14616: <tr>
1.229 gutterid 14617: <td>pre-build-checks-hook</td>
1.239 dholland 14618: <td>pre-configure-checks-hook</td>
1.156 leot 14619: </tr>
14620: <tr>
1.233 wiz 14621: <td>pre-extract</td>
1.239 dholland 14622: <td>pre-fetch</td>
1.156 leot 14623: </tr>
14624: <tr>
1.233 wiz 14625: <td>print-go-deps</td>
1.239 dholland 14626: <td>print-plist</td>
1.156 leot 14627: </tr>
14628: <tr>
1.233 wiz 14629: <td>print-summary-data</td>
1.239 dholland 14630: <td>privileged-install-hook</td>
1.174 leot 14631: </tr>
14632: <tr>
1.233 wiz 14633: <td>pypi</td>
1.239 dholland 14634: <td>python</td>
1.156 leot 14635: </tr>
14636: <tr>
1.233 wiz 14637: <td>r</td>
1.239 dholland 14638: <td>readme-all</td>
1.156 leot 14639: </tr>
14640: <tr>
1.233 wiz 14641: <td>recursive</td>
1.239 dholland 14642: <td>recv</td>
1.156 leot 14643: </tr>
14644: <tr>
1.233 wiz 14645: <td>recvfrom</td>
1.239 dholland 14646: <td>regcomp</td>
1.156 leot 14647: </tr>
14648: <tr>
1.233 wiz 14649: <td>release-localbase-lock</td>
1.239 dholland 14650: <td>release-lock</td>
1.156 leot 14651: </tr>
14652: <tr>
1.233 wiz 14653: <td>relro</td>
1.239 dholland 14654: <td>remove</td>
1.174 leot 14655: </tr>
14656: <tr>
1.233 wiz 14657: <td>removed</td>
1.239 dholland 14658: <td>rename</td>
1.174 leot 14659: </tr>
14660: <tr>
1.233 wiz 14661: <td>renamed</td>
1.239 dholland 14662: <td>reorder</td>
1.156 leot 14663: </tr>
14664: <tr>
1.233 wiz 14665: <td>replace</td>
1.239 dholland 14666: <td>replace_interpreter</td>
1.226 gutterid 14667: </tr>
14668: <tr>
1.233 wiz 14669: <td>reproducible</td>
1.239 dholland 14670: <td>resolv</td>
1.226 gutterid 14671: </tr>
14672: <tr>
1.233 wiz 14673: <td>root</td>
1.239 dholland 14674: <td>ruby</td>
1.156 leot 14675: </tr>
14676: <tr>
1.233 wiz 14677: <td>send</td>
1.239 dholland 14678: <td>sendfile</td>
1.156 leot 14679: </tr>
14680: <tr>
1.233 wiz 14681: <td>sendto</td>
1.239 dholland 14682: <td>setenv</td>
1.156 leot 14683: </tr>
14684: <tr>
1.233 wiz 14685: <td>setgid</td>
1.239 dholland 14686: <td>setprogname</td>
1.174 leot 14687: </tr>
14688: <tr>
1.233 wiz 14689: <td>setuid</td>
1.239 dholland 14690: <td>sh</td>
1.156 leot 14691: </tr>
14692: <tr>
1.233 wiz 14693: <td>shebang</td>
1.239 dholland 14694: <td>show</td>
1.156 leot 14695: </tr>
14696: <tr>
1.233 wiz 14697: <td>show-all</td>
1.239 dholland 14698: <td>show-build-defs</td>
1.156 leot 14699: </tr>
14700: <tr>
1.233 wiz 14701: <td>show-depends</td>
1.239 dholland 14702: <td>show-depends-dirs</td>
1.156 leot 14703: </tr>
14704: <tr>
1.233 wiz 14705: <td>show-depends-pkgpaths</td>
1.239 dholland 14706: <td>show-depends-recursive</td>
1.181 rillig 14707: </tr>
14708: <tr>
1.233 wiz 14709: <td>show-deps</td>
1.239 dholland 14710: <td>show-distfiles</td>
1.156 leot 14711: </tr>
14712: <tr>
1.233 wiz 14713: <td>show-downlevel</td>
1.239 dholland 14714: <td>show-subdir-var</td>
1.222 gutterid 14715: </tr>
14716: <tr>
1.233 wiz 14717: <td>show-tools</td>
1.239 dholland 14718: <td>show-var</td>
1.223 nia 14719: </tr>
14720: <tr>
1.233 wiz 14721: <td>show-vars</td>
1.239 dholland 14722: <td>snprintf</td>
1.156 leot 14723: </tr>
14724: <tr>
1.233 wiz 14725: <td>socket</td>
1.239 dholland 14726: <td>ssp</td>
1.156 leot 14727: </tr>
14728: <tr>
1.233 wiz 14729: <td>st_mode</td>
1.239 dholland 14730: <td>stage-install</td>
1.156 leot 14731: </tr>
14732: <tr>
1.233 wiz 14733: <td>strcasestr</td>
1.239 dholland 14734: <td>strict</td>
1.156 leot 14735: </tr>
14736: <tr>
1.233 wiz 14737: <td>strip</td>
1.239 dholland 14738: <td>strndup</td>
1.174 leot 14739: </tr>
14740: <tr>
1.233 wiz 14741: <td>strnlen</td>
1.239 dholland 14742: <td>strsep</td>
1.156 leot 14743: </tr>
14744: <tr>
1.233 wiz 14745: <td>subst</td>
1.237 gutterid 14746: <td>substitutions</td>
1.238 wiz 14747: </tr>
14748: <tr>
1.226 gutterid 14749: <td>sun</td>
1.238 wiz 14750: <td>sunpro</td>
1.214 leot 14751: </tr>
14752: <tr>
1.226 gutterid 14753: <td>sunwspro</td>
1.239 dholland 14754: <td>symlink</td>
1.212 wiz 14755: </tr>
14756: <tr>
1.228 gutterid 14757: <td>test</td>
1.239 dholland 14758: <td>test-env</td>
1.227 wiz 14759: </tr>
14760: <tr>
1.228 gutterid 14761: <td>tex</td>
1.239 dholland 14762: <td>texlive</td>
1.223 nia 14763: </tr>
14764: <tr>
1.228 gutterid 14765: <td>tmp</td>
1.239 dholland 14766: <td>todo</td>
1.161 leot 14767: </tr>
14768: <tr>
1.228 gutterid 14769: <td>tool</td>
1.239 dholland 14770: <td>tools</td>
1.156 leot 14771: </tr>
14772: <tr>
1.228 gutterid 14773: <td>tools-libtool-m4-override</td>
1.239 dholland 14774: <td>transitive</td>
1.156 leot 14775: </tr>
14776: <tr>
1.228 gutterid 14777: <td>type</td>
1.239 dholland 14778: <td>ulimit</td>
1.156 leot 14779: </tr>
14780: <tr>
1.228 gutterid 14781: <td>undefined</td>
1.239 dholland 14782: <td>undo-replace</td>
1.156 leot 14783: </tr>
14784: <tr>
1.228 gutterid 14785: <td>unlimit</td>
1.239 dholland 14786: <td>unprivileged</td>
1.156 leot 14787: </tr>
14788: <tr>
1.228 gutterid 14789: <td>unprivileged-install-hook</td>
1.239 dholland 14790: <td>unstripped</td>
1.156 leot 14791: </tr>
14792: <tr>
1.228 gutterid 14793: <td>update</td>
1.239 dholland 14794: <td>updated</td>
1.156 leot 14795: </tr>
14796: <tr>
1.228 gutterid 14797: <td>upload</td>
1.239 dholland 14798: <td>upload-distfiles</td>
1.156 leot 14799: </tr>
14800: <tr>
1.228 gutterid 14801: <td>use_tools</td>
1.239 dholland 14802: <td>user</td>
1.156 leot 14803: </tr>
14804: <tr>
1.228 gutterid 14805: <td>utimes</td>
1.239 dholland 14806: <td>vasprintf</td>
1.156 leot 14807: </tr>
14808: <tr>
1.228 gutterid 14809: <td>verbose</td>
1.239 dholland 14810: <td>vsnprintf</td>
1.156 leot 14811: </tr>
14812: <tr>
1.228 gutterid 14813: <td>warn</td>
1.239 dholland 14814: <td>warning</td>
1.156 leot 14815: </tr>
14816: <tr>
1.228 gutterid 14817: <td>warnings</td>
1.239 dholland 14818: <td>warnx</td>
1.156 leot 14819: </tr>
14820: <tr>
1.228 gutterid 14821: <td>wattr_off</td>
1.239 dholland 14822: <td>wattr_on</td>
1.156 leot 14823: </tr>
14824: <tr>
1.228 gutterid 14825: <td>work</td>
1.239 dholland 14826: <td>wrapper</td>
1.156 leot 14827: </tr>
14828: <tr>
1.174 leot 14829: <td>wrkdir</td>
1.239 dholland 14830: <td> </td>
1.156 leot 14831: </tr>
14832: </table>
1.154 rillig 14833: </div>
14834: <div class="appendix">
14835: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 14836: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 14837: <div class="toc">
14838: <p><b>Table of Contents</b></p>
1.100 leot 14839: <dl class="toc">
1.207 leot 14840: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
14841: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 14842: </dl>
14843: </div>
14844: <p>This section contains information on editing the pkgsrc
14845: guide itself.</p>
1.41 asau 14846: <div class="sect1">
1.1 dsieger 14847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 14848: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.1 dsieger 14849: <p>The pkgsrc guide's source code is stored in
14850: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
14851: are created from it:</p>
1.41 asau 14852: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 14853: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
14854: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.174 leot 14855: <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>
14856: <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 14857: The PDF version of the pkgsrc guide.</p></li>
1.174 leot 14858: <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 14859: PostScript version of the pkgsrc guide.</p></li>
14860: </ul></div>
14861: </div>
1.41 asau 14862: <div class="sect1">
1.1 dsieger 14863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 14864: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.1 dsieger 14865: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 14866: <div class="procedure"><ol class="procedure" type="1">
1.190 bacon 14867: <li class="step"><p>Make sure you have checked out the htdocs repository
14868: into a sibling directory of your pkgsrc directory. You will need
14869: the ability to commit from both pkgsrc and htdocs.</p></li>
1.41 asau 14870: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 14871: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 14872: documentation) installed. These are automatically installed when
1.207 leot 14873: 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 14874: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 14875: right directory. All further steps will take place
14876: here.</p></li>
1.41 asau 14877: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 14878: <code class="filename">files/</code>.</p></li>
1.41 asau 14879: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 14880: guide for valid XML and to build the final output files. If you
14881: get any errors at this stage, you can just edit the files, as
14882: there are only symbolic links in the working directory, pointing
14883: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 14884: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 14885: commit)</strong></span></p></li>
1.41 asau 14886: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 14887: regenerate the output files with the proper RCS
14888: Ids.</p></li>
1.41 asau 14889: <li class="step">
1.10 hubertf 14890: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 14891: commit the files in both <code class="filename">pkgsrc/doc</code> and
14892: <code class="filename">htdocs</code>.</p>
1.41 asau 14893: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 14894: <h3 class="title">Note</h3>
14895: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 14896: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
14897: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 14898: directory.</p>
14899: </div>
14900: </li>
14901: </ol></div>
14902: </div>
14903: </div>
14904: </div></body>
14905: </html>
CVSweb <webmaster@jp.NetBSD.org>